The SSH connection class for the update module.


Expanded class hierarchy of FileTransferSSH


core/includes/filetransfer/, line 6


Contains filters are case sensitive
Namesort descending Modifiers Type Description
FileTransfer::$chrootPath private property Path to connection chroot.
FileTransfer::$connectionHandle private property The instantiated connection object.
FileTransfer::$hostname protected property The hostname for this file transfer.
FileTransfer::$jail protected property Full path to directory where file-transfer is restricted to.
FileTransfer::$password protected property The password for this file transfer.
FileTransfer::$port protected property The port for this file transfer.
FileTransfer::$username protected property The username for this file transfer.
FileTransfer::checkPath protected final function Checks that the path is inside the jail and throws an exception if not.
FileTransfer::chmod final public function Changes the permissions of the specified $path (file or directory).
FileTransfer::copyDirectory final public function Copies a directory.
FileTransfer::copyFile public final function Copies a file.
FileTransfer::createDirectory public final function Creates a directory.
FileTransfer::findChroot function Returns the chroot property for this connection.
FileTransfer::fixRemotePath protected final function Returns a modified path suitable for passing to the server.
FileTransfer::removeDirectory public final function Removes a directory.
FileTransfer::removeFile public final function Removes a file.
FileTransfer::sanitizePath function Changes backslashes to slashes, also removes a trailing slash.
FileTransfer::setChroot function Sets the chroot and changes the jail to match the correct path scheme
FileTransfer::__get function Implementation of the magic __get() method.
FileTransfer::__isset public function Implementation of the magic __isset() method.
FileTransfer::__set public function Implementation of the magic __set() method.
FileTransfer::__unset public function Implementation of the magic __unset() method.
FileTransferSSH::chmodJailed function Changes the permissions of the file / directory specified in $path Overrides FileTransferChmodInterface::chmodJailed
FileTransferSSH::connect public function Connects to the server. Overrides FileTransfer::connect
FileTransferSSH::copyDirectoryJailed protected function Copies a directory. Overrides FileTransfer::copyDirectoryJailed
FileTransferSSH::copyFileJailed protected function Copies a file. Overrides FileTransfer::copyFileJailed
FileTransferSSH::createDirectoryJailed protected function Creates a directory. Overrides FileTransfer::createDirectoryJailed
FileTransferSSH::factory static function Classes that extend this class must override the factory() static method. Overrides FileTransfer::factory
FileTransferSSH::getSettingsForm public function Returns the form to configure the FileTransfer class for SSH. Overrides FileTransfer::getSettingsForm
FileTransferSSH::isDirectory public function WARNING: This is untested. It is not currently used, but should do the trick. Overrides FileTransfer::isDirectory
FileTransferSSH::isFile public function Checks if a particular path is a file (not a directory). Overrides FileTransfer::isFile
FileTransferSSH::removeDirectoryJailed protected function Removes a directory. Overrides FileTransfer::removeDirectoryJailed
FileTransferSSH::removeFileJailed protected function Removes a file. Overrides FileTransfer::removeFileJailed
FileTransferSSH::__construct function The constructor for the UpdateConnection class. This method is also called from the classes that extend this class and override this method. Overrides FileTransfer::__construct