123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342 |
- <?php
- /**
- * @file
- * Contains the SearchApiViewsHandlerFilterOptions class.
- */
- /**
- * Views filter handler for fields with a limited set of possible values.
- */
- class SearchApiViewsHandlerFilterOptions extends SearchApiViewsHandlerFilter {
- /**
- * Stores the values which are available on the form.
- *
- * @var array
- */
- protected $value_options = NULL;
- /**
- * The type of form element used to display the options.
- *
- * @var string
- */
- protected $value_form_type = 'checkboxes';
- /**
- * Retrieves a wrapper for this filter's field.
- *
- * @return EntityMetadataWrapper|null
- * A wrapper for the field which this filter uses.
- */
- protected function get_wrapper() {
- if ($this->query) {
- $index = $this->query->getIndex();
- }
- elseif (substr($this->view->base_table, 0, 17) == 'search_api_index_') {
- $index = search_api_index_load(substr($this->view->base_table, 17));
- }
- else {
- return NULL;
- }
- $wrapper = $index->entityWrapper(NULL, TRUE);
- $parts = explode(':', $this->real_field);
- foreach ($parts as $i => $part) {
- if (!isset($wrapper->$part)) {
- return NULL;
- }
- $wrapper = $wrapper->$part;
- $info = $wrapper->info();
- if ($i < count($parts) - 1) {
- // Unwrap lists.
- $level = search_api_list_nesting_level($info['type']);
- for ($j = 0; $j < $level; ++$j) {
- $wrapper = $wrapper[0];
- }
- }
- }
- return $wrapper;
- }
- /**
- * Fills the value_options property with all possible options.
- */
- protected function get_value_options() {
- if (isset($this->value_options)) {
- return;
- }
- $wrapper = $this->get_wrapper();
- if ($wrapper) {
- $this->value_options = $wrapper->optionsList('view');
- }
- else {
- $this->value_options = array();
- }
- }
- /**
- * Provide a list of options for the operator form.
- */
- public function operator_options() {
- $options = array(
- '=' => t('Is one of'),
- 'all of' => t('Is all of'),
- '<>' => t('Is none of'),
- 'empty' => t('Is empty'),
- 'not empty' => t('Is not empty'),
- );
- // "Is all of" doesn't make sense for single-valued fields.
- if (empty($this->definition['multi-valued'])) {
- unset($options['all of']);
- }
- return $options;
- }
- /**
- * Set "reduce" option to FALSE by default.
- */
- public function expose_options() {
- parent::expose_options();
- $this->options['expose']['reduce'] = FALSE;
- }
- /**
- * Add the "reduce" option to the exposed form.
- */
- public function expose_form(&$form, &$form_state) {
- parent::expose_form($form, $form_state);
- $form['expose']['reduce'] = array(
- '#type' => 'checkbox',
- '#title' => t('Limit list to selected items'),
- '#description' => t('If checked, the only items presented to the user will be the ones selected here.'),
- '#default_value' => !empty($this->options['expose']['reduce']),
- );
- }
- /**
- * Define "reduce" option.
- */
- public function option_definition() {
- $options = parent::option_definition();
- $options['value'] = array('default' => '');
- $options['expose']['contains']['reduce'] = array('default' => FALSE);
- return $options;
- }
- /**
- * Reduce the options according to the selection.
- */
- protected function reduce_value_options() {
- foreach ($this->value_options as $id => $option) {
- if (!isset($this->options['value'][$id])) {
- unset($this->value_options[$id]);
- }
- }
- return $this->value_options;
- }
- /**
- * Save set checkboxes.
- */
- public function value_submit($form, &$form_state) {
- // Drupal's FAPI system automatically puts '0' in for any checkbox that
- // was not set, and the key to the checkbox if it is set.
- // Unfortunately, this means that if the key to that checkbox is 0,
- // we are unable to tell if that checkbox was set or not.
- // Luckily, the '#value' on the checkboxes form actually contains
- // *only* a list of checkboxes that were set, and we can use that
- // instead.
- $form_state['values']['options']['value'] = $form['value']['#value'];
- }
- /**
- * Provide a form for setting options.
- */
- public function value_form(&$form, &$form_state) {
- $this->get_value_options();
- if (!empty($this->options['expose']['reduce']) && !empty($form_state['exposed'])) {
- $options = $this->reduce_value_options();
- }
- else {
- $options = $this->value_options;
- }
- $form['value'] = array(
- '#type' => $this->value_form_type,
- '#title' => empty($form_state['exposed']) ? t('Value') : '',
- '#options' => $options,
- '#multiple' => TRUE,
- '#size' => min(4, count($options)),
- '#default_value' => is_array($this->value) ? $this->value : array(),
- );
- // Hide the value box if the operator is 'empty' or 'not empty'.
- // Radios share the same selector so we have to add some dummy selector.
- if (empty($form_state['exposed'])) {
- $form['value']['#states']['visible'] = array(
- ':input[name="options[operator]"],dummy-empty' => array('!value' => 'empty'),
- ':input[name="options[operator]"],dummy-not-empty' => array('!value' => 'not empty'),
- );
- }
- elseif (!empty($this->options['expose']['use_operator'])) {
- $name = $this->options['expose']['operator_id'];
- $form['value']['#states']['visible'] = array(
- ':input[name="' . $name . '"],dummy-empty' => array('!value' => 'empty'),
- ':input[name="' . $name . '"],dummy-not-empty' => array('!value' => 'not empty'),
- );
- }
- }
- /**
- * Provides a summary of this filter's value for the admin UI.
- */
- public function admin_summary() {
- if (!empty($this->options['exposed'])) {
- return t('exposed');
- }
- if ($this->operator === 'empty') {
- return t('is empty');
- }
- if ($this->operator === 'not empty') {
- return t('is not empty');
- }
- if (!is_array($this->value)) {
- return;
- }
- $operator_options = $this->operator_options();
- $operator = $operator_options[$this->operator];
- $values = '';
- // Remove every element which is not known.
- $this->get_value_options();
- foreach ($this->value as $i => $value) {
- if (!isset($this->value_options[$value])) {
- unset($this->value[$i]);
- }
- }
- // Choose different kind of ouput for 0, a single and multiple values.
- if (count($this->value) == 0) {
- return $this->operator != '<>' ? t('none') : t('any');
- }
- elseif (count($this->value) == 1) {
- switch ($this->operator) {
- case '=':
- case 'all of':
- $operator = '=';
- break;
- case '<>':
- $operator = '<>';
- break;
- }
- // If there is only a single value, use just the plain operator, = or <>.
- $operator = check_plain($operator);
- $values = check_plain($this->value_options[reset($this->value)]);
- }
- else {
- foreach ($this->value as $value) {
- if ($values !== '') {
- $values .= ', ';
- }
- if (drupal_strlen($values) > 20) {
- $values .= '…';
- break;
- }
- $values .= check_plain($this->value_options[$value]);
- }
- }
- return $operator . (($values !== '') ? ' ' . $values : '');
- }
- /**
- * {@inheritdoc}
- */
- function accept_exposed_input($input) {
- $accepted = parent::accept_exposed_input($input);
- // Grouped filters will have the raw form values structure from the
- // checkboxes as the value here. Convert that into the correct array of
- // values instead.
- if ($accepted && is_array($this->value) && $this->is_a_group()) {
- // For some reason, Views thinks it's a good idea to nest the form values
- // into a second array in some cases. That one will be numerically indexed
- // with just a single entry, though, so it should be relatively easy to
- // spot.
- if (count($this->value) && isset($this->value[0])) {
- $this->value = reset($this->value);
- }
- $this->value = array_keys(array_filter($this->value));
- if (!$this->value) {
- return FALSE;
- }
- }
- return $accepted;
- }
- /**
- * Add this filter to the query.
- */
- public function query() {
- if ($this->operator === 'empty') {
- $this->query->condition($this->real_field, NULL, '=', $this->options['group']);
- return;
- }
- if ($this->operator === 'not empty') {
- $this->query->condition($this->real_field, NULL, '<>', $this->options['group']);
- return;
- }
- // Extract the value.
- while (is_array($this->value) && count($this->value) == 1) {
- $this->value = reset($this->value);
- }
- // Determine operator and conjunction. The defaults are already right for
- // "all of".
- $operator = '=';
- $conjunction = 'AND';
- switch ($this->operator) {
- case '=':
- $conjunction = 'OR';
- break;
- case '<>':
- $operator = '<>';
- break;
- }
- // If the value is an empty array, we either want no filter at all (for
- // "is none of"), or want to find only items with no value for the field.
- if ($this->value === array()) {
- if ($operator != '<>') {
- $this->query->condition($this->real_field, NULL, '=', $this->options['group']);
- }
- return;
- }
- if (is_scalar($this->value) && $this->value !== '') {
- $this->query->condition($this->real_field, $this->value, $operator, $this->options['group']);
- }
- elseif ($this->value) {
- $filter = $this->query->createFilter($conjunction);
- // $filter will be NULL if there were errors in the query.
- if ($filter) {
- foreach ($this->value as $v) {
- $filter->condition($this->real_field, $v, $operator);
- }
- $this->query->filter($filter, $this->options['group']);
- }
- }
- }
- }
|