class oa_views_plugin_exposed_form in Open Atrium Core 7.2

@file Defines an exposed form plugin that contains some OA goodies.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_exposed_form
      • class \oa_views_plugin_exposed_form

1 string reference to 'oa_views_plugin_exposed_form'

oa_core_views_plugins in ./oa_core.views.inc

Implements hook_views_plugins().

File

plugins/views/oa_views_plugin_exposed_form.inc, line 8

Defines an exposed form plugin that contains some OA goodies.

class oa_views_plugin_exposed_form extends views_plugin_exposed_form {

  /**
   * Provide options and defaults.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['collapsed_filter'] = array(
      'default' => TRUE,
      'translatable' => TRUE,
    );
    return $options;
  }

  /**
   * Provide options form.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['collapsed_filter'] = array(
      '#type' => 'checkbox',
      '#title' => t('Collapsed filter'),
      '#description' => t('Adds a button that will show the exposed filter. Collapsed by default.'),
      '#default_value' => $this->options['collapsed_filter'],
    );
  }

  /**
   * Alter the exposed form based on our settings.
   */
  function exposed_form_alter(&$form, &$form_state) {
    parent::exposed_form_alter($form, $form_state);
    $form['#collapsed_filter'] = $this->options['collapsed_filter'];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
oa_views_plugin_exposed_form::exposed_form_alter		function	Alter the exposed form based on our settings. Overrides views_plugin_exposed_form::exposed_form_alter
oa_views_plugin_exposed_form::options_form		function	Provide options form. Overrides views_plugin_exposed_form::options_form
oa_views_plugin_exposed_form::option_definition		function	Provide options and defaults. Overrides views_plugin_exposed_form::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::options_submit	public	function	Handle any special handling on the validate form.	9
views_plugin::options_validate	public	function	Validate the options form.	10
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_exposed_form::exposed_form_submit	public	function	This function is executed when exposed form is submited.
views_plugin_exposed_form::exposed_form_validate	public	function
views_plugin_exposed_form::init	public	function	Initialize the plugin.
views_plugin_exposed_form::post_execute	public	function
views_plugin_exposed_form::post_render	public	function
views_plugin_exposed_form::pre_execute	public	function
views_plugin_exposed_form::pre_render	public	function		1
views_plugin_exposed_form::query	public	function	Add anything to the query that we might need to. Overrides views_plugin::query	1
views_plugin_exposed_form::render_exposed_form	public	function	Render the exposed filter form.
views_plugin_exposed_form::reset_form	public	function