function FileTransfer::getSettingsForm

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

Returns a form to collect connection settings credentials.

Implementing classes can either extend this form with fields collecting the specific information they need, or override it entirely.

2 calls to FileTransfer::getSettingsForm()
FileTransferFTP::getSettingsForm in includes/filetransfer/ftp.inc
Returns the form to configure the FileTransfer class for FTP.
FileTransferSSH::getSettingsForm in includes/filetransfer/ssh.inc
Returns the form to configure the FileTransfer class for SSH.
2 methods override FileTransfer::getSettingsForm()
FileTransferFTP::getSettingsForm in includes/filetransfer/ftp.inc
Returns the form to configure the FileTransfer class for FTP.
FileTransferSSH::getSettingsForm in includes/filetransfer/ssh.inc
Returns the form to configure the FileTransfer class for SSH.

File

includes/filetransfer/filetransfer.inc, line 331

Class

FileTransfer

Code

public function getSettingsForm() {
    $form['username'] = array(
        '#type' => 'textfield',
        '#title' => t('Username'),
    );
    $form['password'] = array(
        '#type' => 'password',
        '#title' => t('Password'),
        '#description' => t('Your password is not saved in the database and is only used to establish a connection.'),
    );
    $form['advanced'] = array(
        '#type' => 'fieldset',
        '#title' => t('Advanced settings'),
        '#collapsible' => TRUE,
        '#collapsed' => TRUE,
    );
    $form['advanced']['hostname'] = array(
        '#type' => 'textfield',
        '#title' => t('Host'),
        '#default_value' => 'localhost',
        '#description' => t('The connection will be created between your web server and the machine hosting the web server files. In the vast majority of cases, this will be the same machine, and "localhost" is correct.'),
    );
    $form['advanced']['port'] = array(
        '#type' => 'textfield',
        '#title' => t('Port'),
        '#default_value' => NULL,
    );
    return $form;
}

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