Class: VFTPFile

[line 49]

FTP Client

Tags:

• var - FTP Client
• access - protected

Type: object

Overrides:

[line 58]

FTP Folder

Tags:

• var - FTP Folder
• access - protected

Type: VFTPFolder

Overrides:

static VFTPFile &getInstance( &$client)

[line 67]

Get instance of File object

Tags:

• return - File object
• access - public

Overrides VFile::getInstance() (Get instance of File object)

Parameters:

• &$client -

VFTPFile __construct( &$filesystem, VFilesystem $filesystem)

[line 486]

Class constructor

Tags:

• access - public

Overrides VFilesystemDriver::__construct() (Class Constructor)

Parameters:

• VFilesystem $filesystem - Filesystem
• &$filesystem -

boolean copy( string $src, string $dest, [string $path = null], [ $sourceSystem = null])

[line 269]

Copies a file

Tags:

• return - True on success

Overrides VFile::copy() (Copies a file)

Parameters:

• string $src - The path to the source file
• string $dest - The path to the destination file
• string $path - An optional base path to prefix to the file names
• $sourceSystem -

boolean delete( mixed $file)

[line 318]

Delete a file or array of files

Tags:

• return - True on success
• access - public

Overrides VFile::delete() (Delete a file or array of files)

Parameters:

• mixed $file - The file name or an array of file names

boolean exists( string $file)

[line 452]

Check if file exists

Tags:

• return - True if path is a file
• access - public

Overrides VFile::exists() (Check if file exists)

Parameters:

• string $file - File path

string|object The getExt( string $file)

[line 123]

Gets the extension of a file name

Tags:

• return - file extension on success, error or warning on failure
• access - public

Overrides VFile::getExt() (Gets the extension of a file name)

Parameters:

• string $file - The file name

VFTPFolder &getFolderInstance( )

[line 81]

Get instance of Folder object

Tags:

• return - Folder object
• access - public

Overrides VFile::getFolderInstance() (Get instance of Folder object)

Parameters:

integer|object Unix getMTime( string $file)

[line 99]

Get modification time

Tags:

• return - timestamp on success, warning or error otherwise
• access - public

Overrides VFile::getMTime() (Get modification time)

Parameters:

• string $file - Filename

string getName( string $file)

[line 469]

Returns the name, sans any path

Tags:

• return - filename

Overrides VFile::getName() (Returns the name, sans any path)

Parameters:

• string $file - File path

string makeSafe( string $file)

[line 153]

Makes file name safe to use

Tags:

• return - The sanitised string
• access - public

Overrides VFile::makeSafe() (Makes file name safe to use)

Parameters:

• string $file - The name of the file [not full path]

string|object Filename mktemp( [string $prefix = 'php'], [string $dir = false])

[line 167]

Make a temporary file

Tags:

• return - on success, error or warning otherwise
• access - public

Overrides VFile::mktemp() (Make a temporary file)

Parameters:

• string $prefix - Filename prefix
• string $dir - Directory to create file

boolean|object True move( string $src, string $dest, [string $path = ''])

[line 352]

Moves a file

Tags:

• return - on success, error or warning otherwise
• access - public

Overrides VFile::move() (Moves a file)

Parameters:

• string $src - The path to the source file
• string $dest - The path to the destination file
• string $path - An optional base path to prefix to the file names

mixed read( string $filename, [boolean $incpath = false], [int $amount = 0], [int $chunksize = 8192], [int $offset = 0])

[line 394]

Read the contents of a file

Tags:

• return - Returns file contents on success, error or warning on failure
• access - public

Overrides VFile::read() (Read the contents of a file)

Parameters:

• string $filename - The full file path
• boolean $incpath - Use include path
• int $amount - Amount of file to read
• int $chunksize - Size of chunks to read
• int $offset - Offset of the file

string stripExt( string $file)

[line 140]

Strips the last extension off a file name

Tags:

• return - The file name without the extension
• access - public

Overrides VFile::stripExt() (Strips the last extension off a file name)

Parameters:

• string $file - The file name

boolean|object Returns upload( string $src, string $dest)

[line 438]

Moves an uploaded file to a destination folder

UNSUPPORTED!!!

Tags:

• return - a warning as this method is not supported by this driver
• access - public

Overrides VFile::upload() (Moves an uploaded file to a destination folder)

Parameters:

• string $src - The name of the php (temporary) uploaded file
• string $dest - The path (including filename) to move the uploaded file to

boolean write( string $file, string $buffer)

[line 239]

Write contents to a file

Tags:

• return - True on success
• access - public

Overrides VFile::write() (Write contents to a file)

Parameters:

• string $file - The full file path
• string $buffer - The buffer to write