Class elFinderVolumeLocalFileSystem

elFinder driver for local filesystem.

elFinderVolumeLocalFileSystem

Direct known subclasses

Author: Dmitry (dio) Levashov
Author: Troex Nevelin
Located at zp-extensions/elFinder/php/elFinderVolumeLocalFileSystem.class.php

Methods summary
`public`	# `__construct( )` Constructor Extend options with required fields Constructor Extend options with required fields Author Dmitry (dio) Levashov
`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 Overrides `elFinderVolumeDriver::init()`
`protected`	# `configure( )` Configure after successfull mount. Configure after successfull mount. Throws `elFinderAbortException` Author Dmitry (dio) Levashov Overrides `elFinderVolumeDriver::configure()`
`public number\|boolean`	# `localFileSystemInotify( string $path, integer $standby, number $compare )` Long pooling sync checker This function require server command `inotifywait` If `inotifywait` need full path, Please add `define('ELFINER_INOTIFYWAIT_PATH', '/PATH_TO/inotifywait');` into connector.php Long pooling sync checker This function require server command `inotifywait` If `inotifywait` need full path, Please add `define('ELFINER_INOTIFYWAIT_PATH', '/PATH_TO/inotifywait');` into connector.php Parameters `$path` `$standby` `$compare` Returns number\|boolean Throws `elFinderAbortException`
`protected string`	# `_dirname( string $path )` Return parent directory path Return parent directory path Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`protected string`	# `_basename( string $path )` Return file name Return file name Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`protected string`	# `_joinPath( string $dir, string $name )` Join dir name and file name and retur full path Join dir name and file name and retur full path Parameters `$dir` `$name` Returns string Author Dmitry (dio) Levashov
`protected string`	# `_normpath( string $path )` Return normalized path, this works the same as os.path.normpath() in Python Return normalized path, this works the same as os.path.normpath() in Python Parameters `$path` path Returns string Author Troex Nevelin
`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
`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` file path Returns string Author Dmitry (dio) Levashov
`protected string`	# `_path( string $path )` Return fake path started from root dir Return fake path started from root dir Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`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
`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
`protected array`	# `getOwnerStat( integer $uid, integer $gid )` Get stat `owner`, `group` and `isowner` by `uid` and `gid` Sub-fuction of _stat() and _scandir() Get stat `owner`, `group` and `isowner` by `uid` and `gid` Sub-fuction of _stat() and _scandir() Parameters `$uid` `$gid` Returns array stat
`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
`protected string`	# `_dimensions( string $path, string $mime )` Return object width and height Usualy used for images, but can be realize for video etc... Return object width and height Usualy used for images, but can be realize for video etc... Parameters `$path` file path `$mime` file mime type Returns string Author Dmitry (dio) Levashov
`protected string`	# `readlink( string $path )` Return symlink target file Return symlink target file Parameters `$path` link path Returns string Author Dmitry (dio) Levashov
`protected array`	# `_scandir( string $path )` Return files list in directory. Return files list in directory. Parameters `$path` dir path Returns array Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected false\|resource`	# `_fopen( string $path, string $mode = 'rb' )` Open file and return file pointer Open file and return file pointer Parameters `$path` file path `$mode` Returns false\|resource Author Dmitry (dio) Levashov
`protected boolean`	# `_fclose( resource $fp, string $path = '' )` Close opened file Close opened file Parameters `$fp` file pointer `$path` Returns boolean Author Dmitry (dio) Levashov
`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
`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
`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
`protected boolean`	# `_copy( string $source, string $targetDir, string $name )` Copy file into another file Copy file into another file Parameters `$source` source file path `$targetDir` target directory path `$name` new file name Returns boolean Author Dmitry (dio) Levashov
`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
`protected boolean`	# `_unlink( string $path )` Remove file Remove file Parameters `$path` file path Returns boolean Author Dmitry (dio) Levashov
`protected boolean`	# `_rmdir( string $path )` Remove dir Remove dir Parameters `$path` dir path Returns boolean Author Dmitry (dio) Levashov
`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
`protected string\|false`	# `_getContents( string $path )` Get file contents Get file contents Parameters `$path` file path Returns string\|false Author Dmitry (dio) Levashov
`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
`protected`	# `_checkArchivers( )` Detect available archivers Detect available archivers Throws `elFinderAbortException`
`protected boolean`	# `_chmod( string $path, string $mode )` chmod availability chmod availability Parameters `$path` `$mode` Returns boolean
`protected boolean`	# `_findSymlinks( string $path )` Recursive symlinks search Recursive symlinks search Parameters `$path` file/dir path Returns boolean Throws Exception Author Dmitry (dio) Levashov
`protected array\|string\|boolean`	# `_extract( string $path, array $arc )` Extract files from archive Extract files from archive Parameters `$path` archive path `$arc` archiver command and arguments (same as in $this->archivers) Returns array\|string\|boolean Throws `elFinderAbortException` Author Dmitry (dio) Levashov, Alexey Sukhotin
`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 Throws `elFinderAbortException` Author Dmitry (dio) Levashov, Alexey Sukhotin
`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` Returns string Author Naoki Sawada Overrides `elFinderVolumeDriver::getWorkFile()`
`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 Overrides `elFinderVolumeDriver::delTree()`
`protected array\|boolean`	# `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\|boolean false Overrides `elFinderVolumeDriver::isNameExists()`
`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 Naoki Sawada Overrides `elFinderVolumeDriver::doSearch()`
`public`	# `localFileSystemSearchIteratorFilter( $file, $key, $iterator )`
`protected boolean`	# `localFileSystemSymlink( string $target, string $link )` Creates a symbolic link Creates a symbolic link Parameters `$target` The target `$link` The link Returns boolean ( result of symlink() )

Methods inherited from elFinderVolumeDriver
abspathCE(), addError(), added(), allowCreate(), allowPutMime(), archive(), attr(), basenameCE(), cacheDir(), canCreateTmb(), canResize(), checkExtractItems(), childsByAttr(), chmod(), clearSessionCache(), clearcache(), clearcaches(), clearstatcache(), close(), closest(), closestByAttr(), commandDisabled(), convEnc(), convEncIn(), convEncOut(), copy(), copyFrom(), copyFromAllowed(), countSize(), createTmb(), crypt(), debug(), decode(), defaultPath(), dimensions(), dir(), dirnameCE(), driverId(), duplicate(), encode(), error(), extract(), fcloseCE(), ffmpegToImg(), file(), fopenCE(), fstat(), gdImage(), gdImageBackground(), gdImageCreate(), getArchivers(), getContentUrl(), getContents(), getExtentionByMime(), getFullPath(), getHash(), getImageSize(), getItemsInHand(), getMimeTable(), getOption(), getOptionsPlugin(), getPath(), getRootPath(), getRootStatExtra(), getRootstatCachekey(), getScandir(), getSession(), getSubstituteImgLink(), getTempFile(), getTempLinkInfo(), getTempPath(), getUploadMaxSize(), getUploadTaget(), gettmb(), gettree(), id(), imageMagickConvertPrepare(), imageUtil(), imagickImage(), imgCrop(), imgResize(), imgRotate(), imgSquareFit(), inpathCE(), isMyReload(), isReadable(), isSameType(), isUploadableByName(), joinPathCE(), loadMimeTypes(), localFindSymlinks(), localMoveRecursive(), localRmdirRecursive(), localScandir(), ls(), makeArchive(), mimeAccepted(), mimeTypeNormalize(), mimetype(), mimetypeInternalDetect(), mkdir(), mkfile(), mount(), move(), nameAccepted(), normpathCE(), open(), options(), parents(), paste(), path(), procExec(), putContents(), realpath(), relpathCE(), remoteArchive(), remove(), removed(), rename(), resetRemoved(), resetResultStat(), resize(), rm(), rmTmb(), rmdirRecursive(), root(), saveCE(), saveSessionCache(), scandir(), scandirCE(), search(), searchMatchName(), sessionRestart(), setError(), setMimesFilter(), setNeedOnline(), setSession(), setUploadOverwrite(), size(), stat(), stripos(), subdirs(), subdirsCE(), symlinkCE(), tmb(), tmbname(), tmpfile(), tree(), umount(), uncrypt(), uniqueName(), unpackArchive(), updateCache(), updateSubdirsCache(), upload(), zipArchiveUnzip(), zipArchiveZip(), zipdl()

Magic methods inherited from elFinderVolumeDriver
`netmountPrepare(), postNetmount()`

Properties summary
`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	# `'l'`
`protected integer`	`$archiveSize` Required to count total archive files size Required to count total archive files size	# `0`
`protected boolean`	`$statOwner` Is checking stat owner Is checking stat owner	# `false`

Properties inherited from elFinderVolumeDriver
$ARGS, $URL, $access, $added, $archivers, $attributes, $cache, $cryptLib, $defaults, $dirnameValidator, $dirsCache, $disabled, $disabledGetUrl, $doSearchCurrentQuery, $encoding, $error, $extractToNewdir, $finfo, $getMaxSize, $id, $imgConverter, $imgLib, $maxArcFilesSize, $mimeDetect, $mimetypes, $mounted, $nameValidator, $needOnline, $netMountKey, $onlyMimes, $options, $removed, $root, $rootModified, $rootName, $searchStart, $separator, $separatorForHash, $session, $sessionCache, $sessionCaching, $startPath, $subdirsCache, $systemRoot, $tmbPath, $tmbPathWritable, $tmbSize, $tmbURL, $tmp, $tmpLinkPath, $tmpLinkUrl, $today, $treeDeep, $uploadAllow, $uploadDeny, $uploadMaxSize, $uploadOrder, $uploadOverwrite, $yesterday

Classes

Interfaces

Exceptions

Functions

Class elFinderVolumeLocalFileSystem

Direct known subclasses

Author

Returns

Overrides

Throws

Author

Overrides

Parameters

Returns

Throws

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Throws

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns