PHP Класс elFinder\elFinder

Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$mountErrors array Errors from not mounted volumes
$netDrivers
$volumesCnt integer Mounted volumes count Required to create unique volume id

Защищенные свойства (Protected)

Свойство Тип Описание
$commands array Commands and required arguments list
$debug string Send debug to client?
$default elFinderStorageDriver Default root (storage)
$listeners array Commands listeners
$loaded boolean Is elFinder init correctly?
$time string script work time for debug
$uploadDebug string undocumented class variable
$version string API version number
$volumes array Storages (root dirs)

Открытые методы

Метод Описание
__construct ( $opts ) : void Constructor
bind ( $cmd, $handler ) : elFinder Add handler to elFinder command
commandArgsList ( $cmd ) : array Return command required arguments info
commandExists ( $cmd ) : boolean Return true if command exists
error ( ) : array Normalize error messages
exec ( string $cmd, array $args ) : array Exec command and return result
loaded ( ) : boolean Return true if fm init correctly
realpath ( string $hash ) : string Return file real path
unbind ( $cmd, $handler ) : elFinder Remove event (command exec) handler
version ( ) : string Return version (api) number

Защищенные методы

Метод Описание
archive ( array $args ) : array Create archive
dim ( array $args ) : array Return image dimmensions
duplicate ( array $args ) : array Duplicate file - create copy with "copy %d" suffix
extract ( array $args ) : array Extract files from archive
file ( $args ) : array Required to output file in browser when volume URL is not set Return array contains opened file pointer, root itself and required headers
filter ( array $files ) : array Remove from files list hidden files and files with required mime types
get ( array $args ) : array Return file content
getNetVolumes ( ) : array Return network volumes config.
hashes ( array $files ) : array Return fils hashes list
info ( array $args ) : array Return file info (used by client "places" ui)
ls ( $args ) : array Return dir files names list
mkdir ( $args ) : array Create directory
mkfile ( $args ) : array Create empty file
netmount ( $args )
open ( $args ) : array "Open" directory Return array with following elements - cwd - opened dir info - files - opened dir content [and dirs tree if $args[tree]] - api - api version (if $args[init]) - uplMaxSize - if $args[init] - error - on failed
parents ( $args ) : array Return parents dir for required directory
paste ( $args ) : array Copy/move files into new destination
put ( $args ) : array Save content into text file
rename ( array $args ) : array Rename file
resize ( $args ) : array Resize image
rm ( $args ) : array Remove dirs/files
saveNetVolumes ( array $volumes ) : void Save network volumes config.
search ( array $args ) : array Search files
size ( $args ) : array Count total files size
tmb ( $args ) : array Return new created thumbnails list
toArray ( array $data ) : array Return files info array
tree ( $args ) : array Return subdirs for required directory
upload ( $args ) : array Save uploaded files
utime ( )
volume ( $hash ) : elFinderStorageDriver Return root - file's owner

Описание методов

__construct() публичный Метод

Constructor
Автор: Dmitry (dio) Levashov
public __construct ( $opts ) : void
Результат void

archive() защищенный Метод

Create archive
Автор: Dmitry (dio) Levashov,
Автор: Alexey Sukhotin
protected archive ( array $args ) : array
$args array command arguments
Результат array

bind() публичный Метод

Add handler to elFinder command
Автор: Dmitry (dio) Levashov
public bind ( $cmd, $handler ) : elFinder
Результат elFinder

commandArgsList() публичный Метод

Return command required arguments info
Автор: Dmitry (dio) Levashov
public commandArgsList ( $cmd ) : array
Результат array

commandExists() публичный Метод

Return true if command exists
Автор: Dmitry (dio) Levashov
public commandExists ( $cmd ) : boolean
Результат boolean

dim() защищенный Метод

Return image dimmensions
Автор: Dmitry (dio) Levashov
protected dim ( array $args ) : array
$args array command arguments
Результат array

duplicate() защищенный Метод

Duplicate file - create copy with "copy %d" suffix
Автор: Dmitry (dio) Levashov
protected duplicate ( array $args ) : array
$args array command arguments
Результат array

error() публичный Метод

Normalize error messages
Автор: Dmitry (dio) Levashov
public error ( ) : array
Результат array

exec() публичный Метод

Exec command and return result
Автор: Dmitry (dio) Levashov
public exec ( string $cmd, array $args ) : array
$cmd string command name
$args array command arguments
Результат array

extract() защищенный Метод

Extract files from archive
Автор: Dmitry (dio) Levashov,
Автор: Alexey Sukhotin
protected extract ( array $args ) : array
$args array command arguments
Результат array

file() защищенный Метод

Required to output file in browser when volume URL is not set Return array contains opened file pointer, root itself and required headers
Автор: Dmitry (dio) Levashov
protected file ( $args ) : array
Результат array

filter() защищенный Метод

Remove from files list hidden files and files with required mime types
Автор: Dmitry (dio) Levashov
protected filter ( array $files ) : array
$files array files info
Результат array

get() защищенный Метод

Return file content
Автор: Dmitry (dio) Levashov
protected get ( array $args ) : array
$args array command arguments
Результат array

getNetVolumes() защищенный Метод

Return network volumes config.
Автор: Dmitry (dio) Levashov
protected getNetVolumes ( ) : array
Результат array

hashes() защищенный Метод

Return fils hashes list
Автор: Dmitry (dio) Levashov
protected hashes ( array $files ) : array
$files array files info
Результат array

info() защищенный Метод

Return file info (used by client "places" ui)
Автор: Dmitry Levashov
protected info ( array $args ) : array
$args array command arguments
Результат array

loaded() публичный Метод

Return true if fm init correctly
Автор: Dmitry (dio) Levashov
public loaded ( ) : boolean
Результат boolean

ls() защищенный Метод

Return dir files names list
Автор: Dmitry (dio) Levashov
protected ls ( $args ) : array
Результат array

mkdir() защищенный Метод

Create directory
Автор: Dmitry (dio) Levashov
protected mkdir ( $args ) : array
Результат array

mkfile() защищенный Метод

Create empty file
Автор: Dmitry (dio) Levashov
protected mkfile ( $args ) : array
Результат array

netmount() защищенный Метод

protected netmount ( $args )

open() защищенный Метод

"Open" directory Return array with following elements - cwd - opened dir info - files - opened dir content [and dirs tree if $args[tree]] - api - api version (if $args[init]) - uplMaxSize - if $args[init] - error - on failed
Автор: Dmitry (dio) Levashov
protected open ( $args ) : array
Результат array

parents() защищенный Метод

Return parents dir for required directory
Автор: Dmitry (dio) Levashov
protected parents ( $args ) : array
Результат array

paste() защищенный Метод

Copy/move files into new destination
Автор: Dmitry (dio) Levashov
protected paste ( $args ) : array
Результат array

put() защищенный Метод

Save content into text file
Автор: Dmitry (dio) Levashov
protected put ( $args ) : array
Результат array

realpath() публичный Метод

Return file real path
Автор: Dmitry (dio) Levashov
public realpath ( string $hash ) : string
$hash string file hash
Результат string

rename() защищенный Метод

Rename file
Автор: Dmitry (dio) Levashov
protected rename ( array $args ) : array
$args array
Результат array

resize() защищенный Метод

Resize image
Автор: Dmitry (dio) Levashov
Автор: Alexey Sukhotin
protected resize ( $args ) : array
Результат array

rm() защищенный Метод

Remove dirs/files
Автор: Dmitry (dio) Levashov
protected rm ( $args ) : array
Результат array

saveNetVolumes() защищенный Метод

Save network volumes config.
Автор: Dmitry (dio) Levashov
protected saveNetVolumes ( array $volumes ) : void
$volumes array volumes config
Результат void

size() защищенный Метод

Count total files size
Автор: Dmitry (dio) Levashov
protected size ( $args ) : array
Результат array

tmb() защищенный Метод

Return new created thumbnails list
Автор: Dmitry (dio) Levashov
protected tmb ( $args ) : array
Результат array

toArray() защищенный Метод

Return files info array
Автор: Dmitry (dio) Levashov
protected toArray ( array $data ) : array
$data array one file info or files info
Результат array

tree() защищенный Метод

Return subdirs for required directory
Автор: Dmitry (dio) Levashov
protected tree ( $args ) : array
Результат array

unbind() публичный Метод

Remove event (command exec) handler
Автор: Dmitry (dio) Levashov
public unbind ( $cmd, $handler ) : elFinder
Результат elFinder

upload() защищенный Метод

Save uploaded files
Автор: Dmitry (dio) Levashov
protected upload ( $args ) : array
Результат array

utime() защищенный Метод

protected utime ( )

version() публичный Метод

Return version (api) number
Автор: Dmitry (dio) Levashov
public version ( ) : string
Результат string

volume() защищенный Метод

Return root - file's owner
Автор: Dmitry (dio) Levashov
protected volume ( $hash ) : elFinderStorageDriver
Результат elFinderStorageDriver

Описание свойств

$commands защищенное свойство

Commands and required arguments list
protected array $commands
Результат array

$debug защищенное свойство

Send debug to client?
protected string $debug
Результат string

$default защищенное свойство

Default root (storage)
protected elFinderStorageDriver $default
Результат elFinderStorageDriver

$listeners защищенное свойство

Commands listeners
protected array $listeners
Результат array

$loaded защищенное свойство

Is elFinder init correctly?
protected bool $loaded
Результат boolean

$mountErrors публичное свойство

Errors from not mounted volumes
public array $mountErrors
Результат array

$netDrivers публичное статическое свойство

public static $netDrivers

$time защищенное свойство

script work time for debug
protected string $time
Результат string

$uploadDebug защищенное свойство

undocumented class variable
protected string $uploadDebug
Результат string

$version защищенное свойство

API version number
protected string $version
Результат string

$volumes защищенное свойство

Storages (root dirs)
protected array $volumes
Результат array

$volumesCnt публичное статическое свойство

Mounted volumes count Required to create unique volume id
public static int $volumesCnt
Результат integer