Class elFinderVolumeFTP

Simple elFinder driver for FTP

elFinderVolumeFTP

Author: Dmitry (dio) Levashov
Author: Cem (discofever)
Located at zp-extensions/elFinder/php/elFinderVolumeFTP.class.php

Methods summary
`public`	# `__construct( )` Constructor Extend options with required fields Constructor Extend options with required fields Author Dmitry (dio) Levashov Cem (DiscoFever)
`public array`	# `netmountPrepare( $options )` Prepare Call from elFinder::netmout() before volume->mount() Prepare Call from elFinder::netmout() before volume->mount() Parameters `$options` Returns array volume root options Author Naoki Sawada
`protected boolean`	# `init( )` Prepare FTP connection Connect to remote server and check if credentials are correct, if so, store the connection id in $ftp_conn Prepare FTP connection Connect to remote server and check if credentials are correct, if so, store the connection id in $ftp_conn Returns boolean Author Dmitry (dio) Levashov Cem (DiscoFever) Overrides `elFinderVolumeDriver::init()`
`protected`	# `configure( )` Configure after successfull mount. Configure after successfull mount. Throws `elFinderAbortException` Author Dmitry (dio) Levashov Overrides `elFinderVolumeDriver::configure()`
`protected boolean`	# `connect( )` Connect to ftp server Connect to ftp server Returns boolean Author Dmitry (dio) Levashov
`protected array`	# `ftpRawList( string $path )` Call ftp_rawlist with option prefix Call ftp_rawlist with option prefix Parameters `$path` Returns array
`public`	# `umount( )` Close opened connection Close opened connection Author Dmitry (dio) Levashov Overrides `elFinderVolumeDriver::umount()`
`protected array`	# `parseRaw( string $raw, $base, boolean $nameOnly = false )` Parse line from ftp_rawlist() output and return file stat (array) Parse line from ftp_rawlist() output and return file stat (array) Parameters `$raw` line from ftp_rawlist() output `$base` `$nameOnly` Returns array Author Dmitry Levashov
`protected array`	# `normalizeRawWindows( string $raw )` Normalize MS-DOS style FTP LIST Raw line Normalize MS-DOS style FTP LIST Raw line Parameters `$raw` line from FTP LIST (MS-DOS style) Returns array Author Naoki Sawada
`protected array`	# `parsePermissions( string $perm, Boolean $isowner = true )` Parse permissions string. Return array(read => true/false, write => true/false) Parse permissions string. Return array(read => true/false, write => true/false) Parameters `$perm` permissions string 'rwx' + 'rwx' + 'rwx' ^ ^ ^ \| \| +-> others \| +---------> group +-----------------> owner The isowner parameter is computed by the caller. If the owner parameter in the options is true, the user is the actual owner of all objects even if che user used in the ftp Login is different from the file owner id. If the owner parameter is false to understand if the user is the file owner we compare the ftp user with the file owner id. `$isowner` . Tell if the current user is the owner of the object. Returns array Author Dmitry (dio) Levashov Ugo Vierucci
`protected`	# `cacheDir( string $path )` Cache dir contents Cache dir contents Parameters `$path` dir path Author Dmitry Levashov Overrides `elFinderVolumeDriver::cacheDir()`
`protected string`	# `ftpMode( string $path )` Return ftp transfer mode for file Return ftp transfer mode for file Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`protected string`	# `_dirname( string $path )` Return parent directory path Return parent directory path Parameters `$path` file path Returns string Author Naoki Sawada
`protected string`	# `_basename( string $path )` Return file name Return file name Parameters `$path` file path Returns string Author Naoki Sawada
`protected string`	# `_joinPath( string $dir, string $name )` Join dir name and file name and retur full path Join dir name and file name and retur full path Parameters `$dir` `$name` Returns string Author Dmitry (dio) Levashov
`protected string`	# `_normpath( string $path )` Return normalized path, this works the same as os.path.normpath() in Python Return normalized path, this works the same as os.path.normpath() in Python Parameters `$path` path Returns string Author Troex Nevelin
`protected string`	# `_relpath( string $path )` Return file path related to root dir Return file path related to root dir Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`protected string`	# `_abspath( string $path )` Convert path related to root dir into real path Convert path related to root dir into real path Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`protected string`	# `_path( string $path )` Return fake path started from root dir Return fake path started from root dir Parameters `$path` file path Returns string Author Dmitry (dio) Levashov
`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 Author Dmitry (dio) Levashov
`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 `$path` file path Returns array\|false Author Dmitry (dio) Levashov
`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 `$path` dir path Returns boolean Author Dmitry (dio) Levashov
`protected string\|false`	# `_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\|false Throws ImagickException `elFinderAbortException` Author Dmitry (dio) Levashov
`protected array`	# `_scandir( string $path )` Return files list in directory. Return files list in directory. Parameters `$path` dir path Returns array Author Dmitry (dio) Levashov Cem (DiscoFever)
`protected false\|resource`	# `_fopen( string $path, string $mode = 'rb' )` Open file and return file pointer Open file and return file pointer Parameters `$path` file path `$mode` Returns false\|resource Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected`	# `_fclose( resource $fp, string $path = '' )` Close opened file Close opened file Parameters `$fp` file pointer `$path` Author Dmitry (dio) Levashov
`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 Author Dmitry (dio) Levashov
`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 Author Dmitry (dio) Levashov
`protected boolean`	# `_symlink( string $target, string $path, string $name )` Create symlink. FTP driver does not support symlinks. Create symlink. FTP driver does not support symlinks. Parameters `$target` link target `$path` symlink path `$name` Returns boolean Author Dmitry (dio) Levashov
`protected boolean`	# `_copy( string $source, string $targetDir, string $name )` Copy file into another file Copy file into another file Parameters `$source` source file path `$targetDir` target directory path `$name` new file name Returns boolean Author Dmitry (dio) Levashov
`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 Author Dmitry (dio) Levashov
`protected boolean`	# `_unlink( string $path )` Remove file Remove file Parameters `$path` file path Returns boolean Author Dmitry (dio) Levashov
`protected boolean`	# `_rmdir( string $path )` Remove dir Remove dir Parameters `$path` dir path Returns boolean Author Dmitry (dio) Levashov
`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 Author Dmitry (dio) Levashov
`protected string\|false`	# `_getContents( string $path )` Get file contents Get file contents Parameters `$path` file path Returns string\|false Throws `elFinderAbortException` Author Dmitry (dio) Levashov
`protected boolean`	# `_filePutContents( string $path, string $content )` Write a string to a file Write a string to a file Parameters `$path` file path `$content` new file content Returns boolean Author Dmitry (dio) Levashov
`protected`	# `_checkArchivers( )` Detect available archivers Detect available archivers Throws `elFinderAbortException`
`protected boolean`	# `_chmod( string $path, string $mode )` chmod availability chmod availability Parameters `$path` `$mode` Returns boolean
`protected true`	# `_extract( string $path, array $arc )` Extract files from archive Extract files from archive Parameters `$path` archive path `$arc` archiver command and arguments (same as in $this->archivers) Returns true Throws `elFinderAbortException` Author Dmitry (dio) Levashov, Alexey Sukhotin
`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 Throws `elFinderAbortException` Author Dmitry (dio) Levashov, Alexey Sukhotin
`protected array`	# `ftp_scan_dir( $remote_directory, $targets = null )` Gets an array of absolute remote FTP paths of files and folders in $remote_directory omitting symbolic links. Gets an array of absolute remote FTP paths of files and folders in $remote_directory omitting symbolic links. Parameters `$remote_directory` remote FTP path to scan for file and folders recursively `$targets` Array of target item. `null` is to get all of items Returns array of elements each of which is an array of two elements: $item['path'] - absolute remote FTP path $item['type'] - either 'f' for file or 'd' for directory

Methods inherited from elFinderVolumeDriver
abspathCE(), addError(), added(), allowCreate(), allowPutMime(), archive(), attr(), basenameCE(), canCreateTmb(), canResize(), checkExtractItems(), childsByAttr(), chmod(), clearSessionCache(), clearcache(), clearcaches(), clearstatcache(), close(), closest(), closestByAttr(), commandDisabled(), 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(), 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(), uncrypt(), uniqueName(), unpackArchive(), updateCache(), updateSubdirsCache(), upload(), zipArchiveUnzip(), zipArchiveZip(), zipdl()

Magic methods inherited from elFinderVolumeDriver
`netmountPrepare(), postNetmount()`

Properties summary
`protected string`	`$driverId` Driver id Must be started from letter and contains [a-z0-9] Used as part of volume id Driver id Must be started from letter and contains [a-z0-9] Used as part of volume id	# `'f'`
`protected resource`	`$connect` FTP Connection Instance FTP Connection Instance	# `null`
`protected string`	`$tmpPath` Directory for tmp files If not set driver will try to use tmbDir as tmpDir Directory for tmp files If not set driver will try to use tmbDir as tmpDir	# `''`
`protected string`	`$ftpError` Last FTP error message Last FTP error message	# `''`
`protected boolean`	`$ftpOsUnix` FTP server output list as ftp on linux FTP server output list as ftp on linux	#
`protected string`	`$ftpListOption` FTP LIST command option FTP LIST command option	# `'-al'`
`protected boolean`	`$isPureFtpd` Is connected server Pure FTPd? Is connected server Pure FTPd?	# `false`
`protected boolean`	`$isFTPS` Is connected server with FTPS? Is connected server with FTPS?	# `false`
`protected string`	`$tmp` Tmp folder path Tmp folder path	# `''`

Properties inherited from elFinderVolumeDriver
$ARGS, $URL, $access, $added, $archivers, $attributes, $cache, $cryptLib, $defaults, $dirnameValidator, $dirsCache, $disabled, $disabledGetUrl, $doSearchCurrentQuery, $encoding, $error, $extractToNewdir, $finfo, $getMaxSize, $id, $imgConverter, $imgLib, $maxArcFilesSize, $mimeDetect, $mimetypes, $mounted, $nameValidator, $needOnline, $netMountKey, $onlyMimes, $options, $removed, $root, $rootModified, $rootName, $searchStart, $separator, $separatorForHash, $session, $sessionCache, $sessionCaching, $startPath, $subdirsCache, $systemRoot, $tmbPath, $tmbPathWritable, $tmbSize, $tmbURL, $tmpLinkPath, $tmpLinkUrl, $today, $treeDeep, $uploadAllow, $uploadDeny, $uploadMaxSize, $uploadOrder, $uploadOverwrite, $yesterday

Classes

Interfaces

Exceptions

Functions

Class elFinderVolumeFTP

Author

Parameters

Returns

Author

Returns

Author

Overrides

Throws

Author

Overrides

Returns

Author

Parameters

Returns

Author

Overrides

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Author

Overrides

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Author

Parameters

Returns

Throws

Author

Parameters

Returns

Author

Parameters

Returns

Throws

Author

Parameters

Author

Parameters