recca0120 / laravel-elfinder

lib/elFinder.class.php

Doc Comments +8 added lines, -8 removed lines

@@ -595,7 +595,7 @@ 
 	/**
 	 * Return elFinder session wrapper instance.
 	 *
-	 * @return  object  elFinderSessionInterface
+	 * @return  elFinderSessionInterface  elFinderSessionInterface
 	 **/
 	public function getSession()
 	{
@@ -1195,7 +1195,7 @@ 
 	/**
 	 * Return elFinder static variable.
 	 *
-	 * @param $key
+	 * @param string $key
 	 * @return mixed|null
 	 */
 	public static function getStaticVar($key)
@@ -1275,8 +1275,8 @@ 
 	 * Get stream resource pointer by URL.
 	 *
 	 * @param array  $data  array('target'=>'URL', 'headers' => array())
-	 * @param number $redirectLimit
-	 * @return resource|bool
+	 * @param integer $redirectLimit
+	 * @return resource
 	 *
 	 * @author Naoki Sawada
 	 */
@@ -1376,7 +1376,7 @@ 
 	 *
 	 * @throws \Exception
 	 *
-	 * @return mixed
+	 * @return string
 	 *
 	 * @author Naoki Sawada
 	 */
@@ -2428,7 +2428,7 @@ 
 	 * @param  string $str
 	 * @param  array  $extTable
 	 * @param  array  $args
-	 * @return array
+	 * @return string[]
 	 * @author Naoki Sawada
 	 */
 	protected function parse_data_scheme($str, $extTable, $args = null)
@@ -3570,7 +3570,7 @@ 
 	 *
 	 * @param array|string $hashes
 	 * @param bool $autoUnlock
-	 * @return bool
+	 * @return false|null
 	 */
 	protected function itemLock($hashes, $autoUnlock = true)
 	{
@@ -3599,7 +3599,7 @@ 
 	 * Do unlock target item.
 	 *
 	 * @param string $hash
-	 * @return bool
+	 * @return boolean|null
 	 */
 	protected function itemUnlock($hash)
 	{

lib/elFinderSession.php

Doc Comments +3 added lines

@@ -172,6 +172,9 @@
 	    return $this;
 	}
 
+    /**
+     * @param string $key
+     */
     protected function &getSessionRef($key)
     {
         $session = null;

lib/elFinderVolumeBox.class.php

Doc Comments +11 added lines, -18 removed lines

@@ -284,7 +284,6 @@ 
      * process of on netunmount
      * Drop `box` & rm thumbs.
      *
-     * @param array $options
      *
      * @return bool
      */
@@ -393,11 +392,9 @@ 
     /**
      * Obtains a new access token from OAuth. This token is valid for one hour.
      *
-     * @param string $clientSecret The Box client secret
+     * @param string $client_secret The Box client secret
      * @param string $code         The code returned by Box after
      *                             successful log in
-     * @param string $redirectUri  Must be the same as the redirect URI passed
-     *                             to LoginUrl
      *
      * @throws \Exception Thrown if this Client instance's clientId is not set
      * @throws \Exception Thrown if the redirect URI of this Client instance's
@@ -449,7 +446,7 @@ 
     /**
      * Get token and auto refresh.
      *
-     * @return true|string error message
+     * @return boolean error message
      */
     protected function _bd_refreshToken()
     {
@@ -533,8 +530,8 @@ 
     /**
      * Creates a base cURL object which is compatible with the Box.com API.
      *
-     * @param string $path The path of the API call (eg. /folders/0)
      *
+     * @param string $url
      * @return resource A compatible cURL object
      */
     protected function _bd_fetch($url, $contents = false)
@@ -582,7 +579,7 @@ 
      *
      * @param resource    $curl
      * @param bool|string $decodeOrParent
-     * @param array       $headers
+     * @param string[]       $headers
      *
      * @throws \Exception
      *
@@ -636,7 +633,6 @@ 
     /**
      * Drive query and fetchAll.
      *
-     * @param string $sql
      *
      * @return bool|array
      */
@@ -740,7 +736,6 @@ 
      * Get thumbnail from Box.com.
      *
      * @param string $path
-     * @param string $size
      *
      * @return string | boolean
      */
@@ -763,6 +758,7 @@ 
      * Remove item.
      *
      * @param string $path file path
+     * @param string $type
      *
      * @return bool
      **/
@@ -979,7 +975,7 @@ 
      * @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
@@ -1038,7 +1034,6 @@ 
      * Create thumnbnail and return it's URL on success.
      *
      * @param string $path file path
-     * @param string $mime file mime type
 
      * @return string|false
      *
@@ -1395,7 +1390,6 @@ 
      * Open file and return file pointer.
      *
      * @param string $path  file path
-     * @param bool   $write open file for writing
      *
      * @return resource|false
      *
@@ -1421,7 +1415,7 @@ 
      *
      * @param resource $fp file pointer
      *
-     * @return bool
+     * @return boolean|null
      *
      * @author Dmitry (dio) Levashov
      **/
@@ -1505,7 +1499,7 @@ 
      * @param string $targetDir target directory path
      * @param string $name      new file name
      *
-     * @return string|false
+     * @return string|boolean
      *
      * @author Dmitry (dio) Levashov
      **/
@@ -1552,7 +1546,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
@@ -1630,7 +1624,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)
      *
@@ -1729,7 +1722,7 @@ 
      * @param string $path    file path
      * @param string $content new file content
      *
-     * @return bool
+     * @return string|boolean
      *
      * @author Dmitry (dio) Levashov
      **/
@@ -1791,7 +1784,7 @@ 
      *
      * @param string $path file/dir path
      *
-     * @return bool
+     * @return boolean|null
      *
      * @author Dmitry (dio) Levashov
      **/

lib/elFinderVolumeDriver.class.php

Doc Comments +15 added lines, -14 removed lines

@@ -1831,7 +1831,6 @@ 
 	 *
 	 * @param  string    $hash   directory hash
 	 * @param  bool|null $lineal only lineal parents
-	 * @param  string    $until  hash that is enough to that extent >= 2.1.24
 	 * @return array
 	 * @author Dmitry (dio) Levashov
 	 **/
@@ -2446,7 +2445,7 @@ 
 	 * Return file contents.
 	 *
 	 * @param  string  $hash  file hash
-	 * @return string|false
+	 * @return boolean|string
 	 * @author Dmitry (dio) Levashov
 	 **/
 	public function getContents($hash)
@@ -2764,7 +2763,7 @@ 
 	 *
 	 * @param  string $q search string
 	 * @param  array $mimes
-	 * @param null $hash
+	 * @param string|null $hash
 	 * @return array
 	 * @author Dmitry (dio) Levashov
 	 */
@@ -3592,7 +3591,8 @@ 
 	 * Not implemented.
 	 *
 	 * @param  string  path
-	 * @return mixed
+	 * @param string $path
+	 * @return string
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function crypt($path)
@@ -3605,7 +3605,8 @@ 
 	 * Not implemented.
 	 *
 	 * @param  mixed  hash
-	 * @return mixed
+	 * @param string $hash
+	 * @return string
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function uncrypt($hash)
@@ -3657,7 +3658,7 @@ 
 	 * @param  string $from from character encoding
 	 * @param  string $to to character encoding
 	 * @param  string $locale local locale
-	 * @param $restoreLocale
+	 * @param boolean $restoreLocale
 	 * @param  string $unknown replaces character for unknown
 	 * @return mixed
 	 */
@@ -3910,7 +3911,7 @@ 
 	 *
 	 * @param string $dir parent dir path
 	 * @param string $name new file name
-	 * @param null $isDir
+	 * @param boolean $isDir
 	 * @return bool
 	 * @author Dmitry (dio) Levashov
 	 */
@@ -4634,7 +4635,7 @@ 
 	 * @param  string  $src   source path
 	 * @param  string  $dst   destination dir path
 	 * @param  string  $name  new file name (optionaly)
-	 * @return string|false
+	 * @return string
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function copy($src, $dst, $name)
@@ -4710,7 +4711,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)
@@ -4740,7 +4741,7 @@ 
 	 * @param  string  $src          source file hash
 	 * @param  string  $destination  destination dir path
 	 * @param  string  $name         file name
-	 * @return string|false
+	 * @return string
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function copyFrom($volume, $src, $destination, $name)
@@ -5371,8 +5372,8 @@ 
 	 * @param  string $path image file
 	 * @param  int $width square width
 	 * @param  int $height square height
-	 * @param int|string $align reserved
-	 * @param int|string $valign reserved
+	 * @param string $align reserved
+	 * @param string $valign reserved
 	 * @param  string $bgcolor square background color in #rrggbb format
 	 * @param  string $destformat image destination format
 	 * @param  int $jpgQuality JEPG quality (1-100)
@@ -5642,7 +5643,7 @@ 
 	 *
 	 * @param  string $command command line
 	 * @param  array $output stdout strings
-	 * @param array|int $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
@@ -6146,7 +6147,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
 	 * @author Naoki Sawada

lib/elFinderVolumeDropbox.class.php

Doc Comments +4 added lines, -4 removed lines

@@ -725,7 +725,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
 	 **/
@@ -1119,7 +1119,7 @@ 
 	 *
 	 * @param  resource $fp file pointer
 	 * @param string $path
-	 * @return bool
+	 * @return boolean|null
 	 * @author Dmitry (dio) Levashov
 	 */
 	protected function _fclose($fp, $path = '')
@@ -1324,7 +1324,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)
@@ -1386,7 +1386,7 @@ 
 	 * Recursive symlinks search.
 	 *
 	 * @param  string  $path  file/dir path
-	 * @return bool
+	 * @return boolean|null
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function _findSymlinks($path)

lib/elFinderVolumeDropbox2.class.php

Doc Comments +7 added lines, -12 removed lines

@@ -295,7 +295,6 @@ 
      * process of on netunmount
      * Drop `Dropbox` & rm thumbs.
      *
-     * @param array $options
      *
      * @return bool
      */
@@ -402,7 +401,7 @@ 
      *
      * @param string $path
      *
-     * @return array
+     * @return string[]
      */
     protected function _db_splitPath($path)
     {
@@ -489,7 +488,6 @@ 
      * Get thumbnail from Dropbox.
      *
      * @param string $path
-     * @param string $size
      *
      * @return string | boolean
      */
@@ -506,7 +504,7 @@ 
      * Join dir name and file name(display name) and retur full path.
      *
      * @param unknown $dir
-     * @param unknown $displayName
+     * @param string $displayName
      *
      * @return string
      */
@@ -785,7 +783,6 @@ 
      * Create thumnbnail and return it's URL on success.
      *
      * @param string $path file path
-     * @param string $mime file mime type
      *
      * @return string|false
      *
@@ -1112,7 +1109,6 @@ 
      * Open file and return file pointer.
      *
      * @param string $path  file path
-     * @param bool   $write open file for writing
      *
      * @return resource|false
      *
@@ -1142,7 +1138,7 @@ 
      *
      * @param resource $fp file pointer
      *
-     * @return bool
+     * @return boolean|null
      *
      * @author Naoki Sawada
      **/
@@ -1229,7 +1225,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
@@ -1286,7 +1282,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)
      *
@@ -1352,7 +1347,7 @@ 
      * @param string $path    file path
      * @param string $content new file content
      *
-     * @return bool
+     * @return boolean|string
      *
      * @author Naoki Sawada
      **/
@@ -1414,7 +1409,7 @@ 
      *
      * @param string $path file/dir path
      *
-     * @return bool
+     * @return boolean|null
      *
      * @author Dmitry (dio) Levashov
      **/
@@ -1462,7 +1457,7 @@ 
      *
      * @param string $path
      *
-     * @return object Dropbox metadata
+     * @return string Dropbox metadata
      */
     private function _db_getFile($path, $fields = '')
     {

lib/elFinderVolumeFTP.class.php

Doc Comments +14 added lines, -14 removed lines

@@ -573,7 +573,7 @@ 
 	 * Return ftp transfer mode for file.
 	 *
 	 * @param  string  $path  file path
-	 * @return string
+	 * @return integer
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function ftpMode($path)
@@ -764,7 +764,7 @@ 
 	 * If file does not exists - returns empty array or false.
 	 *
 	 * @param  string  $path    file path
-	 * @return array|false
+	 * @return string
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function _stat($path)
@@ -1048,7 +1048,7 @@ 
 	 *
 	 * @param  resource $fp file pointer
 	 * @param string $path
-	 * @return bool
+	 * @return boolean|null
 	 * @author Dmitry (dio) Levashov
 	 */
 	protected function _fclose($fp, $path = '')
@@ -1066,7 +1066,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)
@@ -1086,7 +1086,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)
@@ -1123,7 +1123,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)
@@ -1151,7 +1151,7 @@ 
 	 * @param  string $source source file path
 	 * @param $targetDir
 	 * @param  string $name file name
-	 * @return bool|string
+	 * @return string|false
 	 * @internal param string $target target dir path
 	 * @author Dmitry (dio) Levashov
 	 */
@@ -1194,7 +1194,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)
@@ -1270,7 +1270,7 @@ 
 	 *
 	 * @param string $path
 	 * @param string $mode
-	 * @return bool
+	 * @return integer
 	 */
 	protected function _chmod($path, $mode)
 	{
@@ -1283,7 +1283,7 @@ 
 	 * Recursive symlinks search.
 	 *
 	 * @param  string  $path  file/dir path
-	 * @return bool
+	 * @return boolean|null
 	 * @author Dmitry (dio) Levashov
 	 **/
 	protected function _findSymlinks($path)
@@ -1462,7 +1462,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
 	 **/
@@ -1587,9 +1587,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)
@@ -1664,7 +1664,7 @@ 
 	/**
 	 * Returns array of strings containing all files and folders in the specified local directory.
 	 * @param $dir
-	 * @param $omitSymlinks
+	 * @param boolean $omitSymlinks
 	 * @param string $prefix
 	 * @return array array of files and folders names relative to the $path
 	 * or an empty array if the directory $path is empty,

lib/elFinderVolumeGoogleDrive.class.php

Doc Comments +5 added lines, -12 removed lines

@@ -327,7 +327,6 @@ 
      * process of on netunmount
      * Drop `googledrive` & rm thumbs.
      *
-     * @param array $options
      *
      * @return bool
      */
@@ -582,7 +581,6 @@ 
     /**
      * Get ID based path from item ID.
      *
-     * @param string $path
      */
     protected function _gd_getMountPaths($id)
     {
@@ -686,7 +684,6 @@ 
      * Get thumbnail from GoogleDrive.com.
      *
      * @param string $path
-     * @param string $size
      *
      * @return string | boolean
      */
@@ -1204,7 +1201,6 @@ 
      * Create thumnbnail and return it's URL on success.
      *
      * @param string $path file path
-     * @param string $mime file mime type
      *
      * @return string|false
      *
@@ -1518,7 +1514,6 @@ 
      * Open file and return file pointer.
      *
      * @param string $path  file path
-     * @param bool   $write open file for writing
      *
      * @return resource|false
      *
@@ -1562,7 +1557,7 @@ 
      *
      * @param resource $fp file pointer
      *
-     * @return bool
+     * @return boolean|null
      *
      * @author Dmitry (dio) Levashov
      **/
@@ -1685,7 +1680,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
@@ -1764,7 +1759,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)
      *
@@ -1897,7 +1891,7 @@ 
      *
      * @param string $path file path
      *
-     * @return string|false
+     * @return boolean|string
      *
      * @author Dmitry (dio) Levashov
      **/
@@ -1925,7 +1919,7 @@ 
      * @param string $path    file path
      * @param string $content new file content
      *
-     * @return bool
+     * @return string|boolean
      *
      * @author Dmitry (dio) Levashov
      **/
@@ -1987,7 +1981,7 @@ 
      *
      * @param string $path file/dir path
      *
-     * @return bool
+     * @return boolean|null
      *
      * @author Dmitry (dio) Levashov
      **/
@@ -2033,7 +2027,6 @@ 
     /**
      * Drive query and fetchAll.
      *
-     * @param string $sql
      *
      * @return bool|array
      */

lib/elFinderVolumeLocalFileSystem.class.php

Doc Comments +4 added lines, -4 removed lines

@@ -828,7 +828,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)
@@ -850,7 +850,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)
@@ -910,7 +910,7 @@ 
 	 * @param  string $source source file path
 	 * @param $targetDir
 	 * @param  string $name file name
-	 * @return bool|string
+	 * @return string|false
 	 * @internal param string $target target dir path
 	 * @author Dmitry (dio) Levashov
 	 */
@@ -1196,7 +1196,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
 	 **/