elFinderVolumeExponent
extends elFinderVolumeLocalFileSystem
in package
This is the class elFinderVolumeExponent elFinder volume driver for the Exponent CMS expFile filesystem.
Tags
Table of Contents
- alt() : mixed
- Get/Set expFile Alt
- debug() : array<string|int, mixed>
- Return debug info for client
- owner() : string
- Get expFile Owner
- paste() : array<string|int, mixed>|false
- Paste files
- resize() : array<string|int, mixed>|false
- Resize image
- shared() : mixed
- Get/Set expFile shared status
- title() : mixed
- Get/Set expFile Title
- upload() : mixed
- _copy() : bool
- Copy file into another file
- _get_expFile() : expFile
- Return the expFile for the given path or create new expFile
- _mkfile() : string|bool
- Create file and return it's path or false on failed
- _move_expFile() : array<string|int, mixed>|int
- Move an expFile to the given path
- _remove_expFile() : mixed
- Delete an expFile record based on the given path
- _save() : bool|string
- Create new file and write into it from file pointer.
- _unlink() : bool
- Remove file
- scan_folder() : mixed
- Recursive method to move expFile record directories
- stat() : array<string|int, mixed>
- Return fileinfo, also check if in expFiles table and add if missing
Methods
alt()
Get/Set expFile Alt
public
alt(string $target[, string $newalt = null ]) : mixed
Parameters
- $target : string
- $newalt : string = null
Return values
mixed —debug()
Return debug info for client
public
debug() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —owner()
Get expFile Owner
public
owner(string $target[, string $newowner = null ]) : string
Parameters
- $target : string
- $newowner : string = null
Return values
string —paste()
Paste files
public
paste(object $volume, $src, string $dst[, bool $rmSrc = false ][, array<string|int, mixed> $hashes = array() ]) : array<string|int, mixed>|false
Parameters
- $volume : object
-
source volume
- $src :
- $dst : string
-
destination dir hash
- $rmSrc : bool = false
-
remove source after copy?
- $hashes : array<string|int, mixed> = array()
Tags
Return values
array<string|int, mixed>|false —resize()
Resize image
public
resize(string $hash, int $width, int $height, int $x, int $y[, string $mode = 'resize' ][, string $bg = '' ], int $degree[, int $jpgQuality = null ]) : array<string|int, mixed>|false
Parameters
- $hash : string
-
image file
- $width : int
-
new width
- $height : int
-
new height
- $x : int
-
X start poistion for crop
- $y : int
-
Y start poistion for crop
- $mode : string = 'resize'
-
action how to mainpulate image
- $bg : string = ''
-
background color
- $degree : int
-
rotete degree
- $jpgQuality : int = null
-
JEPG quality (1-100)
Tags
Return values
array<string|int, mixed>|false —shared()
Get/Set expFile shared status
public
shared(string $target[, string $newshared = null ]) : mixed
Parameters
- $target : string
- $newshared : string = null
Return values
mixed —title()
Get/Set expFile Title
public
title(string $target[, string $newtitle = null ]) : mixed
Parameters
- $target : string
- $newtitle : string = null
Return values
mixed —upload()
public
upload(mixed $fp, mixed $dst, mixed $name, mixed $tmpname[, mixed $hashes = array() ]) : mixed
Parameters
- $fp : mixed
- $dst : mixed
- $name : mixed
- $tmpname : mixed
- $hashes : mixed = array()
Return values
mixed —_copy()
Copy file into another file
protected
_copy(string $source, string $targetDir, string $name) : bool
Parameters
- $source : string
-
source file path
- $targetDir : string
-
target directory path
- $name : string
-
new file name
Tags
Return values
bool —_get_expFile()
Return the expFile for the given path or create new expFile
protected
static _get_expFile(string $path[, mixed $newuser = null ]) : expFile
Parameters
- $path : string
- $newuser : mixed = null
Tags
Return values
expFile —_mkfile()
Create file and return it's path or false on failed
protected
_mkfile(string $path, string $name) : string|bool
Parameters
- $path : string
-
parent dir path
- $name : string
-
new file name
Tags
Return values
string|bool —_move_expFile()
Move an expFile to the given path
protected
_move_expFile(string $oldpath, string $newpath) : array<string|int, mixed>|int
Parameters
- $oldpath : string
-
source file hash or path
- $newpath : string
-
dest dir hash or path
Tags
Return values
array<string|int, mixed>|int —_remove_expFile()
Delete an expFile record based on the given path
protected
_remove_expFile(string $oldpath) : mixed
Parameters
- $oldpath : string
-
source file hash
Tags
Return values
mixed —_save()
Create new file and write into it from file pointer.
protected
_save(resource $fp, string $dir, string $name, array<string|int, mixed> $stat) : bool|string
Return new file path or false on error.
Parameters
- $fp : resource
-
file pointer
- $dir : string
-
target dir path
- $name : string
-
file name
- $stat : array<string|int, mixed>
-
file stat (required by some virtual fs)
Tags
Return values
bool|string —_unlink()
Remove file
protected
_unlink(string $path) : bool
Parameters
- $path : string
-
file path
Tags
Return values
bool —scan_folder()
Recursive method to move expFile record directories
protected
scan_folder( $npath, $opath) : mixed
Parameters
Return values
mixed —stat()
Return fileinfo, also check if in expFiles table and add if missing
protected
stat(string $path) : array<string|int, mixed>
Parameters
- $path : string
-
file cache