Studio-42 / elFinder

php/elFinder.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -1344,7 +1344,7 @@
 	 * 
 	 * @param  string $str
 	 * @param  array  $extTable
-	 * @return array
+	 * @return string[]
 	 * @author Naoki Sawada
 	 */
 	protected function parse_data_scheme( $str, $extTable ) {

Indentation +18 added lines, -18 removed lines

@@ -1149,18 +1149,18 @@ 
 	}
 
 	/**
-	* Get remote contents
-	*
-	* @param  string   $url     target url
-	* @param  int      $timeout timeout (sec)
-	* @param  int      $redirect_max redirect max count
-	* @param  string   $ua
-	* @param  resource $fp
-	* @return string or bool(false)
-	* @retval string contents
-	* @retval false  error
-	* @author Naoki Sawada
-	**/
+	 * Get remote contents
+	 *
+	 * @param  string   $url     target url
+	 * @param  int      $timeout timeout (sec)
+	 * @param  int      $redirect_max redirect max count
+	 * @param  string   $ua
+	 * @param  resource $fp
+	 * @return string or bool(false)
+	 * @retval string contents
+	 * @retval false  error
+	 * @author Naoki Sawada
+	 **/
 	protected function get_remote_contents( &$url, $timeout = 30, $redirect_max = 5, $ua = 'Mozilla/5.0', $fp = null ) {
 		$method = (function_exists('curl_exec') && !ini_get('safe_mode'))? 'curl_get_contents' : 'fsock_get_contents'; 
 		return $this->$method( $url, $timeout, $redirect_max, $ua, $fp );
@@ -2090,12 +2090,12 @@ 
 	}
 	
 	/**
-	* Return content URL
-	*
-	* @param  array  $args  command arguments
-	* @return array
-	* @author Naoki Sawada
-	**/
+	 * Return content URL
+	 *
+	 * @param  array  $args  command arguments
+	 * @return array
+	 * @author Naoki Sawada
+	 **/
 	protected function url($args) {
 		$target = $args['target'];
 		$options = isset($args['options'])? $args['options'] : array();

php/elFinderVolumeDropbox.class.php

Doc Comments +5 added lines, -12 removed lines

@@ -234,7 +234,6 @@ 
 	 * process of on netunmount
 	 * Drop table `dropbox` & rm thumbs
 	 * 
-	 * @param array $options
 	 * @return boolean
 	 */
 	public function netunmount($netVolumes, $key) {
@@ -431,7 +430,7 @@ 
 	/**
 	 * Check DB for delta cache
 	 * 
-	 * @return void
+	 * @return boolean
 	 */
 	private function checkDB() {
 		$res = $this->query('SELECT * FROM sqlite_master WHERE type=\'table\' AND name=\''.$this->DB_TableName.'\'');
@@ -685,7 +684,7 @@ 
 	* @param  string  $src   source path
 	* @param  string  $dst   destination dir path
 	* @param  string  $name  new file name (optionaly)
-	* @return string|false
+	* @return string|boolean
 	* @author Dmitry (dio) Levashov
 	* @author Naoki Sawada
 	**/
@@ -739,10 +738,6 @@ 
 	* Create thumnbnail and return it's URL on success
 	*
 	* @param  string  $path  file path
-	* @param  string  $mime  file mime type
-	* @return string|false
-	* @author Dmitry (dio) Levashov
-	* @author Naoki Sawada
 	**/
 	protected function createTmb($path, $stat) {
 		if (!$stat || !$this->canCreateTmb($path, $stat)) {
@@ -1099,7 +1094,6 @@ 
 	 * Open file and return file pointer
 	 *
 	 * @param  string  $path  file path
-	 * @param  bool    $write open file for writing
 	 * @return resource|false
 	 * @author Dmitry (dio) Levashov
 	 **/
@@ -1141,7 +1135,7 @@ 
 	 * Close opened file
 	 *
 	 * @param  resource  $fp  file pointer
-	 * @return bool
+	 * @return boolean|null
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function _fclose($fp, $path='') {
@@ -1225,7 +1219,7 @@ 
 	 * Return new file path or false.
 	 *
 	 * @param  string  $source  source file path
-	 * @param  string  $target  target dir path
+	 * @param  string  $targetDir  target dir path
 	 * @param  string  $name    file name
 	 * @return string|bool
 	 * @author Dmitry (dio) Levashov
@@ -1274,7 +1268,6 @@ 
 	 * Return new file path or false on error.
 	 *
 	 * @param  resource  $fp   file pointer
-	 * @param  string    $dir  target dir path
 	 * @param  string    $name file name
 	 * @param  array     $stat file stat (required by some virtual fs)
 	 * @return bool|string
@@ -1320,7 +1313,7 @@ 
 	 *
 	 * @param  string  $path     file path
 	 * @param  string  $content  new file content
-	 * @return bool
+	 * @return boolean|string
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function _filePutContents($path, $content) {

Indentation +49 added lines, -49 removed lines

@@ -192,7 +192,7 @@ 
 						$options['url'] = $this->getConnectorUrl();
 					}
 					$callback  = $options['url']
-					           . '?cmd=netmount&protocol=dropbox&host=dropbox.com&user=init&pass=return&node='.$options['id'].$cdata;
+							   . '?cmd=netmount&protocol=dropbox&host=dropbox.com&user=init&pass=return&node='.$options['id'].$cdata;
 					
 					try {
 						$tokens = $this->oauth->getRequestToken();
@@ -265,9 +265,9 @@ 
 	 */
 	private function getConnectorUrl() {
 		$url  = ((isset($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) !== 'off')? 'https://' : 'http://')
-		       . $_SERVER['SERVER_NAME']                                              // host
-		      . ($_SERVER['SERVER_PORT'] == 80 ? '' : ':' . $_SERVER['SERVER_PORT'])  // port
-		       . $_SERVER['REQUEST_URI'];                                             // path & query
+			   . $_SERVER['SERVER_NAME']                                              // host
+			  . ($_SERVER['SERVER_PORT'] == 80 ? '' : ':' . $_SERVER['SERVER_PORT'])  // port
+			   . $_SERVER['REQUEST_URI'];                                             // path & query
 		list($url) = explode('?', $url);
 		return $url;
 	}
@@ -605,7 +605,7 @@ 
 		$stat['mime']  = $raw['is_dir']? 'directory' : $raw['mime_type'];
 		$stat['size']  = $stat['mime'] == 'directory' ? 0 : $raw['bytes'];
 		$stat['ts']    = isset($raw['client_mtime'])? strtotime($raw['client_mtime']) :
-		                (isset($raw['modified'])? strtotime($raw['modified']) : $_SERVER['REQUEST_TIME']);
+						(isset($raw['modified'])? strtotime($raw['modified']) : $_SERVER['REQUEST_TIME']);
 		$stat['dirs'] = 0;
 		if ($raw['is_dir']) {
 			$stat['dirs'] = (int)(bool)$this->query('select path from '.$this->DB_TableName.' where isdir=1 and path='.$this->DB->quote(strtolower($raw['path'])));
@@ -648,14 +648,14 @@ 
 	}
 
 	/**
-	* Recursive files search
-	*
-	* @param  string  $path   dir path
-	* @param  string  $q      search string
-	* @param  array   $mimes
-	* @return array
-	* @author Naoki Sawada
-	**/
+	 * Recursive files search
+	 *
+	 * @param  string  $path   dir path
+	 * @param  string  $q      search string
+	 * @param  array   $mimes
+	 * @return array
+	 * @author Naoki Sawada
+	 **/
 	protected function doSearch($path, $q, $mimes) {
 		$result = array();
 		$sth = $this->DB->prepare('select dat from '.$this->DB_TableName.' WHERE path LIKE ? AND fname LIKE ?');
@@ -679,16 +679,16 @@ 
 	}
 	
 	/**
-	* Copy file/recursive copy dir only in current volume.
-	* Return new file path or false.
-	*
-	* @param  string  $src   source path
-	* @param  string  $dst   destination dir path
-	* @param  string  $name  new file name (optionaly)
-	* @return string|false
-	* @author Dmitry (dio) Levashov
-	* @author Naoki Sawada
-	**/
+	 * Copy file/recursive copy dir only in current volume.
+	 * Return new file path or false.
+	 *
+	 * @param  string  $src   source path
+	 * @param  string  $dst   destination dir path
+	 * @param  string  $name  new file name (optionaly)
+	 * @return string|false
+	 * @author Dmitry (dio) Levashov
+	 * @author Naoki Sawada
+	 **/
 	protected function copy($src, $dst, $name) {
 
 		$this->clearcache();
@@ -699,14 +699,14 @@ 
 	}
 	
 	/**
-	* Remove file/ recursive remove dir
-	*
-	* @param  string  $path   file path
-	* @param  bool    $force  try to remove even if file locked
-	* @return bool
-	* @author Dmitry (dio) Levashov
-	* @author Naoki Sawada
-	**/
+	 * Remove file/ recursive remove dir
+	 *
+	 * @param  string  $path   file path
+	 * @param  bool    $force  try to remove even if file locked
+	 * @return bool
+	 * @author Dmitry (dio) Levashov
+	 * @author Naoki Sawada
+	 **/
 	protected function remove($path, $force = false, $recursive = false) {
 		$stat = $this->stat($path);
 		$stat['realpath'] = $path;
@@ -736,14 +736,14 @@ 
 	}
 	
 	/**
-	* Create thumnbnail and return it's URL on success
-	*
-	* @param  string  $path  file path
-	* @param  string  $mime  file mime type
-	* @return string|false
-	* @author Dmitry (dio) Levashov
-	* @author Naoki Sawada
-	**/
+	 * Create thumnbnail and return it's URL on success
+	 *
+	 * @param  string  $path  file path
+	 * @param  string  $mime  file mime type
+	 * @return string|false
+	 * @author Dmitry (dio) Levashov
+	 * @author Naoki Sawada
+	 **/
 	protected function createTmb($path, $stat) {
 		if (!$stat || !$this->canCreateTmb($path, $stat)) {
 			return false;
@@ -828,13 +828,13 @@ 
 	}
 	
 	/**
-	* Return content URL
-	*
-	* @param string  $hash  file hash
-	* @param array $options options
-	* @return array
-	* @author Naoki Sawada
-	**/
+	 * Return content URL
+	 *
+	 * @param string  $hash  file hash
+	 * @param array $options options
+	 * @return array
+	 * @author Naoki Sawada
+	 **/
 	public function getContentUrl($hash, $options = array()) {
 		if (($file = $this->file($hash)) == false || !$file['url'] || $file['url'] == 1) {
 			$path = $this->decode($hash);
@@ -897,9 +897,9 @@ 
 			try {
 				$request2 = new HTTP_Request2();
 				$request2->setConfig(array(
-                    'ssl_verify_peer' => false,
-                    'ssl_verify_host' => false
-                ));
+					'ssl_verify_peer' => false,
+					'ssl_verify_host' => false
+				));
 				$request2->setUrl($url);
 				$request2->setMethod(HTTP_Request2::METHOD_HEAD);
 				$result = $request2->send();

php/elFinderVolumeFTP.class.php

Doc Comments +12 added lines, -12 removed lines

@@ -477,7 +477,7 @@ 
 	 * Return ftp transfer mode for file
 	 *
 	 * @param  string  $path  file path
-	 * @return string
+	 * @return integer
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function ftpMode($path) {
@@ -841,7 +841,6 @@ 
 	 * Open file and return file pointer
 	 *
 	 * @param  string  $path  file path
-	 * @param  bool    $write open file for writing
 	 * @return resource|false
 	 * @author Dmitry (dio) Levashov
 	 **/
@@ -866,7 +865,7 @@ 
 	 * Close opened file
 	 *
 	 * @param  resource  $fp  file pointer
-	 * @return bool
+	 * @return boolean|null
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function _fclose($fp, $path='') {
@@ -883,7 +882,7 @@ 
 	 *
 	 * @param  string  $path  parent dir path
 	 * @param string  $name  new directory name
-	 * @return string|bool
+	 * @return false|string
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function _mkdir($path, $name) {
@@ -901,7 +900,7 @@ 
 	 *
 	 * @param  string  $path  parent dir path
 	 * @param string  $name  new file name
-	 * @return string|bool
+	 * @return string|false
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function _mkfile($path, $name) {
@@ -933,7 +932,7 @@ 
 	 * @param  string  $source     source file path
 	 * @param  string  $targetDir  target directory path
 	 * @param  string  $name       new file name
-	 * @return bool
+	 * @return string|false
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function _copy($source, $targetDir, $name) {
@@ -958,9 +957,9 @@ 
 	 * Return new file path or false.
 	 *
 	 * @param  string  $source  source file path
-	 * @param  string  $target  target dir path
+	 * @param  string  $targetDir  target dir path
 	 * @param  string  $name    file name
-	 * @return string|bool
+	 * @return string|false
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function _move($source, $targetDir, $name) {
@@ -998,7 +997,7 @@ 
 	 * @param  string    $dir  target dir path
 	 * @param  string    $name file name
 	 * @param  array     $stat file stat (required by some virtual fs)
-	 * @return bool|string
+	 * @return string|false
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function _save($fp, $dir, $name, $stat) {
@@ -1231,7 +1230,7 @@ 
 	 * @param  array   $files  files names list
 	 * @param  string  $name   archive name
 	 * @param  array   $arc    archiver options
-	 * @return string|bool
+	 * @return false|string
 	 * @author Dmitry (dio) Levashov,
 	 * @author Alexey Sukhotin
 	 **/
@@ -1350,9 +1349,9 @@ 
 	 * Downloads specified files from remote directory
 	 * if there is a directory among files it is downloaded recursively (omitting symbolic links).
 	 * 
-	 * @param $remote_directory string remote FTP path to a source directory to download from.
+	 * @param string $remote_directory string remote FTP path to a source directory to download from.
 	 * @param array $files list of files to download from remote directory.
-	 * @param $dest_local_directory string destination folder to store downloaded files.
+	 * @param string $dest_local_directory string destination folder to store downloaded files.
 	 * @return bool true on success and false on failure.
 	 */
 	private function ftp_download_files($remote_directory, array $files, $dest_local_directory)
@@ -1423,6 +1422,7 @@ 
 	 * Returns array of strings containing all files and folders in the specified local directory.
 	 * @param $dir
 	 * @param string $prefix
+	 * @param boolean $omitSymlinks
 	 * @internal param string $path path to directory to scan.
 	 * @return array array of files and folders names relative to the $path
 	 * or an empty array if the directory $path is empty,

php/elFinderVolumeMySQL.class.php

Doc Comments +7 added lines, -7 removed lines

@@ -611,7 +611,7 @@ 
 	 * Close opened file
 	 *
 	 * @param  resource  $fp  file pointer
-	 * @return bool
+	 * @return boolean|null
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function _fclose($fp, $path='') {
@@ -628,7 +628,7 @@ 
 	 *
 	 * @param  string  $path  parent dir path
 	 * @param string  $name  new directory name
-	 * @return string|bool
+	 * @return string|false
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function _mkdir($path, $name) {
@@ -640,7 +640,7 @@ 
 	 *
 	 * @param  string  $path  parent dir path
 	 * @param string  $name  new file name
-	 * @return string|bool
+	 * @return string|false
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function _mkfile($path, $name) {
@@ -684,9 +684,9 @@ 
 	 * Return new file path or false.
 	 *
 	 * @param  string  $source  source file path
-	 * @param  string  $target  target dir path
+	 * @param  string  $targetDir  target dir path
 	 * @param  string  $name    file name
-	 * @return string|bool
+	 * @return string|false
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function _move($source, $targetDir, $name) {
@@ -869,7 +869,7 @@ 
 	 *
 	 * @param  string  $path  archive path
 	 * @param  array   $arc   archiver command and arguments (same as in $this->archivers)
-	 * @return true
+	 * @return boolean
 	 * @author Dmitry (dio) Levashov, 
 	 * @author Alexey Sukhotin
 	 **/
@@ -884,7 +884,7 @@ 
 	 * @param  array   $files  files names list
 	 * @param  string  $name   archive name
 	 * @param  array   $arc    archiver options
-	 * @return string|bool
+	 * @return boolean
 	 * @author Dmitry (dio) Levashov, 
 	 * @author Alexey Sukhotin
 	 **/

php/plugins/AutoResize/plugin.php

Doc Comments +8 added lines

@@ -107,6 +107,10 @@ 
 		}
 	}
 	
+	/**
+	 * @param double $width
+	 * @param double $height
+	 */
 	private function resize_gd($src, $width, $height, $quality, $srcImgInfo) {
 		switch ($srcImgInfo['mime']) {
 			case 'image/gif':
@@ -177,6 +181,10 @@ 
 		return false;
 	}
 	
+	/**
+	 * @param double $width
+	 * @param double $height
+	 */
 	private function resize_imagick($src, $width, $height, $quality) {
 		try {
 			$img = new imagick($src);

Indentation +46 added lines, -46 removed lines

@@ -1,51 +1,51 @@
 <?php
 /**
- * elFinder Plugin AutoResize
- *
- * Auto resize on file upload.
- *
- * ex. binding, configure on connector options
- *	$opts = array(
- *		'bind' => array(
- *			'upload.presave' => array(
- *				'Plugin.AutoResize.onUpLoadPreSave'
- *			)
- *		),
- *		// global configure (optional)
- *		'plugin' => array(
- *			'AutoResize' => array(
- *				'enable'         => true,       // For control by volume driver
- *				'maxWidth'       => 1024,       // Path to Water mark image
- *				'maxHeight'      => 1024,       // Margin right pixel
- *				'quality'        => 95,         // JPEG image save quality
- *				'preserveExif'   => false,      // Preserve EXIF data (Imagick only)
- *				'targetType'     => IMG_GIF|IMG_JPG|IMG_PNG|IMG_WBMP // Target image formats ( bit-field )
- *			)
- *		),
- *		// each volume configure (optional)
- *		'roots' => array(
- *			array(
- *				'driver' => 'LocalFileSystem',
- *				'path'   => '/path/to/files/',
- *				'URL'    => 'http://localhost/to/files/'
- *				'plugin' => array(
- *					'AutoResize' => array(
- *						'enable'         => true,       // For control by volume driver
- *						'maxWidth'       => 1024,       // Path to Water mark image
- *						'maxHeight'      => 1024,       // Margin right pixel
- *						'quality'        => 95,         // JPEG image save quality
- *						'preserveExif'   => false,      // Preserve EXIF data (Imagick only)
- *						'targetType'     => IMG_GIF|IMG_JPG|IMG_PNG|IMG_WBMP // Target image formats ( bit-field )
- *					)
- *				)
- *			)
- *		)
- *	);
- *
- * @package elfinder
- * @author Naoki Sawada
- * @license New BSD
- */
+	 * elFinder Plugin AutoResize
+	 *
+	 * Auto resize on file upload.
+	 *
+	 * ex. binding, configure on connector options
+	 *	$opts = array(
+	 *		'bind' => array(
+	 *			'upload.presave' => array(
+	 *				'Plugin.AutoResize.onUpLoadPreSave'
+	 *			)
+	 *		),
+	 *		// global configure (optional)
+	 *		'plugin' => array(
+	 *			'AutoResize' => array(
+	 *				'enable'         => true,       // For control by volume driver
+	 *				'maxWidth'       => 1024,       // Path to Water mark image
+	 *				'maxHeight'      => 1024,       // Margin right pixel
+	 *				'quality'        => 95,         // JPEG image save quality
+	 *				'preserveExif'   => false,      // Preserve EXIF data (Imagick only)
+	 *				'targetType'     => IMG_GIF|IMG_JPG|IMG_PNG|IMG_WBMP // Target image formats ( bit-field )
+	 *			)
+	 *		),
+	 *		// each volume configure (optional)
+	 *		'roots' => array(
+	 *			array(
+	 *				'driver' => 'LocalFileSystem',
+	 *				'path'   => '/path/to/files/',
+	 *				'URL'    => 'http://localhost/to/files/'
+	 *				'plugin' => array(
+	 *					'AutoResize' => array(
+	 *						'enable'         => true,       // For control by volume driver
+	 *						'maxWidth'       => 1024,       // Path to Water mark image
+	 *						'maxHeight'      => 1024,       // Margin right pixel
+	 *						'quality'        => 95,         // JPEG image save quality
+	 *						'preserveExif'   => false,      // Preserve EXIF data (Imagick only)
+	 *						'targetType'     => IMG_GIF|IMG_JPG|IMG_PNG|IMG_WBMP // Target image formats ( bit-field )
+	 *					)
+	 *				)
+	 *			)
+	 *		)
+	 *	);
+	 *
+	 * @package elfinder
+	 * @author Naoki Sawada
+	 * @license New BSD
+	 */
 class elFinderPluginAutoResize {
 
 	private $opts = array();

php/plugins/Sanitizer/plugin.php

Indentation +43 added lines, -43 removed lines

@@ -1,48 +1,48 @@
 <?php
 /**
- * elFinder Plugin Sanitizer
- *
- * Sanitizer of file-name and file-path etc.
- *
- * ex. binding, configure on connector options
- *	$opts = array(
- *		'bind' => array(
- *			'upload.pre mkdir.pre mkfile.pre rename.pre archive.pre' => array(
- *				'Plugin.Sanitizer.cmdPreprocess'
- *			),
- *			'upload.presave' => array(
- *				'Plugin.Sanitizer.onUpLoadPreSave'
- *			)
- *		),
- *		// global configure (optional)
- *		'plugin' => array(
- *			'Sanitizer' => array(
- *				'enable' => true,
- *				'targets'  => array('\\','/',':','*','?','"','<','>','|'), // target chars
- *				'replace'  => '_'    // replace to this
- *			)
- *		),
- *		// each volume configure (optional)
- *		'roots' => array(
- *			array(
- *				'driver' => 'LocalFileSystem',
- *				'path'   => '/path/to/files/',
- *				'URL'    => 'http://localhost/to/files/'
- *				'plugin' => array(
- *					'Sanitizer' => array(
- *						'enable' => true,
- *						'targets'  => array('\\','/',':','*','?','"','<','>','|'), // target chars
- *						'replace'  => '_'    // replace to this
- *					)
- *				)
- *			)
- *		)
- *	);
- *
- * @package elfinder
- * @author Naoki Sawada
- * @license New BSD
- */
+	 * elFinder Plugin Sanitizer
+	 *
+	 * Sanitizer of file-name and file-path etc.
+	 *
+	 * ex. binding, configure on connector options
+	 *	$opts = array(
+	 *		'bind' => array(
+	 *			'upload.pre mkdir.pre mkfile.pre rename.pre archive.pre' => array(
+	 *				'Plugin.Sanitizer.cmdPreprocess'
+	 *			),
+	 *			'upload.presave' => array(
+	 *				'Plugin.Sanitizer.onUpLoadPreSave'
+	 *			)
+	 *		),
+	 *		// global configure (optional)
+	 *		'plugin' => array(
+	 *			'Sanitizer' => array(
+	 *				'enable' => true,
+	 *				'targets'  => array('\\','/',':','*','?','"','<','>','|'), // target chars
+	 *				'replace'  => '_'    // replace to this
+	 *			)
+	 *		),
+	 *		// each volume configure (optional)
+	 *		'roots' => array(
+	 *			array(
+	 *				'driver' => 'LocalFileSystem',
+	 *				'path'   => '/path/to/files/',
+	 *				'URL'    => 'http://localhost/to/files/'
+	 *				'plugin' => array(
+	 *					'Sanitizer' => array(
+	 *						'enable' => true,
+	 *						'targets'  => array('\\','/',':','*','?','"','<','>','|'), // target chars
+	 *						'replace'  => '_'    // replace to this
+	 *					)
+	 *				)
+	 *			)
+	 *		)
+	 *	);
+	 *
+	 * @package elfinder
+	 * @author Naoki Sawada
+	 * @license New BSD
+	 */
 class elFinderPluginSanitizer
 {
 	private $opts = array();

php/elFinderVolumeDriver.class.php

Indentation +13 added lines, -13 removed lines

@@ -200,11 +200,11 @@ 
 		'mimefile'        => '',
 		// mime type normalize map : Array '[ext]:[detected mime type]' => '[normalized mime]'
 		'mimeMap'         => array(
-		                     'md:application/x-genesis-rom' => 'text/x-markdown',
-		                     'md:text/plain'                => 'text/x-markdown',
-		                     'markdown:text/plain'          => 'text/x-markdown',
-		                     'css:text/x-asm'               => 'text/css'
-		                    ),
+							 'md:application/x-genesis-rom' => 'text/x-markdown',
+							 'md:text/plain'                => 'text/x-markdown',
+							 'markdown:text/plain'          => 'text/x-markdown',
+							 'css:text/x-asm'               => 'text/css'
+							),
 		// directory for thumbnails
 		'tmbPath'         => '.tmb',
 		// mode to create thumbnails dir
@@ -4070,14 +4070,14 @@ 
 	// }
 
 	/**
-	* Find position of first occurrence of string in a string with multibyte support
-	*
-	* @param  string  $haystack  The string being checked.
-	* @param  string  $needle    The string to find in haystack.
-	* @param  int     $offset    The search offset. If it is not specified, 0 is used.
-	* @return int|bool
-	* @author Alexey Sukhotin
-	**/
+	 * Find position of first occurrence of string in a string with multibyte support
+	 *
+	 * @param  string  $haystack  The string being checked.
+	 * @param  string  $needle    The string to find in haystack.
+	 * @param  int     $offset    The search offset. If it is not specified, 0 is used.
+	 * @return int|bool
+	 * @author Alexey Sukhotin
+	 **/
 	protected function stripos($haystack , $needle , $offset = 0) {
 		if (function_exists('mb_stripos')) {
 			return mb_stripos($haystack , $needle , $offset);

Doc Comments +17 added lines, -20 removed lines

@@ -1238,7 +1238,6 @@ 
 	 * Return file info or false on error
 	 *
 	 * @param  string   $hash      file hash
-	 * @param  bool     $realpath  add realpath field to file info
 	 * @return array|false
 	 * @author Dmitry (dio) Levashov
 	 **/
@@ -1259,7 +1258,6 @@ 
 	 * Return folder info
 	 *
 	 * @param  string   $hash  folder hash
-	 * @param  bool     $hidden  return hidden file info
 	 * @return array|false
 	 * @author Dmitry (dio) Levashov
 	 **/
@@ -1592,7 +1590,6 @@ 
 	 *
 	 * @param  Resource $fp      file pointer
 	 * @param  string   $dst     destination folder hash
-	 * @param  string   $src     file name
 	 * @param  string   $tmpname file tmp name - required to detect mime type
 	 * @return array|false
 	 * @author Dmitry (dio) Levashov
@@ -1678,7 +1675,6 @@ 
 	 * Paste files
 	 *
 	 * @param  Object  $volume  source volume
-	 * @param  string  $source  file hash
 	 * @param  string  $dst     destination dir hash
 	 * @param  bool    $rmSrc   remove source after copy?
 	 * @return array|false
@@ -2301,7 +2297,6 @@ 
 	 * Open file and return file pointer (with convert encording)
 	 *
 	 * @param  string  $path  file path
-	 * @param  bool    $write open file for writing
 	 * @return resource|false
 	 * @author Naoki Sawada
 	 **/
@@ -2432,7 +2427,8 @@ 
 	 * Not implemented
 	 *
 	 * @param  string  path
-	 * @return mixed
+	 * @param string $path
+	 * @return string
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function crypt($path) {
@@ -2444,7 +2440,8 @@ 
 	 * Not implemented
 	 *
 	 * @param  mixed  hash
-	 * @return mixed
+	 * @param string $hash
+	 * @return string
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function uncrypt($hash) {
@@ -2477,7 +2474,6 @@ 
 	/**
 	 * Return new unique name based on file name and suffix
 	 *
-	 * @param  string  $path    file path
 	 * @param  string  $suffix  suffix append to name
 	 * @return string
 	 * @author Dmitry (dio) Levashov
@@ -2545,6 +2541,7 @@ 
 	 * @param  string $to      to character encoding
 	 * @param  string $locale  local locale
 	 * @param  string $unknown replaces character for unknown
+	 * @param boolean $restoreLocale
 	 * @return mixed
 	 */
 	protected function convEnc($var, $from, $to, $locale, $restoreLocale, $unknown = '_') {
@@ -2726,6 +2723,7 @@ 
 	 *
 	 * @param string $dir  parent dir path
 	 * @param string $name new file name
+	 * @param boolean $isDir
 	 * @return bool
 	 * @author Dmitry (dio) Levashov
 	 **/
@@ -3279,7 +3277,7 @@ 
 	 * @param  string  $src   source path
 	 * @param  string  $dst   destination dir path
 	 * @param  string  $name  new file name (optionaly)
-	 * @return string|false
+	 * @return boolean|string
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function copy($src, $dst, $name) {
@@ -3332,7 +3330,7 @@ 
 	 * @param  string  $src   source path
 	 * @param  string  $dst   destination dir path
 	 * @param  string  $name  new file name 
-	 * @return string|false
+	 * @return string|boolean
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function move($src, $dst, $name) {
@@ -3358,7 +3356,7 @@ 
 	 * @param  string  $src          source file hash
 	 * @param  string  $destination  destination dir path
 	 * @param  string  $name         file name
-	 * @return string|false
+	 * @return boolean|string
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function copyFrom($volume, $src, $destination, $name) {
@@ -3506,7 +3504,7 @@ 
 	 * @param  string  $path  thumnbnail path 
 	 * @param  array   $stat  file stat
 	 * @param  bool    $checkTmbPath
-	 * @return string|bool
+	 * @return boolean
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function canCreateTmb($path, $stat, $checkTmbPath = true) {
@@ -3523,7 +3521,7 @@ 
 	 *
 	 * @param  string  $path  thumnbnail path 
 	 * @param  array   $stat  file stat
-	 * @return string|bool
+	 * @return boolean
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function canResize($path, $stat) {
@@ -3534,7 +3532,6 @@ 
 	 * Create thumnbnail and return it's URL on success
 	 *
 	 * @param  string  $path  file path
-	 * @param  string  $mime  file mime type
 	 * @return string|false
 	 * @author Dmitry (dio) Levashov
 	 **/
@@ -4013,7 +4010,7 @@ 
 	 *
 	 * @param  string  $command       command line
 	 * @param  array   $output        stdout strings
-	 * @param  array   $return_var    process exit code
+	 * @param  integer   $return_var    process exit code
 	 * @param  array   $error_output  stderr strings
 	 * @return int     exit code
 	 * @author Alexey Sukhotin
@@ -4225,7 +4222,7 @@ 
 	* @param  string  $haystack  The string being checked.
 	* @param  string  $needle    The string to find in haystack.
 	* @param  int     $offset    The search offset. If it is not specified, 0 is used.
-	* @return int|bool
+	* @return integer
 	* @author Alexey Sukhotin
 	**/
 	protected function stripos($haystack , $needle , $offset = 0) {
@@ -4450,7 +4447,7 @@ 
 	 * @param  array   $files  files names list
 	 * @param  string  $name   archive name
 	 * @param  array   $arc    archiver options
-	 * @return string|bool
+	 * @return string|false
 	 * @author Dmitry (dio) Levashov, 
 	 * @author Alexey Sukhotin
 	 * @author Naoki Sawada
@@ -4507,7 +4504,7 @@ 
 	 * @param  string        $dir      target dir
 	 * @param  array         $files    files names list
 	 * @param  string|object $zipPath  Zip archive name
-	 * @return void
+	 * @return boolean
 	 * @author Naoki Sawada
 	 */
 	protected static function zipArchiveZip($dir, $files, $zipPath) {
@@ -4763,7 +4760,7 @@ 
 	 * Copy file into another file (only inside one volume)
 	 *
 	 * @param  string  $source  source file path
-	 * @param  string  $target  target dir path
+	 * @param  string  $targetDir  target dir path
 	 * @param  string  $name    file name
 	 * @return bool
 	 * @author Dmitry (dio) Levashov
@@ -4775,7 +4772,7 @@ 
 	 * Return new file path or false.
 	 *
 	 * @param  string  $source  source file path
-	 * @param  string  $target  target dir path
+	 * @param  string  $targetDir  target dir path
 	 * @param  string  $name    file name
 	 * @return string|bool
 	 * @author Dmitry (dio) Levashov

php/plugins/Normalizer/plugin.php

Indentation +52 added lines, -52 removed lines

@@ -1,57 +1,57 @@
 <?php
 /**
- * elFinder Plugin Normalizer
- * 
- * UTF-8 Normalizer of file-name and file-path etc.
- * nfc(NFC): Canonical Decomposition followed by Canonical Composition
- * nfkc(NFKC): Compatibility Decomposition followed by Canonical
- * 
- * This plugin require Class "Normalizer" (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
- * or PEAR package "I18N_UnicodeNormalizer"
- * 
- * ex. binding, configure on connector options
- *	$opts = array(
- *		'bind' => array(
- *			'upload.pre mkdir.pre mkfile.pre rename.pre archive.pre' => array(
- *				'Plugin.Normalizer.cmdPreprocess'
- *			),
- *			'upload.presave' => array(
- *				'Plugin.Normalizer.onUpLoadPreSave'
- *			)
- *		),
- *		// global configure (optional)
- *		'plugin' => array(
- *			'Normalizer' => array(
- *				'enable'    => true,
- *				'nfc'       => true,
- *				'nfkc'      => true,
- *				'lowercase' => false,
- * 				'convmap'   => array()
- *			)
- *		),
- *		// each volume configure (optional)
- *		'roots' => array(
- *			array(
- *				'driver' => 'LocalFileSystem',
- *				'path'   => '/path/to/files/',
- *				'URL'    => 'http://localhost/to/files/'
- *				'plugin' => array(
- *					'Normalizer' => array(
- *						'enable'    => true,
- *						'nfc'       => true,
- *						'nfkc'      => true,
- * 						'lowercase' => false,
- * 						'convmap'   => array()
- *					)
- *				)
- *			)
- *		)
- *	);
- *
- * @package elfinder
- * @author Naoki Sawada
- * @license New BSD
- */
+	 * elFinder Plugin Normalizer
+	 * 
+	 * UTF-8 Normalizer of file-name and file-path etc.
+	 * nfc(NFC): Canonical Decomposition followed by Canonical Composition
+	 * nfkc(NFKC): Compatibility Decomposition followed by Canonical
+	 * 
+	 * This plugin require Class "Normalizer" (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
+	 * or PEAR package "I18N_UnicodeNormalizer"
+	 * 
+	 * ex. binding, configure on connector options
+	 *	$opts = array(
+	 *		'bind' => array(
+	 *			'upload.pre mkdir.pre mkfile.pre rename.pre archive.pre' => array(
+	 *				'Plugin.Normalizer.cmdPreprocess'
+	 *			),
+	 *			'upload.presave' => array(
+	 *				'Plugin.Normalizer.onUpLoadPreSave'
+	 *			)
+	 *		),
+	 *		// global configure (optional)
+	 *		'plugin' => array(
+	 *			'Normalizer' => array(
+	 *				'enable'    => true,
+	 *				'nfc'       => true,
+	 *				'nfkc'      => true,
+	 *				'lowercase' => false,
+	 * 				'convmap'   => array()
+	 *			)
+	 *		),
+	 *		// each volume configure (optional)
+	 *		'roots' => array(
+	 *			array(
+	 *				'driver' => 'LocalFileSystem',
+	 *				'path'   => '/path/to/files/',
+	 *				'URL'    => 'http://localhost/to/files/'
+	 *				'plugin' => array(
+	 *					'Normalizer' => array(
+	 *						'enable'    => true,
+	 *						'nfc'       => true,
+	 *						'nfkc'      => true,
+	 * 						'lowercase' => false,
+	 * 						'convmap'   => array()
+	 *					)
+	 *				)
+	 *			)
+	 *		)
+	 *	);
+	 *
+	 * @package elfinder
+	 * @author Naoki Sawada
+	 * @license New BSD
+	 */
 class elFinderPluginNormalizer
 {
 	private $opts = array();

php/elFinderVolumeS3.class.php

Doc Comments +5 added lines, -5 removed lines

@@ -407,7 +407,7 @@ 
 	 * 

 	 * @param  resource  $fp    file pointer

 	 * @param  string    $path  file path

-	 * @return bool

+	 * @return boolean|null

 	 * @author Dmitry (dio) Levashov

 	 **/

 	protected function _fclose($fp, $path='') {

@@ -508,7 +508,7 @@ 
 	 * @param  string  $source  source file path

 	 * @param  string  $targetDir  target dir path

 	 * @param  string  $name    file name

-	 * @return string|bool

+	 * @return boolean

 	 * @author Dmitry (dio) Levashov

 	 **/

 	protected function _move($source, $targetDir, $name) {

@@ -574,7 +574,7 @@ 
 	 * @param  string $dir target dir path

 	 * @param  string $name file name

 	 * @param  array $stat

-	 * @return bool|string

+	 * @return boolean

 	 * @author Dmitry (dio) Levashov

 	 */

 	protected function _save($fp, $dir, $name, $stat) {

@@ -585,7 +585,7 @@ 
 	 * Get file contents

 	 *

 	 * @param  string  $path  file path

-	 * @return string|false

+	 * @return boolean

 	 * @author Dmitry (dio) Levashov

 	 **/

 	protected function _getContents($path) {

@@ -624,7 +624,7 @@ 
 	 * @param  array   $files  files names list

 	 * @param  string  $name   archive name

 	 * @param  array   $arc    archiver options

-	 * @return string|bool

+	 * @return boolean

 	 * @author Dmitry (dio) Levashov, 

 	 * @author Alexey Sukhotin

 	 **/