You are here

Home » API reference » Redirect 8 » RedirectDomainForm.php

class RedirectDomainForm in Redirect 8

Provides a redirect domain configuration form.

Hierarchy

Expanded class hierarchy of RedirectDomainForm

1 string reference to 'RedirectDomainForm'
redirect_domain.routing.yml in modules/redirect_domain/redirect_domain.routing.yml
modules/redirect_domain/redirect_domain.routing.yml

File

modules/redirect_domain/src/Form/RedirectDomainForm.php, line 11

Namespace

Drupal\redirect_domain\Form
View source 
class RedirectDomainForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    if (!$form_state
      ->has('maximum_domains')) {
      $form_state
        ->set('maximum_domains', 1);
    }
    $form['redirects'] = [
      '#type' => 'table',
      '#tree' => TRUE,
      '#header' => [
        $this
          ->t('From domain'),
        $this
          ->t('Sub path'),
        $this
          ->t('Destination'),
      ],
      '#prefix' => '<div id="redirect-domain-wrapper">',
      '#suffix' => '</div>',
    ];
    $rows = [];

    // Obtain domain redirects from configuration.
    if ($domain_redirects = $this
      ->config('redirect_domain.domains')
      ->get('domain_redirects')) {
      foreach ($domain_redirects as $key => $value) {
        foreach ($value as $item) {
          $form['redirects'][] = [
            'from' => [
              '#type' => 'textfield',
              '#value' => str_replace(':', '.', $key),
            ],
            'sub_path' => [
              '#type' => 'textfield',
              '#value' => $item['sub_path'],
            ],
            'destination' => [
              '#type' => 'textfield',
              '#value' => $item['destination'],
            ],
          ];
        }
      }
    }

    // Fields for the new domain redirects.
    for ($i = 0; $i < $form_state
      ->get('maximum_domains'); $i++) {
      $form['redirects'][] = [
        'from' => [
          '#type' => 'textfield',
        ],
        'sub_path' => [
          '#type' => 'textfield',
          '#value' => '/',
        ],
        'destination' => [
          '#type' => 'textfield',
        ],
      ];
    }
    $form['add'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Add another'),
      '#submit' => [
        '::addAnotherSubmit',
      ],
      '#ajax' => [
        'callback' => '::ajaxAddAnother',
        'wrapper' => 'redirect-domain-wrapper',
      ],
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#button_type' => 'primary',
      '#value' => $this
        ->t('Save'),
    ];
    return $form;
  }

  /**
   * Ajax callback for adding another domain redirect.
   *
   * @param array $form
   *   The form structure.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   *
   * @return array
   *   The new domain redirect form part.
   */
  public function ajaxAddAnother(array $form, FormStateInterface $form_state) {
    return $form['redirects'];
  }

  /**
   * Submit callback for adding a new domain field.
   */
  public function addAnotherSubmit(array $form, FormStateInterface $form_state) {
    $form_state
      ->set('maximum_domains', $form_state
      ->get('maximum_domains') + 1);
    $form_state
      ->setRebuild(TRUE);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    if ($redirects = $form_state
      ->getValue('redirects')) {
      foreach ($redirects as $redirect) {
        if (strpos($redirect['from'], '://') !== FALSE) {
          $form_state
            ->setErrorByName('redirects', $this
            ->t('No protocol should be included in the redirect domain.'));
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $domain_redirects = [];
    $domain_config = $this
      ->config('redirect_domain.domains');
    if ($redirects = $form_state
      ->getValue('redirects')) {
      foreach ($redirects as $redirect) {
        if (!empty($redirect['from']) && !empty($redirect['destination'])) {

          // Replace '.' with ':' for an eligible key.
          // @see \Drupal\redirect_domain\EventSubscriber\DomainRedirectRequestSubscriber::onKernelRequestCheckDomainRedirect()
          $redirect['from'] = str_replace('.', ':', $redirect['from']);
          $domain_redirects[$redirect['from']][] = [
            'sub_path' => '/' . ltrim($redirect['sub_path'], '/'),
            'destination' => $redirect['destination'],
          ];
        }
      }
    }
    $domain_config
      ->set('domain_redirects', $domain_redirects);
    $domain_config
      ->save();
    $this
      ->messenger()
      ->addMessage($this
      ->t('The domain redirects have been saved.'));
  }

}

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.
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.
RedirectDomainForm::addAnotherSubmit public function Submit callback for adding a new domain field.
RedirectDomainForm::ajaxAddAnother public function Ajax callback for adding another domain redirect.
RedirectDomainForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
RedirectDomainForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
RedirectDomainForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
RedirectDomainForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
RedirectDomainForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.