• Home
• elFinder

PHP Class elFinder

Core class. Datei anzeigen Open project: studio-42/elfinder Class Usage Examples

Public Properties

Property	Type	Description
$defaultMimefile	string	elFinderVolumeDriver default mime.type file path
$instance	object	elFinder instance
$locale	string	elFinder global locale
$maxTargets		Max allowed numbar of @var targets (0 - no limit)
$mountErrors	array	Errors from not mounted volumes
$netDrivers	array	Network mount drivers
$phpErrors	array	Errors from PHP
$sessionCacheKey	string	elFinder global sessionCacheKey
$volumesCnt	integer	Mounted volumes count Required to create unique volume id

Protected Properties

Property	Type	Description
$base64encodeSessionData	boolean	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
$callbackWindowURL		URL for callback output window for CORS redirect to this URL when callback output
$commands	array	Commands and required arguments list
$commonTempPath	string	elFinder common tempraly path
$debug	string	Send debug to client?
$default	elFinderStorageDriver	Default root (storage)
$listeners	array	Commands listeners
$loaded	boolean	Is elFinder init correctly?
$maxArcFilesSize	integer	Max allowed archive files size (0 - no limit)
$netVolumesSessionKey	string	Session key of net mount volumes
$optionsNetVolumes	array	Additional volume root options for network mounting volume
$plugins	array	Plugins instance
$session	elFinderSessionInterface	elFinder session wrapper object
$sessionCloseEarlier	boolean	Call session_write_close() before exec command?
$sessionUseCmds	array	SESSION use commands @see __construct()
$time	string	script work time for debug
$timeout	integer	session expires timeout
$uploadDebug	string	undocumented class variable
$uploadTempPath	string	Temp dir path for Upload
$version	string	API version number
$volumes	array	Storages (root dirs)

Public Methods

Method	Description
__construct ( $opts )	Constructor
bind ( $cmd, $handler ) : elFinder	Add handler to elFinder command
commandArgsList ( $cmd ) : array	Return command required arguments info
commandExists ( $cmd ) : boolean	Return true if command exists
curlExec ( resource $curl, array $options = [], array $headers = [] ) : mixed	Call curl_exec() with supported redirect on safe_mode or open_basedir
error ( ) : array	Normalize error messages
exec ( string $cmd, array $args ) : array	Exec command and return result
extendTimeLimit ( Int $time = null ) : void	Extend PHP execution time limit
getConnectorUrl ( ) : string	Get script url.
getIniBytes ( string $iniName = '', string $val = '' ) : number	Return bytes from php.ini value
getSession ( ) : object	Return elFinder session wrapper instance
getStaticVar ( $key ) : mixed | null	Return elFinder static variable
getStreamByUrl ( array $data, number $redirectLimit = 5 ) : resource | boolean	Get stream resource pointer by URL
getVolume ( $hash ) : elFinderStorageDriver	Return root - file's owner (public func of volume())
isAnimationGif ( string $path ) : boolean	Return Is Animation Gif
isSeekableStream ( resource $resource ) : boolean	Return Is seekable stream resource
loaded ( ) : boolean	Return true if fm init correctly
phpErrorHandler ( integer $errno, string $errstr, string $errfile, integer $errline ) : void | boolean	PHP error handler, catch error types only E_WARNING | E_NOTICE | E_USER_WARNING | E_USER_NOTICE
realpath ( string $hash ) : string	Return file real path
rewind ( resource $resource ) : void	Rewind stream resource
sessionDataDecode ( mixed &$var, boolean $checkIs = null ) : boolean | mixed	base64_decode and unserialize of session data (If needed)
sessionDataEncode ( mixed $var ) : mixed | string	serialize and base64_encode of session data (If needed)
sessionWrite ( ) : void	Call session_write_close() if session is restarted
unbind ( $cmd, $handler ) : elFinder	Remove event (command exec) handler
updateNetVolumeOption ( string $netKey, string $optionKey, mixed $val )	Update sesstion value of a NetVolume option
version ( ) : string	Return version (api) number

Protected Methods

Method	Description
archive ( array $args ) : array	Create archive
callback ( $args )	Output callback result with JavaScript that control elFinder or HTTP redirect to callbackWindowURL
chmod ( $args ) : array	chmod
curl_get_contents ( string &$url, integer $timeout, integer $redirect_max, string $ua, resource $outfp ) : string	Get remote contents with cURL
detectFileExtension ( string $path ) : string	Detect file type extension by local path
dim ( array $args ) : array	Return image dimensions
duplicate ( array $args ) : array	Duplicate file - create copy with "copy %d" suffix
ensureDirsRecursively ( object $volume, string $target, string $dirs, string $path = '' ) : array | false	Ensure directories recursively
extract ( array $args ) : array	Extract files from archive
file ( $args ) : array	Required to output file in browser when volume URL is not set Return array contains opened file pointer, root itself and required headers
filter ( array $files ) : array	Remove from files list hidden files and files with required mime types
fsock_get_contents ( string &$url, integer $timeout, integer $redirect_max, string $ua, resource $outfp ) : string	Get remote contents with fsockopen()
get ( array $args ) : array	Return file content
getNetVolumeUniqueId ( array $netVolumes = null, string $prefix = 'nm' ) : string | false	Return Network mount volume unique ID
getNetVolumes ( ) : array	Return network volumes config.
getPluginInstance ( string $name, array $opts = [] ) : object | boolean	Get plugin instance & set to $this->plugins
get_remote_contents ( string &$url, integer $timeout = 30, integer $redirect_max = 5, string $ua = 'Mozilla/5.0', resource $fp = null ) : string	Get remote contents
hashes ( array $files ) : array	Return fils hashes list
info ( array $args ) : array	Return file info (used by client "places" ui)
ls ( $args ) : array	Return dir files names list
mkdir ( $args ) : array	Create directory
mkfile ( $args ) : array	Create empty file
netmount ( $args )
open ( $args ) : array	"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
parents ( $args ) : array	Return parents dir for required directory
parse_data_scheme ( string $str, array $extTable ) : array	Parse Data URI scheme
paste ( $args ) : array	Copy/move files into new destination
put ( $args ) : array	Save content into text file
removeNetVolume ( string $key, object $volume ) : boolean	Remove netmount volume
rename ( array $args ) : array	Rename file
resize ( $args ) : array	Resize image
rm ( $args ) : array	Remove dirs/files
saveNetVolumes ( array $volumes ) : void	Save network volumes config.
search ( array $args ) : array	Search files
size ( $args ) : array	Count total files size
tmb ( $args ) : array	Return new created thumbnails list
toArray ( array $data ) : array	Return files info array
tree ( $args ) : array	Return subdirs for required directory
upload ( $args ) : array	Save uploaded files
url ( array $args ) : array	Return content URL
utime ( )
volume ( $hash ) : elFinderStorageDriver	Return root - file's owner
zipdl ( $args ) : array	Download files/folders as an archive file

Private Methods

Method	Description
checkChunkedFile ( string $tmpname, string $chunk, string $cid, string $tempDir, null $volume = null ) : array	Check chunked upload files
getTempDir ( string $volumeTempPath = null ) : string	Get temporary directory path
session_expires ( )

Method Details

Property Details