PHP 클래스 elFinderVolumeFTP

저자: Dmitry (dio) Levashov
저자: Cem (discofever)
상속: extends elFinderVolumeDriver
파일 보기 프로젝트 열기: studio-42/elfinder 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$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

공개 메소드들

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

보호된 메소드들

메소드 설명
_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)

비공개 메소드들

메소드 설명
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.

메소드 상세

__construct() 공개 메소드

Constructor Extend options with required fields
저자: Dmitry (dio) Levashov
저자: Cem (DiscoFever)
public __construct ( )

_abspath() 보호된 메소드

Convert path related to root dir into real path
저자: Dmitry (dio) Levashov
protected _abspath ( string $path ) : string
$path string file path
리턴 string

_archive() 보호된 메소드

Create archive and return its path
저자: Dmitry (dio) Levashov,
저자: Alexey Sukhotin
protected _archive ( string $dir, array $files, string $name, array $arc ) : string | boolean
$dir string target dir
$files array files names list
$name string archive name
$arc array archiver options
리턴 string | boolean

_basename() 보호된 메소드

Return file name
저자: Naoki Sawada
protected _basename ( string $path ) : string
$path string file path
리턴 string

_checkArchivers() 보호된 메소드

Detect available archivers
protected _checkArchivers ( ) : void
리턴 void

_chmod() 보호된 메소드

chmod availability
protected _chmod ( string $path, string $mode ) : boolean
$path string
$mode string
리턴 boolean

_copy() 보호된 메소드

Copy file into another file
저자: Dmitry (dio) Levashov
protected _copy ( string $source, string $targetDir, string $name ) : boolean
$source string source file path
$targetDir string target directory path
$name string new file name
리턴 boolean

_dimensions() 보호된 메소드

..
저자: Dmitry (dio) Levashov
protected _dimensions ( string $path, string $mime ) : string | false
$path string file path
$mime string file mime type
리턴 string | false

_dirname() 보호된 메소드

Return parent directory path
저자: Naoki Sawada
protected _dirname ( string $path ) : string
$path string file path
리턴 string

_extract() 보호된 메소드

Extract files from archive
저자: Dmitry (dio) Levashov,
저자: Alexey Sukhotin
protected _extract ( string $path, array $arc ) : true
$path string archive path
$arc array archiver command and arguments (same as in $this->archivers)
리턴 true

_fclose() 보호된 메소드

Close opened file
저자: Dmitry (dio) Levashov
protected _fclose ( resource $fp, string $path = '' ) : boolean
$fp resource file pointer
$path string
리턴 boolean

_filePutContents() 보호된 메소드

Write a string to a file
저자: Dmitry (dio) Levashov
protected _filePutContents ( string $path, string $content ) : boolean
$path string file path
$content string new file content
리턴 boolean

_fopen() 보호된 메소드

Open file and return file pointer
저자: Dmitry (dio) Levashov
protected _fopen ( string $path, string $mode = 'rb' ) : false | resource
$path string file path
$mode string
리턴 false | resource

_getContents() 보호된 메소드

Get file contents
저자: Dmitry (dio) Levashov
protected _getContents ( string $path ) : string | false
$path string file path
리턴 string | false

_inpath() 보호된 메소드

Return true if $path is children of $parent
저자: Dmitry (dio) Levashov
protected _inpath ( string $path, string $parent ) : boolean
$path string path to check
$parent string parent path
리턴 boolean

_joinPath() 보호된 메소드

Join dir name and file name and retur full path
저자: Dmitry (dio) Levashov
protected _joinPath ( string $dir, string $name ) : string
$dir string
$name string
리턴 string

_mkdir() 보호된 메소드

Create dir and return created dir path or false on failed
저자: Dmitry (dio) Levashov
protected _mkdir ( string $path, string $name ) : string | boolean
$path string parent dir path
$name string new directory name
리턴 string | boolean

_mkfile() 보호된 메소드

Create file and return it's path or false on failed
저자: Dmitry (dio) Levashov
protected _mkfile ( string $path, string $name ) : string | boolean
$path string parent dir path
$name string new file name
리턴 string | boolean

_move() 보호된 메소드

Return new file path or false.
저자: Dmitry (dio) Levashov
protected _move ( string $source, $targetDir, string $name ) : boolean | string
$source string source file path
$targetDir
$name string file name
리턴 boolean | string

_normpath() 보호된 메소드

Return normalized path, this works the same as os.path.normpath() in Python
저자: Troex Nevelin
protected _normpath ( string $path ) : string
$path string path
리턴 string

_path() 보호된 메소드

Return fake path started from root dir
저자: Dmitry (dio) Levashov
protected _path ( string $path ) : string
$path string file path
리턴 string

_relpath() 보호된 메소드

Return file path related to root dir
저자: Dmitry (dio) Levashov
protected _relpath ( string $path ) : string
$path string file path
리턴 string

_rmdir() 보호된 메소드

Remove dir
저자: Dmitry (dio) Levashov
protected _rmdir ( string $path ) : boolean
$path string dir path
리턴 boolean

_save() 보호된 메소드

Return new file path or false on error.
저자: Dmitry (dio) Levashov
protected _save ( resource $fp, string $dir, string $name, array $stat ) : boolean | string
$fp resource file pointer
$dir string target dir path
$name string file name
$stat array file stat (required by some virtual fs)
리턴 boolean | string

_scandir() 보호된 메소드

Return files list in directory.
저자: Dmitry (dio) Levashov
저자: Cem (DiscoFever)
protected _scandir ( string $path ) : array
$path string dir path
리턴 array

_stat() 보호된 메소드

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.
저자: Dmitry (dio) Levashov
protected _stat ( string $path ) : array | false
$path string file path
리턴 array | false

_subdirs() 보호된 메소드

Return true if path is dir and has at least one childs directory
저자: Dmitry (dio) Levashov
protected _subdirs ( string $path ) : boolean
$path string dir path
리턴 boolean

cacheDir() 보호된 메소드

Cache dir contents
저자: Dmitry Levashov
protected cacheDir ( string $path ) : void
$path string dir path
리턴 void

configure() 보호된 메소드

Configure after successfull mount.
저자: Dmitry (dio) Levashov
protected configure ( ) : void
리턴 void

connect() 보호된 메소드

Connect to ftp server
저자: Dmitry (dio) Levashov
protected connect ( ) : boolean
리턴 boolean

ftpMode() 보호된 메소드

Return ftp transfer mode for file
저자: Dmitry (dio) Levashov
protected ftpMode ( string $path ) : string
$path string file path
리턴 string

ftp_scan_dir() 보호된 메소드

Gets an array of absolute remote FTP paths of files and folders in $remote_directory omitting symbolic links.
protected ftp_scan_dir ( $remote_directory, $targets = null ) : array
$remote_directory string remote FTP path to scan for file and folders recursively
$targets array Array of target item. `null` is to get all of items
리턴 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

init() 보호된 메소드

Prepare FTP connection Connect to remote server and check if credentials are correct, if so, store the connection id in $ftp_conn
저자: Dmitry (dio) Levashov
저자: Cem (DiscoFever)
protected init ( ) : boolean
리턴 boolean

netmountPrepare() 공개 메소드

Prepare Call from elFinder::netmout() before volume->mount()
저자: Naoki Sawada
public netmountPrepare ( $options ) : Array
$options
리턴 Array

normalizeRawWindows() 보호된 메소드

Normalize MS-DOS style FTP LIST Raw line
저자: Naoki Sawada
protected normalizeRawWindows ( string $raw ) : array
$raw string line from FTP LIST (MS-DOS style)
리턴 array

parsePermissions() 보호된 메소드

Parse permissions string. Return array(read => true/false, write => true/false)
저자: Dmitry (dio) Levashov
protected parsePermissions ( string $perm, string $user = '' ) : string
$perm string permissions string
$user string
리턴 string

parseRaw() 보호된 메소드

Parse line from ftp_rawlist() output and return file stat (array)
저자: Dmitry Levashov
protected parseRaw ( string $raw, $base, boolean $nameOnly = false ) : array
$raw string line from ftp_rawlist() output
$base
$nameOnly boolean
리턴 array

umount() 공개 메소드

Close opened connection
저자: Dmitry (dio) Levashov
public umount ( ) : void
리턴 void

프로퍼티 상세

$connect 보호되어 있는 프로퍼티

FTP Connection Instance
protected ftp $connect
리턴 ftp

$driverId 보호되어 있는 프로퍼티

Driver id Must be started from letter and contains [a-z0-9] Used as part of volume id
protected string $driverId
리턴 string

$ftpError 보호되어 있는 프로퍼티

Last FTP error message
protected string $ftpError
리턴 string

$ftpOsUnix 보호되어 있는 프로퍼티

FTP server output list as ftp on linux
protected bool $ftpOsUnix
리턴 boolean

$tmp 보호되어 있는 프로퍼티

Tmp folder path
protected string $tmp
리턴 string

$tmpPath 보호되어 있는 프로퍼티

Directory for tmp files If not set driver will try to use tmbDir as tmpDir
protected string $tmpPath
리턴 string