• Home
• elFinderVolumeFTP

PHP Class elFinderVolumeFTP

Datei anzeigen Open project: studio-42/elfinder Class Usage Examples

Protected Properties

Property	Type	Description
$connect	ftp	FTP Connection Instance
$driverId	string	Driver id Must be started from letter and contains [a-z0-9] Used as part of volume id
$ftpError	string	Last FTP error message
$ftpOsUnix	boolean	FTP server output list as ftp on linux
$tmp	string	Tmp folder path
$tmpPath	string	Directory for tmp files If not set driver will try to use tmbDir as tmpDir

Public Methods

Method	Description
__construct ( )	Constructor Extend options with required fields
netmountPrepare ( $options ) : Array	Prepare Call from elFinder::netmout() before volume->mount()
umount ( ) : void	Close opened connection

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 | false	Return object width and height Ususaly 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 $target, string $path, string $name ) : boolean	Create symlink. FTP driver does not support symlinks.
_unlink ( string $path ) : boolean	Remove file
cacheDir ( string $path ) : void	Cache dir contents
configure ( ) : void	Configure after successfull mount.
connect ( ) : boolean	Connect to ftp server
ftpMode ( string $path ) : string	Return ftp transfer mode for file
ftp_scan_dir ( $remote_directory, $targets = null ) : array	Gets an array of absolute remote FTP paths of files and folders in $remote_directory omitting symbolic links.
init ( ) : boolean	Prepare FTP connection Connect to remote server and check if credentials are correct, if so, store the connection id in $ftp_conn
normalizeRawWindows ( string $raw ) : array	Normalize MS-DOS style FTP LIST Raw line
parsePermissions ( string $perm, string $user = '' ) : string	Parse permissions string. Return array(read => true/false, write => true/false)
parseRaw ( string $raw, $base, boolean $nameOnly = false ) : array	Parse line from ftp_rawlist() output and return file stat (array)

Private Methods

Method	Description
deleteDir ( $dirPath ) : boolean	Delete local directory recursively.
ftp_download_files ( $remote_directory, array $files, $dest_local_directory ) : boolean	Downloads specified files from remote directory if there is a directory among files it is downloaded recursively (omitting symbolic links).
listFilesInDirectory ( $dir, $omitSymlinks, string $prefix = '' ) : array	Returns array of strings containing all files and folders in the specified local directory.
tempDir ( ) : string	Create writable temporary directory and return path to it.

Method Details

Property Details