Class elFinder

elFinder - file manager for web. Core class.

Package: elfinder
Author: Dmitry (dio) Levashov
Author: Troex Nevelin
Author: Alexey Sukhotin
Located at zp-extensions/elFinder/php/elFinder.class.php

Methods summary
`public`	# `__construct( array $opts )` Constructor Constructor Parameters `$opts` and roots configurations Author Dmitry (dio) Levashov
`public elFinderSessionInterface`	# `getSession( )` Return elFinder session wrapper instance Return elFinder session wrapper instance Returns `elFinderSessionInterface`
`public boolean`	# `loaded( )` Return true if fm init correctly Return true if fm init correctly Returns boolean Author Dmitry (dio) Levashov
`public string`	# `version( )` Return version (api) number Return version (api) number Returns string Author Dmitry (dio) Levashov
`public string`	# `revision( )` Return revision (api) number Return revision (api) number Returns string Author Naoki Sawada
`public elFinder`	# `bind( string $cmd, string\|array $handler )` Add handler to elFinder command Add handler to elFinder command Parameters `$cmd` name `$handler` name or array(object, method) Returns `elFinder` Author Dmitry (dio) Levashov
`public elFinder`	# `unbind( string $cmd, string\|array $handler )` Remove event (command exec) handler Remove event (command exec) handler Parameters `$cmd` name `$handler` name or array(object, method) Returns `elFinder` Author Dmitry (dio) Levashov
`public`	# `trigger( string $cmd, array $vars, array & $errors )` Trigger binded functions Trigger binded functions Parameters `$cmd` binded command name `$vars` variables to pass to listeners `$errors` array into which the error is written
`public boolean`	# `commandExists( string $cmd )` Return true if command exists Return true if command exists Parameters `$cmd` name Returns boolean Author Dmitry (dio) Levashov
`public elFinderVolumeDriver`	# `getVolume( string $hash )` Return root - file's owner (public func of volume()) Return root - file's owner (public func of volume()) Parameters `$hash` hash Returns `elFinderVolumeDriver` Author Naoki Sawada
`public array`	# `commandArgsList( string $cmd )` Return command required arguments info Return command required arguments info Parameters `$cmd` name Returns array Author Dmitry (dio) Levashov
`public array`	# `exec( string $cmd, array $args )` Exec command and return result Exec command and return result Parameters `$cmd` command name `$args` command arguments Returns array Throws `elFinderAbortException`\|Exception Author Dmitry (dio) Levashov
`public string`	# `realpath( string $hash )` Return file real path Return file real path Parameters `$hash` file hash Returns string Author Dmitry (dio) Levashov
`public elFinder`	# `setCustomData( string\|array $key, mixed $val = null )` Sets custom data(s). Sets custom data(s). Parameters `$key` The key or data array `$val` The value Returns `elFinder` ( elFinder instance )
`public elFinder`	# `removeCustomData( string $key )` Removes a custom data. Removes a custom data. Parameters `$key` The key Returns `elFinder` ( elFinder instance )
`public boolean`	# `updateNetVolumeOption( string $netKey, string $optionKey, mixed $val )` Update sesstion value of a NetVolume option Update sesstion value of a NetVolume option Parameters `$netKey` `$optionKey` `$val` Returns boolean
`public`	# `removeUrlContentSaveId( string $id )` remove of session var "urlContentSaveIds" remove of session var "urlContentSaveIds" Parameters `$id`
`protected array`	# `getNetVolumes( )` Return network volumes config. Return network volumes config. Returns array Author Dmitry (dio) Levashov
`protected`	# `saveNetVolumes( array $volumes )` Save network volumes config. Save network volumes config. Parameters `$volumes` volumes config Author Dmitry (dio) Levashov
`protected boolean`	# `removeNetVolume( string $key, object $volume )` Remove netmount volume Remove netmount volume Parameters `$key` netvolume key `$volume` volume driver instance Returns boolean
`protected object`	# `getPluginInstance( string $name, array $opts = array() )` Get plugin instance & set to $this->plugins Get plugin instance & set to $this->plugins Parameters `$name` Plugin name (dirctory name) `$opts` Plugin options (optional) Returns object \| bool Plugin object instance Or false Author Naoki Sawada
`public array`	# `error( )` Normalize error messages Normalize error messages Returns array Author Dmitry (dio) Levashov
`protected array`	# `netmount( $args )` Parameters `$args` Returns array Throws `elFinderAbortException`
`protected array`	# `open( array $args )` "Open" directory Return array with following elements - cwd - opened dir info - files - opened dir content [and dirs tree if $args[tree]] - api - api version (if $args[init]) - uplMaxSize - if $args[init] - error - on failed "Open" directory Return array with following elements - cwd - opened dir info - files - opened dir content [and dirs tree if $args[tree]] - api - api version (if $args[init]) - uplMaxSize - if $args[init] - error - on failed Parameters `$args` arguments Returns array Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected array`	# `ls( array $args )` Return dir files names list Return dir files names list Parameters `$args` arguments Returns array Author Dmitry (dio) Levashov
`protected array`	# `tree( array $args )` Return subdirs for required directory Return subdirs for required directory Parameters `$args` arguments Returns array Author Dmitry (dio) Levashov
`protected array`	# `parents( array $args )` Return parents dir for required directory Return parents dir for required directory Parameters `$args` arguments Returns array Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected array`	# `tmb( array $args )` Return new created thumbnails list Return new created thumbnails list Parameters `$args` arguments Returns array Throws ImagickException `elFinderAbortException` Author Dmitry (dio) Levashov
`protected array`	# `zipdl( array $args )` Download files/folders as an archive file 1st: Return srrsy contains download archive file info 2nd: Return array contains opened file pointer, root itself and required headers Download files/folders as an archive file 1st: Return srrsy contains download archive file info 2nd: Return array contains opened file pointer, root itself and required headers Parameters `$args` arguments Returns array Throws Exception Author Naoki Sawada
`protected array`	# `file( array $args )` Required to output file in browser when volume URL is not set Return array contains opened file pointer, root itself and required headers Required to output file in browser when volume URL is not set Return array contains opened file pointer, root itself and required headers Parameters `$args` arguments Returns array Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected array`	# `size( array $args )` Count total files size Count total files size Parameters `$args` arguments Returns array Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected array`	# `mkdir( array $args )` Create directory Create directory Parameters `$args` arguments Returns array Author Dmitry (dio) Levashov
`protected array`	# `mkfile( array $args )` Create empty file Create empty file Parameters `$args` arguments Returns array Author Dmitry (dio) Levashov
`protected array`	# `rename( array $args )` Rename file, Accept multiple items >= API 2.1031 Rename file, Accept multiple items >= API 2.1031 Parameters `$args` Returns array Throws `elFinderAbortException` Author Dmitry (dio) Levashov Naoki Sawada
`protected array`	# `duplicate( array $args )` Duplicate file - create copy with "copy %d" suffix Duplicate file - create copy with "copy %d" suffix Parameters `$args` command arguments Returns array Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected array`	# `rm( array $args )` Remove dirs/files Remove dirs/files Parameters `$args` arguments Returns array Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected array`	# `subdirs( array $args )` Return has subdirs Return has subdirs Parameters `$args` arguments Returns array Author Dmitry Naoki Sawada
`protected array`	# `editor( array $args = array() )` Gateway for custom contents editor Gateway for custom contents editor Parameters `$args` command arguments Returns array Author Naoki Sawada
`protected`	# `abort( array $args = array() )` Abort current request and make flag file to running check Abort current request and make flag file to running check Parameters `$args`
`protected string,`	# `get_remote_contents( string & $url, integer $timeout = 30, integer $redirect_max = 5, string $ua = 'Mozilla/5.0', resource $fp = null )` Get remote contents Get remote contents Parameters `$url` target url `$timeout` timeout (sec) `$redirect_max` redirect max count `$ua` `$fp` Returns string, resource or bool(false) Author Naoki Sawada Rettval false error Retval string contents resource conttents
`protected string,`	# `curl_get_contents( string & $url, integer $timeout, integer $redirect_max, string $ua, resource $outfp )` Get remote contents with cURL Get remote contents with cURL Parameters `$url` target url `$timeout` timeout (sec) `$redirect_max` redirect max count `$ua` `$outfp` Returns string, resource or bool(false) Author Naoki Sawada Retval string contents resource conttents false error
`protected string,`	# `fsock_get_contents( string & $url, integer $timeout, integer $redirect_max, string $ua, resource $outfp )` Get remote contents with fsockopen() Get remote contents with fsockopen() Parameters `$url` url `$timeout` timeout (sec) `$redirect_max` redirect max count `$ua` `$outfp` Returns string, resource or bool(false) Throws `elFinderAbortException` Author Naoki Sawada Retval string contents resource conttents false error
`protected array`	# `parse_data_scheme( string $str, array $extTable, array $args = null )` Parse Data URI scheme Parse Data URI scheme Parameters `$str` `$extTable` `$args` Returns array Author Naoki Sawada
`protected string`	# `detectMimeType( string $path )` Detect file MIME Type by local path Detect file MIME Type by local path Parameters `$path` Local path Returns string file MIME Type Author Naoki Sawada
`protected string`	# `detectFileExtension( object $volume, string $path, string $name )` Detect file type extension by local path Detect file type extension by local path Parameters `$volume` elFinderVolumeDriver instance `$path` Local path `$name` Filename to save Returns string file type extension with dot Author Naoki Sawada
`protected array`	# `chmod( array $args )` chmod chmod Parameters `$args` arguments Returns array Throws `elFinderAbortException` Author David Bartle
`protected array`	# `upload( array $args )` Save uploaded files Save uploaded files Parameters `$args` Returns array Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected array`	# `paste( array $args )` Copy/move files into new destination Copy/move files into new destination Parameters `$args` arguments Returns array Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected array`	# `get( array $args )` Return file content Return file content Parameters `$args` command arguments Returns array Author Dmitry (dio) Levashov
`protected array`	# `put( $args )` Save content into text file Save content into text file Parameters `$args` Returns array Author Dmitry (dio) Levashov
`protected array`	# `extract( array $args )` Extract files from archive Extract files from archive Parameters `$args` command arguments Returns array Author Dmitry (dio) Levashov, Alexey Sukhotin
`protected array`	# `archive( array $args )` Create archive Create archive Parameters `$args` command arguments Returns array Throws Exception Author Dmitry (dio) Levashov, Alexey Sukhotin
`protected array`	# `search( array $args )` Search files Search files Parameters `$args` command arguments Returns array Throws `elFinderAbortException` Author Dmitry Levashov
`protected array`	# `info( array $args )` Return file info (used by client "places" ui) Return file info (used by client "places" ui) Parameters `$args` command arguments Returns array Throws `elFinderAbortException` Author Dmitry Levashov
`protected array`	# `dim( array $args )` Return image dimensions Return image dimensions Parameters `$args` command arguments Returns array Throws ImagickException `elFinderAbortException` Author Dmitry (dio) Levashov
`protected array`	# `resize( array $args )` Resize image Resize image Parameters `$args` arguments Returns array Throws ImagickException `elFinderAbortException` Author Dmitry (dio) Levashov Alexey Sukhotin
`protected array`	# `url( array $args )` Return content URL Return content URL Parameters `$args` command arguments Returns array Author Naoki Sawada
`protected`	# `callback( array $args )` Output callback result with JavaScript that control elFinder or HTTP redirect to callbackWindowURL Output callback result with JavaScript that control elFinder or HTTP redirect to callbackWindowURL Parameters `$args` arguments Throws `elFinderAbortException` Author Naoki Sawada
`protected boolean`	# `toastErrorHandler( integer $errno, string $errstr, string $errfile, integer $errline )` Error handler for send toast message to client side Error handler for send toast message to client side Parameters `$errno` `$errstr` `$errfile` `$errline` Returns boolean
`public static boolean`	# `phpErrorHandler( integer $errno, string $errstr, string $errfile, integer $errline )` PHP error handler, catch error types only E_WARNING \| E_NOTICE \| E_USER_WARNING \| E_USER_NOTICE PHP error handler, catch error types only E_WARNING \| E_NOTICE \| E_USER_WARNING \| E_USER_NOTICE Parameters `$errno` `$errstr` `$errfile` `$errline` Returns boolean
`protected elFinderVolumeDriver\|boolean`	# `volume( string $hash )` Return root - file's owner Return root - file's owner Parameters `$hash` hash Returns `elFinderVolumeDriver`\|boolean (false) Author Dmitry (dio) Levashov
`protected array`	# `toArray( array $data )` Return files info array Return files info array Parameters `$data` one file info or files info Returns array Author Dmitry (dio) Levashov
`protected array`	# `hashes( array $files )` Return fils hashes list Return fils hashes list Parameters `$files` files info Returns array Author Dmitry (dio) Levashov
`protected array`	# `filter( array $files )` Remove from files list hidden files and files with required mime types Remove from files list hidden files and files with required mime types Parameters `$files` files info Returns array Author Dmitry (dio) Levashov
`protected`	# `utime( )`
`protected string\|false`	# `getNetVolumeUniqueId( array $netVolumes = null, string $prefix = 'nm' )` Return Network mount volume unique ID Return Network mount volume unique ID Parameters `$netVolumes` Saved netvolumes array `$prefix` Id prefix Returns string\|false Author Naoki Sawada
`protected boolean`	# `itemLocked( string $hash )` Is item locked? Is item locked? Parameters `$hash` Returns boolean
`protected`	# `itemLock( array\|string $hashes, boolean $autoUnlock = true )` Do lock target item Do lock target item Parameters `$hashes` `$autoUnlock`
`protected boolean`	# `itemUnlock( string $hash )` Do unlock target item Do unlock target item Parameters `$hash` Returns boolean
`public`	# `itemAutoUnlock( )` unlock locked items on command completion unlock locked items on command completion
`protected array\|false`	# `ensureDirsRecursively( object $volume, string $target, array $dirs, string $path = '' )` Ensure directories recursively Ensure directories recursively Parameters `$volume` Volume object `$target` Target hash `$dirs` Array of directory tree to ensure `$path` Relative path form target hash Returns array\|false array('stats' => array([stat of maked directory]), 'hashes' => array('[path]' => '[hash]'), 'makes' => array([New directory hashes]), 'error' => array([Error name])) Author Naoki Sawada
`public`	# `setToastErrorHandler( array $opts )` Sets the toast error handler. Sets the toast error handler. Parameters `$opts` The options
`public string`	# `utf8Encode( string $str )` String encode convert to UTF-8 String encode convert to UTF-8 Parameters `$str` Input string Returns string UTF-8 string
`public static string`	# `getApiFullVersion( )` Return full version of API that this connector supports all functions Return full version of API that this connector supports all functions Returns string
`public static boolean`	# `isAnimationGif( string $path )` Return Is Animation Gif Return Is Animation Gif Parameters `$path` server local path of target image Returns boolean
`public static boolean`	# `isAnimationPng( string $path )` Return Is Animation Png Return Is Animation Png Parameters `$path` server local path of target image Returns boolean
`public static boolean`	# `isSeekableStream( resource $resource )` Return Is seekable stream resource Return Is seekable stream resource Parameters `$resource` Returns boolean
`public static`	# `rewind( resource $resource )` Rewind stream resource Rewind stream resource Parameters `$resource`
`public static boolean`	# `isSeekableUrl( <type> $resource )` Determines whether the specified resource is seekable url. Determines whether the specified resource is seekable url. Parameters `$resource` The resource Returns boolean True if the specified resource is seekable url, False otherwise.
`public static mixed\|string`	# `sessionDataEncode( mixed $var )` serialize and base64_encode of session data (If needed) serialize and base64_encode of session data (If needed) Deprecated Parameters `$var` target variable Returns mixed\|string Author Naoki Sawada
`public static boolean\|mixed`	# `sessionDataDecode( mixed & $var, boolean $checkIs = null )` base64_decode and unserialize of session data (If needed) base64_decode and unserialize of session data (If needed) Deprecated Parameters `$var` target variable `$checkIs` data type for check (array\|string\|object\|int) Returns boolean\|mixed Author Naoki Sawada
`public static`	# `sessionWrite( )` Call session_write_close() if session is restarted Call session_write_close() if session is restarted Deprecated
`public static mixed\|null`	# `getStaticVar( $key )` Return elFinder static variable Return elFinder static variable Parameters `$key` Returns mixed\|null
`public static`	# `extendTimeLimit( Int $time = null )` Extend PHP execution time limit and also check connection is aborted Extend PHP execution time limit and also check connection is aborted Parameters `$time` Throws `elFinderAbortException`
`public static`	# `checkAborted( )` Check connection is aborted Script stop immediately if connection aborted Check connection is aborted Script stop immediately if connection aborted Throws `elFinderAbortException`
`public static number`	# `getIniBytes( string $iniName = '', string $val = '' )` Return bytes from php.ini value Return bytes from php.ini value Parameters `$iniName` `$val` Returns number
`public static number`	# `xKilobyte( integer\|string $val )` Return X 1KByte Return X 1KByte Parameters `$val` The value Returns number
`public static string`	# `getConnectorUrl( )` Get script url. Get script url. Returns string full URL Author Naoki Sawada
`public static resource\|boolean`	# `getStreamByUrl( array $data, integer $redirectLimit = 5 )` Get stream resource pointer by URL Get stream resource pointer by URL Parameters `$data` array('target'=>'URL', 'headers' => array()) `$redirectLimit` Returns resource\|boolean Author Naoki Sawada
`public string`	# `getFetchCookieFile( )` Gets the fetch cookie file for curl. Gets the fetch cookie file for curl. Returns string The fetch cookie file.
`public static mixed`	# `curlExec( resource $curl, array $options = array(), array $headers = array(), array $postData = array() )` Call curl_exec() with supported redirect on `safe_mode` or `open_basedir` Call curl_exec() with supported redirect on `safe_mode` or `open_basedir` Parameters `$curl` `$options` `$headers` `$postData` Returns mixed Throws Exception Author Naoki Sawada
`public static boolean`	# `aborted( )` Return bool that current request was aborted by client side Return bool that current request was aborted by client side Returns boolean
`public static array`	# `splitFileExtention( string $name )` Return array ["name without extention", "extention"] by filename Return array ["name without extention", "extention"] by filename Parameters `$name` Returns array
`public static integer`	# `getMemorySizeByImageInfo( array $imgInfo )` Gets the memory size by imageinfo. Gets the memory size by imageinfo. Parameters `$imgInfo` array that result of getimagesize() Returns integer The memory size by imageinfo.
`public static`	# `expandMemoryForGD( array $imgInfos )` Auto expand memory for GD processing Auto expand memory for GD processing Parameters `$imgInfos` The image infos
`public static integer`	# `procExec( string $command, string & $output = '', integer & $return_var = -1, string & $error_output = '' )` Execute shell command Execute shell command Parameters `$command` command line `$output` stdout strings `$return_var` process exit code `$error_output` stderr strings Returns integer exit code Throws `elFinderAbortException` Author Alexey Sukhotin
`protected static string`	# `getCmdOfBind( string $cmd )` Get command name of binded "commandName.subName" Get command name of binded "commandName.subName" Parameters `$cmd` Returns string
`protected static string`	# `addSubToBindName( string $cmd, string $sub )` Add subName to commandName Add subName to commandName Parameters `$cmd` `$sub` Returns string
`public static`	# `rmFileInDisconnected( string $file )` Remove a file if connection is disconnected Remove a file if connection is disconnected Parameters `$file`
`public static`	# `onShutdown( )` Call back function on shutdown - delete files in $GLOBALS['elFinderTempFiles'] Call back function on shutdown - delete files in $GLOBALS['elFinderTempFiles']
`public static`	# `GlobGC( string $pattern, integer $time )` Garbage collection with glob Garbage collection with glob Parameters `$pattern` `$time`

Constants summary
`string`	`ERROR_ACCESS_DENIED`	# `'errAccess'`
`string`	`ERROR_ARC_MAXSIZE`	# `'errArcMaxSize'`
`string`	`ERROR_ARC_SYMLINKS`	# `'errArcSymlinks'`
`string`	`ERROR_ARCHIVE`	# `'errArchive'`
`string`	`ERROR_ARCHIVE_EXEC`	# `'errArchiveExec'`
`string`	`ERROR_ARCHIVE_TYPE`	# `'errArcType'`
`string`	`ERROR_CONF`	# `'errConf'`
`string`	`ERROR_CONF_NO_JSON`	# `'errJSON'`
`string`	`ERROR_CONF_NO_VOL`	# `'errNoVolumes'`
`string`	`ERROR_CONV_UTF8`	# `'errConvUTF8'`
`string`	`ERROR_COPY`	# `'errCopy'`
`string`	`ERROR_COPY_FROM`	# `'errCopyFrom'`
`string`	`ERROR_COPY_ITSELF`	# `'errCopyInItself'`
`string`	`ERROR_COPY_TO`	# `'errCopyTo'`
`string`	`ERROR_CREATING_TEMP_DIR`	# `'errCreatingTempDir'`
`string`	`ERROR_DIR_NOT_FOUND`	# `'errFolderNotFound'`
`string`	`ERROR_EXISTS`	# `'errExists'`
`string`	`ERROR_EXTRACT`	# `'errExtract'`
`string`	`ERROR_EXTRACT_EXEC`	# `'errExtractExec'`
`string`	`ERROR_FILE_NOT_FOUND`	# `'errFileNotFound'`
`string`	`ERROR_FTP_DOWNLOAD_FILE`	# `'errFtpDownloadFile'`
`string`	`ERROR_FTP_MKDIR`	# `'errFtpMkdir'`
`string`	`ERROR_FTP_UPLOAD_FILE`	# `'errFtpUploadFile'`
`string`	`ERROR_INV_PARAMS`	# `'errCmdParams'`
`string`	`ERROR_INVALID_DIRNAME`	# `'errInvDirname'`
`string`	`ERROR_INVALID_NAME`	# `'errInvName'`
`string`	`ERROR_LOCKED`	# `'errLocked'`
`string`	`ERROR_MAX_TARGTES`	# `'errMaxTargets'`
`string`	`ERROR_MKDIR`	# `'errMkdir'`
`string`	`ERROR_MKFILE`	# `'errMkfile'`
`string`	`ERROR_MKOUTLINK`	# `'errMkOutLink'`
`string`	`ERROR_MOVE`	# `'errMove'`
`string`	`ERROR_NETMOUNT`	# `'errNetMount'`
`string`	`ERROR_NETMOUNT_FAILED`	# `'errNetMountFailed'`
`string`	`ERROR_NETMOUNT_NO_DRIVER`	# `'errNetMountNoDriver'`
`string`	`ERROR_NETUNMOUNT`	# `'errNetUnMount'`
`string`	`ERROR_NOT_ARCHIVE`	# `'errNoArchive'`
`string`	`ERROR_NOT_DIR`	# `'errNotFolder'`
`string`	`ERROR_NOT_FILE`	# `'errNotFile'`
`string`	`ERROR_NOT_REPLACE`	# `'errNotReplace'`
`string`	`ERROR_NOT_UTF8_CONTENT`	# `'errNotUTF8Content'`
`string`	`ERROR_OPEN`	# `'errOpen'`
`string`	`ERROR_PERM_DENIED`	# `'errPerm'`
`string`	`ERROR_REAUTH_REQUIRE`	# `'errReauthRequire'`
`string`	`ERROR_RENAME`	# `'errRename'`
`string`	`ERROR_REPLACE`	# `'errReplace'`
`string`	`ERROR_RESIZE`	# `'errResize'`
`string`	`ERROR_RESIZESIZE`	# `'errResizeSize'`
`string`	`ERROR_RM`	# `'errRm'`
`string`	`ERROR_RM_SRC`	# `'errRmSrc'`
`string`	`ERROR_SAVE`	# `'errSave'`
`string`	`ERROR_SEARCH_TIMEOUT`	# `'errSearchTimeout'`
`string`	`ERROR_SESSION_EXPIRES`	# `'errSessionExpires'`
`string`	`ERROR_TRGDIR_NOT_FOUND`	# `'errTrgFolderNotFound'`
`string`	`ERROR_UNKNOWN`	# `'errUnknown'`
`string`	`ERROR_UNKNOWN_CMD`	# `'errUnknownCmd'`
`string`	`ERROR_UNSUPPORT_TYPE`	# `'errUsupportType'`
`string`	`ERROR_UPLOAD`	# `'errUpload'`
`string`	`ERROR_UPLOAD_FILE`	# `'errUploadFile'`
`string`	`ERROR_UPLOAD_FILE_MIME`	# `'errUploadMime'`
`string`	`ERROR_UPLOAD_FILE_SIZE`	# `'errUploadFileSize'`
`string`	`ERROR_UPLOAD_NO_FILES`	# `'errUploadNoFiles'`
`string`	`ERROR_UPLOAD_TEMP`	# `'errUploadTemp'`
`string`	`ERROR_UPLOAD_TOTAL_SIZE`	# `'errUploadTotalSize'`
`string`	`ERROR_UPLOAD_TRANSFER`	# `'errUploadTransfer'`

Properties summary
`protected static float`	`$ApiVersion` API version number API version number	# `2.1`
`protected string`	`$version` API version number API version number Deprecated	#
`protected static integer`	`$ApiRevision` API revision that this connector supports all functions API revision that this connector supports all functions	# `57`
`protected array`	`$volumes` Storages (root dirs) Storages (root dirs)	# `array()`
`public static object`	`$instance` elFinder instance elFinder instance	# `null`
`public static array`	`$currentArgs` Current request args Current request args	# `array()`
`public static array`	`$netDrivers` Network mount drivers Network mount drivers	# `array()`
`public static string`	`$locale` elFinder global locale elFinder global locale	# `''`
`public static string`	`$defaultMimefile` elFinderVolumeDriver default mime.type file path elFinderVolumeDriver default mime.type file path	# `''`
`public static string`	`$tmpLinkPath` A file save destination path when a temporary content URL is required on a network volume or the like It can be overwritten by volume route setting A file save destination path when a temporary content URL is required on a network volume or the like It can be overwritten by volume route setting	# `''`
`public static string`	`$tmpLinkUrl` A file save destination URL when a temporary content URL is required on a network volume or the like It can be overwritten by volume route setting A file save destination URL when a temporary content URL is required on a network volume or the like It can be overwritten by volume route setting	# `''`
`public static integer`	`$tmpLinkLifeTime` Temporary content URL lifetime (seconds) Temporary content URL lifetime (seconds)	# `3600`
`public static array`	`$textMimes` MIME type list handled as a text file MIME type list handled as a text file	# array( 'application/dash+xml', 'application/docbook+xml', 'application/javascript', 'application/json', 'application/plt', 'application/sat', 'application/sql', 'application/step', 'application/vnd.hp-hpgl', 'application/x-awk', 'application/x-config', 'application/x-csh', 'application/x-empty', 'application/x-mpegurl', 'application/x-perl', 'application/x-php', 'application/x-web-config', 'application/xhtml+xml', 'application/xml', 'audio/x-mp3-playlist', 'image/cgm', 'image/svg+xml', 'image/vnd.dxf', 'model/iges' )
`public static integer\|string`	`$memoryLimitGD` Maximum memory size to be extended during GD processing (0: not expanded, -1: unlimited or memory size notation) Maximum memory size to be extended during GD processing (0: not expanded, -1: unlimited or memory size notation)	# `0`
`protected static string`	`$abortCheckFile` Path of current request flag file for abort check Path of current request flag file for abort check	# `null`
`protected elFinderSessionInterface`	`$session` elFinder session wrapper object elFinder session wrapper object	#
`public static string`	`$sessionCacheKey` elFinder global sessionCacheKey elFinder global sessionCacheKey Deprecated	# `''`
`protected static boolean`	`$base64encodeSessionData` elFinder base64encodeSessionData elFinder save session data as `UTF-8` If the session storage mechanism of the system does not allow `UTF-8` And it must be `true` option 'base64encodeSessionData' of elFinder WARNING: When enabling this option, if saving the data passed from the user directly to the session variable, it make vulnerable to the object injection attack, so use it carefully. see https://github.com/Studio-42/elFinder/issues/2345 elFinder base64encodeSessionData elFinder save session data as `UTF-8` If the session storage mechanism of the system does not allow `UTF-8` And it must be `true` option 'base64encodeSessionData' of elFinder WARNING: When enabling this option, if saving the data passed from the user directly to the session variable, it make vulnerable to the object injection attack, so use it carefully. see https://github.com/Studio-42/elFinder/issues/2345	# `false`
`protected static string`	`$commonTempPath` elFinder common tempraly path elFinder common tempraly path Default "./.tmp" or sys_get_temp_dir()	# `''`
`protected callable`	`$urlUploadFilter` Callable function for URL upload filter The first argument is a URL and the second argument is an instance of the elFinder class A filter should be return true (to allow) / false (to disallow) Callable function for URL upload filter The first argument is a URL and the second argument is an instance of the elFinder class A filter should be return true (to allow) / false (to disallow) Default null	# `null`
`protected static string`	`$connectionFlagsPath` Connection flag files path that connection check of current request Connection flag files path that connection check of current request Default value of $commonTempPath	# `''`
`protected array`	`$optionsNetVolumes` Additional volume root options for network mounting volume Additional volume root options for network mounting volume	# `array()`
`protected string`	`$netVolumesSessionKey` Session key of net mount volumes Session key of net mount volumes Deprecated	# `''`
`public static integer`	`$volumesCnt` Mounted volumes count Required to create unique volume id Mounted volumes count Required to create unique volume id	# `1`
`protected elFinderVolumeDriver`	`$default` Default root (storage) Default root (storage)	# `null`
`protected array`	`$commands` Commands and required arguments list Commands and required arguments list	# array( 'abort' => array('id' => true), 'archive' => array('targets' => true, 'type' => true, 'mimes' => false, 'name' => false), 'callback' => array('node' => true, 'json' => false, 'bind' => false, 'done' => false), 'chmod' => array('targets' => true, 'mode' => true), 'dim' => array('target' => true, 'substitute' => false), 'duplicate' => array('targets' => true, 'suffix' => false), 'editor' => array('name' => true, 'method' => true, 'args' => false), 'extract' => array('target' => true, 'mimes' => false, 'makedir' => false), 'file' => array('target' => true, 'download' => false, 'cpath' => false, 'onetime' => false), 'get' => array('target' => true, 'conv' => false), 'info' => array('targets' => true, 'compare' => false), 'ls' => array('target' => true, 'mimes' => false, 'intersect' => false), 'mkdir' => array('target' => true, 'name' => false, 'dirs' => false), 'mkfile' => array('target' => true, 'name' => true, 'mimes' => false), 'netmount' => array('protocol' => true, 'host' => true, 'path' => false, 'port' => false, 'user' => false, 'pass' => false, 'alias' => false, 'options' => false), 'open' => array('target' => false, 'tree' => false, 'init' => false, 'mimes' => false, 'compare' => false), 'parents' => array('target' => true, 'until' => false), 'paste' => array('dst' => true, 'targets' => true, 'cut' => false, 'mimes' => false, 'renames' => false, 'hashes' => false, 'suffix' => false), 'put' => array('target' => true, 'content' => '', 'mimes' => false, 'encoding' => false), 'rename' => array('target' => true, 'name' => true, 'mimes' => false, 'targets' => false, 'q' => false), 'resize' => array('target' => true, 'width' => false, 'height' => false, 'mode' => false, 'x' => false, 'y' => false, 'degree' => false, 'quality' => false, 'bg' => false), 'rm' => array('targets' => true), 'search' => array('q' => true, 'mimes' => false, 'target' => false, 'type' => false), 'size' => array('targets' => true), 'subdirs' => array('targets' => true), 'tmb' => array('targets' => true), 'tree' => array('target' => true), 'upload' => array('target' => true, 'FILES' => true, 'mimes' => false, 'html' => false, 'upload' => false, 'name' => false, 'upload_path' => false, 'chunk' => false, 'cid' => false, 'node' => false, 'renames' => false, 'hashes' => false, 'suffix' => false, 'mtime' => false, 'overwrite' => false, 'contentSaveId' => false), 'url' => array('target' => true, 'options' => false), 'zipdl' => array('targets' => true, 'download' => false) )
`protected array`	`$plugins` Plugins instance Plugins instance	# `array()`
`protected array`	`$listeners` Commands listeners Commands listeners	# `array()`
`protected string`	`$time` script work time for debug script work time for debug	# `0`
`protected boolean`	`$loaded` Is elFinder init correctly? Is elFinder init correctly?	# `false`
`protected string`	`$debug` Send debug to client? Send debug to client?	# `false`
`protected boolean`	`$sessionCloseEarlier` Call `session_write_close()` before exec command? Call `session_write_close()` before exec command?	# `true`
`protected array`	`$sessionUseCmds` SESSION use commands @see __construct() SESSION use commands @see __construct()	# `array()`
`protected integer`	`$timeout` session expires timeout session expires timeout	# `0`
`protected string`	`$uploadTempPath` Temp dir path for Upload Temp dir path for Upload	# `''`
`protected integer`	`$maxArcFilesSize` Max allowed archive files size (0 - no limit) Max allowed archive files size (0 - no limit)	# `0`
`protected string`	`$uploadDebug` undocumented class variable undocumented class variable	# `''`
`public integer`	`$maxTargets` Max allowed numbar of targets (0 - no limit) Max allowed numbar of targets (0 - no limit)	# `1000`
`public static array`	`$phpErrors` Errors from PHP Errors from PHP	# `array()`
`public array`	`$mountErrors` Errors from not mounted volumes Errors from not mounted volumes	# `array()`
`public static array`	`$archivers` Archivers cache Archivers cache	# `array()`
`protected string`	`$callbackWindowURL` URL for callback output window for CORS redirect to this URL when callback output URL for callback output window for CORS redirect to this URL when callback output	# `''`
`protected array`	`$autoUnlocks` hash of items to unlock on command completion hash of items to unlock on command completion	# `array()`
`protected integer`	`$itemLockExpire` Item locking expiration (seconds) Default: 3600 secs Item locking expiration (seconds) Default: 3600 secs	# `3600`
`protected array\|null`	`$customData` Additional request querys Additional request querys	# `null`
`protected array`	`$removeContentSaveIds` Ids to remove of session var "urlContentSaveIds" for contents uploading by URL Ids to remove of session var "urlContentSaveIds" for contents uploading by URL	# `array()`
`protected boolean`	`$throwErrorOnExec` Flag of throw Error on exec() Flag of throw Error on exec()	# `false`
`protected array`	`$toastParamsDefault` Default params of toastParams Default params of toastParams	# `array( 'mode' => 'warning', 'prefix' => '' )`

Classes

Interfaces

Exceptions

Functions

Class elFinder

Parameters

Author

Returns

Returns

Author

Returns

Author

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Throws

Author

Parameters

Returns

Author

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Author

Parameters

Author

Parameters

Returns

Parameters

Returns

Author

Returns

Author

Parameters

Returns

Throws

Parameters

Returns

Throws

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Throws

Author

Parameters

Returns

Throws

Author

Parameters

Returns

Throws

Author