1 views_plugin_display_page.inc views_plugin_display_page::options_form(&$form, &$form_state)

Provide the default form for setting options.

Overrides views_plugin_display::options_form

File

core/modules/views/plugins/views_plugin_display_page.inc, line 304
Contains the page display plugin.

Class

views_plugin_display_page
The plugin that handles a full page.

Code

function options_form(&$form, &$form_state) {
  // It is very important to call the parent function here:
  parent::options_form($form, $form_state);

  switch ($form_state['section']) {
    case 'path':
      $form['#title'] .= t('The menu path or URL of this view');
      $form['#help_topic'] = 'path';
      $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->get_option('path'),
        '#field_prefix' => '<span dir="ltr">' . url(NULL, array('absolute' => TRUE)) . (config_get('system.core', 'clean_url') ? '' : '?q='),
        '#field_suffix' => '</span>&lrm;',
        '#attributes' => array('dir' => 'ltr'),
      );
      break;
    case 'menu':
      $form['#title'] .= t('Menu item entry');
      $form['#help_topic'] = 'menu';
      $form['menu'] = array(
        '#prefix' => '<div class="clearfix">',
        '#suffix' => '</div>',
        '#tree' => TRUE,
      );
      $menu = $this->get_option('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' => 'number',
        '#default_value' => isset($menu['weight']) ? $menu['weight'] : 0,
        '#description' => t('This number sets the order of the menu item or tab, with lower weights coming first. Negative values are allowed.'),
        '#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'),
        '#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'),
          ),
        ),
      );
      $form['menu']['context_only_inline'] = array(
        '#title' => t('Hide menu tab'),
        '#suffix' => '</div>',
        '#type' => 'checkbox',
        '#default_value' => !empty($menu['context_only_inline']),
        '#description' => t('Only display menu item entry in contextual links. Menu tab should not be displayed.'),
        '#states' => array(
          'visible' => array(
            ':input[name="menu[type]"]' => array('value' => 'tab'),
            ':input[name="menu[context]"]' => array('checked' => TRUE),
          ),
        ),
      );
      break;
    case 'tab_options':
      $form['#title'] .= t('Default tab options');
      $tab_options = $this->get_option('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, Backdrop 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('Item weight'),
        '#type' => 'textfield',
        '#default_value' => $tab_options['weight'],
        '#size' => 5,
        '#description' => t('Enter the weight of the menu item or tab. The lower the number, the earlier in the list it will be.'),
        '#states' => array(
          'visible' => array(
            array(
              ':input[name="menu[parent][type]"]' => array('value' => 'normal'),
            ),
            array(
              ':input[name="menu[parent][type]"]' => array('value' => 'tab'),
            ),
            array(
              ':input[name="menu[parent][type]"]' => array('value' => 'default tab'),
            ),
          ),
        ),
      );
      break;
  }
}