public function Page::buildOptionsForm in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/views/src/Plugin/views/display/Page.php \Drupal\views\Plugin\views\display\Page::buildOptionsForm()

Provide a form to edit options for this plugin.

Overrides PathPluginBase::buildOptionsForm

File

core/modules/views/src/Plugin/views/display/Page.php, line 256

Class

Page

The plugin that handles a full page.

Namespace

Drupal\views\Plugin\views\display

Code

public function buildOptionsForm(&$form, FormStateInterface $form_state) {
  parent::buildOptionsForm($form, $form_state);
  switch ($form_state
    ->get('section')) {
    case 'menu':
      $form['#title'] .= $this
        ->t('Menu link entry');
      $form['menu'] = [
        '#prefix' => '<div class="clearfix">',
        '#suffix' => '</div>',
        '#tree' => TRUE,
      ];
      $menu = $this
        ->getOption('menu');
      if (empty($menu)) {
        $menu = [
          'type' => 'none',
          'title' => '',
          'weight' => 0,
          'expanded' => FALSE,
        ];
      }
      $form['menu']['type'] = [
        '#prefix' => '<div class="views-left-30">',
        '#suffix' => '</div>',
        '#title' => $this
          ->t('Type'),
        '#type' => 'radios',
        '#options' => [
          'none' => $this
            ->t('No menu entry'),
          'normal' => $this
            ->t('Normal menu entry'),
          'tab' => $this
            ->t('Menu tab'),
          'default tab' => $this
            ->t('Default menu tab'),
        ],
        '#default_value' => $menu['type'],
      ];
      $form['menu']['title'] = [
        '#prefix' => '<div class="views-left-50">',
        '#title' => $this
          ->t('Menu link title'),
        '#type' => 'textfield',
        '#default_value' => $menu['title'],
        '#states' => [
          'visible' => [
            [
              ':input[name="menu[type]"]' => [
                'value' => 'normal',
              ],
            ],
            [
              ':input[name="menu[type]"]' => [
                'value' => 'tab',
              ],
            ],
            [
              ':input[name="menu[type]"]' => [
                'value' => 'default tab',
              ],
            ],
          ],
        ],
      ];
      $form['menu']['description'] = [
        '#title' => $this
          ->t('Description'),
        '#type' => 'textfield',
        '#default_value' => $menu['description'],
        '#description' => $this
          ->t("Shown when hovering over the menu link."),
        '#states' => [
          'visible' => [
            [
              ':input[name="menu[type]"]' => [
                'value' => 'normal',
              ],
            ],
            [
              ':input[name="menu[type]"]' => [
                'value' => 'tab',
              ],
            ],
            [
              ':input[name="menu[type]"]' => [
                'value' => 'default tab',
              ],
            ],
          ],
        ],
      ];
      $form['menu']['expanded'] = [
        '#title' => $this
          ->t('Show as expanded'),
        '#type' => 'checkbox',
        '#default_value' => !empty($menu['expanded']),
        '#description' => $this
          ->t('If selected and this menu link has children, the menu will always appear expanded.'),
      ];
      $menu_parent = $menu['menu_name'] . ':' . $menu['parent'];
      $menu_link = 'views_view:views.' . $form_state
        ->get('view')
        ->id() . '.' . $form_state
        ->get('display_id');
      $form['menu']['parent'] = $this->parentFormSelector
        ->parentSelectElement($menu_parent, $menu_link);
      $form['menu']['parent'] += [
        '#title' => $this
          ->t('Parent'),
        '#description' => $this
          ->t('The maximum depth for a link and all its children is fixed. Some menu links may not be available as parents if selecting them would exceed this limit.'),
        '#attributes' => [
          'class' => [
            'menu-title-select',
          ],
        ],
        '#states' => [
          'visible' => [
            [
              ':input[name="menu[type]"]' => [
                'value' => 'normal',
              ],
            ],
            [
              ':input[name="menu[type]"]' => [
                'value' => 'tab',
              ],
            ],
          ],
        ],
      ];
      $form['menu']['weight'] = [
        '#title' => $this
          ->t('Weight'),
        '#type' => 'textfield',
        '#default_value' => isset($menu['weight']) ? $menu['weight'] : 0,
        '#description' => $this
          ->t('In the menu, the heavier links will sink and the lighter links will be positioned nearer the top.'),
        '#states' => [
          'visible' => [
            [
              ':input[name="menu[type]"]' => [
                'value' => 'normal',
              ],
            ],
            [
              ':input[name="menu[type]"]' => [
                'value' => 'tab',
              ],
            ],
            [
              ':input[name="menu[type]"]' => [
                'value' => 'default tab',
              ],
            ],
          ],
        ],
      ];
      $form['menu']['context'] = [
        '#title' => $this
          ->t('Context'),
        '#suffix' => '</div>',
        '#type' => 'checkbox',
        '#default_value' => !empty($menu['context']),
        '#description' => $this
          ->t('Displays the link in contextual links'),
        '#states' => [
          'visible' => [
            ':input[name="menu[type]"]' => [
              'value' => 'tab',
            ],
          ],
        ],
      ];
      break;
    case 'tab_options':
      $form['#title'] .= $this
        ->t('Default tab options');
      $tab_options = $this
        ->getOption('tab_options');
      if (empty($tab_options)) {
        $tab_options = [
          'type' => 'none',
          'title' => '',
          'weight' => 0,
        ];
      }
      $form['tab_markup'] = [
        '#markup' => '<div class="js-form-item form-item description">' . $this
          ->t('When providing a menu link as a tab, Drupal needs to know what the parent menu link of that tab will be. Sometimes the parent will already exist, but other times you will need to have one created. The path of a parent link will always be the same path with the last part left off. i.e, if the path to this view is <em>foo/bar/baz</em>, the parent path would be <em>foo/bar</em>.') . '</div>',
      ];
      $form['tab_options'] = [
        '#prefix' => '<div class="clearfix">',
        '#suffix' => '</div>',
        '#tree' => TRUE,
      ];
      $form['tab_options']['type'] = [
        '#prefix' => '<div class="views-left-25">',
        '#suffix' => '</div>',
        '#title' => $this
          ->t('Parent menu link'),
        '#type' => 'radios',
        '#options' => [
          'none' => $this
            ->t('Already exists'),
          'normal' => $this
            ->t('Normal menu link'),
          'tab' => $this
            ->t('Menu tab'),
        ],
        '#default_value' => $tab_options['type'],
      ];
      $form['tab_options']['title'] = [
        '#prefix' => '<div class="views-left-75">',
        '#title' => $this
          ->t('Title'),
        '#type' => 'textfield',
        '#default_value' => $tab_options['title'],
        '#description' => $this
          ->t('If creating a parent menu link, enter the title of the link.'),
        '#states' => [
          'visible' => [
            [
              ':input[name="tab_options[type]"]' => [
                'value' => 'normal',
              ],
            ],
            [
              ':input[name="tab_options[type]"]' => [
                'value' => 'tab',
              ],
            ],
          ],
        ],
      ];
      $form['tab_options']['description'] = [
        '#title' => $this
          ->t('Description'),
        '#type' => 'textfield',
        '#default_value' => $tab_options['description'],
        '#description' => $this
          ->t('If creating a parent menu link, enter the description of the link.'),
        '#states' => [
          'visible' => [
            [
              ':input[name="tab_options[type]"]' => [
                'value' => 'normal',
              ],
            ],
            [
              ':input[name="tab_options[type]"]' => [
                'value' => 'tab',
              ],
            ],
          ],
        ],
      ];
      $form['tab_options']['weight'] = [
        '#suffix' => '</div>',
        '#title' => $this
          ->t('Tab weight'),
        '#type' => 'textfield',
        '#default_value' => $tab_options['weight'],
        '#size' => 5,
        '#description' => $this
          ->t('If the parent menu link is a tab, enter the weight of the tab. Heavier tabs will sink and the lighter tabs will be positioned nearer to the first menu link.'),
        '#states' => [
          'visible' => [
            ':input[name="tab_options[type]"]' => [
              'value' => 'tab',
            ],
          ],
        ],
      ];
      break;
  }
}