You are here

public function LanguageCookieConditionBlacklistedPaths::buildConfigurationForm in Language Cookie 8

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and #array_parents, see \Drupal\Core\Render\Element\FormElement.

Parameters

array $form: An associative array containing the initial structure of the plugin form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

Return value

array The form structure.

Overrides ConditionPluginBase::buildConfigurationForm

File

src/Plugin/LanguageCookieCondition/LanguageCookieConditionBlacklistedPaths.php, line 123

Class

LanguageCookieConditionBlacklistedPaths
Class for the Blacklisted paths condition plugin.

Namespace

Drupal\language_cookie\Plugin\LanguageCookieCondition

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form[$this
    ->getPluginId()] = [
    '#type' => 'textarea',
    '#default_value' => implode(PHP_EOL, (array) $this->configuration[$this
      ->getPluginId()]),
    '#size' => 10,
    '#description' => $this
      ->t('Specify on which paths the language cookie should be circumvented.') . '<br />' . $this
      ->t("Specify pages by using their paths. A path must start with <em>/</em>. Enter one path per line. The '*' character is a wildcard. Example paths are %blog for the blog page and %blog-wildcard for every personal blog. %front is the front page.", [
      '%blog' => '/blog',
      '%blog-wildcard' => '/blog/*',
      '%front' => '<front>',
    ]),
  ];
  return $form;
}