samayo / bulletproof

src/bulletproof.php

Indentation +505 added lines, -505 removed lines

@@ -15,509 +15,509 @@
 
 class Image implements \ArrayAccess
 {
-    /**
-     * @var string The new image name, to be provided or will be generated
-     */
-    protected $name;
-
-    /**
-     * @var int The image width in pixels
-     */
-    protected $width;
-
-    /**
-     * @var int The image height in pixels
-     */
-    protected $height;
-
-    /**
-     * @var string The image mime type (extension)
-     */
-    protected $mime;
-
-    /**
-     * @var string The full image path (dir + image + mime)
-     */
-    protected $fullPath;
-
-    /**
-     * @var string The folder or image storage location
-     */
-    protected $location;
-
-    /**
-     * @var array The min and max image size allowed for upload (in bytes)
-     */
-    protected $size = array(100, 500000);
-
-    /**
-     * @var array The max height and width image allowed
-     */
-    protected $dimensions = array(5000, 5000);
-
-    /**
-     * @var array The mime types allowed for upload
-     */
-    protected $mimeTypes = array('jpeg', 'png', 'gif', 'jpg');
-
-    /**
-     * @var array list of known image types
-     */
-    protected $acceptedMimes = array(
-      1 => 'gif', 'jpeg', 'png', 'swf', 'psd',
-      'bmp', 'tiff', 'tiff', 'jpc', 'jp2', 'jpx',
-      'jb2', 'swc', 'iff', 'wbmp', 'xbm', 'ico',
-    );
-
-    /**
-     * @var string The language
-     */
-    protected $language = 'en';
-
-    /**
-     * @var array error messages strings
-     */
-    protected $commonUploadErrors = array(
-      'en' => array(
-        UPLOAD_ERR_OK => '',
-        UPLOAD_ERR_INI_SIZE => 'Image is larger than the specified amount set by the server',
-        UPLOAD_ERR_FORM_SIZE => 'Image is larger than the specified amount specified by browser',
-        UPLOAD_ERR_PARTIAL => 'Image could not be fully uploaded. Please try again later',
-        UPLOAD_ERR_NO_FILE => 'Image is not found',
-        UPLOAD_ERR_NO_TMP_DIR => 'Can\'t write to disk, due to server configuration ( No tmp dir found )',
-        UPLOAD_ERR_CANT_WRITE => 'Failed to write file to disk. Please check you file permissions',
-        UPLOAD_ERR_EXTENSION => 'A PHP extension has halted this file upload process',
-
-        'ERROR_01' => 'Function \'exif_imagetype\' Not found. Please enable \'php_exif\' in your php.ini',
-        'ERROR_02' => 'No file input found with name: (%1$s)',
-        'ERROR_03' => 'Invalid dimension! Values must be integers',
-        'ERROR_04' => 'Can not create a directory (%1$s), please check write permission',
-        'ERROR_05' => 'Error! directory (%1$s) could not be created',
-        'ERROR_06' => 'Invalid File! Only (%1$s) image types are allowed',
-        'ERROR_07' => 'Image size should be minumum %1$s, upto maximum %2$s',
-        'ERROR_08' => 'Image height/width should be less than %1$s/%2$s pixels',
-        'ERROR_09' => 'Error! the language does not exist',
-      ),
-      'es' => array(
-        UPLOAD_ERR_OK => '',
-        UPLOAD_ERR_INI_SIZE => 'La imagen es más larga que la cantidad especificada por el servidor',
-        UPLOAD_ERR_FORM_SIZE => 'La imagen es mayor que la cantidad especificada por el navegador',
-        UPLOAD_ERR_PARTIAL => 'La imagen no fue completamente subida. Por favor inténtalo de nuevo más tarde',
-        UPLOAD_ERR_NO_FILE => 'La imagen no fue encontrada',
-        UPLOAD_ERR_NO_TMP_DIR => 'No se puede escribir en el disco debido a la configuración del servidor (directorio tmp no fue encontrado)',
-        UPLOAD_ERR_CANT_WRITE => 'No se pudo escribir en el disco. Por favor verifique sus permisos',
-        UPLOAD_ERR_EXTENSION => 'Una extensión de PHP ha interrumpido el proceso de subida del archivo',
-
-        'ERROR_01' => 'La función \'exif_imagetype\' no fue encontrada. Por favor habilita \'php_exif\' en php.ini',
-        'ERROR_02' => 'No se pudo encontrar el archivo de entrada con nombre: (%1$s)',
-        'ERROR_03' => 'Dimensiones inválidas! Los valores necesitan ser enteros',
-        'ERROR_04' => 'No se pudo crear el directorio (%1$s), por favor revisa los permisos de escritura',
-        'ERROR_05' => 'Error! directorio (%1$s) no pudo ser creado',
-        'ERROR_06' => 'Archivo inválido! Solo los tipos de imagen (%1$s) son permitidos',
-        'ERROR_07' => 'La imagen necesita ser por lo menos %1$s, y un máximo %2$s',
-        'ERROR_08' => 'El largo y ancho de la imagen necesita ser menos que %1$s/%2$s pixeles',
-        'ERROR_09' => 'Error! El idioma no existe',
-      ),
-    );
-
-    /**
-     * @var array storage for the global array
-     */
-    private $_files = array();
-
-    /**
-     * @var string storage for any errors
-     */
-    private $error = '';
-
-    /**
-     * @param array $_files represents the $_FILES array passed as dependency
-     */
-    public function __construct(array $_files = array())
-    {
-      if (!function_exists('exif_imagetype')) {
-        $this->error = $this->commonUploadErrors[$this->language]['ERROR_01'];
-      }
-
-      $this->_files = $_files;
-    }
-
-    /**
-     * \ArrayAccess unused method
-     * 
-     * @param mixed $offset
-     * @param mixed $value
-     */
-    public function offsetSet($offset, $value) {}
-
-    /**
-     * \ArrayAccess unused method
-     * 
-     * @param mixed $offset
-     */
-    public function offsetExists($offset){}
-
-    /**
-     * \ArrayAccess unused method
-     * 
-     * @param mixed $offset
-     */
-    public function offsetUnset($offset){}
-
-    /**
-     * \ArrayAccess - get array value from object
-     *
-     * @param mixed $offset
-     *
-     * @return string|bool
-     */
-    public function offsetGet($offset)
-    {
-      // return false if $_FILES['key'] isn't found
-      if (!isset($this->_files[$offset])) {
-        $this->error = sprintf($this->commonUploadErrors[$this->language]['ERROR_02'], $offset);
-        return false;
-      }
-
-      $this->_files = $this->_files[$offset];
-
-      // check for common upload errors
-      if (isset($this->_files['error'])) {
-        $this->error = $this->commonUploadErrors[$this->language][$this->_files['error']];
-      }
-
-      return true;
-    }
-
-    /**
-     * Sets max image height and width limit.
-     *
-     * @param $maxWidth int max width value
-     * @param $maxHeight int max height value
-     *
-     * @return $this
-     */
-    public function setDimension($maxWidth, $maxHeight)
-    {
-      if ( (int) $maxWidth && (int) $maxHeight) {
-        $this->dimensions = array($maxWidth, $maxHeight);
-      } else {
-        $this->error = $this->commonUploadErrors[$this->language]['ERROR_03'];
-      }
-
-      return $this;
-    }
-
-    /**
-     * Returns the full path of the image ex 'location/image.mime'.
-     *
-     * @return string
-     */
-    public function getFullPath()
-    {
-      return $this->fullPath = $this->getLocation().'/'.$this->getName().'.'.$this->getMime();
-    }
-
-    /**
-     * Define a language
-     *
-     * @param $lang string language code 
-     *
-     * @return $this
-     */
-    public function setLanguage($lang)
-    {
-      if (isset($this->commonUploadErrors[$lang])) {
-        $this->language = $lang;
-      } else {
-        $this->error = $this->commonUploadErrors[$this->language]['ERROR_09'];
-      }
-
-      return $this;
-    }
-
-    /**
-     * Returns the image size in bytes.
-     *
-     * @return int
-     */
-    public function getSize()
-    {
-      return (int) $this->_files['size'];
-    }
-
-    /**
-     * Define a min and max image size for uploading.
-     *
-     * @param $min int minimum value in bytes
-     * @param $max int maximum value in bytes
-     *
-     * @return $this
-     */
-    public function setSize($min, $max)
-    {
-      $this->size = array($min, $max);
-      return $this;
-    }
-
-    /**
-     * Returns a JSON format of the image width, height, name, mime ...
-     *
-     * @return string
-     */
-    public function getJson()
-    {
-      return json_encode(
-        array(
-          'name' => $this->name,
-          'mime' => $this->mime,
-          'height' => $this->height,
-          'width' => $this->width,
-          'size' => $this->_files['size'],
-          'location' => $this->location,
-          'fullpath' => $this->fullPath,
-        )
-      );
-    }
-
-    /**
-     * Returns the image mime type.
-     *
-     * @return null|string
-     */
-    public function getMime()
-    {
-      if (!$this->mime) {
-        $this->mime = $this->getImageMime($this->_files['tmp_name']);
-      }
-
-      return $this->mime;
-    }
-
-    /**
-     * Define a mime type for uploading.
-     *
-     * @param array $fileTypes
-     *
-     * @return $this
-     */
-    public function setMime(array $fileTypes)
-    {
-      $this->mimeTypes = $fileTypes;
-      return $this;
-    }
-
-    /**
-     * Gets the real image mime type.
-     *
-     * @param $tmp_name string The upload tmp directory
-     *
-     * @return null|string
-     */
-    protected function getImageMime($tmp_name)
-    {
-      $this->mime = @$this->acceptedMimes[exif_imagetype($tmp_name)];
-      if (!$this->mime) {
-        return null;
-      }
-
-      return $this->mime;
-    }
-
-    /**
-     * Returns error string
-     *
-     * @return string
-     */
-    public function getError()
-    {
-      return $this->error;
-    }
-
-    /**
-     * Returns the image name.
-     *
-     * @return string
-     */
-    public function getName()
-    {
-      if (!$this->name) {
-        $this->name = uniqid('', true).'_'.str_shuffle(implode(range('e', 'q')));
-      }
-
-      return $this->name;
-    }
-
-    /**
-     * Provide image name if not provided.
-     *
-     * @param null $isNameProvided
-     *
-     * @return $this
-     */
-    public function setName($isNameProvided = null)
-    {
-      if ($isNameProvided) {
-        $this->name = filter_var($isNameProvided, FILTER_SANITIZE_STRING);
-      }
-
-      return $this;
-    }
-
-    /**
-     * Returns the image width.
-     *
-     * @return int
-     */
-    public function getWidth()
-    {
-      if ($this->width != null) {
-        return $this->width;
-      }
-
-      list($width) = getimagesize($this->_files['tmp_name']);
-
-      return $width;
-    }
-
-    /**
-     * Returns the image height in pixels.
-     *
-     * @return int
-     */
-    public function getHeight()
-    {
-      if ($this->height != null) {
-        return $this->height;
-      }
-
-      list(, $height) = getimagesize($this->_files['tmp_name']);
-
-      return $height;
-    }
-
-    /**
-     * Returns the storage / folder name.
-     *
-     * @return string
-     */
-    public function getLocation()
-    {
-      if (!$this->location) {
-        $this->setLocation();
-      }
-
-      return $this->location;
-    }
-
-    /**
-     * Validate directory/permission before creating a folder.
-     *
-     * @param $dir string the folder name to check
-     *
-     * @return bool
-     */
-    private function isDirectoryValid($dir)
-    {
-      return !file_exists($dir) && !is_dir($dir) || is_writable($dir);
-    }
-
-    /**
-     * Creates a location for upload storage.
-     *
-     * @param $dir string the folder name to create
-     * @param int $permission chmod permission
-     *
-     * @return $this
-     */
-    public function setLocation($dir = 'bulletproof', $permission = 0666)
-    {
-      $isDirectoryValid = $this->isDirectoryValid($dir);
-
-      if (!$isDirectoryValid) {
-        $this->error = sprintf($this->commonUploadErrors[$this->language]['ERROR_04'], $dir);
-        return false;
-      }
-
-      $create = !is_dir($dir) ? @mkdir('' . $dir, (int) $permission, true) : true;
-
-      if (!$create) {
-        $this->error = sprintf($this->commonUploadErrors[$this->language]['ERROR_05'], $dir);
-        return false;
-      }
-
-      $this->location = $dir;
-
-      return $this;
-    }
-
-    /**
-     * Validate image size, dimension or mimetypes
-     *
-     * @return boolean
-     */
-    protected function contraintsValidator()
-    {
-      /* check image for valid mime types and return mime */
-      $this->getImageMime($this->_files['tmp_name']);
-      /* validate image mime type */
-      if (!in_array($this->mime, $this->mimeTypes)) {
-        $this->error = sprintf($this->commonUploadErrors[$this->language]['ERROR_06'], implode(', ', $this->mimeTypes));
-        return false;
-      }
-
-      /* get image sizes */
-      list($minSize, $maxSize) = $this->size;
-
-      /* check image size based on the settings */
-      if ($this->_files['size'] < $minSize || $this->_files['size'] > $maxSize) {
-        $min = $minSize.' bytes ('.intval($minSize / 1000).' kb)';
-        $max = $maxSize.' bytes ('.intval($maxSize / 1000).' kb)';
-        $this->error = sprintf($this->commonUploadErrors[$this->language]['ERROR_07'], $min, $max);
-        return false;
-      }
-
-      /* check image dimension */
-      list($maxWidth, $maxHeight) = $this->dimensions;
-      $this->width = $this->getWidth();
-      $this->height = $this->getHeight();
-
-      if ($this->height > $maxHeight || $this->width > $maxWidth) {
-        $this->error = sprintf($this->commonUploadErrors[$this->language]['ERROR_08'], $maxHeight, $maxWidth);
-        return false;
-      }
-
-      return true;
-    }
-
-    /**
-     * Validate and save (upload) file
-     *
-     * @return false|Image
-     */
-    public function upload()
-    {
-      if ($this->error !== '') {
-        return false;
-      }
-
-      $isValid = $this->contraintsValidator();
-
-      $isSuccess = $isValid && $this->isSaved($this->_files['tmp_name'], $this->getFullPath());
-
-      return $isSuccess ? $this : false;
-    }
-
-    /**
-     * Final upload method to be called, isolated for testing purposes.
-     *
-     * @param $tmp_name int the temporary location of the image file
-     * @param $destination int upload destination
-     *
-     * @return bool
-     */
-    protected function isSaved($tmp_name, $destination)
-    {
-      return move_uploaded_file($tmp_name, $destination);
-    }
+	/**
+	 * @var string The new image name, to be provided or will be generated
+	 */
+	protected $name;
+
+	/**
+	 * @var int The image width in pixels
+	 */
+	protected $width;
+
+	/**
+	 * @var int The image height in pixels
+	 */
+	protected $height;
+
+	/**
+	 * @var string The image mime type (extension)
+	 */
+	protected $mime;
+
+	/**
+	 * @var string The full image path (dir + image + mime)
+	 */
+	protected $fullPath;
+
+	/**
+	 * @var string The folder or image storage location
+	 */
+	protected $location;
+
+	/**
+	 * @var array The min and max image size allowed for upload (in bytes)
+	 */
+	protected $size = array(100, 500000);
+
+	/**
+	 * @var array The max height and width image allowed
+	 */
+	protected $dimensions = array(5000, 5000);
+
+	/**
+	 * @var array The mime types allowed for upload
+	 */
+	protected $mimeTypes = array('jpeg', 'png', 'gif', 'jpg');
+
+	/**
+	 * @var array list of known image types
+	 */
+	protected $acceptedMimes = array(
+	  1 => 'gif', 'jpeg', 'png', 'swf', 'psd',
+	  'bmp', 'tiff', 'tiff', 'jpc', 'jp2', 'jpx',
+	  'jb2', 'swc', 'iff', 'wbmp', 'xbm', 'ico',
+	);
+
+	/**
+	 * @var string The language
+	 */
+	protected $language = 'en';
+
+	/**
+	 * @var array error messages strings
+	 */
+	protected $commonUploadErrors = array(
+	  'en' => array(
+		UPLOAD_ERR_OK => '',
+		UPLOAD_ERR_INI_SIZE => 'Image is larger than the specified amount set by the server',
+		UPLOAD_ERR_FORM_SIZE => 'Image is larger than the specified amount specified by browser',
+		UPLOAD_ERR_PARTIAL => 'Image could not be fully uploaded. Please try again later',
+		UPLOAD_ERR_NO_FILE => 'Image is not found',
+		UPLOAD_ERR_NO_TMP_DIR => 'Can\'t write to disk, due to server configuration ( No tmp dir found )',
+		UPLOAD_ERR_CANT_WRITE => 'Failed to write file to disk. Please check you file permissions',
+		UPLOAD_ERR_EXTENSION => 'A PHP extension has halted this file upload process',
+
+		'ERROR_01' => 'Function \'exif_imagetype\' Not found. Please enable \'php_exif\' in your php.ini',
+		'ERROR_02' => 'No file input found with name: (%1$s)',
+		'ERROR_03' => 'Invalid dimension! Values must be integers',
+		'ERROR_04' => 'Can not create a directory (%1$s), please check write permission',
+		'ERROR_05' => 'Error! directory (%1$s) could not be created',
+		'ERROR_06' => 'Invalid File! Only (%1$s) image types are allowed',
+		'ERROR_07' => 'Image size should be minumum %1$s, upto maximum %2$s',
+		'ERROR_08' => 'Image height/width should be less than %1$s/%2$s pixels',
+		'ERROR_09' => 'Error! the language does not exist',
+	  ),
+	  'es' => array(
+		UPLOAD_ERR_OK => '',
+		UPLOAD_ERR_INI_SIZE => 'La imagen es más larga que la cantidad especificada por el servidor',
+		UPLOAD_ERR_FORM_SIZE => 'La imagen es mayor que la cantidad especificada por el navegador',
+		UPLOAD_ERR_PARTIAL => 'La imagen no fue completamente subida. Por favor inténtalo de nuevo más tarde',
+		UPLOAD_ERR_NO_FILE => 'La imagen no fue encontrada',
+		UPLOAD_ERR_NO_TMP_DIR => 'No se puede escribir en el disco debido a la configuración del servidor (directorio tmp no fue encontrado)',
+		UPLOAD_ERR_CANT_WRITE => 'No se pudo escribir en el disco. Por favor verifique sus permisos',
+		UPLOAD_ERR_EXTENSION => 'Una extensión de PHP ha interrumpido el proceso de subida del archivo',
+
+		'ERROR_01' => 'La función \'exif_imagetype\' no fue encontrada. Por favor habilita \'php_exif\' en php.ini',
+		'ERROR_02' => 'No se pudo encontrar el archivo de entrada con nombre: (%1$s)',
+		'ERROR_03' => 'Dimensiones inválidas! Los valores necesitan ser enteros',
+		'ERROR_04' => 'No se pudo crear el directorio (%1$s), por favor revisa los permisos de escritura',
+		'ERROR_05' => 'Error! directorio (%1$s) no pudo ser creado',
+		'ERROR_06' => 'Archivo inválido! Solo los tipos de imagen (%1$s) son permitidos',
+		'ERROR_07' => 'La imagen necesita ser por lo menos %1$s, y un máximo %2$s',
+		'ERROR_08' => 'El largo y ancho de la imagen necesita ser menos que %1$s/%2$s pixeles',
+		'ERROR_09' => 'Error! El idioma no existe',
+	  ),
+	);
+
+	/**
+	 * @var array storage for the global array
+	 */
+	private $_files = array();
+
+	/**
+	 * @var string storage for any errors
+	 */
+	private $error = '';
+
+	/**
+	 * @param array $_files represents the $_FILES array passed as dependency
+	 */
+	public function __construct(array $_files = array())
+	{
+	  if (!function_exists('exif_imagetype')) {
+		$this->error = $this->commonUploadErrors[$this->language]['ERROR_01'];
+	  }
+
+	  $this->_files = $_files;
+	}
+
+	/**
+	 * \ArrayAccess unused method
+	 * 
+	 * @param mixed $offset
+	 * @param mixed $value
+	 */
+	public function offsetSet($offset, $value) {}
+
+	/**
+	 * \ArrayAccess unused method
+	 * 
+	 * @param mixed $offset
+	 */
+	public function offsetExists($offset){}
+
+	/**
+	 * \ArrayAccess unused method
+	 * 
+	 * @param mixed $offset
+	 */
+	public function offsetUnset($offset){}
+
+	/**
+	 * \ArrayAccess - get array value from object
+	 *
+	 * @param mixed $offset
+	 *
+	 * @return string|bool
+	 */
+	public function offsetGet($offset)
+	{
+	  // return false if $_FILES['key'] isn't found
+	  if (!isset($this->_files[$offset])) {
+		$this->error = sprintf($this->commonUploadErrors[$this->language]['ERROR_02'], $offset);
+		return false;
+	  }
+
+	  $this->_files = $this->_files[$offset];
+
+	  // check for common upload errors
+	  if (isset($this->_files['error'])) {
+		$this->error = $this->commonUploadErrors[$this->language][$this->_files['error']];
+	  }
+
+	  return true;
+	}
+
+	/**
+	 * Sets max image height and width limit.
+	 *
+	 * @param $maxWidth int max width value
+	 * @param $maxHeight int max height value
+	 *
+	 * @return $this
+	 */
+	public function setDimension($maxWidth, $maxHeight)
+	{
+	  if ( (int) $maxWidth && (int) $maxHeight) {
+		$this->dimensions = array($maxWidth, $maxHeight);
+	  } else {
+		$this->error = $this->commonUploadErrors[$this->language]['ERROR_03'];
+	  }
+
+	  return $this;
+	}
+
+	/**
+	 * Returns the full path of the image ex 'location/image.mime'.
+	 *
+	 * @return string
+	 */
+	public function getFullPath()
+	{
+	  return $this->fullPath = $this->getLocation().'/'.$this->getName().'.'.$this->getMime();
+	}
+
+	/**
+	 * Define a language
+	 *
+	 * @param $lang string language code 
+	 *
+	 * @return $this
+	 */
+	public function setLanguage($lang)
+	{
+	  if (isset($this->commonUploadErrors[$lang])) {
+		$this->language = $lang;
+	  } else {
+		$this->error = $this->commonUploadErrors[$this->language]['ERROR_09'];
+	  }
+
+	  return $this;
+	}
+
+	/**
+	 * Returns the image size in bytes.
+	 *
+	 * @return int
+	 */
+	public function getSize()
+	{
+	  return (int) $this->_files['size'];
+	}
+
+	/**
+	 * Define a min and max image size for uploading.
+	 *
+	 * @param $min int minimum value in bytes
+	 * @param $max int maximum value in bytes
+	 *
+	 * @return $this
+	 */
+	public function setSize($min, $max)
+	{
+	  $this->size = array($min, $max);
+	  return $this;
+	}
+
+	/**
+	 * Returns a JSON format of the image width, height, name, mime ...
+	 *
+	 * @return string
+	 */
+	public function getJson()
+	{
+	  return json_encode(
+		array(
+		  'name' => $this->name,
+		  'mime' => $this->mime,
+		  'height' => $this->height,
+		  'width' => $this->width,
+		  'size' => $this->_files['size'],
+		  'location' => $this->location,
+		  'fullpath' => $this->fullPath,
+		)
+	  );
+	}
+
+	/**
+	 * Returns the image mime type.
+	 *
+	 * @return null|string
+	 */
+	public function getMime()
+	{
+	  if (!$this->mime) {
+		$this->mime = $this->getImageMime($this->_files['tmp_name']);
+	  }
+
+	  return $this->mime;
+	}
+
+	/**
+	 * Define a mime type for uploading.
+	 *
+	 * @param array $fileTypes
+	 *
+	 * @return $this
+	 */
+	public function setMime(array $fileTypes)
+	{
+	  $this->mimeTypes = $fileTypes;
+	  return $this;
+	}
+
+	/**
+	 * Gets the real image mime type.
+	 *
+	 * @param $tmp_name string The upload tmp directory
+	 *
+	 * @return null|string
+	 */
+	protected function getImageMime($tmp_name)
+	{
+	  $this->mime = @$this->acceptedMimes[exif_imagetype($tmp_name)];
+	  if (!$this->mime) {
+		return null;
+	  }
+
+	  return $this->mime;
+	}
+
+	/**
+	 * Returns error string
+	 *
+	 * @return string
+	 */
+	public function getError()
+	{
+	  return $this->error;
+	}
+
+	/**
+	 * Returns the image name.
+	 *
+	 * @return string
+	 */
+	public function getName()
+	{
+	  if (!$this->name) {
+		$this->name = uniqid('', true).'_'.str_shuffle(implode(range('e', 'q')));
+	  }
+
+	  return $this->name;
+	}
+
+	/**
+	 * Provide image name if not provided.
+	 *
+	 * @param null $isNameProvided
+	 *
+	 * @return $this
+	 */
+	public function setName($isNameProvided = null)
+	{
+	  if ($isNameProvided) {
+		$this->name = filter_var($isNameProvided, FILTER_SANITIZE_STRING);
+	  }
+
+	  return $this;
+	}
+
+	/**
+	 * Returns the image width.
+	 *
+	 * @return int
+	 */
+	public function getWidth()
+	{
+	  if ($this->width != null) {
+		return $this->width;
+	  }
+
+	  list($width) = getimagesize($this->_files['tmp_name']);
+
+	  return $width;
+	}
+
+	/**
+	 * Returns the image height in pixels.
+	 *
+	 * @return int
+	 */
+	public function getHeight()
+	{
+	  if ($this->height != null) {
+		return $this->height;
+	  }
+
+	  list(, $height) = getimagesize($this->_files['tmp_name']);
+
+	  return $height;
+	}
+
+	/**
+	 * Returns the storage / folder name.
+	 *
+	 * @return string
+	 */
+	public function getLocation()
+	{
+	  if (!$this->location) {
+		$this->setLocation();
+	  }
+
+	  return $this->location;
+	}
+
+	/**
+	 * Validate directory/permission before creating a folder.
+	 *
+	 * @param $dir string the folder name to check
+	 *
+	 * @return bool
+	 */
+	private function isDirectoryValid($dir)
+	{
+	  return !file_exists($dir) && !is_dir($dir) || is_writable($dir);
+	}
+
+	/**
+	 * Creates a location for upload storage.
+	 *
+	 * @param $dir string the folder name to create
+	 * @param int $permission chmod permission
+	 *
+	 * @return $this
+	 */
+	public function setLocation($dir = 'bulletproof', $permission = 0666)
+	{
+	  $isDirectoryValid = $this->isDirectoryValid($dir);
+
+	  if (!$isDirectoryValid) {
+		$this->error = sprintf($this->commonUploadErrors[$this->language]['ERROR_04'], $dir);
+		return false;
+	  }
+
+	  $create = !is_dir($dir) ? @mkdir('' . $dir, (int) $permission, true) : true;
+
+	  if (!$create) {
+		$this->error = sprintf($this->commonUploadErrors[$this->language]['ERROR_05'], $dir);
+		return false;
+	  }
+
+	  $this->location = $dir;
+
+	  return $this;
+	}
+
+	/**
+	 * Validate image size, dimension or mimetypes
+	 *
+	 * @return boolean
+	 */
+	protected function contraintsValidator()
+	{
+	  /* check image for valid mime types and return mime */
+	  $this->getImageMime($this->_files['tmp_name']);
+	  /* validate image mime type */
+	  if (!in_array($this->mime, $this->mimeTypes)) {
+		$this->error = sprintf($this->commonUploadErrors[$this->language]['ERROR_06'], implode(', ', $this->mimeTypes));
+		return false;
+	  }
+
+	  /* get image sizes */
+	  list($minSize, $maxSize) = $this->size;
+
+	  /* check image size based on the settings */
+	  if ($this->_files['size'] < $minSize || $this->_files['size'] > $maxSize) {
+		$min = $minSize.' bytes ('.intval($minSize / 1000).' kb)';
+		$max = $maxSize.' bytes ('.intval($maxSize / 1000).' kb)';
+		$this->error = sprintf($this->commonUploadErrors[$this->language]['ERROR_07'], $min, $max);
+		return false;
+	  }
+
+	  /* check image dimension */
+	  list($maxWidth, $maxHeight) = $this->dimensions;
+	  $this->width = $this->getWidth();
+	  $this->height = $this->getHeight();
+
+	  if ($this->height > $maxHeight || $this->width > $maxWidth) {
+		$this->error = sprintf($this->commonUploadErrors[$this->language]['ERROR_08'], $maxHeight, $maxWidth);
+		return false;
+	  }
+
+	  return true;
+	}
+
+	/**
+	 * Validate and save (upload) file
+	 *
+	 * @return false|Image
+	 */
+	public function upload()
+	{
+	  if ($this->error !== '') {
+		return false;
+	  }
+
+	  $isValid = $this->contraintsValidator();
+
+	  $isSuccess = $isValid && $this->isSaved($this->_files['tmp_name'], $this->getFullPath());
+
+	  return $isSuccess ? $this : false;
+	}
+
+	/**
+	 * Final upload method to be called, isolated for testing purposes.
+	 *
+	 * @param $tmp_name int the temporary location of the image file
+	 * @param $destination int upload destination
+	 *
+	 * @return bool
+	 */
+	protected function isSaved($tmp_name, $destination)
+	{
+	  return move_uploaded_file($tmp_name, $destination);
+	}
 }

Braces +22 added lines, -44 removed lines

@@ -133,8 +133,7 @@ 
     /**
      * @param array $_files represents the $_FILES array passed as dependency
      */
-    public function __construct(array $_files = array())
-    {
+    public function __construct(array $_files = array()) {
       if (!function_exists('exif_imagetype')) {
         $this->error = $this->commonUploadErrors[$this->language]['ERROR_01'];
       }
@@ -171,8 +170,7 @@ 
      *
      * @return string|bool
      */
-    public function offsetGet($offset)
-    {
+    public function offsetGet($offset) {
       // return false if $_FILES['key'] isn't found
       if (!isset($this->_files[$offset])) {
         $this->error = sprintf($this->commonUploadErrors[$this->language]['ERROR_02'], $offset);
@@ -197,8 +195,7 @@ 
      *
      * @return $this
      */
-    public function setDimension($maxWidth, $maxHeight)
-    {
+    public function setDimension($maxWidth, $maxHeight) {
       if ( (int) $maxWidth && (int) $maxHeight) {
         $this->dimensions = array($maxWidth, $maxHeight);
       } else {
@@ -213,8 +210,7 @@ 
      *
      * @return string
      */
-    public function getFullPath()
-    {
+    public function getFullPath() {
       return $this->fullPath = $this->getLocation().'/'.$this->getName().'.'.$this->getMime();
     }
 
@@ -225,8 +221,7 @@ 
      *
      * @return $this
      */
-    public function setLanguage($lang)
-    {
+    public function setLanguage($lang) {
       if (isset($this->commonUploadErrors[$lang])) {
         $this->language = $lang;
       } else {
@@ -241,8 +236,7 @@ 
      *
      * @return int
      */
-    public function getSize()
-    {
+    public function getSize() {
       return (int) $this->_files['size'];
     }
 
@@ -254,8 +248,7 @@ 
      *
      * @return $this
      */
-    public function setSize($min, $max)
-    {
+    public function setSize($min, $max) {
       $this->size = array($min, $max);
       return $this;
     }
@@ -265,8 +258,7 @@ 
      *
      * @return string
      */
-    public function getJson()
-    {
+    public function getJson() {
       return json_encode(
         array(
           'name' => $this->name,
@@ -285,8 +277,7 @@ 
      *
      * @return null|string
      */
-    public function getMime()
-    {
+    public function getMime() {
       if (!$this->mime) {
         $this->mime = $this->getImageMime($this->_files['tmp_name']);
       }
@@ -301,8 +292,7 @@ 
      *
      * @return $this
      */
-    public function setMime(array $fileTypes)
-    {
+    public function setMime(array $fileTypes) {
       $this->mimeTypes = $fileTypes;
       return $this;
     }
@@ -314,8 +304,7 @@ 
      *
      * @return null|string
      */
-    protected function getImageMime($tmp_name)
-    {
+    protected function getImageMime($tmp_name) {
       $this->mime = @$this->acceptedMimes[exif_imagetype($tmp_name)];
       if (!$this->mime) {
         return null;
@@ -329,8 +318,7 @@ 
      *
      * @return string
      */
-    public function getError()
-    {
+    public function getError() {
       return $this->error;
     }
 
@@ -339,8 +327,7 @@ 
      *
      * @return string
      */
-    public function getName()
-    {
+    public function getName() {
       if (!$this->name) {
         $this->name = uniqid('', true).'_'.str_shuffle(implode(range('e', 'q')));
       }
@@ -355,8 +342,7 @@ 
      *
      * @return $this
      */
-    public function setName($isNameProvided = null)
-    {
+    public function setName($isNameProvided = null) {
       if ($isNameProvided) {
         $this->name = filter_var($isNameProvided, FILTER_SANITIZE_STRING);
       }
@@ -369,8 +355,7 @@ 
      *
      * @return int
      */
-    public function getWidth()
-    {
+    public function getWidth() {
       if ($this->width != null) {
         return $this->width;
       }
@@ -385,8 +370,7 @@ 
      *
      * @return int
      */
-    public function getHeight()
-    {
+    public function getHeight() {
       if ($this->height != null) {
         return $this->height;
       }
@@ -401,8 +385,7 @@ 
      *
      * @return string
      */
-    public function getLocation()
-    {
+    public function getLocation() {
       if (!$this->location) {
         $this->setLocation();
       }
@@ -417,8 +400,7 @@ 
      *
      * @return bool
      */
-    private function isDirectoryValid($dir)
-    {
+    private function isDirectoryValid($dir) {
       return !file_exists($dir) && !is_dir($dir) || is_writable($dir);
     }
 
@@ -430,8 +412,7 @@ 
      *
      * @return $this
      */
-    public function setLocation($dir = 'bulletproof', $permission = 0666)
-    {
+    public function setLocation($dir = 'bulletproof', $permission = 0666) {
       $isDirectoryValid = $this->isDirectoryValid($dir);
 
       if (!$isDirectoryValid) {
@@ -456,8 +437,7 @@ 
      *
      * @return boolean
      */
-    protected function contraintsValidator()
-    {
+    protected function contraintsValidator() {
       /* check image for valid mime types and return mime */
       $this->getImageMime($this->_files['tmp_name']);
       /* validate image mime type */
@@ -495,8 +475,7 @@ 
      *
      * @return false|Image
      */
-    public function upload()
-    {
+    public function upload() {
       if ($this->error !== '') {
         return false;
       }
@@ -516,8 +495,7 @@ 
      *
      * @return bool
      */
-    protected function isSaved($tmp_name, $destination)
-    {
+    protected function isSaved($tmp_name, $destination) {
       return move_uploaded_file($tmp_name, $destination);
     }
 }