public function HttpStatusCodeDisplayVariant::buildConfigurationForm in Page Manager 8

Same name and namespace in other branches

1. 8.4 src/Plugin/DisplayVariant/HttpStatusCodeDisplayVariant.php \Drupal\page_manager\Plugin\DisplayVariant\HttpStatusCodeDisplayVariant::buildConfigurationForm()

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 VariantBase::buildConfigurationForm

File

src/Plugin/DisplayVariant/HttpStatusCodeDisplayVariant.php, line 28

Contains \Drupal\page_manager\Plugin\DisplayVariant\HttpStatusCodeDisplayVariant.

Class

HttpStatusCodeDisplayVariant

Provides a variant that returns a response with an HTTP status code.

Namespace

Drupal\page_manager\Plugin\DisplayVariant

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {

  // Don't call VariantBase::buildConfigurationForm() on purpose, because it
  // adds a 'Label' field that we don't actually want to use - we store the
  // label on the page variant entity.

  //$form = parent::buildConfigurationForm($form, $form_state);

  // Get all possible status codes defined by Symfony.
  $options = Response::$statusTexts;

  // Move 403/404/500 to the top.
  $options = [
    '404' => $options['404'],
    '403' => $options['403'],
    '500' => $options['500'],
  ] + $options;

  // Add the HTTP status code, so it's easier for people to find it.
  array_walk($options, function ($title, $code) use (&$options) {
    $options[$code] = $this
      ->t('@code (@title)', [
      '@code' => $code,
      '@title' => $title,
    ]);
  });
  $form['status_code'] = [
    '#title' => $this
      ->t('HTTP status code'),
    '#type' => 'select',
    '#default_value' => $this->configuration['status_code'],
    '#options' => $options,
  ];
  return $form;
}