Methods summary
public
|
#
__construct( )
Constructor
Extend options with required fields
Constructor
Extend options with required fields
|
protected
string
|
#
_dirname( string $path )
Parameters
Returns
string
Inheritdoc
|
protected
string
|
#
_basename( string $path )
Return file name
Parameters
Returns
string
|
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
|
protected
string
|
#
_normpath( string $path )
Return normalized path
Parameters
Returns
string
|
protected
string
|
#
_relpath( string $path )
Return file path related to root dir
Return file path related to root dir
Parameters
Returns
string
|
protected
string
|
#
_abspath( string $path )
Convert path related to root dir into real path
Convert path related to root dir into real path
Parameters
Returns
string
|
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
Returns
string
|
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
|
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
Returns
array|false
|
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
Returns
boolean
|
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
|
protected
|
|
protected
array
|
#
_scandir( string $path )
Return files list in directory
Return files list in directory
Parameters
Returns
array
|
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
|
protected
boolean
|
#
_fclose( resource $fp, string $path = '' )
Close opened file
Parameters
- $fp
- file pointer
- $path
- file path
Returns
boolean
|
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
|
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
|
protected
boolean
|
#
_symlink( string $source, string $targetDir, string $name )
Create symlink
Parameters
- $source
- file to link to
- $targetDir
- folder to create link in
- $name
- symlink name
Returns
boolean
|
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
|
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
|
protected
boolean
|
#
_unlink( string $path )
Remove file
Parameters
Returns
boolean
|
protected
boolean
|
#
_rmdir( string $path )
Remove dir
Parameters
Returns
boolean
|
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
|
protected
string|false
|
#
_getContents( string $path )
Get file contents
Parameters
Returns
string|false
|
protected
boolean
|
#
_filePutContents( string $path, string $content )
Write a string to a file
Parameters
- $path
- file path
- $content
- new file content
Returns
boolean
|
protected
|
|
protected
boolean
|
#
_chmod( string $path, string $mode )
Change file mode (chmod)
Parameters
- $path
- file path
- $mode
- octal string such as '0755'
Returns
boolean
|
protected
|
|
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
|
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(),
configure(),
convEnc(),
convEncIn(),
convEncOut(),
copy(),
copyFrom(),
copyFromAllowed(),
countSize(),
createTmb(),
crypt(),
debug(),
decode(),
defaultPath(),
delTree(),
dimensions(),
dir(),
dirnameCE(),
doSearch(),
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(),
getWorkFile(),
gettmb(),
gettree(),
id(),
imageMagickConvertPrepare(),
imageUtil(),
imagickImage(),
imgCrop(),
imgResize(),
imgRotate(),
imgSquareFit(),
init(),
inpathCE(),
isMyReload(),
isNameExists(),
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()
|
elFinderVolumeGroup