samayo / bulletproof

src/bulletproof.php

Doc Comments +3 added lines, -3 removed lines

@@ -352,7 +352,7 @@ 
     /**
      * Validate directory/permission before creating a folder.
      *
-     * @param $dir string the folder name to check
+     * @param string $dir string the folder name to check
      *
      * @return bool
      */
@@ -393,7 +393,7 @@ 
     /**
      * Validate image size, dimension or mimetypes
      *
-     * @return true|false
+     * @return boolean
      */
     protected function contraintsValidator()
     {
@@ -457,7 +457,7 @@ 
      * 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
+     * @param string $destination int upload destination
      *
      * @return bool
      */

Braces +21 added lines, -42 removed lines

@@ -96,8 +96,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 = 'Function \'exif_imagetype\' Not found. Please enable \'php_exif\' in your php.ini';
       }
@@ -128,8 +127,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('No file input found with name: (%s)', $offset);
@@ -154,8 +152,7 @@ 
      *
      * @return $this
      */
-    public function setDimension($maxWidth, $maxHeight)
-    {
+    public function setDimension($maxWidth, $maxHeight) {
       if ((int) $maxWidth && (int) $maxHeight) {
         $this->dimensions = array($maxWidth, $maxHeight);
       } else {
@@ -170,8 +167,7 @@ 
      *
      * @return string
      */
-    public function getFullPath()
-    {
+    public function getFullPath() {
       return $this->fullPath = $this->getLocation().'/'.$this->getName().'.'.$this->getMime();
     }
 
@@ -180,8 +176,7 @@ 
      *
      * @return int
      */
-    public function getSize()
-    {
+    public function getSize() {
       return (int) $this->_files['size'];
     }
 
@@ -193,8 +188,7 @@ 
      *
      * @return $this
      */
-    public function setSize($min, $max)
-    {
+    public function setSize($min, $max) {
       $this->size = array($min, $max);
       return $this;
     }
@@ -204,8 +198,7 @@ 
      *
      * @return string
      */
-    public function getJson()
-    {
+    public function getJson() {
       return json_encode(
         array(
           'name' => $this->name,
@@ -224,8 +217,7 @@ 
      *
      * @return null|string
      */
-    public function getMime()
-    {
+    public function getMime() {
       if (!$this->mime) {
         $this->mime = $this->getImageMime($this->_files['tmp_name']);
       }
@@ -240,8 +232,7 @@ 
      *
      * @return $this
      */
-    public function setMime(array $fileTypes)
-    {
+    public function setMime(array $fileTypes) {
       $this->mimeTypes = $fileTypes;
       return $this;
     }
@@ -253,8 +244,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;
@@ -268,8 +258,7 @@ 
      *
      * @return string|false
      */
-    public function getError()
-    {
+    public function getError() {
       return $this->error;
     }
 
@@ -278,8 +267,7 @@ 
      *
      * @return string
      */
-    public function getName()
-    {
+    public function getName() {
       if (!$this->name) {
         $this->name = uniqid('', true).'_'.str_shuffle(implode(range('e', 'q')));
       }
@@ -294,8 +282,7 @@ 
      *
      * @return $this
      */
-    public function setName($isNameProvided = null)
-    {
+    public function setName($isNameProvided = null) {
       if ($isNameProvided) {
         $this->name = filter_var($isNameProvided, FILTER_SANITIZE_STRING);
       }
@@ -308,8 +295,7 @@ 
      *
      * @return int
      */
-    public function getWidth()
-    {
+    public function getWidth() {
       if ($this->width != null) {
         return $this->width;
       }
@@ -324,8 +310,7 @@ 
      *
      * @return int
      */
-    public function getHeight()
-    {
+    public function getHeight() {
       if ($this->height != null) {
         return $this->height;
       }
@@ -340,8 +325,7 @@ 
      *
      * @return string
      */
-    public function getLocation()
-    {
+    public function getLocation() {
       if (!$this->location) {
         $this->setLocation();
       }
@@ -356,8 +340,7 @@ 
      *
      * @return bool
      */
-    private function isDirectoryValid($dir)
-    {
+    private function isDirectoryValid($dir) {
       return !file_exists($dir) && !is_dir($dir) || is_writable($dir);
     }
 
@@ -369,8 +352,7 @@ 
      *
      * @return $this
      */
-    public function setLocation($dir = 'bulletproof', $permission = 0666)
-    {
+    public function setLocation($dir = 'bulletproof', $permission = 0666) {
       $isDirectoryValid = $this->isDirectoryValid($dir);
 
       if (!$isDirectoryValid) {
@@ -395,8 +377,7 @@ 
      *
      * @return true|false
      */
-    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 */
@@ -436,8 +417,7 @@ 
      *
      * @return false|Image
      */
-    public function upload()
-    {
+    public function upload() {
       if ($this->error || !isset($this->_files['tmp_name'])) {
         return false;
       }
@@ -461,8 +441,7 @@ 
      *
      * @return bool
      */
-    protected function isSaved($tmp_name, $destination)
-    {
+    protected function isSaved($tmp_name, $destination) {
       return move_uploaded_file($tmp_name, $destination);
     }
 }