You are here

Home » API reference » Simple LDAP 8 » SimpleLdapServerSettingsForm.php

class SimpleLdapServerSettingsForm in Simple LDAP 8

Hierarchy

Expanded class hierarchy of SimpleLdapServerSettingsForm

1 string reference to 'SimpleLdapServerSettingsForm'
simple_ldap.routing.yml in ./simple_ldap.routing.yml
simple_ldap.routing.yml

File

src/Form/SimpleLdapServerSettingsForm.php, line 8

Namespace

Drupal\simple_ldap\Form
View source 
class SimpleLdapServerSettingsForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'simple_ldap_server_settings';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'simple_ldap.server',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('simple_ldap.server');
    $form['status'] = array(
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Connection status'),
    );
    $form['status']['current'] = array(
      '#type' => 'item',
      '#markup' => $this
        ->getBindStatus(),
    );
    $form['server'] = array(
      '#type' => 'fieldset',
      '#title' => $this
        ->t('LDAP Server Connection'),
      '#open' => TRUE,
    );
    $form['server']['host'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Host'),
      '#required' => TRUE,
      '#default_value' => $config
        ->get('host'),
    );
    $form['server']['port'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Port'),
      '#required' => TRUE,
      '#default_value' => $config
        ->get('port'),
    );
    $form['server']['encryption'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Encryption'),
      '#options' => array(
        'none' => $this
          ->t('None'),
        'ssl' => $this
          ->t('SSL'),
        'tls' => $this
          ->t('TLS'),
      ),
      '#default_value' => $config
        ->get('encryption'),
    );

    // For now, we only allow readonly servers.
    $form['server']['readonly'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Read-only'),
      '#default_value' => TRUE,
      '#disabled' => TRUE,
    );
    $form['directory'] = array(
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Directory Information'),
      '#open' => TRUE,
    );
    $form['directory']['binddn'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Bind DN'),
      '#default_value' => $config
        ->get('binddn'),
      '#description' => $this
        ->t('Leave this blank to bind anonymously'),
    );
    $form['directory']['bindpw'] = array(
      '#type' => 'password',
      '#title' => $this
        ->t('Bind password'),
      '#attributes' => array(
        'value' => array(
          $config
            ->get('bindpw'),
        ),
      ),
      '#description' => $this
        ->t('Leave this blank to bind anonymously'),
    );
    $form['directory']['basedn'] = array(
      '#type' => 'textfield',
      '#title' => t('Base DN'),
      '#default_value' => $config
        ->get('basedn'),
      '#description' => t('Leave this blank to attempt to detect the base DN.'),
    );
    $form['directory']['pagesize'] = array(
      '#type' => 'textfield',
      '#title' => t('Search result page size'),
      '#default_value' => $config
        ->get('pagesize'),
      '#description' => $this
        ->t('Leave this blank to disable paged queries.'),
    );

    // Advanced settings.
    $form['advanced'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('Advanced'),
      '#open' => FALSE,
    );
    $form['advanced']['opt_referrals'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Follow LDAP referrals'),
      '#default_value' => $config
        ->get('opt_referrals'),
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->configFactory()
      ->getEditable('simple_ldap.server');
    $config
      ->set('host', $form_state
      ->getValue('host'))
      ->set('port', $form_state
      ->getValue('port'))
      ->set('encryption', $form_state
      ->getValue('encryption'))
      ->set('readonly', $form_state
      ->getValue('readonly'))
      ->set('binddn', $form_state
      ->getValue('binddn'))
      ->set('bindpw', $form_state
      ->getValue('bindpw'))
      ->set('basedn', $form_state
      ->getValue('basedn'))
      ->set('opt_referrals', $form_state
      ->getValue('opt_referrals'))
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * Helper function that returns a message about the status of the connection.
   */
  protected function getBindStatus() {
    $config = $this
      ->config('simple_ldap.server');
    $host = $config
      ->get('host');
    if (!empty($host)) {
      $server = \Drupal::service('simple_ldap.server');
      $server
        ->connect();
      if ($server
        ->bind()) {
        $status = $this
          ->t("Successfully binded to @host.", array(
          '@host' => $host,
        ));
      }
      else {
        $status = $this
          ->t("Could not bind to @host. Please check your settings below.", array(
          '@host' => $host,
        ));
      }
    }
    else {
      $status = 'Not connected.';
    }
    return $status;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 13
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
SimpleLdapServerSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SimpleLdapServerSettingsForm::getBindStatus protected function Helper function that returns a message about the status of the connection.
SimpleLdapServerSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SimpleLdapServerSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SimpleLdapServerSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.