PHP Class elFinderVolumeLocalFileSystem

Author: Dmitry (dio) Levashov
Author: Troex Nevelin
Inheritance: extends elFinderVolumeDriver
Show file Open project: studio-42/elfinder Class Usage Examples

Protected Properties

Property Type Description
$archiveSize integer Required to count total archive files size
$driverId string Driver id Must be started from letter and contains [a-z0-9] Used as part of volume id

Public Methods

Method Description
__construct ( ) Constructor Extend options with required fields
localFileSystemInotify ( string $path, integer $standby, number $compare ) : number | boolean 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
localFileSystemSearchIteratorFilter ( $file, $key, $iterator ) ****************** Original local functions ************************

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 chmod availability
_copy ( string $source, string $targetDir, string $name ) : boolean Copy file into another file
_dimensions ( string $path, string $mime ) : string Return object width and height Usualy used for images, but can be realize for video etc.
_dirname ( string $path ) : string Return parent directory path
_extract ( string $path, array $arc ) : true 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
_findSymlinks ( string $path ) : boolean Recursive symlinks search
_fopen ( string $path, string $mode = 'rb' ) : false | resource 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 retur 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, this works the same as os.path.normpath() in Python
_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
configure ( ) : void Configure after successfull mount.
delTree ( string $localpath ) : boolean Delete dirctory trees
doSearch ( string $path, string $q, array $mimes ) : array Recursive files search
getOwnerStat ( integer $uid, integer $gid ) : array Get stat owner, group and isowner by uid and gid Sub-fuction of _stat() and _scandir()
getWorkFile ( string $path ) : string File path of local server side work file path
init ( ) : boolean Prepare driver before mount volume.
readlink ( string $path ) : string Return symlink target file

Method Details

__construct() public method

Constructor Extend options with required fields
Author: Dmitry (dio) Levashov
public __construct ( )

_abspath() protected method

Convert path related to root dir into real path
Author: Dmitry (dio) Levashov
protected _abspath ( string $path ) : string
$path string file path
return string

_archive() protected method

Create archive and return its path
Author: Dmitry (dio) Levashov,
Author: Alexey Sukhotin
protected _archive ( string $dir, array $files, string $name, array $arc ) : string | boolean
$dir string target dir
$files array files names list
$name string archive name
$arc array archiver options
return string | boolean

_basename() protected method

Return file name
Author: Dmitry (dio) Levashov
protected _basename ( string $path ) : string
$path string file path
return string

_checkArchivers() protected method

Detect available archivers
protected _checkArchivers ( ) : void
return void

_chmod() protected method

chmod availability
protected _chmod ( string $path, string $mode ) : boolean
$path string
$mode string
return boolean

_copy() protected method

Copy file into another file
Author: Dmitry (dio) Levashov
protected _copy ( string $source, string $targetDir, string $name ) : boolean
$source string source file path
$targetDir string target directory path
$name string new file name
return boolean

_dimensions() protected method

..
Author: Dmitry (dio) Levashov
protected _dimensions ( string $path, string $mime ) : string
$path string file path
$mime string file mime type
return string

_dirname() protected method

Return parent directory path
Author: Dmitry (dio) Levashov
protected _dirname ( string $path ) : string
$path string file path
return string

_extract() protected method

Extract files from archive
Author: Dmitry (dio) Levashov,
Author: Alexey Sukhotin
protected _extract ( string $path, array $arc ) : true
$path string archive path
$arc array archiver command and arguments (same as in $this->archivers)
return true

_fclose() protected method

Close opened file
Author: Dmitry (dio) Levashov
protected _fclose ( resource $fp, string $path = '' ) : boolean
$fp resource file pointer
$path string
return boolean

_filePutContents() protected method

Write a string to a file
Author: Dmitry (dio) Levashov
protected _filePutContents ( string $path, string $content ) : boolean
$path string file path
$content string new file content
return boolean

_fopen() protected method

Open file and return file pointer
Author: Dmitry (dio) Levashov
protected _fopen ( string $path, string $mode = 'rb' ) : false | resource
$path string file path
$mode string
return false | resource

_getContents() protected method

Get file contents
Author: Dmitry (dio) Levashov
protected _getContents ( string $path ) : string | false
$path string file path
return string | false

_inpath() protected method

Return true if $path is children of $parent
Author: Dmitry (dio) Levashov
protected _inpath ( string $path, string $parent ) : boolean
$path string path to check
$parent string parent path
return boolean

_joinPath() protected method

Join dir name and file name and retur full path
Author: Dmitry (dio) Levashov
protected _joinPath ( string $dir, string $name ) : string
$dir string
$name string
return string

_mkdir() protected method

Create dir and return created dir path or false on failed
Author: Dmitry (dio) Levashov
protected _mkdir ( string $path, string $name ) : string | boolean
$path string parent dir path
$name string new directory name
return string | boolean

_mkfile() protected method

Create file and return it's path or false on failed
Author: Dmitry (dio) Levashov
protected _mkfile ( string $path, string $name ) : string | boolean
$path string parent dir path
$name string new file name
return string | boolean

_move() protected method

Return new file path or false.
Author: Dmitry (dio) Levashov
protected _move ( string $source, $targetDir, string $name ) : boolean | string
$source string source file path
$targetDir
$name string file name
return boolean | string

_normpath() protected method

Return normalized path, this works the same as os.path.normpath() in Python
Author: Troex Nevelin
protected _normpath ( string $path ) : string
$path string path
return string

_path() protected method

Return fake path started from root dir
Author: Dmitry (dio) Levashov
protected _path ( string $path ) : string
$path string file path
return string

_relpath() protected method

Return file path related to root dir
Author: Dmitry (dio) Levashov
protected _relpath ( string $path ) : string
$path string file path
return string

_rmdir() protected method

Remove dir
Author: Dmitry (dio) Levashov
protected _rmdir ( string $path ) : boolean
$path string dir path
return boolean

_save() protected method

Return new file path or false on error.
Author: Dmitry (dio) Levashov
protected _save ( resource $fp, string $dir, string $name, array $stat ) : boolean | string
$fp resource file pointer
$dir string target dir path
$name string file name
$stat array file stat (required by some virtual fs)
return boolean | string

_scandir() protected method

Return files list in directory.
Author: Dmitry (dio) Levashov
protected _scandir ( string $path ) : array
$path string dir path
return array

_stat() protected method

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.
Author: Dmitry (dio) Levashov
protected _stat ( string $path ) : array | false
$path string file path
return array | false

_subdirs() protected method

Return true if path is dir and has at least one childs directory
Author: Dmitry (dio) Levashov
protected _subdirs ( string $path ) : boolean
$path string dir path
return boolean

configure() protected method

Configure after successfull mount.
Author: Dmitry (dio) Levashov
protected configure ( ) : void
return void

delTree() protected method

Delete dirctory trees
Author: Naoki Sawada
protected delTree ( string $localpath ) : boolean
$localpath string path need convert encoding to server encoding
return boolean

doSearch() protected method

Recursive files search
Author: Dmitry (dio) Levashov
Author: Naoki Sawada
protected doSearch ( string $path, string $q, array $mimes ) : array
$path string dir path
$q string search string
$mimes array
return array

getOwnerStat() protected method

Get stat owner, group and isowner by uid and gid Sub-fuction of _stat() and _scandir()
protected getOwnerStat ( integer $uid, integer $gid ) : array
$uid integer
$gid integer
return array stat

getWorkFile() protected method

File path of local server side work file path
Author: Naoki Sawada
protected getWorkFile ( string $path ) : string
$path string
return string

init() protected method

Return true if volume is ready.
protected init ( ) : boolean
return boolean

localFileSystemInotify() public method

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
public localFileSystemInotify ( string $path, integer $standby, number $compare ) : number | boolean
$path string
$standby integer
$compare number
return number | boolean

localFileSystemSearchIteratorFilter() public method

****************** Original local functions ************************
public localFileSystemSearchIteratorFilter ( $file, $key, $iterator )
$file
$key
$iterator

Property Details

$archiveSize protected property

Required to count total archive files size
protected int $archiveSize
return integer

$driverId protected property

Driver id Must be started from letter and contains [a-z0-9] Used as part of volume id
protected string $driverId
return string