123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474 |
- <?php
- /**
- * @file
- * Definition of views_handler_filter_in_operator.
- */
- /**
- * Simple filter to handle matching of multiple options using checkboxes.
- *
- * Definition items:
- * - options callback: The function to call in order to generate the value
- * options. If omitted, the options 'Yes' and 'No' will be used.
- * - options arguments: An array of arguments to pass to the options callback.
- *
- * @ingroup views_filter_handlers
- */
- class views_handler_filter_in_operator extends views_handler_filter {
- /**
- *
- */
- public $value_form_type = 'checkboxes';
- /**
- * @var array
- * Stores all operations which are available on the form.
- */
- public $value_options = NULL;
- /**
- * {@inheritdoc}
- */
- public function construct() {
- parent::construct();
- $this->value_title = t('Options');
- $this->value_options = NULL;
- }
- /**
- * 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.
- *
- * This can use a guard to be used to reduce database hits as much as
- * possible.
- *
- * @return
- * Return the stored values in $this->value_options if someone expects it.
- */
- public 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 {
- $this->value_options = array(t('Yes'), t('No'));
- }
- return $this->value_options;
- }
- /**
- * {@inheritdoc}
- */
- public function expose_options() {
- parent::expose_options();
- $this->options['expose']['reduce'] = FALSE;
- }
- /**
- * {@inheritdoc}
- */
- 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.'),
- // Safety.
- '#default_value' => !empty($this->options['expose']['reduce']),
- );
- }
- /**
- * {@inheritdoc}
- */
- public function option_definition() {
- $options = parent::option_definition();
- $options['operator']['default'] = 'in';
- $options['value']['default'] = array();
- $options['expose']['contains']['reduce'] = array('default' => FALSE, 'bool' => TRUE);
- return $options;
- }
- /**
- * 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.
- */
- public function operators() {
- $operators = array(
- 'in' => array(
- 'title' => t('Is one of'),
- 'short' => t('in'),
- 'short_single' => t('='),
- 'method' => 'op_simple',
- 'values' => 1,
- ),
- 'not in' => array(
- 'title' => t('Is not one of'),
- 'short' => t('not in'),
- 'short_single' => t('<>'),
- 'method' => 'op_simple',
- 'values' => 1,
- ),
- );
- // if the definition allows for the empty operator, add it.
- if (!empty($this->definition['allow empty'])) {
- $operators += array(
- 'empty' => array(
- 'title' => t('Is empty (NULL)'),
- 'method' => 'op_empty',
- 'short' => t('empty'),
- 'values' => 0,
- ),
- 'not empty' => array(
- 'title' => t('Is not empty (NOT NULL)'),
- 'method' => 'op_empty',
- 'short' => t('not empty'),
- 'values' => 0,
- ),
- );
- }
- return $operators;
- }
- /**
- * Build strings from the operators() for 'select' options.
- */
- public function operator_options($which = 'title') {
- $options = array();
- foreach ($this->operators() as $id => $info) {
- $options[$id] = $info[$which];
- }
- return $options;
- }
- /**
- * {@inheritdoc}
- */
- public function operator_values($values = 1) {
- $options = array();
- foreach ($this->operators() as $id => $info) {
- if (isset($info['values']) && $info['values'] == $values) {
- $options[] = $id;
- }
- }
- return $options;
- }
- /**
- * {@inheritdoc}
- */
- public function value_form(&$form, &$form_state) {
- $form['value'] = array();
- $options = array();
- if (empty($form_state['exposed'])) {
- // Add a select all option to the value form.
- $options = array('all' => t('Select all'));
- }
- $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') {
- $form['value'] = array(
- '#type' => $this->value_form_type,
- '#title' => $this->value_title,
- '#options' => $options,
- '#default_value' => $default_value,
- // These are only valid for 'select' type, but do no harm to checkboxes.
- '#multiple' => TRUE,
- '#size' => count($options) > 8 ? 8 : count($options),
- );
- if (!empty($form_state['exposed']) && !isset($form_state['input'][$identifier])) {
- $form_state['input'][$identifier] = $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));
- }
- }
- }
- /**
- * When using exposed filters, we may be required to reduce the set.
- */
- public function reduce_value_options($input = NULL) {
- if (!isset($input)) {
- $input = $this->value_options;
- }
- // Because options may be an array of strings, or an array of mixed arrays
- // and strings (optgroups) or an array of objects, we have to
- // step through and handle each one individually.
- $options = array();
- foreach ($input as $id => $option) {
- if (is_array($option)) {
- $options[$id] = $this->reduce_value_options($option);
- continue;
- }
- elseif (is_object($option)) {
- $keys = array_keys($option->option);
- $key = array_shift($keys);
- if (isset($this->options['value'][$key])) {
- $options[$id] = $option;
- }
- }
- elseif (isset($this->options['value'][$id])) {
- $options[$id] = $option;
- }
- }
- return $options;
- }
- /**
- * {@inheritdoc}
- */
- public function accept_exposed_input($input) {
- // A very special override because the All state for this type of
- // filter could have a default.
- if (empty($this->options['exposed'])) {
- return TRUE;
- }
- // If this is non-multiple and non-required, then this filter will
- // participate, but using the default settings, *if* 'limit is true.
- if (empty($this->options['expose']['multiple']) && empty($this->options['expose']['required']) && !empty($this->options['expose']['limit'])) {
- $identifier = $this->options['expose']['identifier'];
- if ($input[$identifier] == 'All') {
- return TRUE;
- }
- }
- return parent::accept_exposed_input($input);
- }
- /**
- * {@inheritdoc}
- */
- 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'];
- }
- /**
- * {@inheritdoc}
- */
- public function admin_summary() {
- if ($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))) {
- // Remove every element which is not known.
- foreach ($this->value as $value) {
- if (!isset($this->value_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($this->value_options[$value])) {
- $values = check_plain($this->value_options[$value]);
- }
- else {
- $values = '';
- }
- }
- else {
- foreach ($this->value as $value) {
- if ($values !== '') {
- $values .= ', ';
- }
- if (drupal_strlen($values) > 8) {
- $values .= '...';
- break;
- }
- if (isset($this->value_options[$value])) {
- $values .= check_plain($this->value_options[$value]);
- }
- }
- }
- }
- return $operator . (($values !== '') ? ' ' . $values : '');
- }
- /**
- * {@inheritdoc}
- */
- public function query() {
- $info = $this->operators();
- if (!empty($info[$this->operator]['method'])) {
- $this->{$info[$this->operator]['method']}();
- }
- }
- /**
- * {@inheritdoc}
- */
- public function op_simple() {
- if (empty($this->value)) {
- return;
- }
- $this->ensure_my_table();
- // We use array_values() because the checkboxes keep keys and that can cause
- // array addition problems.
- $this->query->add_where($this->options['group'], "$this->table_alias.$this->real_field", array_values($this->value), $this->operator);
- }
- /**
- * {@inheritdoc}
- */
- public function op_empty() {
- $this->ensure_my_table();
- if ($this->operator == 'empty') {
- $operator = "IS NULL";
- }
- else {
- $operator = "IS NOT NULL";
- }
- $this->query->add_where($this->options['group'], "$this->table_alias.$this->real_field", NULL, $operator);
- }
- /**
- * {@inheritdoc}
- */
- public function validate() {
- $this->get_value_options();
- $errors = array();
- // If the operator is an operator which doesn't require a value, there is
- // no need for additional validation.
- if (in_array($this->operator, $this->operator_values(0))) {
- return array();
- }
- if (!in_array($this->operator, $this->operator_values(1))) {
- $errors[] = t('The operator is invalid on filter: @filter.', array('@filter' => $this->ui_name(TRUE)));
- }
- if (is_array($this->value)) {
- if (!isset($this->value_options)) {
- // Don't validate if there are none value options provided, for example
- // for special handlers.
- return $errors;
- }
- if ($this->options['exposed'] && !$this->options['expose']['required'] && empty($this->value)) {
- // Don't validate if the field is exposed and no default value is
- // provided.
- return $errors;
- }
- // Some filter_in_operator usage uses optgroups forms, so flatten it.
- $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) {
- $errors[] = t('No valid values found on filter: @filter.', array('@filter' => $this->ui_name(TRUE)));
- }
- }
- elseif (!empty($this->value) && ($this->operator == 'in' || $this->operator == 'not in')) {
- $errors[] = t('The value @value is not an array for @operator on filter: @filter', array('@value' => views_var_export($this->value), '@operator' => $this->operator, '@filter' => $this->ui_name(TRUE)));
- }
- return $errors;
- }
- }
|