You are here

class views_content_plugin_display_ctools_context in Chaos Tool Suite (ctools) 7

Same name and namespace in other branches
  1. 6 views_content/plugins/views/views_content_plugin_display_ctools_context.inc \views_content_plugin_display_ctools_context

The plugin that handles a block.

Hierarchy

Expanded class hierarchy of views_content_plugin_display_ctools_context

1 string reference to 'views_content_plugin_display_ctools_context'
views_content_views_plugins in views_content/plugins/views/views_content.views.inc
Implements hook_views_plugins().

File

views_content/plugins/views/views_content_plugin_display_ctools_context.inc, line 13
Contains the block display plugin.

View source
class views_content_plugin_display_ctools_context extends views_plugin_display {

  /**
   * If this variable is true, this display counts as a context. We use this
   * variable so that we can easily build plugins against this display type.
   */
  public $context_display = TRUE;
  public function get_style_type() {
    return 'context';
  }
  public function defaultable_sections($section = NULL) {
    if (in_array($section, array(
      'style_options',
      'style_plugin',
      'row_options',
      'row_plugin',
    ))) {
      return FALSE;
    }
    return parent::defaultable_sections($section);
  }
  public function option_definition() {
    $options = parent::option_definition();
    $options['admin_title'] = array(
      'default' => '',
      'translatable' => TRUE,
    );

    // Overrides for standard stuff:
    $options['style_plugin']['default'] = 'ctools_context';
    $options['row_plugin']['default'] = 'fields';
    $options['defaults']['default']['style_plugin'] = FALSE;
    $options['defaults']['default']['style_options'] = FALSE;
    $options['defaults']['default']['row_plugin'] = FALSE;
    $options['defaults']['default']['row_options'] = FALSE;
    $options['inherit_panels_path'] = array(
      'default' => 0,
    );
    $options['argument_input'] = array(
      'default' => array(),
    );
    return $options;
  }

  /**
   * The display block handler returns the structure necessary for a block.
   */
  public function execute() {
    $this->executing = TRUE;
    return $this->view
      ->render();
  }
  public function preview() {
    $this->previewing = TRUE;
    return $this->view
      ->render();
  }

  /**
   * Render this display.
   */
  public function render() {
    if (!empty($this->previewing)) {
      return theme($this
        ->theme_functions(), array(
        'view' => $this->view,
      ));
    }
    else {

      // We want to process the view like we're theming it, but not actually
      // use the template part. Therefore we run through all the preprocess
      // functions which will populate the variables array.
      $hooks = theme_get_registry();
      $info = $hooks[$this->definition['theme']];
      if (!empty($info['file'])) {
        @(include_once './' . $info['path'] . '/' . $info['file']);
      }
      $this->variables = array(
        'view' => &$this->view,
      );
      if (isset($info['preprocess functions']) && is_array($info['preprocess functions'])) {
        foreach ($info['preprocess functions'] as $preprocess_function) {
          if (function_exists($preprocess_function)) {
            $preprocess_function($this->variables, $this->definition['theme']);
          }
        }
      }
    }
    return $this->variables;
  }

  /**
   * Provide the summary for page options in the views UI.
   *
   * This output is returned as an array.
   */
  public function options_summary(&$categories, &$options) {

    // It is very important to call the parent function here:
    parent::options_summary($categories, $options);
    $categories['context'] = array(
      'title' => t('Context settings'),
      'column' => 'second',
      'build' => array(
        '#weight' => -10,
      ),
    );
    $admin_title = $this
      ->get_option('admin_title');
    if (empty($admin_title)) {
      $admin_title = t('Use view name');
    }
    if (drupal_strlen($admin_title) > 16) {
      $admin_title = drupal_substr($admin_title, 0, 16) . '...';
    }
    $options['admin_title'] = array(
      'category' => 'context',
      'title' => t('Admin title'),
      'value' => $admin_title,
    );
    $options['inherit_panels_path'] = array(
      'category' => 'context',
      'title' => t('Use Panel path'),
      'value' => $this
        ->get_option('inherit_panels_path') ? t('Yes') : t('No'),
    );
    $options['argument_input'] = array(
      'category' => 'context',
      'title' => t('Argument input'),
      'value' => t('Edit'),
    );
  }

  /**
   * Provide the default form for setting options.
   */
  public 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 'row_plugin':

        // This just overwrites the existing row_plugin which is using the wrong options.
        $form['row_plugin']['#options'] = views_fetch_plugin_names('row', 'normal', array(
          $this->view->base_table,
        ));
        break;
      case 'admin_title':
        $form['#title'] .= t('Administrative title');
        $form['admin_title'] = array(
          '#type' => 'textfield',
          '#default_value' => $this
            ->get_option('admin_title'),
          '#description' => t('This is the title that will appear for this view context in the configure context dialog. If left blank, the view name will be used.'),
        );
        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');
        ctools_include('dependent');
        $form['argument_input']['#tree'] = TRUE;
        $converters = ctools_context_get_all_converters();
        ksort($converters);
        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'),
              'context' => t('From context'),
            ),
            '#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' => $converters,
            '#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'],
            '#dependency' => array(
              $type_id => array(
                'context',
              ),
            ),
          );
        }
        break;
    }
  }

  /**
   * Perform any necessary changes to the form values prior to storage.
   * There is no need for this function to actually store the data.
   */
  public function options_submit(&$form, &$form_state) {

    // It is very important to call the parent function here:
    parent::options_submit($form, $form_state);
    switch ($form_state['section']) {
      case 'admin_title':
      case 'argument_input':
      case 'inherit_panels_path':
        $this
          ->set_option($form_state['section'], $form_state['values'][$form_state['section']]);
        break;
    }
  }

  /**
   * Adjust the array of argument input to match the current list of
   * arguments available for this display. This ensures that changing
   * the arguments doesn't cause the argument input field to just
   * break.
   */
  public function get_argument_input() {
    $arguments = $this
      ->get_option('argument_input');
    $handlers = $this
      ->get_handlers('argument');

    // We use a separate output so as to seamlessly discard info for
    // arguments that no longer exist.
    $output = array();
    foreach ($handlers as $id => $handler) {
      if (empty($arguments[$id])) {
        $output[$id] = array(
          'type' => 'none',
          'context' => 'any',
          'context_optional' => FALSE,
          'name' => $handler
            ->ui_name(),
        );
      }
      else {
        $output[$id] = $arguments[$id];
        $output[$id]['name'] = $handler
          ->ui_name();
      }
    }
    return $output;
  }
  public function get_path() {
    if ($this
      ->get_option('link_display') == 'custom_url' && ($override_path = $this
      ->get_option('link_url'))) {
      return $override_path;
    }
    if ($this
      ->get_option('inherit_panels_path')) {
      return $_GET['q'];
    }
    return parent::get_path();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_content_plugin_display_ctools_context::$context_display public property If this variable is true, this display counts as a context. We use this variable so that we can easily build plugins against this display type.
views_content_plugin_display_ctools_context::defaultable_sections public function List which sections are defaultable and what items each section contains. Overrides views_plugin_display::defaultable_sections
views_content_plugin_display_ctools_context::execute public function The display block handler returns the structure necessary for a block. Overrides views_plugin_display::execute
views_content_plugin_display_ctools_context::get_argument_input public function Adjust the array of argument input to match the current list of arguments available for this display. This ensures that changing the arguments doesn't cause the argument input field to just break.
views_content_plugin_display_ctools_context::get_path public function Return the base path to use for this display. Overrides views_plugin_display::get_path
views_content_plugin_display_ctools_context::get_style_type public function Displays can require a certain type of style plugin. Overrides views_plugin_display::get_style_type
views_content_plugin_display_ctools_context::options_form public function Provide the default form for setting options. Overrides views_plugin_display::options_form
views_content_plugin_display_ctools_context::options_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides views_plugin_display::options_submit
views_content_plugin_display_ctools_context::options_summary public function Provide the summary for page options in the views UI. Overrides views_plugin_display::options_summary
views_content_plugin_display_ctools_context::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_plugin_display::option_definition
views_content_plugin_display_ctools_context::preview public function Fully render the display. Overrides views_plugin_display::preview
views_content_plugin_display_ctools_context::render public function Render this display. Overrides views_plugin_display::render
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function
views_plugin::$display public property The current used views display.
views_plugin::$plugin_name public property The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type public property The plugin type of this plugin, for example style or query.
views_plugin::additional_theme_functions public function Provide a list of additional theme functions for the theme info page.
views_plugin::plugin_title public function Return the human readable name of the display.
views_plugin::summary_title public function Returns the summary of the settings in the display. 8
views_plugin::theme_functions public function Provide a full list of possible theme templates used by this style.
views_plugin_display::$extender public property Stores all available display extenders.
views_plugin_display::$handlers public property List of handlers for this display.
views_plugin_display::$view public property The top object of a view. Overrides views_plugin::$view
views_plugin_display::accept_attachments public function Can this display accept attachments?
views_plugin_display::access public function Determine if the user has access to this display of the view.
views_plugin_display::attach_to public function Allow displays to attach to other views. 2
views_plugin_display::destroy public function Destructor. Overrides views_object::destroy
views_plugin_display::displays_exposed public function Determine if this display should display the exposed filters widgets. 1
views_plugin_display::export_handler public function Special method to export items that have handlers.
views_plugin_display::export_option public function Override of export_option() Overrides views_object::export_option
views_plugin_display::export_plugin public function Special handling for plugin export.
views_plugin_display::export_style public function Special handling for the style export.
views_plugin_display::format_themes public function Format a list of theme templates for output by the theme info helper.
views_plugin_display::get_arguments_tokens public function Returns to tokens for arguments.
views_plugin_display::get_argument_text public function Provide some helpful text for the arguments. 1
views_plugin_display::get_field_labels public function List of fields for the current display with the associated relationship.
views_plugin_display::get_handler public function Get the handler object for a single handler.
views_plugin_display::get_handlers public function Get a full array of handlers for $type. This caches them.
views_plugin_display::get_link_display public function Check to see which display to use when creating links.
views_plugin_display::get_option public function Intelligently get an option either from this or default display.
views_plugin_display::get_pager_text public function Provide some helpful text for pagers. 1
views_plugin_display::get_plugin public function Get the instance of a plugin, for example style or row.
views_plugin_display::get_special_blocks public function Provide the block system with any exposed widget blocks for this display.
views_plugin_display::get_url public function
views_plugin_display::has_path public function Check to see if the display has a 'path' field. 1
views_plugin_display::hook_block_list public function If this display creates a block, implement one of these.
views_plugin_display::hook_menu public function If this display creates a page with a menu item, implement it here.
views_plugin_display::init public function 1
views_plugin_display::is_defaulted public function Determine if a given option is set to use the default or current display.
views_plugin_display::is_default_display public function If this display is the 'default' display which contains fallback settings. 1
views_plugin_display::is_identifier_unique public function Check if the provided identifier is unique.
views_plugin_display::options_override public function If override/revert was clicked, perform the proper toggle.
views_plugin_display::options_validate public function Validate the options form. Overrides views_plugin::options_validate 1
views_plugin_display::option_link public function Because forms may be split up into sections, this provides an easy URL to exactly the right section. Don't override this.
views_plugin_display::override_option public function Set an option and force it to be an override.
views_plugin_display::pre_execute public function Set up any variables on the view prior to execution.
views_plugin_display::query public function Inject anything into the query that the display handler needs. Overrides views_plugin::query
views_plugin_display::render_area public function
views_plugin_display::render_empty public function
views_plugin_display::render_filters public function Not all display plugins will support filtering.
views_plugin_display::render_footer public function Render the footer of the view.
views_plugin_display::render_header public function Render the header of the view.
views_plugin_display::render_more_link public function Render the 'more' link.
views_plugin_display::render_pager public function Not all display plugins will suppert pager rendering. 1
views_plugin_display::set_option public function Intelligently set an option either from this display or from the default display, if directed to do so.
views_plugin_display::set_override public function Flip the override setting for the given section.
views_plugin_display::unpack_handler public function Special method to unpack items that have handlers.
views_plugin_display::unpack_plugin public function Special handling for plugin unpacking.
views_plugin_display::unpack_style public function
views_plugin_display::uses_breadcrumb public function Check to see if the display needs a breadcrumb. 1
views_plugin_display::uses_exposed public function Does this display uses exposed filters? 2
views_plugin_display::uses_exposed_form_in_block public function Check to see if the display can put the exposed form in a block.
views_plugin_display::uses_fields public function Determine if the display's style uses fields.
views_plugin_display::uses_link_display public function Check to see if the display has some need to link to another display. 1
views_plugin_display::use_ajax public function Does the display use AJAX?
views_plugin_display::use_group_by public function Does the display have groupby enabled?
views_plugin_display::use_more public function Does the display have a more link enabled?
views_plugin_display::use_more_always public function Should the enabled display more link be shown when no more items?
views_plugin_display::use_more_open_new_window public function Should the enabled display more link being opened in an new window?
views_plugin_display::use_more_text public function Does the display have custom link text?
views_plugin_display::use_pager public function Does the display have a pager enabled? 1
views_plugin_display::validate public function Make sure the display and all associated handlers are valid. Overrides views_plugin::validate 1
views_plugin_display::view_special_blocks public function Render any special blocks provided for this display.