@file Base FileTransfer class.
Classes extending this class perform file operations on directories not writable by the webserver. To achieve this, the class should connect back to the server using some backend (for example FTP or SSH). To keep security, the password should always be asked from the user and never stored. For safety, all methods operate only inside a "jail", by default the Backdrop root.
Hierarchy
- class FileTransfer
Expanded class hierarchy of FileTransfer
File
- core/
includes/ filetransfer/ filetransfer.inc, line 13 - Base FileTransfer class.
Members
Name | Modifiers | Type | Description |
---|---|---|---|
FileTransfer:: |
protected | property | The username for this file transfer. |
FileTransfer:: |
protected | property | The password for this file transfer. |
FileTransfer:: |
protected | property | The hostname for this file transfer. |
FileTransfer:: |
protected | property | The port for this file transfer. |
FileTransfer:: |
protected | property | Full path to directory where file-transfer is restricted to. |
FileTransfer:: |
private | property | Path to connection chroot. |
FileTransfer:: |
private | property | The instantiated connection object. |
FileTransfer:: |
function | The constructor for the FileTransfer class. | |
FileTransfer:: |
static | function | Defines a factory method for this class. |
FileTransfer:: |
function | Implementation of the magic __get() method. | |
FileTransfer:: |
abstract public | function | Connects to the server. |
FileTransfer:: |
final public | function | Copies a directory. |
FileTransfer:: |
final public | function | Changes the permissions of the specified $path (file or directory). |
FileTransfer:: |
public final | function | Creates a directory. |
FileTransfer:: |
public final | function | Removes a directory. |
FileTransfer:: |
public final | function | Copies a file. |
FileTransfer:: |
public final | function | Removes a file. |
FileTransfer:: |
protected final | function | Checks that the path is inside the jail and throws an exception if not. |
FileTransfer:: |
protected final | function | Returns a modified path suitable for passing to the server. |
FileTransfer:: |
function | Changes backslashes to slashes, also removes a trailing slash. | |
FileTransfer:: |
protected | function | Copies a directory. |
FileTransfer:: |
abstract protected | function | Creates a directory. |
FileTransfer:: |
abstract protected | function | Removes a directory. |
FileTransfer:: |
abstract protected | function | Copies a file. |
FileTransfer:: |
abstract protected | function | Removes a file. |
FileTransfer:: |
abstract public | function | Checks if a particular path is a directory |
FileTransfer:: |
abstract public | function | Checks if a particular path is a file (not a directory). |
FileTransfer:: |
function | Returns the chroot property for this connection. | |
FileTransfer:: |
function | Sets the chroot and changes the jail to match the correct path scheme | |
FileTransfer:: |
public | function | Returns a form to collect connection settings credentials. |
FileTransfer:: |
public | function | Implementation of the magic __set() method. |
FileTransfer:: |
public | function | Implementation of the magic __isset() method. |
FileTransfer:: |
public | function | Implementation of the magic __unset() method. |