function FileTransfer::factory

Same name in other branches
  1. 9 core/lib/Drupal/Core/FileTransfer/FileTransfer.php \Drupal\Core\FileTransfer\FileTransfer::factory()
  2. 8.9.x core/lib/Drupal/Core/FileTransfer/FileTransfer.php \Drupal\Core\FileTransfer\FileTransfer::factory()
  3. 10 core/lib/Drupal/Core/FileTransfer/FileTransfer.php \Drupal\Core\FileTransfer\FileTransfer::factory()
  4. 11.x core/lib/Drupal/Core/FileTransfer/FileTransfer.php \Drupal\Core\FileTransfer\FileTransfer::factory()

Classes that extend this class must override the factory() static method.

Parameters

string $jail: The full path where all file operations performed by this object will be restricted to. This prevents the FileTransfer classes from being able to touch other parts of the filesystem.

array $settings: An array of connection settings for the FileTransfer subclass. If the getSettingsForm() method uses any nested settings, the same structure will be assumed here.

Return value

object New instance of the appropriate FileTransfer subclass.

4 methods override FileTransfer::factory()
FileTransferFTP::factory in includes/filetransfer/ftp.inc
Return an object which can implement the FTP protocol.
FileTransferLocal::factory in includes/filetransfer/local.inc
Classes that extend this class must override the factory() static method.
FileTransferSSH::factory in includes/filetransfer/ssh.inc
Classes that extend this class must override the factory() static method.
TestFileTransfer::factory in modules/simpletest/tests/filetransfer.test
Classes that extend this class must override the factory() static method.

File

includes/filetransfer/filetransfer.inc, line 42

Class

FileTransfer

Code

static function factory($jail, $settings) {
    throw new FileTransferException('FileTransfer::factory() static method not overridden by FileTransfer subclass.');
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.