evolution-cms / evolution

manager/media/browser/mcpuk/core/uploader.php

Doc Comments +7 added lines, -7 removed lines

@@ -312,7 +312,7 @@ 
 
     /**
      * @param $filename
-     * @return mixed|string
+     * @return string
      */
     protected function normalizeFilename($filename) {
 		if ($this->getTransaliasSettings()) {
@@ -324,7 +324,7 @@ 
 	}
 
     /**
-     * @param $dirname
+     * @param string $dirname
      * @return string
      */
     protected function normalizeDirname($dirname) {
@@ -408,7 +408,7 @@ 
      * @param $dir
      * @param bool $inclType
      * @param bool $existing
-     * @return bool|string
+     * @return false|string
      */
     protected function checkInputDir($dir, $inclType=true, $existing=true) {
         $dir = path::normalize($dir);
@@ -437,7 +437,7 @@ 
     }
 
     /**
-     * @param $ext
+     * @param string $ext
      * @param $type
      * @return bool
      */
@@ -468,7 +468,7 @@ 
 
     /**
      * @param $path
-     * @return mixed
+     * @return string
      */
     protected function getTypeFromPath($path) {
         return preg_match('/^([^\/]*)\/.*$/', $path, $patt)
@@ -476,7 +476,7 @@ 
     }
 
     /**
-     * @param $path
+     * @param string $path
      * @return string
      */
     protected function removeTypeFromPath($path) {
@@ -694,7 +694,7 @@ 
     }
 
     /**
-     * @param $url
+     * @param string $url
      * @param string $message
      */
     protected function callBack($url, $message="") {

Indentation +68 added lines, -68 removed lines

@@ -1,16 +1,16 @@ 
 <?php
 
 /** This file is part of KCFinder project
-  *
-  *      @desc Uploader class
-  *   @package KCFinder
-  *   @version 2.54
-  *    @author Pavel Tzonkov <sunhater@sunhater.com>
-  * @copyright 2010-2014 KCFinder Project
-  *   @license http://www.opensource.org/licenses/gpl-2.0.php GPLv2
-  *   @license http://www.opensource.org/licenses/lgpl-2.1.php LGPLv2
-  *      @link http://kcfinder.sunhater.com
-  */
+ *
+ *      @desc Uploader class
+ *   @package KCFinder
+ *   @version 2.54
+ *    @author Pavel Tzonkov <sunhater@sunhater.com>
+ * @copyright 2010-2014 KCFinder Project
+ *   @license http://www.opensource.org/licenses/gpl-2.0.php GPLv2
+ *   @license http://www.opensource.org/licenses/lgpl-2.1.php LGPLv2
+ *      @link http://kcfinder.sunhater.com
+ */
 
 class uploader {
 
@@ -18,92 +18,92 @@ 
     const VERSION = "2.54";
 
 /** Config session-overrided settings
-  * @var array */
+ * @var array */
     protected $config = array();
 
 /** Default image driver
-  * @var string */
+ * @var string */
     protected $imageDriver = "gd";
 
 /** Opener applocation properties
-  *   $opener['name']                 Got from $_GET['opener'];
-  *   $opener['CKEditor']['funcNum']  CKEditor function number (got from $_GET)
-  *   $opener['TinyMCE']              Boolean
-  * @var array */
+ *   $opener['name']                 Got from $_GET['opener'];
+ *   $opener['CKEditor']['funcNum']  CKEditor function number (got from $_GET)
+ *   $opener['TinyMCE']              Boolean
+ * @var array */
     protected $opener = array();
 
 /** Got from $_GET['type'] or first one $config['types'] array key, if inexistant
-  * @var string */
+ * @var string */
     protected $type;
 
 /** Helper property. Local filesystem path to the Type Directory
-  * Equivalent: $config['uploadDir'] . "/" . $type
-  * @var string */
+ * Equivalent: $config['uploadDir'] . "/" . $type
+ * @var string */
     protected $typeDir;
 
 /** Helper property. Web URL to the Type Directory
-  * Equivalent: $config['uploadURL'] . "/" . $type
-  * @var string */
+ * Equivalent: $config['uploadURL'] . "/" . $type
+ * @var string */
     protected $typeURL;
 
 /** Linked to $config['types']
-  * @var array */
+ * @var array */
     protected $types = array();
 
 /** Settings which can override default settings if exists as keys in $config['types'][$type] array
-  * @var array */
+ * @var array */
     protected $typeSettings = array('disabled', 'theme', 'dirPerms', 'filePerms', 'denyZipDownload', 'maxImageWidth', 'maxImageHeight', 'thumbWidth', 'thumbHeight', 'jpegQuality', 'access', 'filenameChangeChars', 'dirnameChangeChars', 'denyExtensionRename', 'deniedExts', 'watermark');
 
 /** Got from language file
-  * @var string */
+ * @var string */
     protected $charset;
 
 /** The language got from $_GET['lng'] or $_GET['lang'] or... Please see next property
-  * @var string */
+ * @var string */
     protected $lang = 'en';
 
 /** Possible language $_GET keys
-  * @var array */
+ * @var array */
     protected $langInputNames = array('lang', 'langCode', 'lng', 'language', 'lang_code');
 
 /** Uploaded file(s) info. Linked to first $_FILES element
-  * @var array */
+ * @var array */
     protected $file;
 
 /** Next three properties are got from the current language file
-  * @var string */
+ * @var string */
     protected $dateTimeFull;   // Currently not used
     protected $dateTimeMid;    // Currently not used
     protected $dateTimeSmall;
 
 /** Contain Specified language labels
-  * @var array */
+ * @var array */
     protected $labels = array();
 
 /** Contain unprocessed $_GET array. Please use this instead of $_GET
-  * @var array */
+ * @var array */
     protected $get;
 
 /** Contain unprocessed $_POST array. Please use this instead of $_POST
-  * @var array */
+ * @var array */
     protected $post;
 
 /** Contain unprocessed $_COOKIE array. Please use this instead of $_COOKIE
-  * @var array */
+ * @var array */
     protected $cookie;
 
 /** Session array. Please use this property instead of $_SESSION
-  * @var array */
+ * @var array */
     protected $session;
 
 /** CMS integration attribute (got from $_GET['cms'])
-  * @var string */
+ * @var string */
     protected $cms = "";
 
     protected $modx = null;
 /** Magic method which allows read-only access to protected or private class properties
-  * @param string $property
-  * @return mixed */
+     * @param string $property
+     * @return mixed */
     public function __get($property) {
         return property_exists($this, $property) ? $this->$property : null;
     }
@@ -136,7 +136,7 @@ 
         )
             $this->cms = $this->get['cms'];
 
-		// LINKING UPLOADED FILE
+        // LINKING UPLOADED FILE
         if (count($_FILES))
             $this->file = &$_FILES[key($_FILES)];
 
@@ -217,8 +217,8 @@ 
             $this->config['uploadDir'] = strlen($this->config['uploadDir'])
                 ? path::normalize($this->config['uploadDir'])
                 : path::url2fullPath("/$path");
-         $this->typeDir = "{$this->config['uploadDir']}/{$this->type}";
-         $this->typeURL = "{$this->config['siteURL']}/{$this->config['uploadURL']}/{$this->type}";
+            $this->typeDir = "{$this->config['uploadDir']}/{$this->type}";
+            $this->typeURL = "{$this->config['siteURL']}/{$this->config['uploadURL']}/{$this->type}";
 
         // SITE ROOT
         } elseif ($this->config['uploadURL'] == "/") {
@@ -291,23 +291,23 @@ 
      * @return array|bool|int|null|string|void
      */
     protected function getTransaliasSettings() {
-		$modx = evolutionCMS();
-
-		// Cleaning uploaded filename?
-		$setting = $modx->getDatabase()->select('count(*)', $modx->getDatabase()->getFullTableName('system_settings'), 'setting_name="clean_uploaded_filename" AND setting_value=1');
-		if ($modx->getDatabase()->getValue($setting)>0) {
-			// Transalias plugin active?
-			$res = $modx->getDatabase()->select('properties', $modx->getDatabase()->getFullTableName('site_plugins'), 'name="TransAlias" AND disabled=0');
-			if ($properties = $modx->getDatabase()->getValue($res)) {
-				$properties = $modx->parseProperties($properties, 'TransAlias', 'plugin');
-			} else {
-				$properties = NULL;
-			}
-		} else {
-			$properties = NULL;
-		}
-		return $properties;
-	}
+        $modx = evolutionCMS();
+
+        // Cleaning uploaded filename?
+        $setting = $modx->getDatabase()->select('count(*)', $modx->getDatabase()->getFullTableName('system_settings'), 'setting_name="clean_uploaded_filename" AND setting_value=1');
+        if ($modx->getDatabase()->getValue($setting)>0) {
+            // Transalias plugin active?
+            $res = $modx->getDatabase()->select('properties', $modx->getDatabase()->getFullTableName('site_plugins'), 'name="TransAlias" AND disabled=0');
+            if ($properties = $modx->getDatabase()->getValue($res)) {
+                $properties = $modx->parseProperties($properties, 'TransAlias', 'plugin');
+            } else {
+                $properties = NULL;
+            }
+        } else {
+            $properties = NULL;
+        }
+        return $properties;
+    }
 
 
     /**
@@ -315,13 +315,13 @@ 
      * @return mixed|string
      */
     protected function normalizeFilename($filename) {
-		if ($this->getTransaliasSettings()) {
-        		$format = strrchr($filename, ".");
-        		$filename = str_replace($format, "", $filename);
-            		$filename = $this->modx->stripAlias($filename).$format;
-        	}
-        	return $filename;
-	}
+        if ($this->getTransaliasSettings()) {
+                $format = strrchr($filename, ".");
+                $filename = str_replace($format, "", $filename);
+                    $filename = $this->modx->stripAlias($filename).$format;
+            }
+            return $filename;
+    }
 
     /**
      * @param $dirname
@@ -396,10 +396,10 @@ 
             return $this->label("The image is too big and/or cannot be resized.");
 
 
-	// CHECK FOR MODX MAX FILE SIZE
-	$actualfilesize=filesize($file['tmp_name']);
-	if (isset($this->config['maxfilesize']) && $actualfilesize > $this->config['maxfilesize'])
-	    return $this->label("File is too big: ".$actualfilesize." Bytes. (max ".$this->config['maxfilesize']." Bytes)");
+    // CHECK FOR MODX MAX FILE SIZE
+    $actualfilesize=filesize($file['tmp_name']);
+    if (isset($this->config['maxfilesize']) && $actualfilesize > $this->config['maxfilesize'])
+        return $this->label("File is too big: ".$actualfilesize." Bytes. (max ".$this->config['maxfilesize']." Bytes)");
 
         return true;
     }
@@ -575,7 +575,7 @@ 
             $top = isset($this->config['watermark']['top'])
                 ? $this->config['watermark']['top'] : false;
             $img->watermark($this->config['watermark']['file'], $left, $top);
-		}
+        }
 
         $options = array( 'file' => $file );
 

manager/media/browser/mcpuk/config.php

Indentation +2 added lines, -2 removed lines

@@ -72,8 +72,8 @@
     'maxImageWidth'  => $modx->config['maxImageWidth'],
     'maxImageHeight' => $modx->config['maxImageHeight'],
     'clientResize'   => $modx->config['clientResize'] && $modx->config['maxImageWidth'] && $modx->config['maxImageHeight'] ? array('maxWidth'  => $modx->config['maxImageWidth'],
-                                                                                                                                   'maxHeight' => $modx->config['maxImageHeight'],
-                                                                                                                                   'quality'   => $modx->config['jpegQuality'] / 100
+                                                                                                                                    'maxHeight' => $modx->config['maxImageHeight'],
+                                                                                                                                    'quality'   => $modx->config['jpegQuality'] / 100
     ) : array(),
 
     'thumbWidth'  => $modx->config['thumbWidth'],

manager/media/browser/mcpuk/core/autoload.php

Indentation +18 added lines, -18 removed lines

@@ -1,24 +1,24 @@
 <?php
 
 /** This file is part of KCFinder project
-  *
-  *      @desc This file is included first, before each other
-  *   @package KCFinder
-  *   @version 2.54
-  *    @author Pavel Tzonkov <sunhater@sunhater.com>
-  * @copyright 2010-2014 KCFinder Project
-  *   @license http://www.opensource.org/licenses/gpl-2.0.php GPLv2
-  *   @license http://www.opensource.org/licenses/lgpl-2.1.php LGPLv2
-  *      @link http://kcfinder.sunhater.com
-  *
-  * This file is the place you can put any code (at the end of the file),
-  * which will be executed before any other. Suitable for:
-  *     1. Set PHP ini settings using ini_set()
-  *     2. Custom session save handler with session_set_save_handler()
-  *     3. Any custom integration code. If you use any global variables
-  *        here, they can be accessed in config.php via $GLOBALS array.
-  *        It's recommended to use constants instead.
-  */
+ *
+ *      @desc This file is included first, before each other
+ *   @package KCFinder
+ *   @version 2.54
+ *    @author Pavel Tzonkov <sunhater@sunhater.com>
+ * @copyright 2010-2014 KCFinder Project
+ *   @license http://www.opensource.org/licenses/gpl-2.0.php GPLv2
+ *   @license http://www.opensource.org/licenses/lgpl-2.1.php LGPLv2
+ *      @link http://kcfinder.sunhater.com
+ *
+ * This file is the place you can put any code (at the end of the file),
+ * which will be executed before any other. Suitable for:
+ *     1. Set PHP ini settings using ini_set()
+ *     2. Custom session save handler with session_set_save_handler()
+ *     3. Any custom integration code. If you use any global variables
+ *        here, they can be accessed in config.php via $GLOBALS array.
+ *        It's recommended to use constants instead.
+ */
 define('IN_MANAGER_MODE', true);
 define('MODX_API_MODE', true);
 include_once(__DIR__."/../../../../../index.php");

manager/media/browser/mcpuk/core/browser.php

Doc Comments +4 added lines, -4 removed lines

@@ -441,7 +441,7 @@ 
     }
 
     /**
-     * @return bool
+     * @return null|boolean
      */
     protected function act_delete()
     {
@@ -796,7 +796,7 @@ 
 
     /**
      * @param $file
-     * @param $dir
+     * @param string $dir
      * @return array
      */
     protected function moveUploadFile($file, $dir)
@@ -851,7 +851,7 @@ 
     }
 
     /**
-     * @param null $file
+     * @param string $file
      */
     protected function sendDefaultThumb($file = null)
     {
@@ -1107,7 +1107,7 @@ 
     }
 
     /**
-     * @param $message
+     * @param string $message
      * @param array|null $data
      */
     protected function errorMsg($message, array $data = null)

manager/media/browser/mcpuk/lib/class_image.php

Indentation +93 added lines, -93 removed lines

@@ -1,45 +1,45 @@ 
 <?php
 
 /** This file is part of KCFinder project
-  *
-  *      @desc Abstract image driver class
-  *   @package KCFinder
-  *   @version 2.54
-  *    @author Pavel Tzonkov <sunhater@sunhater.com>
-  * @copyright 2010-2014 KCFinder Project
-  *   @license http://www.opensource.org/licenses/gpl-2.0.php GPLv2
-  *   @license http://www.opensource.org/licenses/lgpl-2.1.php LGPLv2
-  *      @link http://kcfinder.sunhater.com
-  */
+ *
+ *      @desc Abstract image driver class
+ *   @package KCFinder
+ *   @version 2.54
+ *    @author Pavel Tzonkov <sunhater@sunhater.com>
+ * @copyright 2010-2014 KCFinder Project
+ *   @license http://www.opensource.org/licenses/gpl-2.0.php GPLv2
+ *   @license http://www.opensource.org/licenses/lgpl-2.1.php LGPLv2
+ *      @link http://kcfinder.sunhater.com
+ */
 
 abstract class image {
     const DEFAULT_JPEG_QUALITY = 75;
 
 /** Image resource or object
-  * @var mixed */
+ * @var mixed */
     protected $image;
 
 /** Image width in pixels
-  * @var integer */
+ * @var integer */
     protected $width;
 
 /** Image height in pixels
-  * @var integer */
+ * @var integer */
     protected $height;
 
 /** Init error
-  * @var bool */
+ * @var bool */
     protected $initError = false;
 
 /** Driver specific options
-  * @var array */
+ * @var array */
     protected $options = array();
 
 
 /** Magic method which allows read-only access to all protected or private
-  * class properties
-  * @param string $property
-  * @return mixed */
+ * class properties
+ * @param string $property
+ * @return mixed */
 
     final public function __get($property) {
         return property_exists($this, $property) ? $this->$property : null;
@@ -47,15 +47,15 @@ 
 
 
 /** Constructor. Parameter $image should be:
-  *   1. An instance of image driver class (copy instance).
-  *   2. An image represented by the type of the $image property
-  *      (resource or object).
-  *   3. An array with two elements. First - width, second - height.
-  *      Creates a blank image.
-  *   4. A filename string. Get image form file.
-  * Second parameter is used by pass some specific image driver options
-  * @param mixed $image
-  * @param array $options */
+ *   1. An instance of image driver class (copy instance).
+ *   2. An image represented by the type of the $image property
+ *      (resource or object).
+ *   3. An array with two elements. First - width, second - height.
+ *      Creates a blank image.
+ *   4. A filename string. Get image form file.
+ * Second parameter is used by pass some specific image driver options
+ * @param mixed $image
+ * @param array $options */
 
     public function __construct($image, array $options=array()) {
         $this->image = $this->width = $this->height = null;
@@ -70,10 +70,10 @@ 
 
 
 /** Factory pattern to load selected driver. $image and $options are passed
-  * to the constructor of the image driver
-  * @param string $driver
-  * @param mixed $image
-  * @return object */
+ * to the constructor of the image driver
+ * @param string $driver
+ * @param mixed $image
+ * @return object */
 
     final static function factory($driver, $image, array $options=array()) {
         $class = "image_$driver";
@@ -82,9 +82,9 @@ 
 
 
 /** Checks if the drivers in the array parameter could be used. Returns first
-  * found one
-  * @param array $drivers
-  * @return string */
+ * found one
+ * @param array $drivers
+ * @return string */
 
     final static function getDriver(array $drivers=array('gd')) {
         foreach ($drivers as $driver) {
@@ -101,9 +101,9 @@ 
 
 
 /** Returns an array. Element 0 - image resource. Element 1 - width. Element 2 - height.
-  * Returns FALSE on failure.
-  * @param mixed $image
-  * @return array */
+ * Returns FALSE on failure.
+ * @param mixed $image
+ * @return array */
 
     final protected function buildImage($image) {
         $class = get_class($this);
@@ -126,8 +126,8 @@ 
 
 
 /** Returns calculated proportional width from the given height
-  * @param integer $resizedHeight
-  * @return integer */
+ * @param integer $resizedHeight
+ * @return integer */
 
     final public function getPropWidth($resizedHeight) {
         $width = round(($this->width * $resizedHeight) / $this->height);
@@ -137,8 +137,8 @@ 
 
 
 /** Returns calculated proportional height from the given width
-  * @param integer $resizedWidth
-  * @return integer */
+ * @param integer $resizedWidth
+ * @return integer */
 
     final public function getPropHeight($resizedWidth) {
         $height = round(($this->height * $resizedWidth) / $this->width);
@@ -148,45 +148,45 @@ 
 
 
 /** Checks if PHP needs some extra extensions to use the image driver. This
-  * static method should be implemented into driver classes like abstract
-  * methods
-  * @return bool */
+ * static method should be implemented into driver classes like abstract
+ * methods
+ * @return bool */
     static function available() { return false; }
 
 /** Checks if file is an image. This static method should be implemented into
-  * driver classes like abstract methods
-  * @param string $file
-  * @return bool */
+ * driver classes like abstract methods
+ * @param string $file
+ * @return bool */
     static function checkImage($file) { return false; }
 
 /** Resize image. Should return TRUE on success or FALSE on failure
-  * @param integer $width
-  * @param integer $height
-  * @return bool */
+ * @param integer $width
+ * @param integer $height
+ * @return bool */
     abstract public function resize($width, $height);
 
 /** Resize image to fit in given resolution. Should returns TRUE on success
-  * or FALSE on failure. If $background is set, the image size will be
-  * $width x $height and the empty spaces (if any) will be filled with defined
-  * color. Background color examples: "#5f5", "#ff67ca", array(255, 255, 255)
-  * @param integer $width
-  * @param integer $height
-  * @param mixed $background
-  * @return bool */
+ * or FALSE on failure. If $background is set, the image size will be
+ * $width x $height and the empty spaces (if any) will be filled with defined
+ * color. Background color examples: "#5f5", "#ff67ca", array(255, 255, 255)
+ * @param integer $width
+ * @param integer $height
+ * @param mixed $background
+ * @return bool */
     abstract public function resizeFit($width, $height, $background=false);
 
 /** Resize and crop the image to fit in given resolution. Returns TRUE on
-  * success or FALSE on failure
-  * @param mixed $src
-  * @param integer $offset
-  * @return bool */
+ * success or FALSE on failure
+ * @param mixed $src
+ * @param integer $offset
+ * @return bool */
     abstract public function resizeCrop($width, $height, $offset=false);
 
 
 /** Rotate image
-  * @param integer $angle
-  * @param string $background
-  * @return bool */
+ * @param integer $angle
+ * @param string $background
+ * @return bool */
     abstract public function rotate($angle, $background="#000000");
 
     abstract public function flipHorizontal();
@@ -194,44 +194,44 @@ 
     abstract public function flipVertical();
 
 /** Apply a PNG or GIF watermark to the image. $top and $left parameters sets
-  * the offset of the watermark in pixels. Boolean and NULL values are possible
-  * too. In default case (FALSE, FALSE) the watermark should be applyed to
-  * the bottom right corner. NULL values means center aligning. If the
-  * watermark is bigger than the image or it's partialy or fully outside the
-  * image, it shoudn't be applied
-  * @param string $file
-  * @param mixed $top
-  * @param mixed $left
-  * @return bool */
+ * the offset of the watermark in pixels. Boolean and NULL values are possible
+ * too. In default case (FALSE, FALSE) the watermark should be applyed to
+ * the bottom right corner. NULL values means center aligning. If the
+ * watermark is bigger than the image or it's partialy or fully outside the
+ * image, it shoudn't be applied
+ * @param string $file
+ * @param mixed $top
+ * @param mixed $left
+ * @return bool */
     abstract public function watermark($file, $left=false, $top=false);
 
 /** Should output the image. Second parameter is used to pass some options like
-  *   'file' - if is set, the output will be written to a file
-  *   'quality' - compression quality
-  * It's possible to use extra specific options required by image type ($type)
-  * @param string $type
-  * @param array $options
-  * @return bool */
+ *   'file' - if is set, the output will be written to a file
+ *   'quality' - compression quality
+ * It's possible to use extra specific options required by image type ($type)
+ * @param string $type
+ * @param array $options
+ * @return bool */
     abstract public function output($type='jpeg', array $options=array());
 
 /** This method should create a blank image with selected size. Should returns
-  * resource or object related to the created image, which will be passed to
-  * $image property
-  * @param integer $width
-  * @param integer $height
-  * @return mixed */
+ * resource or object related to the created image, which will be passed to
+ * $image property
+ * @param integer $width
+ * @param integer $height
+ * @return mixed */
     abstract protected function getBlankImage($width, $height);
 
 /** This method should create an image from source image. Only first parameter
-  * ($image) is input. Its type should be filename string or a type of the
-  * $image property. See the constructor reference for details. The
-  * parametters $width and $height are output only. Should returns resource or
-  * object related to the created image, which will be passed to $image
-  * property
-  * @param mixed $image
-  * @param integer $width
-  * @param integer $height
-  * @return mixed */
+ * ($image) is input. Its type should be filename string or a type of the
+ * $image property. See the constructor reference for details. The
+ * parametters $width and $height are output only. Should returns resource or
+ * object related to the created image, which will be passed to $image
+ * property
+ * @param mixed $image
+ * @param integer $width
+ * @param integer $height
+ * @return mixed */
     abstract protected function getImage($image, &$width, &$height);
 
 }