class entityreference_filter_view_result in Views Reference Filter 7

The filter to select items from the list generated by another view.

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_filter
    class \views_handler_filter_in_operator
    class \entityreference_filter_view_result

Expanded class hierarchy of entityreference_filter_view_result

1 string reference to 'entityreference_filter_view_result'

entityreference_filter_views_data_alter in ./entityreference_filter.views.inc: Implements hook_views_data_alter().

File

views/entityreference_filter_view_result.inc, line 13: Definition of entityreference_filter_view_result.

View source

class entityreference_filter_view_result extends views_handler_filter_in_operator {
  function option_definition() {
    $options = parent::option_definition();
    $options['value']['default'] = NULL;
    $options['reference_display'] = array(
      'default' => '',
    );
    $options['reference_arguments'] = array(
      'default' => '',
    );
    $options['expose']['contains']['hide_empty_filter'] = array(
      'default' => TRUE,
      'bool' => TRUE,
    );
    return $options;
  }
  function value_form(&$form, &$form_state) {
    parent::value_form($form, $form_state);
    if (!empty($form_state['exposed'])) {

      // Run time.
      $identifier = $this->options['expose']['identifier'];
      if (isset($this->options['reference_arguments']) && strpos($this->options['reference_arguments'], '[') !== FALSE) {

        // This filter depends on other filters dynamically,
        // store data for configuring Drupal.settings.
        $form['#attached']['js'][] = drupal_get_path('module', 'entityreference_filter') . '/entityreference_filter.js';
        if (empty($form['#after_build'])) {
          $form['#after_build'] = array();
        }
        if (!in_array('entityreference_filter_exposed_form_after_build', $form['#after_build'])) {
          $form['#after_build'][] = 'entityreference_filter_exposed_form_after_build';
        }
        $form['#entityreference_filter_view'] = $this->view->name;
        $form['#entityreference_filter_display'] = $this->view->current_display;
        $form['#entityreference_filter_args'] = $this
          ->dynamic_filter_get_view_args();
        $form['#entityreference_filter_autosubmit'] = $this
          ->is_auto_submit();
        if (!isset($form['#entityreference_filter_dynamic'])) {
          $form['#entityreference_filter_dynamic'] = array();
        }
        $form['#entityreference_filter_dynamic'][$identifier] = $this
          ->dynamic_filter_get_controlling_filters();
      }
      $values = $this
        ->get_value_options();

      // Delete irrelevant default values.
      $default_value = isset($form_state['input'][$identifier]) ? $form_state['input'][$identifier] : array();
      if (!is_array($default_value)) {
        $default_value = array(
          $default_value,
        );
      }
      $default_value = array_intersect($default_value, array_keys($values));
      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($values);
          $default_value = array_shift($keys);
        }
        else {
          $copy = $default_value;
          $default_value = array_shift($copy);
        }
      }
      $form_state['input'][$identifier] = $default_value;
      if (empty($values) && !empty($this->options['expose']['hide_empty_filter'])) {

        // Hide the form element.
        if (isset($form['value'])) {
          $form['value']['#prefix'] = '<div class="element-hidden">';
          $form['value']['#suffix'] = '</div>';
        }
      }
      return;
    }
    else {

      // Configuration via View UI time.
      if (isset($form['operator']['#type']) && $form['operator']['#type'] === '') {

        // Views dependent filters module needs option list
        // to configure dependencies.
        $values = $this
          ->get_value_options();
        if (empty($values)) {
          if (isset($form['value'])) {
            $form['value']['#access'] = FALSE;
          }
        }
        return;
      }

      // Don't show value selection widget.
      $form['value']['#access'] = FALSE;
    }
    $displays = views_get_applicable_views('entityreference display');

    // Filter views that list the entity type we want, and group the separate
    // displays by view.
    $options = array();
    $field_base_table = isset($this->definition['filter_base_table']) ? $this->definition['filter_base_table'] : '';
    foreach ($displays as $data) {
      list($view, $display_name) = $data;
      if (empty($field_base_table) || $view->base_table === $field_base_table) {
        $options[$view->name . ':' . $display_name] = $view->name . ' - ' . $view->display[$display_name]->display_title;
      }
    }
    $form['reference_display'] = array(
      '#type' => 'select',
      '#title' => t('View used to select the entities'),
      '#required' => TRUE,
      '#options' => $options,
      '#default_value' => $this->options['reference_display'],
      '#description' => '<p>' . t('Choose the view and display that select the entities that can be referenced.<br />Only views with a display of type "Entity Reference" are eligible.') . '</p>',
    );
    if (empty($this->options['reference_display'])) {
      $form['reference_display']['#description'] .= '<p>' . t('Entity list will be available after saving this setting.') . '</p>';
    }
    $form['reference_arguments'] = array(
      '#type' => 'textfield',
      '#size' => 50,
      '#maxlength' => 256,
      '#title' => t('Arguments for the view'),
      '#default_value' => isset($this->options['reference_arguments']) ? $this->options['reference_arguments'] : '',
      '#description' => t('Define arguments for the view that selects the entities. Empty value means passing arguments of the current view. Format is arg1/arg2/...argN. Possible arguments are !n - argument number n of the current view, [filter_name] - value of the named exposed filter, other strings are passed as is.'),
    );
  }
  function value_submit($form, &$form_state) {
    $form_state['values']['options']['value'] = NULL;
  }
  function expose_form(&$form, &$form_state) {
    parent::expose_form($form, $form_state);
    $form['expose']['hide_empty_filter'] = array(
      '#type' => 'checkbox',
      '#title' => t('Hide empty filter'),
      '#description' => t('Hide the exposed widget if the entity list is empty.'),
      '#default_value' => $this->options['expose']['hide_empty_filter'],
    );
  }
  function exposed_info() {
    $info = parent::exposed_info();
    if (!empty($this->options['expose']['hide_empty_filter'])) {
      $values = $this
        ->get_value_options();
      if (empty($values)) {
        unset($info['operator'], $info['label'], $info['description']);
      }
    }
    return $info;
  }
  function get_value_options() {
    if (isset($this->value_options)) {
      return $this->value_options;
    }

    // Initialize this to prevent infinite loops
    // when circular dependency is set.
    $this->value_options = array();

    // This calculation can create infinite loop.
    $this->value_options = $this
      ->get_configured_views_result();
    return $this->value_options;
  }
  function query() {

    // Recalculate values if the filter is not exposed.
    if (empty($this->options['exposed'])) {
      $this->value = array_keys($this
        ->get_configured_views_result());
      if (empty($this->value)) {

        // If the result is empty, add zero value item to ensure SQL validity.
        $this->value = array(
          0,
        );
      }
    }
    parent::query();
  }
  function get_configured_views_result() {
    if (empty($this->options['reference_display'])) {
      return array();
    }
    list($view_name, $display_name) = explode(':', $this->options['reference_display']);

    // Check that the view is valid and the display still exists.

    /** @var view $view */
    $view = views_get_view($view_name);
    if (!$view || !isset($view->display[$display_name]) || !$view
      ->access($display_name)) {
      watchdog('entityreference', 'The view %view_name is no longer eligible for the filter.', array(
        '%view_name' => $view_name,
      ), WATCHDOG_WARNING);
      return array();
    }
    $view
      ->set_display($display_name);

    // Make sure the query is not cached.
    $view->is_cacheable = FALSE;
    $view
      ->set_items_per_page(0);

    // Make the display render the result as array.
    $view->display_handler
      ->set_option('entityreference_options', array(
      'limit' => 0,
    ));

    // Avoid warnings when the view can't run.
    $view->display_handler->id_field_alias = '';
    $filters_by_identifier = array();
    $args = $this
      ->dynamic_filter_get_view_args();
    if (isset($this->options['reference_arguments'])) {
      $arg_str = trim($this->options['reference_arguments']);
      if (strlen($arg_str) > 0) {
        $args = explode('/', $arg_str);
        foreach ($args as $i => $arg) {
          $arg = trim($arg);
          $first_char = drupal_substr($arg, 0, 1);
          if ($first_char === '!') {
            $arg_no = intval(drupal_substr($arg, 1)) - 1;
            if ($arg_no >= 0) {
              $args[$i] = isset($this->view->args[$arg_no]) ? $this->view->args[$arg_no] : NULL;
              if (is_null($args[$i]) && !empty($this->view->argument)) {
                $arg_keys = array_keys($this->view->argument);
                if (isset($arg_keys[$arg_no])) {
                  $args[$i] = $this->view->argument[$arg_keys[$arg_no]]
                    ->get_value();
                }
              }
            }
          }
          if ($first_char === '[') {
            if (drupal_substr($arg, -1, 1) === ']') {
              if (empty($filters_by_identifier) && !empty($this->view->filter)) {
                foreach ($this->view->filter as $filter_handler) {
                  if (empty($filter_handler->options['exposed'])) {
                    continue;
                  }
                  $filters_by_identifier[$filter_handler->options['expose']['identifier']] = $filter_handler;
                }
              }
              $args[$i] = NULL;
              $filter_name = drupal_substr($arg, 1, drupal_strlen($arg) - 2);
              $input = $this->view
                ->get_exposed_input();
              if (isset($input[$filter_name])) {
                $args[$i] = $input[$filter_name];
              }
              elseif (isset($filters_by_identifier[$filter_name])) {
                $args[$i] = $filters_by_identifier[$filter_name]->value;
              }
              if ($args[$i] === 'All' || $args[$i] === array()) {
                $args[$i] = NULL;
              }
              if (is_array($args[$i])) {
                reset($args[$i]);
                $args[$i] = current($args[$i]);
              }
              if (is_null($args[$i])) {

                // Try to get the first value of list of options
                // if configured so.
                if (isset($filters_by_identifier[$filter_name])) {
                  $filter_handler = $filters_by_identifier[$filter_name];
                  if ((!empty($filter_handler->always_required) || !empty($filter_handler->options['expose']['required'])) && empty($filter_handler->options['expose']['multiple']) && method_exists($filter_handler, 'get_value_options')) {
                    $values = $filter_handler
                      ->get_value_options();
                    if (count($values) > 0) {
                      reset($values);
                      $filter_handler->value = empty($filter_handler->options['expose']['multiple']) ? key($values) : array(
                        key($values),
                      );
                      $args[$i] = key($values);
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
    $result = $view
      ->execute_display($display_name, $args);
    if (is_array($result)) {

      // Clean entity reference style output.
      foreach ($result as &$item) {
        $item = trim($item);
      }
    }
    return $result ? $result : array();
  }
  function dynamic_filter_depends_on($filter_name) {
    if (isset($this->options['reference_arguments'])) {
      $filter_str = '[' . $filter_name . ']';
      $args = explode('/', trim($this->options['reference_arguments']));
      foreach ($args as $arg) {
        return trim($arg) === $filter_str;
      }
    }
    return FALSE;
  }
  function dynamic_filter_get_controlling_filters() {
    $filters = array();
    if (isset($this->options['reference_arguments'])) {
      $arg_str = trim($this->options['reference_arguments']);
      if (strlen($arg_str) > 0) {
        $args = explode('/', $arg_str);
        foreach ($args as $arg) {
          $arg = trim($arg);
          $first_char = drupal_substr($arg, 0, 1);
          if ($first_char === '[') {
            if (drupal_substr($arg, -1, 1) === ']') {
              $filter_name = drupal_substr($arg, 1, drupal_strlen($arg) - 2);
              $filters[] = $filter_name;
            }
          }
        }
      }
    }
    return $filters;
  }
  function dynamic_filter_get_view_args() {
    $args = $this->view->args;
    if (empty($this->view->argument)) {
      return $args;
    }
    $arg_count = count($args);
    $argument_count = count($this->view->argument);
    if ($argument_count > $arg_count) {
      for ($i = $arg_count; $i < $argument_count; $i++) {
        $args[] = NULL;
      }
    }
    $arg_keys = array_keys($this->view->argument);
    foreach ($args as $arg_no => $arg) {
      if (is_null($arg) && isset($arg_keys[$arg_no])) {
        $args[$arg_no] = $this->view->argument[$arg_keys[$arg_no]]
          ->get_value();
      }
    }
    return $args;
  }
  function is_auto_submit() {
    $exposed_form = $this->view->display_handler
      ->get_plugin('exposed_form');
    return !empty($exposed_form->options['autosubmit']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
entityreference_filter_view_result::dynamic_filter_depends_on		function
entityreference_filter_view_result::dynamic_filter_get_controlling_filters		function
entityreference_filter_view_result::dynamic_filter_get_view_args		function
entityreference_filter_view_result::exposed_info		function	Tell the renderer about our exposed form. Overrides views_handler_filter::exposed_info
entityreference_filter_view_result::expose_form		function	Options form subform for exposed filter options. Overrides views_handler_filter_in_operator::expose_form
entityreference_filter_view_result::get_configured_views_result		function
entityreference_filter_view_result::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
entityreference_filter_view_result::is_auto_submit		function
entityreference_filter_view_result::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_handler_filter_in_operator::option_definition
entityreference_filter_view_result::query		function	Add this filter to the query. Overrides views_handler_filter_in_operator::query
entityreference_filter_view_result::value_form		function	Options form subform for setting options. Overrides views_handler_filter_in_operator::value_form
entityreference_filter_view_result::value_submit		function	Perform any necessary changes to the form values prior to storage. Overrides views_handler_filter_in_operator::value_submit
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_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::init	public	function	Provide some extra help to get the operator/value easier to use. Overrides views_handler::init	2
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_form	public	function	Provide the basic form which calls through to subforms. Overrides views_handler::options_form	4
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::$value_form_type	public	property		1
views_handler_filter_in_operator::$value_options	public	property	Stores all operations which are available on the form.
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::admin_summary	public	function	Display the filter on the administrative summary. Overrides views_handler_filter::admin_summary	2
views_handler_filter_in_operator::construct	public	function	Views handlers use a special construct function. Overrides views_object::construct
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_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 entityreference_filter_view_result in Views Reference Filter 7

Hierarchy

File

Members

API Navigation