Studio-42 / elFinder

php/elFinderVolumeDriver.class.php

Indentation +24 added lines, -24 removed lines

@@ -1,16 +1,16 @@ 
 <?php
 /**
- * Base class for elFinder volume.
- * Provide 2 layers:
- *  1. Public API (commands)
- *  2. abstract fs API
- *
- * All abstract methods begin with "_"
- *
- * @author Dmitry (dio) Levashov
- * @author Troex Nevelin
- * @author Alexey Sukhotin
- **/
+	 * Base class for elFinder volume.
+	 * Provide 2 layers:
+	 *  1. Public API (commands)
+	 *  2. abstract fs API
+	 *
+	 * All abstract methods begin with "_"
+	 *
+	 * @author Dmitry (dio) Levashov
+	 * @author Troex Nevelin
+	 * @author Alexey Sukhotin
+	 **/
 abstract class elFinderVolumeDriver {
 	
 	/**
@@ -192,11 +192,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
@@ -4043,14 +4043,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/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

 	 **/