@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

Expanded class hierarchy of FileTransfer

File

core/includes/filetransfer/filetransfer.inc, line 13
Base FileTransfer class.

Members

Contains filters are case sensitive
Name Modifierssort descending Type Description
FileTransfer::__construct function The constructor for the FileTransfer class.
FileTransfer::__get function Implementation of the magic __get() method.
FileTransfer::sanitizePath function Changes backslashes to slashes, also removes a trailing slash.
FileTransfer::findChroot function Returns the chroot property for this connection.
FileTransfer::setChroot function Sets the chroot and changes the jail to match the correct path scheme
FileTransfer::createDirectoryJailed abstract protected function Creates a directory.
FileTransfer::removeDirectoryJailed abstract protected function Removes a directory.
FileTransfer::copyFileJailed abstract protected function Copies a file.
FileTransfer::removeFileJailed abstract protected function Removes a file.
FileTransfer::connect abstract public function Connects to the server.
FileTransfer::isDirectory abstract public function Checks if a particular path is a directory
FileTransfer::isFile abstract public function Checks if a particular path is a file (not a directory).
FileTransfer::copyDirectory final public function Copies a directory.
FileTransfer::chmod final public function Changes the permissions of the specified $path (file or directory).
FileTransfer::$chrootPath private property Path to connection chroot.
FileTransfer::$connectionHandle private property The instantiated connection object.
FileTransfer::copyDirectoryJailed protected function Copies a directory.
FileTransfer::$username protected property The username for this file transfer.
FileTransfer::$password protected property The password for this file transfer.
FileTransfer::$hostname protected property The hostname for this file transfer.
FileTransfer::$port protected property The port for this file transfer.
FileTransfer::$jail protected property Full path to directory where file-transfer is restricted to.
FileTransfer::checkPath protected final function Checks that the path is inside the jail and throws an exception if not.
FileTransfer::fixRemotePath protected final function Returns a modified path suitable for passing to the server.
FileTransfer::getSettingsForm public function Returns a form to collect connection settings credentials.
FileTransfer::__set public function Implementation of the magic __set() method.
FileTransfer::__isset public function Implementation of the magic __isset() method.
FileTransfer::__unset public function Implementation of the magic __unset() method.
FileTransfer::createDirectory public final function Creates a directory.
FileTransfer::removeDirectory public final function Removes a directory.
FileTransfer::copyFile public final function Copies a file.
FileTransfer::removeFile public final function Removes a file.
FileTransfer::factory static function Defines a factory method for this class.