class menu_references_filter_handler in Menu Reference 7

@file Views filter handler

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_filter
    class \views_handler_filter_in_operator
    class \menu_references_filter_handler

Expanded class hierarchy of menu_references_filter_handler

1 string reference to 'menu_references_filter_handler'

menu_reference_field_views_data_alter in views/menu_reference.views.inc: Implements hook_field_views_data_alter().

File

views/handlers/menu_references_filter_handler.inc, line 7: Views filter handler

View source

class menu_references_filter_handler extends views_handler_filter_in_operator {
  var $value_form_type = 'select';
  var $value_options = NULL;
  function construct() {
    parent::construct();
    $this->value_title = t('Menu items');
    $this->value_options = NULL;
  }
  function init(&$view, &$options) {
    parent::init($view, $options);

    // Filter compatibility
    if ($this->operator == '!=') {
      $this->operator = 'not in';
    }
    else {
      $this->operator = 'in';
    }
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['include_childrens'] = array(
      'default' => FALSE,
    );
    return $options;
  }
  function get_value_options() {
    if (isset($this->value_options)) {
      return;
    }
    if (isset($this->definition['options callback']) && is_callable($this->definition['options callback'])) {
      if (isset($this->definition['options arguments']) && is_array($this->definition['options arguments'])) {
        $this->value_options = call_user_func_array($this->definition['options callback'], $this->definition['options arguments']);
      }
      else {
        $this->value_options = call_user_func($this->definition['options callback']);
      }
    }
    else {
      $menu_list = menu_get_menus(TRUE);

      // Get the allowed menues from the field settings.
      $field_settings = field_info_field($this->definition['field_name']);
      $allowed_menus = array_filter($field_settings['settings']['allowed_menus']);
      $options = array();
      foreach ($allowed_menus as $menu) {
        $options[$menu_list[$menu]] = menu_reference_get_menu_hierarchy($menu);
      }
      $this->value_options = $options;
    }
    return $this->value_options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['include_childrens'] = array(
      '#type' => 'checkbox',
      '#title' => t('Include childrens'),
      '#description' => t('Enable to include child items of selected item(s) in view results.'),
      '#default_value' => $this->options['include_childrens'],
    );
  }
  function value_form(&$form, &$form_state) {
    $form['value'] = array();
    $options = array();
    $this
      ->get_value_options();
    $options += $this->value_options;
    $default_value = (array) $this->value;
    $which = 'all';
    if (!empty($form['operator'])) {
      $source = $form['operator']['#type'] == 'radios' ? 'radio:options[operator]' : 'edit-options-operator';
    }
    if (!empty($form_state['exposed'])) {
      $identifier = $this->options['expose']['identifier'];
      if (empty($this->options['expose']['use_operator']) || empty($this->options['expose']['operator_id'])) {

        // Exposed and locked.
        $which = in_array($this->operator, $this
          ->operator_values(1)) ? 'value' : 'none';
      }
      else {
        $source = 'edit-' . drupal_html_id($this->options['expose']['operator_id']);
      }
      if (!empty($this->options['expose']['reduce'])) {
        $options = $this
          ->reduce_value_options();
        if (!empty($this->options['expose']['multiple']) && empty($this->options['expose']['required'])) {
          $default_value = array();
        }
      }
      if (empty($this->options['expose']['multiple'])) {
        if (empty($this->options['expose']['required']) && (empty($default_value) || !empty($this->options['expose']['reduce']))) {
          $default_value = 'All';
        }
        elseif (empty($default_value)) {
          $keys = array_keys($options);
          $default_value = array_shift($keys);
        }
        else {
          $copy = $default_value;
          $default_value = array_shift($copy);
        }
      }
    }
    if ($which == 'all' || $which == 'value') {
      if (!empty($form_state['exposed']) && !isset($form_state['input'][$identifier])) {
        $default_value = !empty($default_value) ? $default_value : 'All';
        $form_state['input'][$identifier] = $default_value;
      }
      $form['value'] = array(
        '#type' => 'select',
        '#title' => $this->value_title,
        '#multiple' => TRUE,
        '#size' => 10,
        '#options' => $options,
        '#default_value' => $default_value,
      );
      if ($which == 'all') {
        if (empty($form_state['exposed']) && in_array($this->value_form_type, array(
          'checkbox',
          'checkboxes',
          'radios',
          'select',
        ))) {
          $form['value']['#prefix'] = '<div id="edit-options-value-wrapper">';
          $form['value']['#suffix'] = '</div>';
        }
        $form['value']['#dependency'] = array(
          $source => $this
            ->operator_values(1),
        );
      }
    }
  }
  function query() {
    $this->value = isset($this->value['value']) ? array(
      $this->value['value'],
    ) : $this->value;

    // Get all the subchild mlids if option is set.
    if (!empty($this->options['include_childrens'])) {

      // Get the menues.
      $field_settings = field_info_field($this->definition['field_name']);
      $allowed_menus = array_filter($field_settings['settings']['allowed_menus']);
      foreach ($allowed_menus as $machine_name) {
        $tmp_values = array();
        foreach ($this->value as $value) {
          $childs = menu_reference_get_all_menu_children($value, $machine_name);
          $tmp_values = array_merge($tmp_values, $childs);
        }
        $this->value = array_merge($this->value, $tmp_values);
      }

      // Remove duplicate mlids.
      $this->value = array_unique($this->value);
    }
    $info = $this
      ->operators();
    if (!empty($info[$this->operator]['method'])) {
      $this
        ->{$info[$this->operator]['method']}();
    }
  }
  function admin_summary() {
    if (method_exists($this, 'is_a_group') && $this
      ->is_a_group()) {
      return t('grouped');
    }
    if (!empty($this->options['exposed'])) {
      return t('exposed');
    }
    $info = $this
      ->operators();
    $this
      ->get_value_options();
    if (!is_array($this->value)) {
      return;
    }
    $operator = check_plain($info[$this->operator]['short']);
    $values = '';
    if (in_array($this->operator, $this
      ->operator_values(1))) {
      $flat_options = form_options_flatten($this->value_options, TRUE);

      // Remove every element which is not known.
      foreach ($this->value as $value) {
        if (!isset($flat_options[$value])) {
          unset($this->value[$value]);
        }
      }

      // Choose different kind of ouput for 0, a single and multiple values.
      if (count($this->value) == 0) {
        $values = t('Unknown');
      }
      elseif (count($this->value) == 1) {

        // If any, use the 'single' short name of the operator instead.
        if (isset($info[$this->operator]['short_single'])) {
          $operator = check_plain($info[$this->operator]['short_single']);
        }
        $keys = $this->value;
        $value = array_shift($keys);
        if (isset($flat_options[$value])) {
          $values = check_plain($value);
        }
        else {
          $values = '';
        }
      }
      else {
        foreach ($this->value as $value) {
          if ($values !== '') {
            $values .= ', ';
          }
          if (drupal_strlen($values) > 8) {
            $values .= '...';
            break;
          }
          if (isset($flat_options[$value])) {
            $values .= check_plain($value);
          }
        }
      }
    }
    return $operator . ($values !== '' ? ' ' . $values : '');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
menu_references_filter_handler::$value_form_type		property	Overrides views_handler_filter_in_operator::$value_form_type
menu_references_filter_handler::$value_options		property	Stores all operations which are available on the form. Overrides views_handler_filter_in_operator::$value_options
menu_references_filter_handler::admin_summary		function	Display the filter on the administrative summary. Overrides views_handler_filter_in_operator::admin_summary
menu_references_filter_handler::construct		function	Views handlers use a special construct function. Overrides views_handler_filter_in_operator::construct
menu_references_filter_handler::get_value_options		function	Child classes should be used to override this function and set the 'value options', unless 'options callback' is defined as a valid function or static public method to generate these values. Overrides views_handler_filter_in_operator::get_value_options
menu_references_filter_handler::init		function	Provide some extra help to get the operator/value easier to use. Overrides views_handler_filter::init
menu_references_filter_handler::options_form		function	Provide the basic form which calls through to subforms. Overrides views_handler_filter::options_form
menu_references_filter_handler::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_handler_filter_in_operator::option_definition
menu_references_filter_handler::query		function	Add this filter to the query. Overrides views_handler_filter_in_operator::query
menu_references_filter_handler::value_form		function	Options form subform for setting options. Overrides views_handler_filter_in_operator::value_form
views_handler::$handler_type	public	property	The type of the handler, for example filter/footer/field.
views_handler::$query	public	property	Where the $query object will reside:.	1
views_handler::$real_field	public	property	The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship	public	property	The relationship used for this field.
views_handler::$table_alias	public	property	The alias of the table of this handler which is used in the query.
views_handler::$view	public	property	The top object of a view. Overrides views_object::$view
views_handler::access	public	function	Check whether current user has access to this handler.	10
views_handler::broken	public	function	Determine if the handler is considered 'broken'.	6
views_handler::case_transform	public	function	Transform a string by a certain method.
views_handler::ensure_my_table	public	function	Ensure the main table for this handler is in the query. This is used a lot.	8
views_handler::exposed_submit	public	function	Submit the exposed handler form.
views_handler::exposed_validate	public	function	Validate the exposed handler form.	4
views_handler::expose_submit	public	function	Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options	public	function	Provide defaults for the handler.
views_handler::extra_options_form	public	function	Provide a form for setting options.	1
views_handler::extra_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.
views_handler::extra_options_validate	public	function	Validate the options form.
views_handler::get_field	public	function	Shortcut to get a handler's raw field value.
views_handler::get_join	public	function	Get the join object that should be used for this handler.
views_handler::groupby_form	public	function	Provide a form for aggregation settings.	1
views_handler::groupby_form_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.	1
views_handler::has_extra_options	public	function	If a handler has 'extra options' it will get a little settings widget and another form called extra_options.	1
views_handler::is_exposed	public	function	Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::needs_style_plugin	public	function	Determine if the argument needs a style plugin.	1
views_handler::placeholder	public	function	Provides a unique placeholders for handlers.
views_handler::post_execute	public	function	Run after the view is executed, before the result is cached.	1
views_handler::pre_query	public	function	Run before the view is built.	1
views_handler::sanitize_value	public	function	Sanitize the value for output.
views_handler::set_relationship	public	function	Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_form	public	function	Shortcut to display the exposed options form.
views_handler::ui_name	public	function	Return a string representing this handler's name in the UI.	9
views_handler::use_group_by	public	function	Provides the handler some groupby.	2
views_handler_filter::$always_multiple	public	property	Disable the possibility to force a single value.	6
views_handler_filter::$always_required	public	property	Disable the possibility to allow a exposed input to be optional.
views_handler_filter::$group_info	public	property	Contains the information of the selected item in a gruped filter.
views_handler_filter::$no_operator	public	property	Disable the possibility to use operators.	2
views_handler_filter::$operator	public	property	Contains the operator which is used on the query.
views_handler_filter::$value	public	property	Contains the actual value of the field.
views_handler_filter::build_group_form	public	function	Build the form to let users create the group of exposed filters.
views_handler_filter::build_group_options	public	function	Provide default options for exposed filters.
views_handler_filter::build_group_submit	public	function	Save new group items, re-enumerates and remove groups marked to delete.
views_handler_filter::build_group_validate	public	function	Validate the build group options form.	1
views_handler_filter::can_build_group	public	function	Determine if a filter can be converted into a group.
views_handler_filter::can_expose	public	function	Determine if a filter can be exposed. Overrides views_handler::can_expose	5
views_handler_filter::can_group	public	function	Can this filter be used in OR groups?	1
views_handler_filter::convert_exposed_input	public	function	Transform the input from a grouped filter into a standard filter.
views_handler_filter::exposed_form	public	function	Render our chunk of the exposed filter form when selecting. Overrides views_handler::exposed_form
views_handler_filter::exposed_info	public	function	Tell the renderer about our exposed form. Overrides views_handler::exposed_info
views_handler_filter::exposed_translate	public	function	Make some translations to a form item to make it more suitable to exposing.
views_handler_filter::expose_validate	public	function	Validate the options form. Overrides views_handler::expose_validate
views_handler_filter::group_form	public	function	Build a form with a group of operator \| values to apply as a single filter.
views_handler_filter::group_multiple_exposed_input	public	function	Options available for a grouped filter which uses checkboxes.
views_handler_filter::is_a_group	public	function	Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler::is_a_group
views_handler_filter::multiple_exposed_input	public	function	Indicate whether users can select multiple group items. Overrides views_handler::multiple_exposed_input
views_handler_filter::operator_form	public	function	Options form subform for setting the operator.	6
views_handler_filter::operator_submit	public	function	Perform any necessary changes to the form values prior to storage.
views_handler_filter::operator_validate	public	function	Validate the operator form.
views_handler_filter::options_submit	public	function	Simple submit handler. Overrides views_handler::options_submit
views_handler_filter::options_validate	public	function	Simple validate handler. Overrides views_handler::options_validate	1
views_handler_filter::prepare_filter_select_options	public	function	Sanitizes the HTML select element's options.
views_handler_filter::show_build_group_button	public	function	Shortcut to display the build_group/hide button.
views_handler_filter::show_build_group_form	public	function	Shortcut to display the exposed options form.
views_handler_filter::show_expose_button	public	function	Shortcut to display the expose/hide button. Overrides views_handler::show_expose_button
views_handler_filter::show_operator_form	public	function	Shortcut to display the operator form.
views_handler_filter::show_value_form	public	function	Shortcut to display the value form.
views_handler_filter::store_exposed_input	public	function	Store the exposed input for processing later. Overrides views_handler::store_exposed_input
views_handler_filter::store_group_input	public	function	If set to remember exposed input in the session, store it there.
views_handler_filter::value_validate	public	function	Validate the options form.	3
views_handler_filter_in_operator::accept_exposed_input	public	function	Check to see if input from the exposed filters should change the behavior. Overrides views_handler_filter::accept_exposed_input	2
views_handler_filter_in_operator::expose_form	public	function	Options form subform for exposed filter options. Overrides views_handler_filter::expose_form	1
views_handler_filter_in_operator::expose_options	public	function	Provide default options for exposed filters. Overrides views_handler_filter::expose_options
views_handler_filter_in_operator::operators	public	function	This kind of construct makes it relatively easy for a child class to add or remove functionality by overriding this function and adding/removing items from this array.	1
views_handler_filter_in_operator::operator_options	public	function	Build strings from the operators() for 'select' options. Overrides views_handler_filter::operator_options	2
views_handler_filter_in_operator::operator_values	public	function
views_handler_filter_in_operator::op_empty	public	function
views_handler_filter_in_operator::op_simple	public	function
views_handler_filter_in_operator::reduce_value_options	public	function	When using exposed filters, we may be required to reduce the set.
views_handler_filter_in_operator::validate	public	function	Validates the handler against the complete View. Overrides views_handler::validate
views_handler_filter_in_operator::value_submit	public	function	Perform any necessary changes to the form values prior to storage. Overrides views_handler_filter::value_submit	2
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::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

You are here

class menu_references_filter_handler in Menu Reference 7

Hierarchy

File

Members

API Navigation