You are here

function views_content_plugin_display_panel_pane::options_form in Chaos Tool Suite (ctools) 6

Same name and namespace in other branches
  1. 7 views_content/plugins/views/views_content_plugin_display_panel_pane.inc \views_content_plugin_display_panel_pane::options_form()

Provide the default form for setting options.

File

views_content/plugins/views/views_content_plugin_display_panel_pane.inc, line 146

Class

views_content_plugin_display_panel_pane
The plugin that handles a panel_pane.

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 'allow':
      $form['#title'] .= t('Allow settings');
      $form['description'] = array(
        '#value' => '<div class="form-item description">' . t('Checked settings will be available in the panel pane config dialog for modification by the panels user. Unchecked settings will not be available and will only use the settings in this display.') . '</div>',
      );
      $options = array(
        'use_pager' => t('Use pager'),
        'items_per_page' => t('Items per page'),
        'offset' => t('Pager offset'),
        'link_to_view' => t('Link to view'),
        'more_link' => t('More link'),
        'path_override' => t('Path override'),
        'title_override' => t('Title override'),
        'exposed_form' => t('Use exposed widgets form as pane configuration'),
        'fields_override' => t('Fields override'),
      );
      $allow = array_filter($this
        ->get_option('allow'));
      $form['allow'] = array(
        '#type' => 'checkboxes',
        '#default_value' => $allow,
        '#options' => $options,
      );
      break;
    case 'pane_title':
      $form['#title'] .= t('Administrative title');
      $form['pane_title'] = array(
        '#type' => 'textfield',
        '#default_value' => $this
          ->get_option('pane_title'),
        '#description' => t('This is the title that will appear for this view pane in the add content dialog. If left blank, the view name will be used.'),
      );
      break;
    case 'pane_description':
      $form['#title'] .= t('Administrative description');
      $form['pane_description'] = array(
        '#type' => 'textfield',
        '#default_value' => $this
          ->get_option('pane_description'),
        '#description' => t('This is text that will be displayed when the user mouses over the pane in the add content dialog. If blank the view description will be used.'),
      );
      break;
    case 'pane_category':
      $form['#title'] .= t('Administrative description');
      $cat = $this
        ->get_option('pane_category');
      $form['pane_category']['#tree'] = TRUE;
      $form['pane_category']['name'] = array(
        '#type' => 'textfield',
        '#default_value' => $cat['name'],
        '#description' => t('This is category the pane will appear in on the add content dialog.'),
      );
      $form['pane_category']['weight'] = array(
        '#title' => t('Weight'),
        '#type' => 'textfield',
        '#default_value' => $cat['weight'],
        '#description' => t('This is the default weight of the category. Note that if the weight of a category is defined in multiple places, only the first one Panels sees will get that definition, so if the weight does not appear to be working, check other places that the weight might be set.'),
      );
      break;
    case 'link_to_view':
      $form['#title'] .= t('Link pane title to view');
      $form['link_to_view'] = array(
        '#type' => 'select',
        '#options' => array(
          1 => t('Yes'),
          0 => t('No'),
        ),
        '#default_value' => $this
          ->get_option('link_to_view'),
      );
      break;
    case 'inherit_panels_path':
      $form['#title'] .= t('Inherit path from panel display');
      $form['inherit_panels_path'] = array(
        '#type' => 'select',
        '#options' => array(
          1 => t('Yes'),
          0 => t('No'),
        ),
        '#default_value' => $this
          ->get_option('inherit_panels_path'),
        '#description' => t('If yes, all links generated by Views, such as more links, summary links, and exposed input links will go to the panels display path, not the view, if the display has a path.'),
      );
      break;
    case 'argument_input':
      $form['#title'] .= t('Choose the data source for view arguments');
      $argument_input = $this
        ->get_argument_input();
      ctools_include('context');
      $form['argument_input']['#tree'] = TRUE;
      foreach ($argument_input as $id => $argument) {
        $form['argument_input'][$id] = array(
          '#tree' => TRUE,
        );
        $safe = str_replace(array(
          '][',
          '_',
          ' ',
        ), '-', $id);
        $type_id = 'edit-argument-input-' . $safe;
        $form['argument_input'][$id]['type'] = array(
          '#type' => 'select',
          '#options' => array(
            'none' => t('No argument'),
            'wildcard' => t('Argument wildcard'),
            'context' => t('From context'),
            'panel' => t('From panel argument'),
            'fixed' => t('Fixed'),
            'user' => t('Input on pane config'),
          ),
          '#id' => $type_id,
          '#title' => t('@arg source', array(
            '@arg' => $argument['name'],
          )),
          '#default_value' => $argument['type'],
        );
        $form['argument_input'][$id]['context'] = array(
          '#type' => 'select',
          '#title' => t('Required context'),
          '#description' => t('If "From context" is selected, which type of context to use.'),
          '#default_value' => $argument['context'],
          '#options' => ctools_context_get_all_converters(),
          '#process' => array(
            'views_process_dependency',
          ),
          '#dependency' => array(
            $type_id => array(
              'context',
            ),
          ),
        );
        $form['argument_input'][$id]['context_optional'] = array(
          '#type' => 'checkbox',
          '#title' => t('Context is optional'),
          '#description' => t('This context need not be present for the pane to function. If you plan to use this, ensure that the argument handler can handle empty values gracefully.'),
          '#default_value' => $argument['context_optional'],
          '#process' => array(
            'views_process_dependency',
          ),
          '#dependency' => array(
            $type_id => array(
              'context',
            ),
          ),
        );
        $form['argument_input'][$id]['panel'] = array(
          '#type' => 'select',
          '#title' => t('Panel argument'),
          '#description' => t('If "From panel argument" is selected, which panel argument to use.'),
          '#default_value' => $argument['panel'],
          '#options' => array(
            0 => t('First'),
            1 => t('Second'),
            2 => t('Third'),
            3 => t('Fourth'),
            4 => t('Fifth'),
            5 => t('Sixth'),
          ),
          '#process' => array(
            'views_process_dependency',
          ),
          '#dependency' => array(
            $type_id => array(
              'panel',
            ),
          ),
        );
        $form['argument_input'][$id]['fixed'] = array(
          '#type' => 'textfield',
          '#title' => t('Fixed argument'),
          '#description' => t('If "Fixed" is selected, what to use as an argument.'),
          '#default_value' => $argument['fixed'],
          '#process' => array(
            'views_process_dependency',
          ),
          '#dependency' => array(
            $type_id => array(
              'fixed',
            ),
          ),
        );
        $form['argument_input'][$id]['label'] = array(
          '#type' => 'textfield',
          '#title' => t('Label'),
          '#description' => t('If this argument is presented to the panels user, what label to apply to it.'),
          '#default_value' => empty($argument['label']) ? $argument['name'] : $argument['label'],
          '#process' => array(
            'views_process_dependency',
          ),
          '#dependency' => array(
            $type_id => array(
              'user',
            ),
          ),
        );
      }
      break;
  }
}