abstract class FileTransferFTP in Drupal 7

Base class for FTP implementations.

Hierarchy

• class \FileTransfer
  • class \FileTransferFTP

1 string reference to 'FileTransferFTP'

system_filetransfer_info in modules/system/system.module

Implements hook_filetransfer_info().

File

includes/filetransfer/ftp.inc, line 6

abstract class FileTransferFTP extends FileTransfer {
  public function __construct($jail, $username, $password, $hostname, $port) {
    $this->username = $username;
    $this->password = $password;
    $this->hostname = $hostname;
    $this->port = $port;
    parent::__construct($jail);
  }

  /**
   * Return an object which can implement the FTP protocol.
   *
   * @param string $jail
   * @param array $settings
   * @return FileTransferFTP
   *   The appropriate FileTransferFTP subclass based on the available
   *   options. If the FTP PHP extension is available, use it.
   */
  static function factory($jail, $settings) {
    $username = empty($settings['username']) ? '' : $settings['username'];
    $password = empty($settings['password']) ? '' : $settings['password'];
    $hostname = empty($settings['advanced']['hostname']) ? 'localhost' : $settings['advanced']['hostname'];
    $port = empty($settings['advanced']['port']) ? 21 : $settings['advanced']['port'];
    if (function_exists('ftp_connect')) {
      $class = 'FileTransferFTPExtension';
    }
    else {
      throw new FileTransferException('No FTP backend available.');
    }
    return new $class($jail, $username, $password, $hostname, $port);
  }

  /**
   * Returns the form to configure the FileTransfer class for FTP.
   */
  public function getSettingsForm() {
    $form = parent::getSettingsForm();
    $form['advanced']['port']['#default_value'] = 21;
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FileTransfer::$hostname	protected	property
FileTransfer::$password	protected	property		1
FileTransfer::$port	protected	property		1
FileTransfer::$username	protected	property		1
FileTransfer::checkPath	final protected	function	Checks that the path is inside the jail and throws an exception if not.
FileTransfer::chmod	final public	function
FileTransfer::connect	abstract protected	function	Connect to the server.	4
FileTransfer::copyDirectory	final public	function	Copies a directory.
FileTransfer::copyDirectoryJailed	protected	function	Copies a directory.	1
FileTransfer::copyFile	final public	function	Copies a file.
FileTransfer::copyFileJailed	abstract protected	function	Copies a file.	4
FileTransfer::createDirectory	final public	function	Creates a directory.
FileTransfer::createDirectoryJailed	abstract protected	function	Creates a directory.	4
FileTransfer::findChroot		function	Return the chroot property for this connection.
FileTransfer::fixRemotePath	final protected	function	Returns a modified path suitable for passing to the server. If a path is a windows path, makes it POSIX compliant by removing the drive letter. If $this->chroot has a value, it is stripped from the path to allow for chroot'd filetransfer systems.
FileTransfer::isDirectory	abstract public	function	Checks if a particular path is a directory	4
FileTransfer::isFile	abstract public	function	Checks if a particular path is a file (not a directory).	4
FileTransfer::removeDirectory	final public	function	Removes a directory.
FileTransfer::removeDirectoryJailed	abstract protected	function	Removes a directory.	4
FileTransfer::removeFile	final public	function	Removes a file.
FileTransfer::removeFileJailed	abstract protected	function	Removes a file.	4
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.
FileTransferFTP::factory	static	function	Return an object which can implement the FTP protocol. Overrides FileTransfer::factory
FileTransferFTP::getSettingsForm	public	function	Returns the form to configure the FileTransfer class for FTP. Overrides FileTransfer::getSettingsForm
FileTransferFTP::__construct	public	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