abstract class FTP in Drupal 9

Defines the base class for FTP implementations.

Hierarchy

• class \Drupal\Core\FileTransfer\FileTransfer
  • class \Drupal\Core\FileTransfer\FTP

1 string reference to 'FTP'

system_filetransfer_info in core/modules/system/system.module

Implements hook_filetransfer_info().

File

core/lib/Drupal/Core/FileTransfer/FTP.php, line 8

Namespace

Drupal\Core\FileTransfer

abstract class FTP extends FileTransfer {

  /**
   * {@inheritdoc}
   */
  public function __construct($jail, $username, $password, $hostname, $port) {
    $this->username = $username;
    $this->password = $password;
    $this->hostname = $hostname;
    $this->port = $port;
    parent::__construct($jail);
  }

  /**
   * {@inheritdoc}
   */
  public 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 = 'Drupal\\Core\\FileTransfer\\FTPExtension';
    }
    else {
      throw new FileTransferException('No FTP backend available.');
    }
    return new $class($jail, $username, $password, $hostname, $port);
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm() {
    $form = parent::getSettingsForm();
    $form['advanced']['port']['#default_value'] = 21;
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FileTransfer::$hostname	protected	property	The hostname for this file transfer.
FileTransfer::$password	protected	property	The password for this file transfer.	1
FileTransfer::$port	protected	property	The port for this file transfer.	1
FileTransfer::$username	protected	property	The username for this file transfer.	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	Changes the permissions of the specified $path (file or directory).
FileTransfer::connect	abstract public	function	Connects 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	public	function	Returns the chroot property for this connection.
FileTransfer::fixRemotePath	final protected	function	Returns a modified path suitable for passing to the server.
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	public	function	Changes backslashes to slashes, also removes a trailing slash.
FileTransfer::setChroot	public	function	Sets the chroot and changes the jail to match the correct path scheme.
FileTransfer::__get	public	function	Implements the magic __get() method.
FTP::factory	public static	function	Defines a factory method for this class. Overrides FileTransfer::factory
FTP::getSettingsForm	public	function	Returns a form to collect connection settings credentials. Overrides FileTransfer::getSettingsForm
FTP::__construct	public	function	Constructs a Drupal\Core\FileTransfer\FileTransfer object. Overrides FileTransfer::__construct