public function PagerFields::buildConfigurationForm in Views Slideshow 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 ViewsSlideshowWidgetBase::buildConfigurationForm

File

src/Plugin/ViewsSlideshowWidget/PagerFields.php, line 32

Class

PagerFields

Provides a pager using fields.

Namespace

Drupal\views_slideshow\Plugin\ViewsSlideshowWidget

Code

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

  // Settings for fields pager.
  $options = [];

  // Get each field and it's name.
  foreach ($this
    ->getConfiguration()['view']->display_handler
    ->getHandlers('field') as $field_name => $field) {
    $options[$field_name] = $field
      ->adminLabel();
  }

  // Need to wrap this so it indents correctly.
  $form['views_slideshow_pager_fields_wrapper'] = [
    '#markup' => '<div class="vs-dependent">',
  ];

  // Add ability to choose which fields to show in the pager.
  $form['views_slideshow_pager_fields_fields'] = [
    '#type' => 'checkboxes',
    '#title' => $this
      ->t('Pager fields'),
    '#options' => $options,
    '#default_value' => $this
      ->getConfiguration()['views_slideshow_pager_fields_fields'],
    '#description' => $this
      ->t('Choose the fields that will appear in the pager.'),
    '#states' => [
      'visible' => [
        ':input[name="' . $this
          ->getConfiguration()['dependency'] . '[enable]"]' => [
          'checked' => TRUE,
        ],
        ':input[name="' . $this
          ->getConfiguration()['dependency'] . '[type]"]' => [
          'value' => 'views_slideshow_pager_fields',
        ],
      ],
    ],
  ];

  // Add field to see if they would like to activate slide and pause on pager
  // hover.
  $form['views_slideshow_pager_fields_hover'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Activate Slide and Pause on Pager Hover'),
    '#default_value' => $this
      ->getConfiguration()['views_slideshow_pager_fields_hover'],
    '#description' => $this
      ->t('Should the slide be activated and paused when hovering over a pager item.'),
    '#states' => [
      'visible' => [
        ':input[name="' . $this
          ->getConfiguration()['dependency'] . '[enable]"]' => [
          'checked' => TRUE,
        ],
        ':input[name="' . $this
          ->getConfiguration()['dependency'] . '[type]"]' => [
          'value' => 'views_slideshow_pager_fields',
        ],
      ],
    ],
  ];
  $form['views_slideshow_pager_fields_wrapper_close'] = [
    '#markup' => '</div>',
  ];
  return $form;
}