class cis_connector_views_plugin_display_extender

  1. cis7 sites/all/modules/elmsln_contrib/cis_connector/cis_connector_views_plugin_display_extender.inc cis_connector_views_plugin_display_extender
  2. cle7 sites/all/modules/elmsln_contrib/cis_connector/cis_connector_views_plugin_display_extender.inc cis_connector_views_plugin_display_extender
  3. elmsmedia7 sites/all/modules/elmsln_contrib/cis_connector/cis_connector_views_plugin_display_extender.inc cis_connector_views_plugin_display_extender
  4. icor7 sites/all/modules/elmsln_contrib/cis_connector/cis_connector_views_plugin_display_extender.inc cis_connector_views_plugin_display_extender
  5. meedjum_blog7 sites/all/modules/elmsln_contrib/cis_connector/cis_connector_views_plugin_display_extender.inc cis_connector_views_plugin_display_extender
  6. mooc7 sites/all/modules/elmsln_contrib/cis_connector/cis_connector_views_plugin_display_extender.inc cis_connector_views_plugin_display_extender

Adds the CIS connector options to the display

@ignore style_class_names

Hierarchy

Expanded class hierarchy of cis_connector_views_plugin_display_extender

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
cis_connector_views_plugin_display_extender::add_signature function
cis_connector_views_plugin_display_extender::options_definition_alter function Alter the options to allow for defaults.
cis_connector_views_plugin_display_extender::options_form function Provide a form to edit options for this plugin.
cis_connector_views_plugin_display_extender::options_submit function Handle any special handling on the validate form.
cis_connector_views_plugin_display_extender::options_summary function Provide the default summary for options in the views UI.
cis_connector_views_plugin_display_extender::option_definition function Provide a form to edit options for this plugin.
cis_connector_views_plugin_display_extender::query function Inject anything into the query that the display_extender handler needs.
views_object::construct function Views handlers use a special construct function so that we can more easily construct them with variable arguments.
views_object::destroy function
views_object::export_option function
views_object::export_options function
views_object::export_option_always function Always exports the option, regardless of the default value.
views_object::options Deprecated function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.
views_object::set_default_options function Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition function Let the handler know what its full definition is.
views_object::unpack_options function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable function Unpack a single option definition.
views_object::unpack_translatables function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults function
views_plugin::additional_theme_functions function Provide a list of additional theme functions for the theme information page
views_plugin::plugin_title function Return the human readable name of the display.
views_plugin::summary_title function Returns the summary of the settings in the display.
views_plugin::theme_functions function Provide a full list of possible theme templates used by this style.
views_plugin::validate function Validate that the plugin is correct and can be saved.
views_plugin_display_extender::defaultable_sections function Static member function to list which sections are defaultable and what items each section contains.
views_plugin_display_extender::init function
views_plugin_display_extender::options_validate function Validate the options form.
views_plugin_display_extender::pre_execute function Set up any variables on the view prior to execution.

File

sites/all/modules/elmsln_contrib/cis_connector/cis_connector_views_plugin_display_extender.inc, line 12
Definition of cis_connector_views_plugin_display_extender.

View source
class cis_connector_views_plugin_display_extender extends views_plugin_display_extender {
  function add_signature(&$view) {
  }
  /**
   * Provide a form to edit options for this plugin.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['cis_bucket'] = array('default' => '-none-');
    $options['cis_instance'] = array('default' => TRUE);
    return $options;
  }
  /**
   * Alter the options to allow for defaults.
   */
  function options_definition_alter(&$options) {
    $options['cis_bucket'] = array('default' => '-none-');
    $options['cis_instance'] = array('default' => TRUE);
  }
  /**
   * Provide a form to edit options for this plugin.
   */
  function options_form(&$form, &$form_state) {
    if ($form['#section'] == 'page-cis_connector') {
      $registry = _cis_connector_build_registry();
      $options = array('-none-' => '-none-');
      foreach ($registry as $key => $option) {
        // only display things we can connect to via backend calls
        if (isset($option['service_address'])) {
          $options[$key] = $key . ' (' . $option['address'] . ')';
        }
      }
      // allow for selection of the bucket to connect to
      $form['cis_bucket'] = array(
        '#type' => 'select',
        '#options' => $options,
        '#title' => t('Connector bucket'),
        '#description' => t('Which service instance should this view connect to'),
        '#weight' => 0,
        '#default_value' => $this->display->get_option('cis_bucket'),
      );
      // allow for designation of a related instance or if this is a single service
      $form['cis_instance'] = array(
        '#type' => 'checkbox',
        '#title' => t('Instance'),
        '#description' => t('Is this an instance of a service or a central service?'),
        '#weight' => 1,
        '#default_value' => $this->display->get_option('cis_instance'),
      );
    }
  }

  /**
   * Handle any special handling on the validate form.
   */
  function options_submit(&$form, &$form_state) {
    if (isset($form_state['values']['cis_bucket'])) {
      $this->display->set_option('cis_bucket', $form_state['values']['cis_bucket']);
      $this->display->set_option('cis_instance', $form_state['values']['cis_instance']);
    }
  }

  /**
   * Provide the default summary for options in the views UI.
   *
   * This output is returned as an array.
   */
  function options_summary(&$categories, &$options) {
    if ($this->view->base_table == 'xml') {
      $bucket = check_plain(trim($this->display->get_option('cis_bucket')));
      $options['cis_connector'] = array(
        'category' => 'other',
        'title' => t('CIS connector'),
        'value' => $bucket,
        'desc' => t('CIS connector settings to modify request address dynamically.'),
      );
    }
  }
  /**
   * Inject anything into the query that the display_extender handler needs.
   */
  function query() {
    if ($this->view->base_table == 'xml') {
      $options = $this->view->display_handler->options;
      $this->view->query->options['cis_bucket'] = $options['cis_bucket'];
      $this->view->query->options['cis_instance'] = $options['cis_instance'];
    }
  }
}

Related topics

1 string reference to 'cis_connector_views_plugin_display_extender'
cis_connector_views_plugins in sites/all/modules/elmsln_contrib/cis_connector/cis_connector.views.inc
Implements hook_views_plugins().