Class elFinderVolumeDriver

Base class for elFinder volume. Provide 2 layers: 1. Public API (commands) 2. abstract fs API All abstract methods begin with "_"

Direct known subclasses

elFinderVolumeBox, elFinderVolumeDropbox, elFinderVolumeDropbox2, elFinderVolumeFTP, elFinderVolumeGoogleDrive, elFinderVolumeGroup, elFinderVolumeLocalFileSystem, elFinderVolumeMySQL, elFinderVolumeOneDrive

Indirect known subclasses

elFinderVolumeTrash, elFinderVolumeTrashMySQL

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

Methods summary
`public`	# `setNeedOnline( boolean $state = null )` Sets the need online. Sets the need online. Parameters `$state` The state
`protected boolean`	# `init( )` Prepare driver before mount volume. Return true if volume is ready. Prepare driver before mount volume. Return true if volume is ready. Returns boolean Author Dmitry (dio) Levashov
`protected`	# `configure( )` Configure after successfull mount. By default set thumbnails path and image manipulation library. Configure after successfull mount. By default set thumbnails path and image manipulation library. Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected`	# `sessionRestart( )` Deprecated
`public string`	# `driverId( )` Return driver id. Used as a part of volume id. Return driver id. Used as a part of volume id. Returns string Author Dmitry (dio) Levashov
`public string`	# `id( )` Return volume id Return volume id Returns string Author Dmitry (dio) Levashov
`public`	# `setSession( $session )` Assign elFinder session wrapper object Assign elFinder session wrapper object Parameters `$session` elFinderSessionInterface
`public object`	# `getSession( )` Get elFinder sesson wrapper object Get elFinder sesson wrapper object Returns object The session object
`public`	# `saveSessionCache( )` Save session cache data Calls this function before umount this volume on elFinder::exec() Save session cache data Calls this function before umount this volume on elFinder::exec()
`public array`	# `debug( )` Return debug info for client Return debug info for client Returns array Author Dmitry (dio) Levashov
`public array\|false`	# `chmod( string $hash, string $mode )` chmod a file or folder chmod a file or folder Parameters `$hash` file or folder hash to chmod `$mode` octal string representing new permissions Returns array\|false Author David Bartle
`public array`	# `fstat( string $hash )` stat a file or folder for elFinder cmd exec stat a file or folder for elFinder cmd exec Parameters `$hash` file or folder hash to chmod Returns array Author Naoki Sawada
`public`	# `clearstatcache( )` Clear PHP stat cache & all of inner stat caches Clear PHP stat cache & all of inner stat caches
`public`	# `clearcaches( string $hash = null )` Clear inner stat caches for target hash Clear inner stat caches for target hash Parameters `$hash`
`public boolean`	# `mount( array $opts )` "Mount" volume. Return true if volume available for read or write, false - otherwise "Mount" volume. Return true if volume available for read or write, false - otherwise Parameters `$opts` Returns boolean Throws `elFinderAbortException` Author Dmitry (dio) Levashov Alexey Sukhotin
`public`	# `umount( )` Some "unmount" stuffs - may be required by virtual fs Some "unmount" stuffs - may be required by virtual fs Author Dmitry (dio) Levashov
`public`	# `clearSessionCache( )` Remove session cache of this volume Remove session cache of this volume
`public array`	# `error( )` Return error message from last failed action Return error message from last failed action Returns array Author Dmitry (dio) Levashov
`public boolean`	# `isUploadableByName( string $name, boolean $allowUnknown = false )` Return is uploadable that given file name Return is uploadable that given file name Parameters `$name` file name `$allowUnknown` Returns boolean Author Naoki Sawada
`public array`	# `getMimeTable( )` Return Extention/MIME Table (elFinderVolumeDriver::$mimetypes) Return Extention/MIME Table (elFinderVolumeDriver::$mimetypes) Returns array Author Naoki Sawada
`public string`	# `getExtentionByMime( string $mime, string $suffix = '' )` Return file extention detected by MIME type Return file extention detected by MIME type Parameters `$mime` MIME type `$suffix` Additional suffix Returns string Author Naoki Sawada
`public`	# `setMimesFilter( array $mimes )` Set mimetypes allowed to display to client Set mimetypes allowed to display to client Parameters `$mimes` Author Dmitry (dio) Levashov
`public string`	# `root( )` Return root folder hash Return root folder hash Returns string Author Dmitry (dio) Levashov
`public string`	# `getRootPath( )` Return root path Return root path Returns string Author Naoki Sawada
`public string`	# `getHash( string $path, string $name = '' )` Return target path hash Return target path hash Parameters `$path` `$name` Returns string Author Naoki Sawada
`public string`	# `getPath( string $hash )` 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 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 Parameters `$hash` Returns string Author Naoki Sawada
`public string`	# `defaultPath( )` Return root or startPath hash Return root or startPath hash Returns string Author Dmitry (dio) Levashov
`public array`	# `options( $hash )` Return volume options required by client: Return volume options required by client: Parameters `$hash` Returns array Author Dmitry (dio) Levashov
`public null\|mixed`	# `getOption( string $name )` Get option value of this volume Get option value of this volume Parameters `$name` target option name Returns null\|mixed target option value Author Naoki Sawada
`public null\|array`	# `getOptionsPlugin( string $name = '' )` Get plugin values of this options Get plugin values of this options Parameters `$name` Plugin name Returns null\|array Plugin values Author Naoki Sawada
`public boolean`	# `commandDisabled( string $cmd )` Return true if command disabled in options Return true if command disabled in options Parameters `$cmd` command name Returns boolean Author Dmitry (dio) Levashov
`public boolean\|null`	# `mimeAccepted( string $mime, array $mimes = null, boolean\|null $empty = true )` Return true if mime is required mimes list Return true if mime is required mimes list Parameters `$mime` mime type to check `$mimes` allowed mime types list or not set to use client mimes list `$empty` what to return on empty list Returns boolean\|null Author Dmitry (dio) Levashov Troex Nevelin
`public boolean`	# `isReadable( )` Return true if voume is readable. Return true if voume is readable. Returns boolean Author Dmitry (dio) Levashov
`public boolean`	# `copyFromAllowed( )` Return true if copy from this volume allowed Return true if copy from this volume allowed Returns boolean Author Dmitry (dio) Levashov
`public string`	# `path( string $hash )` Return file path related to root with convert encoging Return file path related to root with convert encoging Parameters `$hash` file hash Returns string Author Dmitry (dio) Levashov
`public string`	# `realpath( string $hash )` Return file real path if file exists Return file real path if file exists Parameters `$hash` file hash Returns string \| false Author Dmitry (dio) Levashov
`public array`	# `removed( )` Return list of moved/overwrited files Return list of moved/overwrited files Returns array Author Dmitry (dio) Levashov
`public array`	# `added( )` Return list of added files Return list of added files Deprecated Returns array Author Naoki Sawada
`public`	# `resetRemoved( )` Clean removed files list Clean removed files list Author Dmitry (dio) Levashov
`public`	# `resetResultStat( )` Clean added/removed files list Clean added/removed files list
`public string\|false`	# `closest( string $hash, string $attr, boolean $val )` Return file/dir hash or first founded child hash with required attr == $val Return file/dir hash or first founded child hash with required attr == $val Parameters `$hash` file hash `$attr` attribute name `$val` attribute value Returns string\|false Author Dmitry (dio) Levashov
`public array\|false`	# `file( string $hash )` Return file info or false on error Return file info or false on error Parameters `$hash` file hash Returns array\|false Author Dmitry (dio) Levashov
`public array\|false`	# `dir( string $hash, boolean $resolveLink = false )` Return folder info Return folder info Parameters `$hash` folder hash `$resolveLink` Returns array\|false Author Dmitry (dio) Levashov
`public array\|false`	# `scandir( string $hash )` Return directory content or false on error Return directory content or false on error Parameters `$hash` file hash Returns array\|false Author Dmitry (dio) Levashov
`public array\|false`	# `ls( string $hash, null $intersect = null )` Return dir files names list Return dir files names list Parameters `$hash` file hash `$intersect` Returns array\|false Author Dmitry (dio) Levashov
`public array\|false`	# `tree( string $hash = '', integer $deep = 0, string $exclude = '' )` Return subfolders for required folder or false on error Return subfolders for required folder or false on error Parameters `$hash` folder hash or empty string to get tree from root folder `$deep` subdir deep `$exclude` dir hash which subfolders must be exluded from result, required to not get stat twice on cwd subfolders Returns array\|false Author Dmitry (dio) Levashov
`public array\|false`	# `parents( string $hash, boolean\|null $lineal = false )` Return part of dirs tree from required dir up to root dir Return part of dirs tree from required dir up to root dir Parameters `$hash` directory hash `$lineal` only lineal parents Returns array\|false Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`public false\|string`	# `tmb( $hash )` Create thumbnail for required file and return its name or false on failed Create thumbnail for required file and return its name or false on failed Parameters `$hash` Returns false\|string Throws ImagickException `elFinderAbortException` Author Dmitry (dio) Levashov
`public array`	# `size( string $hash )` Return file size / total directory size Return file size / total directory size Parameters `$hash` hash Returns array Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`public Resource\|false`	# `open( string $hash )` Open file for reading and return file pointer Open file for reading and return file pointer Parameters `$hash` hash Returns Resource\|false Author Dmitry (dio) Levashov
`public`	# `close( Resource $fp, string $hash )` Close file pointer Close file pointer Parameters `$fp` file pointer `$hash` file hash Author Dmitry (dio) Levashov
`public array\|false`	# `mkdir( string $dsthash, string $name )` Create directory and return dir info Create directory and return dir info Parameters `$dsthash` destination directory hash `$name` directory name Returns array\|false Author Dmitry (dio) Levashov
`public array\|false`	# `mkfile( string $dst, string $name )` Create empty file and return its info Create empty file and return its info Parameters `$dst` destination directory `$name` file name Returns array\|false Author Dmitry (dio) Levashov
`public array\|false`	# `rename( string $hash, string $name )` Rename file and return file info Rename file and return file info Parameters `$hash` file hash `$name` new file name Returns array\|false Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`public array\|false`	# `duplicate( string $hash, string $suffix = 'copy' )` Create file copy with suffix "copy number" and return its info Create file copy with suffix "copy number" and return its info Parameters `$hash` file hash `$suffix` suffix to add to file name Returns array\|false Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`public array\|false`	# `upload( Resource $fp, string $dst, $name, string $tmpname, array $hashes = array() )` Save uploaded file. On success return array with new file stat and with removed file hash (if existed file was replaced) Save uploaded file. On success return array with new file stat and with removed file hash (if existed file was replaced) Parameters `$fp` file pointer `$dst` destination folder hash `$name` `$tmpname` file tmp name - required to detect mime type `$hashes` exists files hash array with filename as key Returns array\|false Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`public array\|false`	# `paste( Object $volume, $src, string $dst, boolean $rmSrc = false, array $hashes = array() )` Paste files Paste files Parameters `$volume` source volume `$src` `$dst` destination dir hash `$rmSrc` remove source after copy? `$hashes` Returns array\|false Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`public array\|false`	# `zipdl( array $hashes )` Return path info array to archive of target items Return path info array to archive of target items Parameters `$hashes` Returns array\|false Throws Exception Author Naoki Sawada
`public string\|false`	# `getContents( string $hash )` Return file contents Return file contents Parameters `$hash` file hash Returns string\|false Author Dmitry (dio) Levashov
`public array\|false`	# `putContents( string $hash, string $content )` Put content in text file and return file info. Put content in text file and return file info. Parameters `$hash` file hash `$content` new file content Returns array\|false Author Dmitry (dio) Levashov
`public array\|boolean`	# `extract( string $hash, null $makedir = null )` Extract files from archive Extract files from archive Parameters `$hash` archive hash `$makedir` Returns array\|boolean Author Dmitry (dio) Levashov, Alexey Sukhotin
`public array\|boolean`	# `archive( $hashes, $mime, string $name = '' )` Add files to archive Add files to archive Parameters `$hashes` `$mime` `$name` Returns array\|boolean Throws Exception
`protected string\|boolean`	# `remoteArchive( array $hashes, string $name, array $arc )` Create an archive from remote items Create an archive from remote items Parameters `$hashes` files hashes list `$name` archive name `$arc` archiver options Returns string\|boolean path of created archive Throws Exception
`public array\|false`	# `resize( string $hash, integer $width, integer $height, integer $x, integer $y, string $mode = 'resize', string $bg = '', integer $degree = 0, integer $jpgQuality = null )` Resize image Resize image Parameters `$hash` image file `$width` new width `$height` new height `$x` X start poistion for crop `$y` Y start poistion for crop `$mode` action how to mainpulate image `$bg` background color `$degree` rotete degree `$jpgQuality` JEPG quality (1-100) Returns array\|false Throws ImagickException `elFinderAbortException` Author Dmitry (dio) Levashov Alexey Sukhotin nao-pon Troex Nevelin
`public boolean`	# `rm( string $hash )` Remove file/dir Remove file/dir Parameters `$hash` file hash Returns boolean Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`public array`	# `search( string $q, array $mimes, null $hash = null )` Search files Search files Parameters `$q` search string `$mimes` `$hash` Returns array Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`public array\|string`	# `dimensions( string $hash )` Return image dimensions Return image dimensions Parameters `$hash` file hash Returns array\|string Author Dmitry (dio) Levashov
`public boolean`	# `subdirs( string $hash )` Return has subdirs Return has subdirs Parameters `$hash` file hash Returns boolean Author Naoki Sawada
`public boolean\|string`	# `getContentUrl( string $hash, array $options = array() )` Return content URL (for netmout volume driver) If file.url == 1 requests from JavaScript client with XHR Return content URL (for netmout volume driver) If file.url == 1 requests from JavaScript client with XHR Parameters `$hash` file hash `$options` options array Returns boolean\|string Author Naoki Sawada
`public boolean\|array`	# `getTempLinkInfo( string $name = null )` Get temporary contents link infomation Get temporary contents link infomation Parameters `$name` Returns boolean\|array Author Naoki Sawada
`public boolean`	# `getSubstituteImgLink( string $target, array $srcSize, resource $srcfp = null, integer $maxSize = null )` Get URL of substitute image by request args `substitute` or 4th argument $maxSize Get URL of substitute image by request args `substitute` or 4th argument $maxSize Parameters `$target` Target hash `$srcSize` Size info array [width, height] `$srcfp` Source file file pointer `$maxSize` Maximum pixel of substitute image Returns boolean Throws ImagickException `elFinderAbortException`
`public string`	# `getTempPath( )` Return temp path Return temp path Returns string Author Naoki Sawada
`public boolean\|string`	# `getUploadTaget( string $baseTargetHash, string $path, array & $result )` (Make &) Get upload taget dirctory hash (Make &) Get upload taget dirctory hash Parameters `$baseTargetHash` `$path` `$result` Returns boolean\|string Author Naoki Sawada
`public integer`	# `getUploadMaxSize( )` Return this uploadMaxSize value Return this uploadMaxSize value Returns integer Author Naoki Sawada
`public`	# `setUploadOverwrite( $var )`
`public boolean`	# `imageUtil( string $mode, string $src, array $options = array() )` Image file utility Image file utility Parameters `$mode` 'resize', 'rotate', 'propresize', 'crop', 'fitsquare' `$src` Image file local path `$options` excute options Returns boolean Throws ImagickException `elFinderAbortException` Author Naoki Sawada
`public boolean`	# `ffmpegToImg( string $file, array $stat, object $self, integer $ss = null )` Convert Video To Image by ffmpeg Convert Video To Image by ffmpeg Parameters `$file` video source file path `$stat` file stat array `$self` volume driver object `$ss` start seconds Returns boolean Throws `elFinderAbortException` Author Naoki Sawada
`public resource\|boolean`	# `tmpfile( )` Creates a temporary file and return file pointer Creates a temporary file and return file pointer Returns resource\|boolean
`protected boolean`	# `setError( )` Save error message Save error message Returns boolean false Author Naoki Sawada
`protected false`	# `addError( )` Add error message Add error message Returns false Author Dmitry(dio) Levashov
`protected string`	# `dirnameCE( string $path )` Return parent directory path (with convert encoding) Return parent directory path (with convert encoding) Parameters `$path` file path Returns string Author Naoki Sawada
`protected string`	# `basenameCE( string $path )` Return file name (with convert encoding) Return file name (with convert encoding) Parameters `$path` file path Returns string Author Naoki Sawada
`protected string`	# `joinPathCE( string $dir, string $name )` 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 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 Parameters `$dir` dir path `$name` file name Returns string Author Naoki Sawada
`protected string`	# `normpathCE( string $path )` Return normalized path (with convert encoding) Return normalized path (with convert encoding) Parameters `$path` file path Returns string Author Naoki Sawada
`protected string`	# `relpathCE( string $path )` Return file path related to root dir (with convert encoding) Return file path related to root dir (with convert encoding) Parameters `$path` file path Returns string Author Naoki Sawada
`protected string`	# `abspathCE( string $path )` Convert path related to root dir into real path (with convert encoding) Convert path related to root dir into real path (with convert encoding) Parameters `$path` rel file path Returns string Author Naoki Sawada
`protected boolean`	# `inpathCE( string $path, string $parent )` Return true if $path is children of $parent (with convert encoding) Return true if $path is children of $parent (with convert encoding) Parameters `$path` path to check `$parent` parent path Returns boolean Author Naoki Sawada
`protected false\|resource`	# `fopenCE( string $path, string $mode = 'rb' )` Open file and return file pointer (with convert encoding) Open file and return file pointer (with convert encoding) Parameters `$path` file path `$mode` Returns false\|resource Author Naoki Sawada
`protected boolean`	# `fcloseCE( resource $fp, string $path = '' )` Close opened file (with convert encoding) Close opened file (with convert encoding) Parameters `$fp` file pointer `$path` file path Returns boolean Author Naoki Sawada
`protected boolean\|string`	# `saveCE( resource $fp, string $dir, string $name, array $stat )` Create new file and write into it from file pointer. (with convert encoding) Return new file path or false on error. Create new file and write into it from file pointer. (with convert encoding) Return new file path or false on error. Parameters `$fp` file pointer `$dir` target dir path `$name` file name `$stat` file stat (required by some virtual fs) Returns boolean\|string Author Naoki Sawada
`protected boolean`	# `subdirsCE( string $path )` Return true if path is dir and has at least one childs directory (with convert encoding) Return true if path is dir and has at least one childs directory (with convert encoding) Parameters `$path` dir path Returns boolean Author Naoki Sawada
`protected array`	# `scandirCE( string $path )` Return files list in directory (with convert encoding) Return files list in directory (with convert encoding) Parameters `$path` dir path Returns array Author Naoki Sawada
`protected boolean`	# `symlinkCE( string $source, string $targetDir, string $name )` Create symlink (with convert encoding) Create symlink (with convert encoding) Parameters `$source` file to link to `$targetDir` folder to create link in `$name` symlink name Returns boolean Author Naoki Sawada
`protected string`	# `encode( string $path )` Encode path into hash Encode path into hash Parameters `$path` path Returns string Author Dmitry (dio) Levashov Troex Nevelin
`protected string`	# `decode( string $hash )` Decode path from hash Decode path from hash Parameters `$hash` hash Returns string Author Dmitry (dio) Levashov Troex Nevelin
`protected mixed`	# `crypt( string $path )` Return crypted path Not implemented Return crypted path Not implemented Parameters `$path` path Returns mixed Author Dmitry (dio) Levashov
`protected mixed`	# `uncrypt( mixed $hash )` Return uncrypted path Not implemented Return uncrypted path Not implemented Parameters `$hash` hash Returns mixed Author Dmitry (dio) Levashov
`protected boolean`	# `nameAccepted( string $name, boolean $isDir = false )` Validate file name based on $this->options['acceptedName'] regexp or function Validate file name based on $this->options['acceptedName'] regexp or function Parameters `$name` file name `$isDir` Returns boolean Author Dmitry (dio) Levashov
`protected string`	# `getRootstatCachekey( )` Return session rootstat cache key Return session rootstat cache key Returns string
`public string`	# `uniqueName( $dir, $name, string $suffix = ' copy', boolean $checkNum = true, integer $start = 1 )` Return new unique name based on file name and suffix Return new unique name based on file name and suffix Parameters `$dir` `$name` `$suffix` suffix append to name `$checkNum` `$start` Returns string Author Dmitry (dio) Levashov
`public mixed`	# `convEncIn( mixed $var = null, boolean $restoreLocale = false, string $unknown = '_' )` Converts character encoding from UTF-8 to server's one Converts character encoding from UTF-8 to server's one Parameters `$var` target string or array var `$restoreLocale` do retore global locale, default is false `$unknown` replaces character for unknown Returns mixed Author Naoki Sawada
`public mixed`	# `convEncOut( mixed $var = null, boolean $restoreLocale = true, string $unknown = '_' )` Converts character encoding from server's one to UTF-8 Converts character encoding from server's one to UTF-8 Parameters `$var` target string or array var `$restoreLocale` do retore global locale, default is true `$unknown` replaces character for unknown Returns mixed Author Naoki Sawada
`protected mixed`	# `convEnc( mixed $var, string $from, string $to, string $locale, $restoreLocale, string $unknown = '_' )` Converts character encoding (base function) Converts character encoding (base function) Parameters `$var` target string or array var `$from` from character encoding `$to` to character encoding `$locale` local locale `$restoreLocale` `$unknown` replaces character for unknown Returns mixed
`public string`	# `mimeTypeNormalize( string $type, string $name, string $ext = '' )` Normalize MIME-Type by options['mimeMap'] Normalize MIME-Type by options['mimeMap'] Parameters `$type` MIME-Type `$name` Filename `$ext` File extention without first dot (optional) Returns string Normalized MIME-Type
`protected string\|false`	# `getTempFile( string $path = '' )` Get temporary filename. Tempfile will be removed when after script execution finishes or exit() is called. When needing the unique file to a path, give $path to parameter. Get temporary filename. Tempfile will be removed when after script execution finishes or exit() is called. When needing the unique file to a path, give $path to parameter. Parameters `$path` for get unique file to a path Returns string\|false Author Naoki Sawada
`protected string`	# `getWorkFile( string $path )` File path of local server side work file path File path of local server side work file path Parameters `$path` path need convert encoding to server encoding Returns string Author Naoki Sawada
`public array\|false`	# `getImageSize( string $path, string $mime = '' )` Get image size array with `dimensions` Get image size array with `dimensions` Parameters `$path` path need convert encoding to server encoding `$mime` file mime type Returns array\|false Throws ImagickException `elFinderAbortException`
`protected boolean`	# `delTree( string $localpath )` Delete dirctory trees Delete dirctory trees Parameters `$localpath` path need convert encoding to server encoding Returns boolean Throws `elFinderAbortException` Author Naoki Sawada
`protected string\|false`	# `getItemsInHand( array $hashes, string $dir = null, string $canLink = null )` Copy items to a new temporary directory on the local server Copy items to a new temporary directory on the local server Parameters `$hashes` target hashes `$dir` destination directory (for recurcive) `$canLink` it can use link() (for recurcive) Returns string\|false saved path name Throws `elFinderAbortException` Author Naoki Sawada
`protected boolean`	# `attr( string $path, string $name, boolean $val = null, boolean $isDir = null )` Check file attribute Check file attribute Parameters `$path` file path `$name` attribute name (read\|write\|locked\|hidden) `$val` attribute value returned by file system `$isDir` path is directory (true: directory, false: file) Returns boolean Author Dmitry (dio) Levashov
`protected boolean`	# `allowCreate( string $dir, string $name, null $isDir = null )` Return true if file with given name can be created in given folder. Return true if file with given name can be created in given folder. Parameters `$dir` parent dir path `$name` new file name `$isDir` Returns boolean Author Dmitry (dio) Levashov
`protected boolean`	# `allowPutMime( string $mime )` Return true if file MIME type can save with check uploadOrder config. Return true if file MIME type can save with check uploadOrder config. Parameters `$mime` Returns boolean
`protected array\|boolean`	# `stat( string $path )` Return fileinfo Return fileinfo Parameters `$path` file cache Returns array\|boolean Author Dmitry (dio) Levashov
`protected array`	# `getRootStatExtra( )` Get root stat extra key values Get root stat extra key values Returns array stat extras Author Naoki Sawada
`protected array`	# `isNameExists( string $path )` Return fileinfo based on filename For item ID based path file system Please override if needed on each drivers Return fileinfo based on filename For item ID based path file system Please override if needed on each drivers Parameters `$path` file cache Returns array
`protected array`	# `updateCache( string $path, array $stat )` Put file stat in cache and return it Put file stat in cache and return it Parameters `$path` file path `$stat` file stat Returns array Author Dmitry (dio) Levashov
`protected`	# `cacheDir( string $path )` Get stat for folder content and put in cache Get stat for folder content and put in cache Parameters `$path` Author Dmitry (dio) Levashov
`protected`	# `clearcache( )` Clean cache Clean cache Author Dmitry (dio) Levashov
`protected string`	# `mimetype( string $path, string\|boolean $name = '', integer $size = null, string $mime = null )` Return file mimetype Return file mimetype Parameters `$path` file path `$name` `$size` `$mime` was notified from the volume driver Returns string Author Dmitry (dio) Levashov
`protected static`	# `loadMimeTypes( string $mimeTypesFile = '' )` Load file of mime.types Load file of mime.types Parameters `$mimeTypesFile` The mime types file
`protected static string`	# `mimetypeInternalDetect( string $path = '' )` Detect file mimetype using "internal" method or Loading mime.types with $path = '' Detect file mimetype using "internal" method or Loading mime.types with $path = '' Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`protected array`	# `countSize( string $path )` Return file/total directory size infomation Return file/total directory size infomation Parameters `$path` file path Returns array Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected boolean`	# `isSameType( string $mime1, string $mime2 )` Return true if all mimes is directory or files Return true if all mimes is directory or files Parameters `$mime1` mimetype `$mime2` mimetype Returns boolean Author Dmitry (dio) Levashov
`protected string\|false`	# `closestByAttr( string $path, string $attr, boolean $val )` If file has required attr == $val - return file path, If dir has child with has required attr == $val - return child path If file has required attr == $val - return file path, If dir has child with has required attr == $val - return child path Parameters `$path` file path `$attr` attribute name `$val` attribute value Returns string\|false Author Dmitry (dio) Levashov
`protected string\|false`	# `childsByAttr( string $path, string $attr, boolean $val )` Return first found children with required attr == $val Return first found children with required attr == $val Parameters `$path` file path `$attr` attribute name `$val` attribute value Returns string\|false Author Dmitry (dio) Levashov
`protected`	# `isMyReload( $target = '', $ARGtarget = '' )`
`protected`	# `updateSubdirsCache( string $path, boolean $subdirs )` Update subdirs cache data Update subdirs cache data Parameters `$path` `$subdirs`
`protected array`	# `getScandir( string $path )` Return required dir's files info. If onlyMimes is set - return only dirs and files of required mimes Return required dir's files info. If onlyMimes is set - return only dirs and files of required mimes Parameters `$path` dir path Returns array Author Dmitry (dio) Levashov
`protected array`	# `gettree( string $path, integer $deep, string $exclude = '' )` Return subdirs tree Return subdirs tree Parameters `$path` parent dir path `$deep` tree deep `$exclude` Returns array Author Dmitry (dio) Levashov
`protected array`	# `doSearch( string $path, string $q, array $mimes )` Recursive files search Recursive files search Parameters `$path` dir path `$q` search string `$mimes` Returns array Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected string\|false`	# `copy( string $src, string $dst, string $name )` Copy file/recursive copy dir only in current volume. Return new file path or false. Copy file/recursive copy dir only in current volume. Return new file path or false. Parameters `$src` source path `$dst` destination dir path `$name` new file name (optionaly) Returns string\|false Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected string\|false`	# `move( string $src, string $dst, string $name )` Move file Return new file path or false. Move file Return new file path or false. Parameters `$src` source path `$dst` destination dir path `$name` new file name Returns string\|false Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected string\|false`	# `copyFrom( Object $volume, string $src, string $destination, string $name )` Copy file from another volume. Return new file path or false. Copy file from another volume. Return new file path or false. Parameters `$volume` source volume `$src` source file hash `$destination` destination dir path `$name` file name Returns string\|false Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected boolean`	# `remove( string $path, boolean $force = false )` Remove file/ recursive remove dir Remove file/ recursive remove dir Parameters `$path` file path `$force` try to remove even if file locked Returns boolean Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected string`	# `tmbname( array $stat )` Return thumbnail file name for required file Return thumbnail file name for required file Parameters `$stat` file stat Returns string Author Dmitry (dio) Levashov
`protected string\|false`	# `gettmb( string $path, array $stat )` Return thumnbnail name if exists Return thumnbnail name if exists Parameters `$path` file path `$stat` file stat Returns string\|false Author Dmitry (dio) Levashov
`protected string\|boolean`	# `canCreateTmb( string $path, array $stat, boolean $checkTmbPath = true )` Return true if thumnbnail for required file can be created Return true if thumnbnail for required file can be created Parameters `$path` thumnbnail path `$stat` file stat `$checkTmbPath` Returns string\|boolean Author Dmitry (dio) Levashov
`protected string\|boolean`	# `canResize( string $path, array $stat )` Return true if required file can be resized. By default - the same as canCreateTmb Return true if required file can be resized. By default - the same as canCreateTmb Parameters `$path` thumnbnail path `$stat` file stat Returns string\|boolean Author Dmitry (dio) Levashov
`protected false\|string`	# `createTmb( string $path, $stat )` Create thumnbnail and return it's URL on success Create thumnbnail and return it's URL on success Parameters `$path` file path `$stat` Returns false\|string Throws `elFinderAbortException` ImagickException Author Dmitry (dio) Levashov
`protected string\|false`	# `imgResize( string $path, integer $width, integer $height, boolean $keepProportions = false, boolean $resizeByBiggerSide = true, string $destformat = null, integer $jpgQuality = null, array $options = array() )` Resize image Resize image Parameters `$path` image file `$width` new width `$height` new height `$keepProportions` crop image `$resizeByBiggerSide` resize image based on bigger side if true `$destformat` image destination format `$jpgQuality` JEPG quality (1-100) `$options` Other extra options Returns string\|false Throws `elFinderAbortException` Author Dmitry (dio) Levashov Alexey Sukhotin
`protected string\|false`	# `imgCrop( string $path, integer $width, integer $height, boolean $x, boolean $y, string $destformat = null, integer $jpgQuality = null )` Crop image Crop image Parameters `$path` image file `$width` crop width `$height` crop height `$x` crop left offset `$y` crop top offset `$destformat` image destination format `$jpgQuality` JEPG quality (1-100) Returns string\|false Throws `elFinderAbortException` Author Dmitry (dio) Levashov Alexey Sukhotin
`protected false\|string`	# `imgSquareFit( string $path, integer $width, integer $height, integer\|string $align = 'center', integer\|string $valign = 'middle', string $bgcolor = '#0000ff', string $destformat = null, integer $jpgQuality = null )` Put image to square Put image to square Parameters `$path` image file `$width` square width `$height` square height `$align` reserved `$valign` reserved `$bgcolor` square background color in #rrggbb format `$destformat` image destination format `$jpgQuality` JEPG quality (1-100) Returns false\|string Throws ImagickException `elFinderAbortException` Author Dmitry (dio) Levashov Alexey Sukhotin
`protected string\|false`	# `imgRotate( string $path, integer $degree, string $bgcolor = '#ffffff', string $destformat = null, integer $jpgQuality = null )` Rotate image Rotate image Parameters `$path` image file `$degree` rotete degrees `$bgcolor` square background color in #rrggbb format `$destformat` image destination format `$jpgQuality` JEPG quality (1-100) Returns string\|false Throws `elFinderAbortException` Author nao-pon Troex Nevelin
`protected 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`	# `rmTmb( array $stat )` Remove thumbnail, also remove recursively if stat is directory Remove thumbnail, also remove recursively if stat is directory Parameters `$stat` file stat Throws `elFinderAbortException` Author Dmitry (dio) Levashov Naoki Sawada Troex Nevelin
`protected resource\|false`	# `gdImageCreate( string $path, string $mime )` Create an gd image according to the specified mime type Create an gd image according to the specified mime type Parameters `$path` image file `$mime` Returns resource\|false GD image resource identifier
`protected boolean`	# `gdImage( resource $image, string $filename, string $destformat, string $mime, integer $jpgQuality = null )` Output gd image to file Output gd image to file Parameters `$image` gd image resource `$filename` The path to save the file to. `$destformat` The Image type to use for $filename `$mime` The original image mime type `$jpgQuality` JEPG quality (1-100) Returns boolean
`protected boolean`	# `imagickImage( imagick $img, string $filename, string $destformat, integer $jpgQuality = null )` Output imagick image to file Output imagick image to file Parameters `$img` imagick image resource `$filename` The path to save the file to. `$destformat` The Image type to use for $filename `$jpgQuality` JEPG quality (1-100) Returns boolean
`protected`	# `gdImageBackground( resource $image, string $bgcolor )` Assign the proper background to a gd image Assign the proper background to a gd image Parameters `$image` gd image resource `$bgcolor` background color in #rrggbb format
`protected array`	# `imageMagickConvertPrepare( string $path, string $destformat, integer $jpgQuality, array $imageSize = null, null $mime = null )` Prepare variables for exec convert of ImageMagick Prepare variables for exec convert of ImageMagick Parameters `$path` `$destformat` `$jpgQuality` `$imageSize` `$mime` Returns array Throws `elFinderAbortException`
`protected integer\|boolean`	# `stripos( string $haystack, string $needle, integer $offset = 0 )` Find position of first occurrence of string in a string with multibyte support Find position of first occurrence of string in a string with multibyte support Parameters `$haystack` The string being checked. `$needle` The string to find in haystack. `$offset` The search offset. If it is not specified, 0 is used. Returns integer\|boolean Author Alexey Sukhotin
`protected boolean`	# `searchMatchName( String $name, String $query, String $path )` Default serach match method (name match) Default serach match method (name match) Parameters `$name` Item name `$query` Query word `$path` Item path Returns boolean @return bool
`protected array`	# `getArchivers( boolean $use_cache = true )` Get server side available archivers Get server side available archivers Parameters `$use_cache` Returns array Throws `elFinderAbortException`
`protected string`	# `getFullPath( string $path, string $base )` Resolve relative / (Unix-like)absolute path Resolve relative / (Unix-like)absolute path Parameters `$path` target path `$base` base path Returns string
`public boolean`	# `rmdirRecursive( string $dir )` Remove directory recursive on local file system Remove directory recursive on local file system Parameters `$dir` Target dirctory path Returns boolean Throws `elFinderAbortException` Author Naoki Sawada
`protected string\|boolean`	# `makeArchive( string $dir, array $files, string $name, array $arc )` Create archive and return its path Create archive and return its path Parameters `$dir` target dir `$files` files names list `$name` archive name `$arc` archiver options Returns string\|boolean Throws `elFinderAbortException` Author Dmitry (dio) Levashov, Alexey Sukhotin Naoki Sawada
`protected`	# `unpackArchive( string $path, array $arc, boolean\|string $mode = true )` Unpack archive Unpack archive Parameters `$path` archive path `$arc` archiver command and arguments (same as in $this->archivers) `$mode` bool: remove archive ( unlink($path) ) \| string: extract to directory Throws `elFinderAbortException` Author Dmitry (dio) Levashov Alexey Sukhotin Naoki Sawada
`protected array`	# `checkExtractItems( string $path, array $checks = null )` Check and filter the extracted items Check and filter the extracted items Parameters `$path` target local path `$checks` types to check default: ['symlink', 'name', 'writable', 'mime'] Returns array ['symlinks' => [], 'names' => [], 'writables' => [], 'mimes' => [], 'rmNames' => [], 'totalSize' => 0] Throws `elFinderAbortException` Exception Author Naoki Sawada
`protected static array`	# `localScandir( string $dir )` Return files of target directory that is dotfiles excludes. Return files of target directory that is dotfiles excludes. Parameters `$dir` target directory path Returns array Throws Exception Author Naoki Sawada
`protected static boolean`	# `localRmdirRecursive( string $dir )` Remove directory recursive on local file system Remove directory recursive on local file system Parameters `$dir` Target dirctory path Returns boolean Throws `elFinderAbortException` Author Naoki Sawada
`protected static boolean`	# `localMoveRecursive( string $src, string $target, boolean $overWrite = true, boolean $copyJoin = true )` Move item recursive on local file system Move item recursive on local file system Parameters `$src` `$target` `$overWrite` `$copyJoin` Returns boolean Throws `elFinderAbortException` Exception Author Naoki Sawada
`protected static boolean`	# `zipArchiveZip( string $dir, array $files, string\|object $zipPath )` Create Zip archive using PHP class ZipArchive Create Zip archive using PHP class ZipArchive Parameters `$dir` target dir `$files` files names list `$zipPath` Zip archive name Returns boolean Author Naoki Sawada
`protected static boolean`	# `zipArchiveUnzip( string $zipPath, string $toDir )` Unpack Zip archive using PHP class ZipArchive Unpack Zip archive using PHP class ZipArchive Parameters `$zipPath` Zip archive name `$toDir` Extract to path Returns boolean Author Naoki Sawada
`protected static boolean`	# `localFindSymlinks( string $path )` Recursive symlinks search Recursive symlinks search Parameters `$path` file/dir path Returns boolean Throws Exception Author Dmitry (dio) Levashov
`abstract protected string`	# `_dirname( string $path )` Return parent directory path Return parent directory path Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`abstract protected string`	# `_basename( string $path )` Return file name Return file name Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`abstract protected string`	# `_joinPath( string $dir, string $name )` Join dir name and file name and return full path. Some drivers (db) use int as path - so we give to concat path to driver itself Join dir name and file name and return full path. Some drivers (db) use int as path - so we give to concat path to driver itself Parameters `$dir` dir path `$name` file name Returns string Author Dmitry (dio) Levashov
`abstract protected string`	# `_normpath( string $path )` Return normalized path Return normalized path Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`abstract protected string`	# `_relpath( string $path )` Return file path related to root dir Return file path related to root dir Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`abstract protected string`	# `_abspath( string $path )` Convert path related to root dir into real path Convert path related to root dir into real path Parameters `$path` rel file path Returns string Author Dmitry (dio) Levashov
`abstract protected string`	# `_path( string $path )` Return fake path started from root dir. Required to show path on client side. Return fake path started from root dir. Required to show path on client side. Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`abstract protected boolean`	# `_inpath( string $path, string $parent )` Return true if $path is children of $parent Return true if $path is children of $parent Parameters `$path` path to check `$parent` parent path Returns boolean Author Dmitry (dio) Levashov
`abstract protected array\|false`	# `_stat( string $path )` Return stat for given path. Stat contains following fields: - (int) size file size in b. required - (int) ts file modification time in unix time. required - (string) mime mimetype. required for folders, others - optionally - (bool) read read permissions. required - (bool) write write permissions. required - (bool) locked is object locked. optionally - (bool) hidden is object hidden. optionally - (string) alias for symlinks - link target path relative to root path. optionally - (string) target for symlinks - link target path. optionally If file does not exists - returns empty array or false. Return stat for given path. Stat contains following fields: - (int) size file size in b. required - (int) ts file modification time in unix time. required - (string) mime mimetype. required for folders, others - optionally - (bool) read read permissions. required - (bool) write write permissions. required - (bool) locked is object locked. optionally - (bool) hidden is object hidden. optionally - (string) alias for symlinks - link target path relative to root path. optionally - (string) target for symlinks - link target path. optionally If file does not exists - returns empty array or false. Parameters `$path` file path Returns array\|false Author Dmitry (dio) Levashov
`abstract protected boolean`	# `_subdirs( string $path )` Return true if path is dir and has at least one childs directory Return true if path is dir and has at least one childs directory Parameters `$path` dir path Returns boolean Author Dmitry (dio) Levashov
`abstract protected string`	# `_dimensions( string $path, string $mime )` Return object width and height Ususaly used for images, but can be realize for video etc... Return object width and height Ususaly used for images, but can be realize for video etc... Parameters `$path` file path `$mime` file mime type Returns string Author Dmitry (dio) Levashov
`abstract protected array`	# `_scandir( string $path )` Return files list in directory Return files list in directory Parameters `$path` dir path Returns array Author Dmitry (dio) Levashov
`abstract protected resource\|false`	# `_fopen( string $path, string $mode = "rb" )` Open file and return file pointer Open file and return file pointer Parameters `$path` file path `$mode` open mode Returns resource\|false Author Dmitry (dio) Levashov
`abstract protected boolean`	# `_fclose( resource $fp, string $path = '' )` Close opened file Close opened file Parameters `$fp` file pointer `$path` file path Returns boolean Author Dmitry (dio) Levashov
`abstract protected string\|boolean`	# `_mkdir( string $path, string $name )` Create dir and return created dir path or false on failed Create dir and return created dir path or false on failed Parameters `$path` parent dir path `$name` new directory name Returns string\|boolean Author Dmitry (dio) Levashov
`abstract protected string\|boolean`	# `_mkfile( string $path, string $name )` Create file and return it's path or false on failed Create file and return it's path or false on failed Parameters `$path` parent dir path `$name` new file name Returns string\|boolean Author Dmitry (dio) Levashov
`abstract protected boolean`	# `_symlink( string $source, string $targetDir, string $name )` Create symlink Create symlink Parameters `$source` file to link to `$targetDir` folder to create link in `$name` symlink name Returns boolean Author Dmitry (dio) Levashov
`abstract protected boolean\|string`	# `_copy( string $source, $targetDir, string $name )` Copy file into another file (only inside one volume) Copy file into another file (only inside one volume) Parameters `$source` source file path `$targetDir` `$name` file name Returns boolean\|string Author Dmitry (dio) Levashov
`abstract protected boolean\|string`	# `_move( string $source, $targetDir, string $name )` Move file into another parent dir. Return new file path or false. Move file into another parent dir. Return new file path or false. Parameters `$source` source file path `$targetDir` `$name` file name Returns boolean\|string Author Dmitry (dio) Levashov
`abstract protected boolean`	# `_unlink( string $path )` Remove file Remove file Parameters `$path` file path Returns boolean Author Dmitry (dio) Levashov
`abstract protected boolean`	# `_rmdir( string $path )` Remove dir Remove dir Parameters `$path` dir path Returns boolean Author Dmitry (dio) Levashov
`abstract protected boolean\|string`	# `_save( resource $fp, string $dir, string $name, array $stat )` Create new file and write into it from file pointer. Return new file path or false on error. Create new file and write into it from file pointer. Return new file path or false on error. Parameters `$fp` file pointer `$dir` target dir path `$name` file name `$stat` file stat (required by some virtual fs) Returns boolean\|string Author Dmitry (dio) Levashov
`abstract protected string\|false`	# `_getContents( string $path )` Get file contents Get file contents Parameters `$path` file path Returns string\|false Author Dmitry (dio) Levashov
`abstract protected boolean`	# `_filePutContents( string $path, string $content )` Write a string to a file Write a string to a file Parameters `$path` file path `$content` new file content Returns boolean Author Dmitry (dio) Levashov
`abstract protected boolean`	# `_extract( string $path, array $arc )` Extract files from archive Extract files from archive Parameters `$path` file path `$arc` archiver options Returns boolean Author Dmitry (dio) Levashov, Alexey Sukhotin
`abstract protected string\|boolean`	# `_archive( string $dir, array $files, string $name, array $arc )` Create archive and return its path Create archive and return its path Parameters `$dir` target dir `$files` files names list `$name` archive name `$arc` archiver options Returns string\|boolean Author Dmitry (dio) Levashov, Alexey Sukhotin
`abstract protected`	# `_checkArchivers( )` Detect available archivers Detect available archivers Author Dmitry (dio) Levashov, Alexey Sukhotin
`abstract protected boolean`	# `_chmod( string $path, string $mode )` Change file mode (chmod) Change file mode (chmod) Parameters `$path` file path `$mode` octal string such as '0755' Returns boolean Author David Bartle,

Magic methods summary
`public`	# `netmountPrepare( array $options )` Parameters `$options` Returns
`public`	# `postNetmount( array $options )` Parameters `$options` Returns

Properties summary
`public string`	`$netMountKey` Net mount key Net mount key	# `''`
`protected array`	`$ARGS` Request args $_POST or $_GET values Request args $_POST or $_GET values	# `array()`
`protected string`	`$driverId` Driver id Must be started from letter and contains [a-z0-9] Used as part of volume id Driver id Must be started from letter and contains [a-z0-9] Used as part of volume id	# `'a'`
`protected string`	`$id` Volume id - used as prefix for files hashes Volume id - used as prefix for files hashes	# `''`
`protected boolean`	`$mounted` Flag - volume "mounted" and available Flag - volume "mounted" and available	# `false`
`protected string`	`$root` Root directory path Root directory path	# `''`
`protected string`	`$rootName` Root basename \| alias Root basename \| alias	# `''`
`protected string`	`$startPath` Default directory to open Default directory to open	# `''`
`protected string`	`$URL` Base URL Base URL	# `''`
`protected string`	`$tmp` Path to temporary directory Path to temporary directory	#
`protected string`	`$tmpLinkPath` A file save destination path when a temporary content URL is required on a network volume or the like If not specified, it tries to use "Connector Path/../files/.tmb". A file save destination path when a temporary content URL is required on a network volume or the like If not specified, it tries to use "Connector Path/../files/.tmb".	# `''`
`protected string`	`$tmpLinkUrl` A file save destination URL when a temporary content URL is required on a network volume or the like If not specified, it tries to use "Connector URL/../files/.tmb". A file save destination URL when a temporary content URL is required on a network volume or the like If not specified, it tries to use "Connector URL/../files/.tmb".	# `''`
`protected string`	`$tmbPath` Thumbnails dir path Thumbnails dir path	# `''`
`protected boolean`	`$tmbPathWritable` Is thumbnails dir writable Is thumbnails dir writable	# `false`
`protected string`	`$tmbURL` Thumbnails base URL Thumbnails base URL	# `''`
`protected integer`	`$tmbSize` Thumbnails size in px Thumbnails size in px	# `48`
`protected string`	`$imgLib` Image manipulation lib name auto\|imagick\|gd\|convert Image manipulation lib name auto\|imagick\|gd\|convert	# `'auto'`
`protected array`	`$imgConverter` Video to Image converter Video to Image converter	# `array()`
`protected string`	`$cryptLib` Library to crypt files name Library to crypt files name	# `''`
`protected array`	`$archivers` Archivers config Archivers config	# `array( 'create' => array(), 'extract' => array() )`
`protected static integer\|string`	`$maxArcFilesSize` Static var of $this->options['maxArcFilesSize'] Static var of $this->options['maxArcFilesSize']	#
`protected string`	`$encoding` Server character encoding Server character encoding	# `null`
`protected integer`	`$treeDeep` How many subdirs levels return for tree How many subdirs levels return for tree	# `1`
`protected array`	`$error` Errors from last failed action Errors from last failed action	# `array()`
`protected integer`	`$today` Today 24:00 timestamp Today 24:00 timestamp	# `0`
`protected integer`	`$yesterday` Yesterday 24:00 timestamp Yesterday 24:00 timestamp	# `0`
`protected integer`	`$extractToNewdir` Force make dirctory on extract Force make dirctory on extract	# `'auto'`
`protected array`	`$options` Object configuration Object configuration	# array( // Driver ID (Prefix of volume ID), Normally, the value specified for each volume driver is used. 'driverId' => '', // Id (Suffix of volume ID), Normally, the number incremented according to the specified number of volumes is used. 'id' => '', // revision id of root directory that uses for caching control of root stat 'rootRev' => '', // driver type it uses volume root's CSS class name. e.g. 'group' -> Adds 'elfinder-group' to CSS class name. 'type' => '', // root directory path 'path' => '', // Folder hash value on elFinder to be the parent of this volume 'phash' => '', // Folder hash value on elFinder to trash bin of this volume, it require 'copyJoin' to true 'trashHash' => '', // open this path on initial request instead of root path 'startPath' => '', // how many subdirs levels return per request 'treeDeep' => 1, // root url, not set to URL via the connector. If you want to hide the file URL, do not set this value. (replacement for old "fileURL" option) 'URL' => '', // enable onetime URL to a file - (true, false, 'auto' (true if a temporary directory is available) or callable (A function that return onetime URL)) 'onetimeUrl' => 'auto', // directory link url to own manager url with folder hash (`true`, `false`, `'hide'`(No show) or default `'auto'`: URL is empty then `true` else `false`) 'dirUrlOwn' => 'auto', // directory separator. required by client to show paths correctly 'separator' => DIRECTORY_SEPARATOR, // Use '/' as directory separator when the path hash encode/decode on the Windows server too 'winHashFix' => false, // Server character encoding (default is '': UTF-8) 'encoding' => '', // for convert character encoding (default is '': Not change locale) 'locale' => '', // URL of volume icon image 'icon' => '', // CSS Class of volume root in tree 'rootCssClass' => '', // Items to disable session caching 'noSessionCache' => array(), // enable i18n folder name that convert name to elFinderInstance.messages['folder_'+name] 'i18nFolderName' => false, // Search timeout (sec) 'searchTimeout' => 30, // Search exclusion directory regex pattern (require demiliter e.g. '#/path/to/exclude_directory#i') 'searchExDirReg' => '', // library to crypt/uncrypt files names (not implemented) 'cryptLib' => '', // how to detect files mimetypes. (auto/internal/finfo/mime_content_type) 'mimeDetect' => 'auto', // mime.types file path (for mimeDetect==internal) 'mimefile' => '', // Static extension/MIME of general server side scripts to security issues 'staticMineMap' => array( 'php:' => 'text/x-php', 'pht:' => 'text/x-php', 'php3:' => 'text/x-php', 'php4:' => 'text/x-php', 'php5:' => 'text/x-php', 'php7:' => 'text/x-php', 'phtml:' => 'text/x-php', 'cgi:' => 'text/x-httpd-cgi', 'pl:' => 'text/x-perl', 'asp:' => 'text/x-asap', 'aspx:' => 'text/x-asap', 'py:' => 'text/x-python', 'rb:' => 'text/x-ruby', 'jsp:' => 'text/x-jsp' ), // 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', 'css:text/plain' => 'text/css', 'csv:text/plain' => 'text/csv', 'java:text/x-c' => 'text/x-java-source', 'json:text/plain' => 'application/json', 'sql:text/plain' => 'text/x-sql', 'rtf:text/rtf' => 'application/rtf', 'rtfd:text/rtfd' => 'application/rtfd', 'ico:image/vnd.microsoft.icon' => 'image/x-icon', 'svg:text/plain' => 'image/svg+xml', 'pxd:application/octet-stream' => 'image/x-pixlr-data', 'dng:image/tiff' => 'image/x-adobe-dng', 'sketch:application/zip' => 'image/x-sketch', 'sketch:application/octet-stream' => 'image/x-sketch', 'xcf:application/octet-stream' => 'image/x-xcf', 'amr:application/octet-stream' => 'audio/amr', 'm4a:video/mp4' => 'audio/mp4', 'oga:application/ogg' => 'audio/ogg', 'ogv:application/ogg' => 'video/ogg', 'zip:application/x-zip' => 'application/zip', 'm3u8:text/plain' => 'application/x-mpegURL', 'mpd:text/plain' => 'application/dash+xml', 'mpd:application/xml' => 'application/dash+xml', ':application/x-dosexec' => 'application/x-executable', 'doc:application/vnd.ms-office' => 'application/msword', 'xls:application/vnd.ms-office' => 'application/vnd.ms-excel', 'ppt:application/vnd.ms-office' => 'application/vnd.ms-powerpoint', 'yml:text/plain' => 'text/x-yaml', 'ai:application/pdf' => 'application/postscript', 'cgm:text/plain' => 'image/cgm', 'dxf:text/plain' => 'image/vnd.dxf', 'dds:application/octet-stream' => 'image/vnd-ms.dds', 'hpgl:text/plain' => 'application/vnd.hp-hpgl', 'igs:text/plain' => 'model/iges', 'iges:text/plain' => 'model/iges', 'plt:application/octet-stream' => 'application/plt', 'plt:text/plain' => 'application/plt', 'sat:text/plain' => 'application/sat', 'step:text/plain' => 'application/step', 'stp:text/plain' => 'application/step' ), // An option to add MimeMap to the `mimeMap` option // Array '[ext]:[detected mime type]' => '[normalized mime]' 'additionalMimeMap' => array(), // MIME-Type of filetype detected as unknown 'mimeTypeUnknown' => 'application/octet-stream', // MIME regex of send HTTP header "Content-Disposition: inline" or allow preview in quicklook // '.' is allow inline of all of MIME types // '$^' is not allow inline of all of MIME types 'dispInlineRegex' => '^(?:(?:video\|audio)\|image/(?!.+\+xml)\|application/(?:ogg\|x-mpegURL\|dash\+xml)\|(?:text/plain\|application/pdf)$)', // temporary content URL's base path 'tmpLinkPath' => '', // temporary content URL's base URL 'tmpLinkUrl' => '', // directory for thumbnails 'tmbPath' => '.tmb', // mode to create thumbnails dir 'tmbPathMode' => 0777, // thumbnails dir URL. Set it if store thumbnails outside root directory 'tmbURL' => '', // thumbnails size (px) 'tmbSize' => 48, // thumbnails crop (true - crop, false - scale image to fit thumbnail size) 'tmbCrop' => true, // thumbnail URL require custom data as the GET query 'tmbReqCustomData' => false, // thumbnails background color (hex #rrggbb or 'transparent') 'tmbBgColor' => 'transparent', // image rotate fallback background color (hex #rrggbb) 'bgColorFb' => '#ffffff', // image manipulations library (imagick\|gd\|convert\|auto\|none, none - Does not check the image library at all.) 'imgLib' => 'auto', // Fallback self image to thumbnail (nothing imgLib) 'tmbFbSelf' => true, // Video to Image converters ['TYPE or MIME' => ['func' => function($file){ / Converts $file to Image / return true; }, 'maxlen' => (int)TransferLength]] 'imgConverter' => array(), // Max length of transfer to image converter 'tmbVideoConvLen' => 10000000, // Captre point seccond 'tmbVideoConvSec' => 6, // Life time (hour) for thumbnail garbage collection ("0" means no GC) 'tmbGcMaxlifeHour' => 0, // Percentage of garbage collection executed for thumbnail creation command ("1" means "1%") 'tmbGcPercentage' => 1, // Resource path of fallback icon images defailt: php/resouces 'resourcePath' => '', // Jpeg image saveing quality 'jpgQuality' => 100, // Save as progressive JPEG on image editing 'jpgProgressive' => true, // enable to get substitute image with command `dim` 'substituteImg' => true, // on paste file - if true - old file will be replaced with new one, if false new file get name - original_name-number.ext 'copyOverwrite' => true, // if true - join new and old directories content on paste 'copyJoin' => true, // on upload - if true - old file will be replaced with new one, if false new file get name - original_name-number.ext 'uploadOverwrite' => true, // mimetypes allowed to upload 'uploadAllow' => array(), // mimetypes not allowed to upload 'uploadDeny' => array(), // order to process uploadAllow and uploadDeny options 'uploadOrder' => array('deny', 'allow'), // maximum upload file size. NOTE - this is size for every uploaded files 'uploadMaxSize' => 0, // maximum number of chunked upload connection. `-1` to disable chunked upload 'uploadMaxConn' => 3, // maximum get file size. NOTE - Maximum value is 50% of PHP memory_limit 'getMaxSize' => 0, // files dates format 'dateFormat' => 'j M Y H:i', // files time format 'timeFormat' => 'H:i', // if true - every folder will be check for children folders, -1 - every folder will be check asynchronously, false - all folders will be marked as having subfolders 'checkSubfolders' => true, // true, false or -1 // allow to copy from this volume to other ones? 'copyFrom' => true, // allow to copy from other volumes to this one? 'copyTo' => true, // cmd duplicate suffix format e.g. '_%s_' to without spaces 'duplicateSuffix' => ' %s ', // unique name numbar format e.g. '(%d)' to (1), (2)... 'uniqueNumFormat' => '%d', // list of commands disabled on this root 'disabled' => array(), // enable file owner, group & mode info, `false` to inactivate "chmod" command. 'statOwner' => false, // allow exec chmod of read-only files 'allowChmodReadOnly' => false, // regexp or function name to validate new file name 'acceptedName' => '/^[^\.]./', // Notice: overwritten it in some volume drivers contractor // regexp or function name to validate new directory name 'acceptedDirname' => '', // used `acceptedName` if empty value // function/class method to control files permissions 'accessControl' => null, // some data required by access control 'accessControlData' => null, // root stat that return without asking the system when mounted and not the current volume. Query to the system with false. array\|false 'rapidRootStat' => array( 'read' => true, 'write' => true, 'locked' => false, 'hidden' => false, 'size' => 0, // Unknown 'ts' => 0, // Unknown 'dirs' => -1, // Check on demand for subdirectories 'mime' => 'directory' ), // default permissions. 'defaults' => array( 'read' => true, 'write' => true, 'locked' => false, 'hidden' => false ), // files attributes 'attributes' => array(), // max allowed archive files size (0 - no limit) 'maxArcFilesSize' => '2G', // Allowed archive's mimetypes to create. Leave empty for all available types. 'archiveMimes' => array(), // Manual config for archivers. See example below. Leave empty for auto detect 'archivers' => array(), // Use Archive function for remote volume 'useRemoteArchive' => false, // plugin settings 'plugin' => array(), // Is support parent directory time stamp update on add\|remove\|rename item // Default `null` is auto detection that is LocalFileSystem, FTP or Dropbox are `true` 'syncChkAsTs' => null, // Long pooling sync checker function for syncChkAsTs is true // Calls with args (TARGET DIRCTORY PATH, STAND-BY(sec), OLD TIMESTAMP, VOLUME DRIVER INSTANCE, ELFINDER INSTANCE) // This function must return the following values. Changed: New Timestamp or Same: Old Timestamp or Error: false // Default `null` is try use elFinderVolumeLocalFileSystem::localFileSystemInotify() on LocalFileSystem driver // another driver use elFinder stat() checker 'syncCheckFunc' => null, // Long polling sync stand-by time (sec) 'plStandby' => 30, // Sleep time (sec) for elFinder stat() checker (syncChkAsTs is true) 'tsPlSleep' => 10, // Sleep time (sec) for elFinder ls() checker (syncChkAsTs is false) 'lsPlSleep' => 30, // Client side sync interval minimum (ms) // Default `null` is auto set to ('tsPlSleep' or 'lsPlSleep') * 1000 // `0` to disable auto sync 'syncMinMs' => null, // required to fix bug on macos // However, we recommend to use the Normalizer plugin instead this option 'utf8fix' => false, // й ё Й Ё Ø Å 'utf8patterns' => array("\u0438\u0306", "\u0435\u0308", "\u0418\u0306", "\u0415\u0308", "\u00d8A", "\u030a"), 'utf8replace' => array("\u0439", "\u0451", "\u0419", "\u0401", "\u00d8", "\u00c5"), // cache control HTTP headers for commands `file` and `get` 'cacheHeaders' => array( 'Cache-Control: max-age=3600', 'Expires:', 'Pragma:' ), // Header to use to accelerate sending local files to clients (e.g. 'X-Sendfile', 'X-Accel-Redirect') 'xsendfile' => '', // Root path to xsendfile target. Probably, this is required for 'X-Accel-Redirect' on Nginx. 'xsendfilePath' => '' )
`protected array`	`$defaults` Defaults permissions Defaults permissions	# `array( 'read' => true, 'write' => true, 'locked' => false, 'hidden' => false )`
`protected mixed`	`$attributes` Access control function/class Access control function/class	# `array()`
`protected mixed`	`$access` Access control function/class Access control function/class	# `null`
`protected array`	`$uploadAllow` Mime types allowed to upload Mime types allowed to upload	# `array()`
`protected array`	`$uploadDeny` Mime types denied to upload Mime types denied to upload	# `array()`
`protected array`	`$uploadOrder` Order to validate uploadAllow and uploadDeny Order to validate uploadAllow and uploadDeny	# `array()`
`protected integer\|string`	`$uploadMaxSize` Maximum allowed upload file size. Set as number or string with unit - "10M", "500K", "1G" Maximum allowed upload file size. Set as number or string with unit - "10M", "500K", "1G"	# `0`
`protected string`	`$uploadOverwrite` Run time setting of overwrite items on upload Run time setting of overwrite items on upload	# `true`
`protected integer\|string`	`$getMaxSize` Maximum allowed get file size. Set as number or string with unit - "10M", "500K", "1G" Maximum allowed get file size. Set as number or string with unit - "10M", "500K", "1G"	# `-1`
`protected string`	`$mimeDetect` Mimetype detect method Mimetype detect method	# `'auto'`
`protected resource`	`$finfo` Finfo resource for mimeDetect == 'finfo' Finfo resource for mimeDetect == 'finfo'	# `null`
`protected array`	`$disabled` List of disabled client's commands List of disabled client's commands	# `array()`
`protected static array`	`$mimetypes` overwrite extensions/mimetypes to mime.types overwrite extensions/mimetypes to mime.types	# array( // applications 'exe' => 'application/x-executable', 'jar' => 'application/x-jar', // archives 'gz' => 'application/x-gzip', 'tgz' => 'application/x-gzip', 'tbz' => 'application/x-bzip2', 'rar' => 'application/x-rar', // texts 'php' => 'text/x-php', 'js' => 'text/javascript', 'rtfd' => 'application/rtfd', 'py' => 'text/x-python', 'rb' => 'text/x-ruby', 'sh' => 'text/x-shellscript', 'pl' => 'text/x-perl', 'xml' => 'text/xml', 'c' => 'text/x-csrc', 'h' => 'text/x-chdr', 'cpp' => 'text/x-c++src', 'hh' => 'text/x-c++hdr', 'md' => 'text/x-markdown', 'markdown' => 'text/x-markdown', 'yml' => 'text/x-yaml', // images 'bmp' => 'image/x-ms-bmp', 'tga' => 'image/x-targa', 'xbm' => 'image/xbm', 'pxm' => 'image/pxm', //audio 'wav' => 'audio/wav', // video 'dv' => 'video/x-dv', 'wm' => 'video/x-ms-wmv', 'ogm' => 'video/ogg', 'm2ts' => 'video/MP2T', 'mts' => 'video/MP2T', 'ts' => 'video/MP2T', 'm3u8' => 'application/x-mpegURL', 'mpd' => 'application/dash+xml' )
`protected string`	`$separator` Directory separator - required by client Directory separator - required by client	# `DIRECTORY_SEPARATOR`
`protected string`	`$separatorForHash` Directory separator for decode/encode hash Directory separator for decode/encode hash	# `''`
`protected string`	`$systemRoot` System Root path (Unix like: '/', Windows: '\', 'C:\' or 'D:\'...) System Root path (Unix like: '/', Windows: '\', 'C:\' or 'D:\'...)	# `DIRECTORY_SEPARATOR`
`protected array`	`$onlyMimes` Mimetypes allowed to display Mimetypes allowed to display	# `array()`
`protected array`	`$removed` Store files moved or overwrited files info Store files moved or overwrited files info	# `array()`
`protected array`	`$added` Store files added files info Store files added files info	# `array()`
`protected array`	`$cache` Cache storage Cache storage	# `array()`
`protected array`	`$dirsCache` Cache by folders Cache by folders	# `array()`
`protected array`	`$subdirsCache` You should use `$this->sessionCache['subdirs']` instead You should use `$this->sessionCache['subdirs']` instead Deprecated	# `array()`
`protected array`	`$sessionCache` This volume session cache This volume session cache	#
`protected array`	`$sessionCaching` Session caching item list Session caching item list	# `array('rootstat' => true, 'subdirs' => true)`
`protected elFinderSessionInterface`	`$session` elFinder session wrapper object elFinder session wrapper object	#
`protected integer`	`$searchStart` Search start time Search start time	#
`protected array`	`$doSearchCurrentQuery` Current query word on doSearch Current query word on doSearch	# `array()`
`protected boolean`	`$rootModified` Is root modified (for clear root stat cache) Is root modified (for clear root stat cache)	# `false`
`protected string`	`$disabledGetUrl` Is disable of command `url` Is disable of command `url`	# `false`
`protected string`	`$nameValidator` Accepted filename validator Accepted filename validator	#
`protected string`	`$dirnameValidator` Accepted dirname validator Accepted dirname validator	#
`protected boolean`	`$needOnline` This request require online state This request require online state	#

Classes

Interfaces

Exceptions

Functions

Class elFinderVolumeDriver

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Author

Throws

Author

Deprecated

Returns

Author

Returns

Author

Parameters

Returns

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Parameters

Returns

Throws

Author

Author

Returns

Author

Parameters

Returns

Author

Returns

Author

Parameters

Returns

Author

Parameters

Author

Returns

Author

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Returns

Author

Returns

Author

Parameters

Returns

Author

Parameters