public function EntityPager::buildOptionsForm in Entity Pager 8

Same name and namespace in other branches

1. 2.0.x src/Plugin/views/style/EntityPager.php \Drupal\entity_pager\Plugin\views\style\EntityPager::buildOptionsForm()

Provide a form to edit options for this plugin.

Overrides StylePluginBase::buildOptionsForm

File

src/Plugin/views/style/EntityPager.php, line 104

Class

EntityPager

Style plugin to render a view for an Entity Pager.

Namespace

Drupal\entity_pager\Plugin\views\style

Code

public function buildOptionsForm(&$form, FormStateInterface $form_state) {
  parent::buildOptionsForm($form, $form_state);
  $relationship_options = $this
    ->getRelationshipOptions();
  if (!empty($relationship_options)) {
    $form['relationship'] = [
      '#title' => $this
        ->t('Relationship'),
      '#description' => $this
        ->t('Optionally, select a relationship to link to the related entity.'),
      '#type' => 'select',
      '#options' => $relationship_options,
      '#empty_option' => $this
        ->t('None'),
      '#default_value' => $this
        ->getOption('relationship'),
    ];
  }
  $form['link_next'] = [
    '#title' => $this
      ->t('Next label'),
    '#description' => $this
      ->t('The text to display for the Next link. HTML is allowed.'),
    '#type' => 'textfield',
    '#default_value' => $this
      ->getOption('link_next'),
    '#maxlength' => NULL,
  ];
  $form['link_prev'] = [
    '#title' => $this
      ->t('Previous label'),
    '#description' => $this
      ->t('The text to display for the Previous link. HTML is allowed.'),
    '#type' => 'textfield',
    '#default_value' => $this
      ->getOption('link_prev'),
    '#maxlength' => NULL,
  ];
  $form['display_all'] = [
    '#title' => $this
      ->t('Display All link'),
    '#description' => $this
      ->t('Display a link to the parent page of all results.'),
    '#type' => 'checkbox',
    '#default_value' => $this
      ->getOption('display_all'),
  ];
  $token_help = NULL;
  try {
    $token_help = Url::fromRoute('help.page.token')
      ->toString();
  } catch (RouteNotFoundException $e) {

    // Noop.
  }
  $example_list = [
    '#theme' => 'item_list',
    '#items' => [
      $this
        ->t('The URL of a Views listing page of the Entities.'),
      $this
        ->t('%front for the homepage', [
        '%front' => '<front>',
      ]),
      $token_help ? $this
        ->t('A <a href=":token_help">token</a> that relates to the Entity. (e.g. [node:edit-url]).', [
        ':token_help' => $token_help,
      ]) : $this
        ->t('A token that relates to the Entity. (e.g. [node:edit-url]).'),
      $this
        ->t('The token can also be an entity reference if the entity has one. (e.g. [node:field_company]).'),
    ],
  ];
  $examples = \Drupal::service('renderer')
    ->renderPlain($example_list);
  $form['link_all_url'] = [
    '#title' => $this
      ->t('All link URL'),
    '#description' => $this
      ->t('The URL of the listing page link. Examples:') . $examples,
    '#type' => 'textfield',
    '#default_value' => $this
      ->getOption('link_all_url'),
    '#maxlength' => NULL,
    '#states' => [
      'visible' => [
        ':input[name="style_options[display_all]"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['link_all_text'] = [
    '#title' => $this
      ->t('All link label'),
    '#description' => $this
      ->t('The label text to display for the List All link. When an entity reference is used in the <strong>List All URL</strong> box above, just add the same entity reference in this box and the referenced entity title will automatically be displayed. HTML is allowed.'),
    '#type' => 'textfield',
    '#default_value' => $this
      ->getOption('link_all_text'),
    '#maxlength' => NULL,
    '#states' => [
      'visible' => [
        ':input[name="style_options[display_all]"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];
  $form['display_count'] = [
    '#title' => $this
      ->t('Display count'),
    '#description' => $this
      ->t('Display the number of records (e.g. 5 of 8)'),
    '#type' => 'checkbox',
    '#default_value' => $this
      ->getOption('display_count'),
  ];
  $form['circular_paging'] = [
    '#title' => $this
      ->t('Circular paging'),
    '#description' => $this
      ->t('When the last item is active, link to first item and vice versa.'),
    '#type' => 'checkbox',
    '#default_value' => $this
      ->getOption('circular_paging'),
  ];
  $form['show_disabled_links'] = [
    '#title' => $this
      ->t('Show disabled links'),
    '#description' => $this
      ->t('Show disabled next/prev links when on the first or last page.'),
    '#type' => 'checkbox',
    '#default_value' => $this
      ->getOption('show_disabled_links'),
    '#states' => [
      'visible' => [
        ':input[name="style_options[circular_paging]"]' => [
          'checked' => FALSE,
        ],
      ],
    ],
  ];
  $form['log_performance'] = [
    '#title' => $this
      ->t('Log performance suggestions'),
    '#description' => $this
      ->t('Log performance suggestions to Watchdog, see: Reports > Recent log messages.'),
    '#type' => 'checkbox',
    '#default_value' => $this
      ->getOption('log_performance'),
  ];
}