public function PanelsEverywhereDisplayVariant::buildConfigurationForm in Panels Everywhere 8.4

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

File

src/Plugin/DisplayVariant/PanelsEverywhereDisplayVariant.php, line 114

Class

PanelsEverywhereDisplayVariant

Provides a display variant that simply contains blocks.

Namespace

Drupal\panels_everywhere\Plugin\DisplayVariant

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form = parent::buildConfigurationForm($form, $form_state);
  $form['route_override_enabled'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Enable page-manager route override'),
    '#default_value' => $this
      ->isRouteOverrideEnabled(),
    '#description' => $this
      ->t('The default behaviour of page-manager is create a route for the specified path and override any existing route (which effectively replaces that route). This behaviour is not desired for panels_everywhere as it prevents the original content of the route from being rendered properly. This is why panels_everywhere will remove those overrides by default. You may want do enable route overrides in cases you do not want the original route to be processed.'),
  ];
  return $form;
}