• Home
• elFinderVolumeDriver

PHP Class elFinderVolumeDriver

Provide 2 layers: 1. Public API (commands) 2. abstract fs API All abstract methods begin with "_" Mostra file Open project: studio-42/elfinder Class Usage Examples

Public Properties

Property	Type	Description
$netMountKey	string	Net mount key

Protected Properties

Property	Type	Description
$ARGS	array	Request args $_POST or $_GET values
$URL	string	Base URL
$access	mixed	Access control function/class
$added	array	Store files added files info
$archivers	array	Archivers config
$attributes	mixed	Access control function/class
$cache	array	Cache storage
$cryptLib	string	Library to crypt files name
$defaults	array	Defaults permissions
$dirsCache	array	Cache by folders
$disabled	array	List of disabled client's commands
$doSearchCurrentQuery	string	Current query word on doSearch
$driverId	string	Driver id Must be started from letter and contains [a-z0-9] Used as part of volume id
$encoding		Server character encoding
$error	array	Errors from last failed action
$extractToNewdir	integer	Force make dirctory on extract
$finfo	object	Finfo object for mimeDetect == 'finfo'
$id	string	Volume id - used as prefix for files hashes
$imgConverter	array	Video to Image converter
$imgLib	string	Image manipulation lib name auto|imagick|gd|convert
$mimeDetect	string	Mimetype detect method
$mimetypes	array	default extensions/mimetypes for mimeDetect == 'internal'
$mounted	boolean	Flag - volume "mounted" and available
$onlyMimes	array	Mimetypes allowed to display
$options	array	Object configuration
$removed	array	Store files moved or overwrited files info
$root	string	Root directory path
$rootModified	boolean	Is root modified (for clear root stat cache)
$rootName	string	Root basename | alias
$searchStart	integer	Search start time
$separator	string	Directory separator - required by client
$session	elFinderSessionInterface	elFinder session wrapper object
$sessionCache	array	This volume session cache
$sessionCaching	array	Session caching item list
$startPath	string	Default directory to open
$subdirsCache	array	You should use $this->sessionCache['subdirs'] instead
$systemRoot	string	..)
$tmbPath	string	Thumbnails dir path
$tmbPathWritable	boolean	Is thumbnails dir writable
$tmbSize	integer	Thumbnails size in px
$tmbURL	string	Thumbnails base URL
$today	integer	Today 24:00 timestamp
$treeDeep	integer	How many subdirs levels return for tree
$uploadAllow	array	Mime types allowed to upload
$uploadDeny	array	Mime types denied to upload
$uploadMaxSize	integer | string	Set as number or string with unit - "10M", "500K", "1G"
$uploadOrder	array	Order to validate uploadAllow and uploadDeny
$yesterday	integer	Yesterday 24:00 timestamp

Public Methods

Method	Description
__destruct ( )	Destracter
added ( ) : array	Return list of added files
archive ( $hashes, $mime, string $name = '' ) : array | boolean	Add files to archive
chmod ( string $hash, string $mode ) : array | false	chmod a file or folder
clearcaches ( string $hash = null )	Clear inner stat caches for target hash
clearstatcache ( )	Clear PHP stat cache & all of inner stat caches
close ( Resource $fp, string $hash ) : void	Close file pointer
closest ( string $hash, string $attr, boolean $val ) : string | false	Return file/dir hash or first founded child hash with required attr == $val
commandDisabled ( string $cmd ) : boolean	Return true if command disabled in options
convEncIn ( mixed $var = null, boolean $restoreLocale = false, string $unknown = '_' ) : mixed	Converts character encoding from UTF-8 to server's one
convEncOut ( mixed $var = null, boolean $restoreLocale = true, string $unknown = '_' ) : mixed	Converts character encoding from server's one to UTF-8
copyFromAllowed ( ) : boolean	Return true if copy from this volume allowed
debug ( ) : array	Return debug info for client
defaultPath ( ) : string	Return root or startPath hash
dimensions ( string $hash ) : array	Return image dimensions
dir ( string $hash, boolean $resolveLink = false ) : array | false	Return folder info
driverId ( ) : string	Return driver id. Used as a part of volume id.
duplicate ( string $hash, string $suffix = 'copy' ) : array | false	Create file copy with suffix "copy number" and return its info
error ( ) : array	Return error message from last failed action
extract ( string $hash, null $makedir = null ) : array | boolean	Extract files from archive
ffmpegToImg ( $file, $stat ) : boolean	Convert Video To Image by ffmpeg
file ( string $hash ) : array | false	Return file info or false on error
fstat ( string $hash ) : array	stat a file or folder for elFinder cmd exec
getContentUrl ( string $hash, array $options = [] ) : boolean | string	Return content URL (for netmout volume driver) If file.url == 1 requests from JavaScript client with XHR
getContents ( string $hash ) : string | false	Return file contents
getExtentionByMime ( string $mime, string $suffix = '' ) : string	Return file extention detected by MIME type
getHash ( string $path, string $name = '' ) : string	Return target path hash
getImageSize ( string $path, string $mime = '' ) : array | false	Get image size array with dimensions
getMimeTable ( ) : array	Return Extention/MIME Table (elFinderVolumeDriver::$mimetypes)
getOption ( string $name ) : null | mixed	Get option value of this volume
getOptionsPlugin ( string $name = '' ) : null | array	Get plugin values of this options
getPath ( string $hash ) : string	Return decoded path of target hash This method do not check the stat of target Use method realpath() to do check of the stat of target
getTempPath ( ) : string	Return temp path
getUploadMaxSize ( ) : integer	Return this uploadMaxSize value
getUploadTaget ( string $baseTargetHash, string $path, array &$result ) : boolean | string	(Make &) Get upload taget dirctory hash
id ( ) : string	Return volume id
imageUtil ( string $mode, string $src, array $options = [] ) : boolean	Image file utility
isReadable ( ) : boolean	Return true if voume is readable.
isUploadableByName ( string $name, boolean $allowUnknown = true ) : boolean	Return is uploadable that given file name
ls ( string $hash, null $intersect = null ) : array	Return dir files names list
mimeAccepted ( string $mime, array $mimes = null, boolean | null $empty = true ) : boolean | null	Return true if mime is required mimes list
mkdir ( string $dsthash, string $name ) : array | false	Create directory and return dir info
mkfile ( string $dst, string $name ) : array | false	Create empty file and return its info
mount ( array $opts ) : boolean	"Mount" volume.
open ( $hash ) : Resource	Open file for reading and return file pointer
options ( $hash ) : array	Return volume options required by client:
parents ( string $hash, boolean | null $lineal = false ) : array	Return part of dirs tree from required dir up to root dir
paste ( Object $volume, $src, string $dst, boolean $rmSrc = false, array $hashes = [] ) : array | false	Paste files
path ( string $hash ) : string	Return file path related to root with convert encoging
putContents ( string $hash, string $content ) : array	Put content in text file and return file info.
realpath ( string $hash ) : string | false	Return file real path if file exists
removed ( ) : array	Return list of moved/overwrited files
rename ( string $hash, string $name ) : array | false	Rename file and return file info
resetRemoved ( ) : void	Clean removed files list
resetResultStat ( ) : void	Clean added/removed files list
resize ( string $hash, integer $width, integer $height, integer $x, integer $y, string $mode = 'resize', string $bg = '', integer $degree, integer $jpgQuality = null ) : array | false	Resize image
rm ( string $hash ) : boolean	Remove file/dir
rmdirRecursive ( string $dir ) : boolean	Remove directory recursive on local file system
root ( ) : string	Return root folder hash
scandir ( string $hash ) : array | false	Return directory content or false on error
search ( string $q, array $mimes, null $hash = null ) : array	Search files
setMimesFilter ( array $mimes ) : void	Set mimetypes allowed to display to client
setSession ( $session )	Assign elFinder session wrapper object
size ( $hash ) : integer	Return file size / total directory size
tmb ( $hash ) : false | string	Create thumbnail for required file and return its name of false on failed
tree ( string $hash = '', integer $deep, string $exclude = '' ) : array | false	Return subfolders for required folder or false on error
umount ( ) : void	Some "unmount" stuffs - may be required by virtual fs
uniqueName ( $dir, $name, string $suffix = ' copy', boolean $checkNum = true, integer $start = 1 ) : string	Return new unique name based on file name and suffix
upload ( Resource $fp, string $dst, $name, string $tmpname, array $hashes = [] ) : array | false	Save uploaded file.
zipdl ( array $hashes ) : string	Return path to archive of target items

Protected Methods

Method	Description
_abspath ( string $path ) : string	Convert path related to root dir into real path
_archive ( string $dir, array $files, string $name, array $arc ) : string | boolean	Create archive and return its path
_basename ( string $path ) : string	Return file name
_checkArchivers ( ) : void	Detect available archivers
_chmod ( string $path, string $mode ) : boolean	Change file mode (chmod)
_copy ( string $source, $targetDir, string $name ) : boolean | string	Copy file into another file (only inside one volume)
_dimensions ( string $path, string $mime ) : string	Return object width and height Ususaly used for images, but can be realize for video etc.
_dirname ( string $path ) : string	Return parent directory path
_extract ( string $path, array $arc ) : boolean	Extract files from archive
_fclose ( resource $fp, string $path = '' ) : boolean	Close opened file
_filePutContents ( string $path, string $content ) : boolean	Write a string to a file
_fopen ( string $path, string $mode = "rb" ) : resource | false	Open file and return file pointer
_getContents ( string $path ) : string | false	Get file contents
_inpath ( string $path, string $parent ) : boolean	Return true if $path is children of $parent
_joinPath ( string $dir, string $name ) : string	Join dir name and file name and return full path.
_mkdir ( string $path, string $name ) : string | boolean	Create dir and return created dir path or false on failed
_mkfile ( string $path, string $name ) : string | boolean	Create file and return it's path or false on failed
_move ( string $source, $targetDir, string $name ) : boolean | string	Move file into another parent dir.
_normpath ( string $path ) : string	Return normalized path
_path ( string $path ) : string	Return fake path started from root dir.
_relpath ( string $path ) : string	Return file path related to root dir
_rmdir ( string $path ) : boolean	Remove dir
_save ( resource $fp, string $dir, string $name, array $stat ) : boolean | string	Create new file and write into it from file pointer.
_scandir ( string $path ) : array	Return files list in directory
_stat ( string $path ) : array | false	Return stat for given path.
_subdirs ( string $path ) : boolean	Return true if path is dir and has at least one childs directory
_symlink ( string $source, string $targetDir, string $name ) : boolean	Create symlink
_unlink ( string $path ) : boolean	Remove file
abspathCE ( string $path ) : string	Convert path related to root dir into real path (with convert encoding)
allowCreate ( string $dir, string $name, null $isDir = null ) : boolean	Return true if file with given name can be created in given folder.
allowPutMime ( string $mime ) : boolean	Return true if file MIME type can save with check uploadOrder config.
attr ( string $path, string $name, boolean $val = null, boolean $isDir = null ) : boolean	Check file attribute
basenameCE ( string $path ) : string	Return file name (with convert encoding)
cacheDir ( string $path ) : void	Get stat for folder content and put in cache
canCreateTmb ( string $path, array $stat, boolean $checkTmbPath = true ) : string | boolean	Return true if thumnbnail for required file can be created
canResize ( string $path, array $stat ) : string | boolean	Return true if required file can be resized.
childsByAttr ( string $path, string $attr, boolean $val ) : string | false	Return first found children with required attr == $val
clearcache ( ) : void	Clean cache
closestByAttr ( string $path, string $attr, boolean $val ) : string | false	If file has required attr == $val - return file path, If dir has child with has required attr == $val - return child path
configure ( ) : void	Configure after successfull mount.
convEnc ( mixed $var, string $from, string $to, string $locale, $restoreLocale, string $unknown = '_' ) : mixed	Converts character encoding (base function)
copy ( string $src, string $dst, string $name ) : string | false	Copy file/recursive copy dir only in current volume.
copyFrom ( Object $volume, string $src, string $destination, string $name ) : string | false	Copy file from another volume.
countSize ( string $path ) : integer	Return file/total directory size
createTmb ( string $path, $stat ) : false | string	Create thumnbnail and return it's URL on success
crypt ( $path ) : mixed	Return crypted path Not implemented
decode ( $hash ) : string	Decode path from hash
delTree ( string $localpath ) : boolean	Delete dirctory trees
dirnameCE ( string $path ) : string	Return parent directory path (with convert encoding)
doSearch ( string $path, string $q, array $mimes ) : array	Recursive files search
encode ( $path ) : string	Encode path into hash
fcloseCE ( resource $fp, string $path = '' ) : boolean	Close opened file (with convert encoding)
fopenCE ( string $path, string $mode = 'rb' ) : false | resource	Open file and return file pointer (with convert encoding)
gdImage ( resource $image, string $filename, string $destformat, string $mime, integer $jpgQuality = null ) : boolean	Output gd image to file
gdImageBackground ( resource $image, string $bgcolor )	Assign the proper background to a gd image
gdImageCreate ( string $path, string $mime ) : gd	Create an gd image according to the specified mime type
getArchivers ( boolean $use_cache = true ) : array	Get server side available archivers
getFullPath ( string $path, string $base ) : string	Resolve relative / (Unix-like)absolute path
getItemsInHand ( array $hashes, string $dir = null ) : string | false	Copy items to a new temporary directory on the local server
getRootStatExtra ( ) : array	Get root stat extra key values
getScandir ( string $path ) : array	Return required dir's files info.
getTempFile ( string $path = '' ) : string | false	Get temporary filename. Tempfile will be removed when after script execution finishes or exit() is called.
getWorkFile ( string $path ) : string	File path of local server side work file path
gettmb ( string $path, array $stat ) : string | false	Return thumnbnail name if exists
gettree ( string $path, integer $deep, string $exclude = '' ) : array	Return subdirs tree
imageMagickConvertPrepare ( string $path, string $destformat, integer $jpgQuality, array $imageSize = null ) : array	Prepare variables for exec convert of ImageMagick
imagickImage ( resource $img, string $filename, string $destformat, integer $jpgQuality = null ) : boolean	Output imagick image to file
imgCrop ( string $path, integer $width, integer $height, boolean $x, boolean $y, string $destformat = null, integer $jpgQuality = null ) : string | false	Crop image
imgResize ( string $path, integer $width, integer $height, boolean $keepProportions = false, boolean $resizeByBiggerSide = true, string $destformat = null, integer $jpgQuality = null, array $options = [] ) : string | false	Resize image
imgRotate ( string $path, integer $degree, string $bgcolor = '#ffffff', string $destformat = null, integer $jpgQuality = null ) : string | false	Rotate image
imgSquareFit ( string $path, integer $width, integer $height, integer | string $align = 'center', integer | string $valign = 'middle', string $bgcolor = '#0000ff', string $destformat = null, integer $jpgQuality = null ) : false | string	Put image to square
init ( ) : boolean	Prepare driver before mount volume.
inpathCE ( string $path, string $parent ) : boolean	Return true if $path is children of $parent (with convert encoding)
isMyReload ( $target = '', $ARGtarget = '' )
isNameExists ( string $path ) : array	Return fileinfo based on filename For item ID based path file system Please override if needed on each drivers
isSameType ( string $mime1, string $mime2 ) : boolean	Return true if all mimes is directory or files
joinPathCE ( string $dir, string $name ) : string	Join dir name and file name and return full path. (with convert encoding) Some drivers (db) use int as path - so we give to concat path to driver itself
localScandir ( string $dir ) : array	Return files of target directory that is dotfiles excludes.
makeArchive ( string $dir, array $files, string $name, array $arc ) : string | boolean	Create archive and return its path
mimetype ( string $path, string $name = '' ) : string	Return file mimetype
mimetypeInternalDetect ( string $path = '' ) : string	Detect file mimetype using "internal" method or Loading mime.types with $path = ''
move ( string $src, string $dst, string $name ) : string | false	Move file Return new file path or false.
nameAccepted ( string $name ) : boolean	Validate file name based on $this->options['acceptedName'] regexp or function
normpathCE ( string $path ) : string	Return normalized path (with convert encoding)
procExec ( string $command, array &$output = null, array | integer &$return_var, array &$error_output = null ) : integer	Execute shell command
relpathCE ( string $path ) : string	Return file path related to root dir (with convert encoding)
remove ( string $path, boolean $force = false ) : boolean	Remove file/ recursive remove dir
rmTmb ( string $stat ) : void	Remove thumbnail, also remove recursively if stat is directory
saveCE ( resource $fp, string $dir, string $name, array $stat ) : boolean | string	Create new file and write into it from file pointer. (with convert encoding) Return new file path or false on error.
scandirCE ( string $path ) : array	Return files list in directory (with convert encoding)
sessionRestart ( )
setError ( $error ) : false	Save error message
stat ( string $path ) : array	Return fileinfo
stripos ( string $haystack, string $needle, integer $offset ) : integer | boolean	Find position of first occurrence of string in a string with multibyte support
subdirsCE ( string $path ) : boolean	Return true if path is dir and has at least one childs directory (with convert encoding)
symlinkCE ( string $source, string $targetDir, string $name ) : boolean	Create symlink (with convert encoding)
tmbname ( array $stat ) : string	Return thumbnail file name for required file
uncrypt ( $hash ) : mixed	Return uncrypted path Not implemented
unpackArchive ( string $path, array $arc, boolean $remove = true ) : void	Unpack archive
updateCache ( string $path, array $stat ) : array	Put file stat in cache and return it
zipArchiveUnzip ( string $zipPath, string $toDir ) : boolean	Unpack Zip archive using PHP class ZipArchive
zipArchiveZip ( string $dir, array $files, string | object $zipPath ) : boolean	Create Zip archive using PHP class ZipArchive

Method Details

Property Details