public function Page::buildOptionsForm in Views (for Drupal 7) 8.3

Provide the default form for setting options.

Overrides DisplayPluginBase::buildOptionsForm

1 call to Page::buildOptionsForm()

Feed::buildOptionsForm in lib/Drupal/views/Plugin/views/display/Feed.php

Provide the default form for setting options.

1 method overrides Page::buildOptionsForm()

Feed::buildOptionsForm in lib/Drupal/views/Plugin/views/display/Feed.php

Provide the default form for setting options.

File

lib/Drupal/views/Plugin/views/display/Page.php, line 324

Definition of Drupal\views\Plugin\views\display\Page.

Class

Page

The plugin that handles a full page.

Namespace

Drupal\views\Plugin\views\display

Code

public function buildOptionsForm(&$form, &$form_state) {

  // It is very important to call the parent function here:
  parent::buildOptionsForm($form, $form_state);
  switch ($form_state['section']) {
    case 'path':
      $form['#title'] .= t('The menu path or URL of this view');
      $form['path'] = array(
        '#type' => 'textfield',
        '#description' => t('This view will be displayed by visiting this path on your site. You may use "%" in your URL to represent values that will be used for contextual filters: For example, "node/%/feed".'),
        '#default_value' => $this
          ->getOption('path'),
        '#field_prefix' => '<span dir="ltr">' . url(NULL, array(
          'absolute' => TRUE,
        )),
        '#field_suffix' => '</span>&lrm;',
        '#attributes' => array(
          'dir' => 'ltr',
        ),
      );
      break;
    case 'menu':
      $form['#title'] .= t('Menu item entry');
      $form['menu'] = array(
        '#prefix' => '<div class="clearfix">',
        '#suffix' => '</div>',
        '#tree' => TRUE,
      );
      $menu = $this
        ->getOption('menu');
      if (empty($menu)) {
        $menu = array(
          'type' => 'none',
          'title' => '',
          'weight' => 0,
        );
      }
      $form['menu']['type'] = array(
        '#prefix' => '<div class="views-left-30">',
        '#suffix' => '</div>',
        '#title' => t('Type'),
        '#type' => 'radios',
        '#options' => array(
          'none' => t('No menu entry'),
          'normal' => t('Normal menu entry'),
          'tab' => t('Menu tab'),
          'default tab' => t('Default menu tab'),
        ),
        '#default_value' => $menu['type'],
      );
      $form['menu']['title'] = array(
        '#prefix' => '<div class="views-left-50">',
        '#title' => t('Title'),
        '#type' => 'textfield',
        '#default_value' => $menu['title'],
        '#description' => t('If set to normal or tab, enter the text to use for the menu item.'),
        '#states' => array(
          'visible' => array(
            array(
              ':input[name="menu[type]"]' => array(
                'value' => 'normal',
              ),
            ),
            array(
              ':input[name="menu[type]"]' => array(
                'value' => 'tab',
              ),
            ),
            array(
              ':input[name="menu[type]"]' => array(
                'value' => 'default tab',
              ),
            ),
          ),
        ),
      );
      $form['menu']['description'] = array(
        '#title' => t('Description'),
        '#type' => 'textfield',
        '#default_value' => $menu['description'],
        '#description' => t("If set to normal or tab, enter the text to use for the menu item's description."),
        '#states' => array(
          'visible' => array(
            array(
              ':input[name="menu[type]"]' => array(
                'value' => 'normal',
              ),
            ),
            array(
              ':input[name="menu[type]"]' => array(
                'value' => 'tab',
              ),
            ),
            array(
              ':input[name="menu[type]"]' => array(
                'value' => 'default tab',
              ),
            ),
          ),
        ),
      );

      // Only display the menu selector if menu module is enabled.
      if (module_exists('menu')) {
        $form['menu']['name'] = array(
          '#title' => t('Menu'),
          '#type' => 'select',
          '#options' => menu_get_menus(),
          '#default_value' => $menu['name'],
          '#description' => t('Insert item into an available menu.'),
          '#states' => array(
            'visible' => array(
              array(
                ':input[name="menu[type]"]' => array(
                  'value' => 'normal',
                ),
              ),
              array(
                ':input[name="menu[type]"]' => array(
                  'value' => 'tab',
                ),
              ),
            ),
          ),
        );
      }
      else {
        $form['menu']['name'] = array(
          '#type' => 'value',
          '#value' => $menu['name'],
        );
        $form['menu']['markup'] = array(
          '#markup' => t('Menu selection requires the activation of menu module.'),
        );
      }
      $form['menu']['weight'] = array(
        '#title' => t('Weight'),
        '#type' => 'textfield',
        '#default_value' => isset($menu['weight']) ? $menu['weight'] : 0,
        '#description' => t('The lower the weight the higher/further left it will appear.'),
        '#states' => array(
          'visible' => array(
            array(
              ':input[name="menu[type]"]' => array(
                'value' => 'normal',
              ),
            ),
            array(
              ':input[name="menu[type]"]' => array(
                'value' => 'tab',
              ),
            ),
            array(
              ':input[name="menu[type]"]' => array(
                'value' => 'default tab',
              ),
            ),
          ),
        ),
      );
      $form['menu']['context'] = array(
        '#title' => t('Context'),
        '#suffix' => '</div>',
        '#type' => 'checkbox',
        '#default_value' => !empty($menu['context']),
        '#description' => t('Displays the link in contextual links'),
        '#states' => array(
          'visible' => array(
            ':input[name="menu[type]"]' => array(
              'value' => 'tab',
            ),
          ),
        ),
      );
      break;
    case 'tab_options':
      $form['#title'] .= t('Default tab options');
      $tab_options = $this
        ->getOption('tab_options');
      if (empty($tab_options)) {
        $tab_options = array(
          'type' => 'none',
          'title' => '',
          'weight' => 0,
        );
      }
      $form['tab_markup'] = array(
        '#markup' => '<div class="form-item description">' . t('When providing a menu item as a tab, Drupal needs to know what the parent menu item 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 item 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'] = array(
        '#prefix' => '<div class="clearfix">',
        '#suffix' => '</div>',
        '#tree' => TRUE,
      );
      $form['tab_options']['type'] = array(
        '#prefix' => '<div class="views-left-25">',
        '#suffix' => '</div>',
        '#title' => t('Parent menu item'),
        '#type' => 'radios',
        '#options' => array(
          'none' => t('Already exists'),
          'normal' => t('Normal menu item'),
          'tab' => t('Menu tab'),
        ),
        '#default_value' => $tab_options['type'],
      );
      $form['tab_options']['title'] = array(
        '#prefix' => '<div class="views-left-75">',
        '#title' => t('Title'),
        '#type' => 'textfield',
        '#default_value' => $tab_options['title'],
        '#description' => t('If creating a parent menu item, enter the title of the item.'),
        '#states' => array(
          'visible' => array(
            array(
              ':input[name="tab_options[type]"]' => array(
                'value' => 'normal',
              ),
            ),
            array(
              ':input[name="tab_options[type]"]' => array(
                'value' => 'tab',
              ),
            ),
          ),
        ),
      );
      $form['tab_options']['description'] = array(
        '#title' => t('Description'),
        '#type' => 'textfield',
        '#default_value' => $tab_options['description'],
        '#description' => t('If creating a parent menu item, enter the description of the item.'),
        '#states' => array(
          'visible' => array(
            array(
              ':input[name="tab_options[type]"]' => array(
                'value' => 'normal',
              ),
            ),
            array(
              ':input[name="tab_options[type]"]' => array(
                'value' => 'tab',
              ),
            ),
          ),
        ),
      );

      // Only display the menu selector if menu module is enabled.
      if (module_exists('menu')) {
        $form['tab_options']['name'] = array(
          '#title' => t('Menu'),
          '#type' => 'select',
          '#options' => menu_get_menus(),
          '#default_value' => $tab_options['name'],
          '#description' => t('Insert item into an available menu.'),
          '#states' => array(
            'visible' => array(
              ':input[name="tab_options[type]"]' => array(
                'value' => 'normal',
              ),
            ),
          ),
        );
      }
      else {
        $form['tab_options']['name'] = array(
          '#type' => 'value',
          '#value' => $tab_options['name'],
        );
        $form['tab_options']['markup'] = array(
          '#markup' => t('Menu selection requires the activation of menu module.'),
        );
      }
      $form['tab_options']['weight'] = array(
        '#suffix' => '</div>',
        '#title' => t('Tab weight'),
        '#type' => 'textfield',
        '#default_value' => $tab_options['weight'],
        '#size' => 5,
        '#description' => t('If the parent menu item is a tab, enter the weight of the tab. The lower the number, the more to the left it will be.'),
        '#states' => array(
          'visible' => array(
            ':input[name="tab_options[type]"]' => array(
              'value' => 'tab',
            ),
          ),
        ),
      );
      break;
  }
}