Constructor Extend options with required fields
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Configure after successfull mount.
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::configure()
- Configure after successfull mount.
string readlink(
string
$path
)
|
|
Return symlink target file
Parameters:
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
string _abspath(
string
$path
)
|
|
Convert path related to root dir into real path
Parameters:
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_abspath()
- Convert path related to root dir into real path
string|bool _archive(
string
$dir, array
$files, string
$name, array
$arc
)
|
|
Create archive and return its path
Parameters:
string |
$dir: |
target dir |
array |
$files: |
files names list |
string |
$name: |
archive name |
array |
$arc: |
archiver options |
API Tags:
Information Tags:
Author: | Alexey Sukhotin |
Author: | Dmitry (dio) Levashov, |
Redefinition of:
- elFinderVolumeDriver::_archive()
- Create archive and return its path
string _basename(
string
$path
)
|
|
Return file name
Parameters:
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_basename()
- Return file name
bool _copy(
string
$source, string
$targetDir, string
$name
)
|
|
Copy file into another file
Parameters:
string |
$source: |
source file path |
string |
$targetDir: |
target directory path |
string |
$name: |
new file name |
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_copy()
- Copy file into another file (only inside one volume)
string _dimensions(
string
$path, string
$mime
)
|
|
Return object width and height Usualy used for images, but can be realize for video etc...
Parameters:
string |
$path: |
file path |
string |
$mime: |
file mime type |
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_dimensions()
- Return object width and height Ususaly used for images, but can be realize for video etc...
string _dirname(
string
$path
)
|
|
Return parent directory path
Parameters:
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_dirname()
- Return parent directory path
true _extract(
string
$path, array
$arc
)
|
|
Extract files from archive
Parameters:
string |
$path: |
archive path |
array |
$arc: |
archiver command and arguments (same as in $this->archivers) |
API Tags:
Information Tags:
Author: | Alexey Sukhotin |
Author: | Dmitry (dio) Levashov, |
Redefinition of:
- elFinderVolumeDriver::_extract()
- Extract files from archive
bool _fclose(
resource
$fp, [
$path = '']
)
|
|
Close opened file
Parameters:
resource |
$fp: |
file pointer |
|
$path: |
|
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_fclose()
- Close opened file
bool _filePutContents(
string
$path, string
$content
)
|
|
Write a string to a file
Parameters:
string |
$path: |
file path |
string |
$content: |
new file content |
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_filePutContents()
- Write a string to a file
bool _findSymlinks(
string
$path
)
|
|
Recursive symlinks search
Parameters:
string |
$path: |
file/dir path |
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
resource|false _fopen(
string
$path, [
$mode = 'rb'], bool
$write
)
|
|
Open file and return file pointer
Parameters:
string |
$path: |
file path |
bool |
$write: |
open file for writing |
|
$mode: |
|
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_fopen()
- Open file and return file pointer
string|false _getContents(
string
$path
)
|
|
Get file contents
Parameters:
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_getContents()
- Get file contents
bool _inpath(
string
$path, string
$parent
)
|
|
Return true if $path is children of $parent
Parameters:
string |
$path: |
path to check |
string |
$parent: |
parent path |
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_inpath()
- Return true if $path is children of $parent
string _joinPath(
string
$dir, string
$name
)
|
|
Join dir name and file name and retur full path
Parameters:
string |
$dir: |
|
string |
$name: |
|
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_joinPath()
- Join dir name and file name and return full path.
string|bool _mkdir(
string
$path, string
$name
)
|
|
Create dir and return created dir path or false on failed
Parameters:
string |
$path: |
parent dir path |
string |
$name: |
new directory name |
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_mkdir()
- Create dir and return created dir path or false on failed
string|bool _mkfile(
string
$path, string
$name
)
|
|
Create file and return it's path or false on failed
Parameters:
string |
$path: |
parent dir path |
string |
$name: |
new file name |
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_mkfile()
- Create file and return it's path or false on failed
string|bool _move(
string
$source,
$targetDir, string
$name, string
$target
)
|
|
Move file into another parent dir.
Return new file path or false.
Parameters:
string |
$source: |
source file path |
string |
$target: |
target dir path |
string |
$name: |
file name |
|
$targetDir: |
|
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_move()
- Move file into another parent dir.
string _normpath(
string
$path
)
|
|
Return normalized path, this works the same as os.path.normpath() in Python
Parameters:
API Tags:
Information Tags:
Redefinition of:
- elFinderVolumeDriver::_normpath()
- Return normalized path
string _path(
string
$path
)
|
|
Return fake path started from root dir
Parameters:
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_path()
- Return fake path started from root dir.
string _relpath(
string
$path
)
|
|
Return file path related to root dir
Parameters:
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_relpath()
- Return file path related to root dir
bool _rmdir(
string
$path
)
|
|
Remove dir
Parameters:
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_rmdir()
- Remove dir
bool|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.
Parameters:
resource |
$fp: |
file pointer |
string |
$dir: |
target dir path |
string |
$name: |
file name |
array |
$stat: |
file stat (required by some virtual fs) |
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_save()
- Create new file and write into it from file pointer.
array _scandir(
string
$path
)
|
|
Return files list in directory.
Parameters:
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_scandir()
- Return files list in directory
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.
Parameters:
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_stat()
- Return stat for given path.
bool _subdirs(
string
$path
)
|
|
Return true if path is dir and has at least one childs directory
Parameters:
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_subdirs()
- Return true if path is dir and has at least one childs directory
bool _symlink(
string
$source, string
$targetDir, string
$name
)
|
|
Create symlink
Parameters:
string |
$source: |
file to link to |
string |
$targetDir: |
folder to create link in |
string |
$name: |
symlink name |
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_symlink()
- Create symlink
bool _unlink(
string
$path
)
|
|
Remove file
Parameters:
API Tags:
Information Tags:
Author: | Dmitry (dio) Levashov |
Redefinition of:
- elFinderVolumeDriver::_unlink()
- Remove file
void _unpack(
string
$path, array
$arc
)
|
|
Unpack archive
Parameters:
string |
$path: |
archive path |
array |
$arc: |
archiver command and arguments (same as in $this->archivers) |
API Tags:
Information Tags:
Author: | Alexey Sukhotin |
Author: | Dmitry (dio) Levashov |