You are here

Home » API reference » VBO Hide 7 » vbo_hide_plugin_display_extender.inc

class vbo_hide_plugin_display_extender in VBO Hide 7

@file Views plugin handler. Contains all relevant options and related logic. Implements the Views Form API.

Hierarchy

Expanded class hierarchy of vbo_hide_plugin_display_extender

1 string reference to 'vbo_hide_plugin_display_extender'
vbo_hide_views_plugins in views/vbo_hide.views.inc
Implements hook_views_plugin().

File

views/vbo_hide_plugin_display_extender.inc, line 9
Views plugin handler. Contains all relevant options and related logic. Implements the Views Form API.

View source 
class vbo_hide_plugin_display_extender extends views_plugin_display_extender {

  /**
   * Returns setting options.
   */
  function option_definition() {

    // Call parent method so that default functionality not override.
    $options = parent::option_definition();
    $options['vbo_hide'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Provide the default form for setting options.
   */
  function options_form(&$form, &$form_state) {

    // Call parent method so that default functionality not override.
    parent::options_form($form, $form_state);
    $vbo_value = $this->display
      ->get_option('vbo_hide');
    switch ($form_state['section']) {
      case 'vbo_hide':
        $form['#title'] .= t('Hide VBO when no data in View');
        $form['vbo_hide'] = array(
          '#type' => 'radios',
          '#options' => array(
            0 => t('No'),
            1 => t('Yes'),
          ),
          '#default_value' => isset($vbo_value) ? $this->display
            ->get_option('vbo_hide') : 0,
          '#description' => t('Hide the Views Bulk Operations options if there is no data in View?'),
        );
        break;
    }
  }

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

    // Call parent method so that default functionality not override.
    parent::options_submit($form, $form_state);
    $vbo_hide = isset($form_state['values']['vbo_hide']) ? $form_state['values']['vbo_hide'] : 0;

    // If no value in any how for VBO hide, then will store 0.
    switch ($form_state['section']) {
      case 'vbo_hide':
        $this->display
          ->set_option('vbo_hide', $vbo_hide);
        break;
    }
  }

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

    // Call parent method so that default functionality does not override.
    parent::options_summary($categories, $options);
    $vbo_hide = check_plain(trim($this->display
      ->get_option('vbo_hide')));
    $options['vbo_hide'] = array(
      'category' => 'other',
      'title' => t('Hide VBO'),
      'value' => $vbo_hide == 1 ? t('Yes') : t('No'),
      'desc' => t('Change whether or not to display Views Bulk Operations options for this View.'),
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
vbo_hide_plugin_display_extender::options_form function Provide the default form for setting options. Overrides views_plugin_display_extender::options_form
vbo_hide_plugin_display_extender::options_submit function Perform any necessary changes to the form values prior to storage. Overrides views_plugin_display_extender::options_submit
vbo_hide_plugin_display_extender::options_summary function Provide the summary for attachment options in the views UI. Overrides views_plugin_display_extender::options_summary
vbo_hide_plugin_display_extender::option_definition function Returns setting options. Overrides views_object::option_definition
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::destroy public function Destructor. 2
views_object::export_option public function 1
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::$view public property The top object of a view. Overrides views_object::$view 1
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::validate public function Validate that the plugin is correct and can be saved. 3
views_plugin_display_extender::defaultable_sections public function Static member function to list which sections are defaultable and what items each section contains.
views_plugin_display_extender::init public function
views_plugin_display_extender::options_definition_alter public function Provide a form to edit options for this plugin.
views_plugin_display_extender::options_validate public function Validate the options form. Overrides views_plugin::options_validate
views_plugin_display_extender::pre_execute public function Set up any variables on the view prior to execution.
views_plugin_display_extender::query public function Inject anything into the query that the display_extender handler needs. Overrides views_plugin::query