danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * Definition of views_handler_argument_string.
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Basic argument handler to implement string arguments that may have length
danielebarchiesi@0:  * limits.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @ingroup views_argument_handlers
danielebarchiesi@0:  */
danielebarchiesi@0: class views_handler_argument_string extends views_handler_argument {
danielebarchiesi@0:   function init(&$view, &$options) {
danielebarchiesi@0:     parent::init($view, $options);
danielebarchiesi@0:     if (!empty($this->definition['many to one'])) {
danielebarchiesi@0:       $this->helper = new views_many_to_one_helper($this);
danielebarchiesi@0: 
danielebarchiesi@0:       // Ensure defaults for these, during summaries and stuff:
danielebarchiesi@0:       $this->operator = 'or';
danielebarchiesi@0:       $this->value = array();
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function option_definition() {
danielebarchiesi@0:     $options = parent::option_definition();
danielebarchiesi@0: 
danielebarchiesi@0:     $options['glossary'] = array('default' => FALSE, 'bool' => TRUE);
danielebarchiesi@0:     $options['limit'] = array('default' => 0);
danielebarchiesi@0:     $options['case'] = array('default' => 'none');
danielebarchiesi@0:     $options['path_case'] = array('default' => 'none');
danielebarchiesi@0:     $options['transform_dash'] = array('default' => FALSE, 'bool' => TRUE);
danielebarchiesi@0:     $options['break_phrase'] = array('default' => FALSE, 'bool' => TRUE);
danielebarchiesi@0: 
danielebarchiesi@0:     if (!empty($this->definition['many to one'])) {
danielebarchiesi@0:       $options['add_table'] = array('default' => FALSE, 'bool' => TRUE);
danielebarchiesi@0:       $options['require_value'] = array('default' => FALSE, 'bool' => TRUE);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     return $options;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function options_form(&$form, &$form_state) {
danielebarchiesi@0:     parent::options_form($form, $form_state);
danielebarchiesi@0: 
danielebarchiesi@0:     $form['glossary'] = array(
danielebarchiesi@0:       '#type' => 'checkbox',
danielebarchiesi@0:       '#title' => t('Glossary mode'),
danielebarchiesi@0:       '#description' => t('Glossary mode applies a limit to the number of characters used in the filter value, which allows the summary view to act as a glossary.'),
danielebarchiesi@0:       '#default_value' => $this->options['glossary'],
danielebarchiesi@0:       '#fieldset' => 'more',
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $form['limit'] = array(
danielebarchiesi@0:       '#type' => 'textfield',
danielebarchiesi@0:       '#title' => t('Character limit'),
danielebarchiesi@0:       '#description' => t('How many characters of the filter value to filter against. If set to 1, all fields starting with the first letter in the filter value would be matched.'),
danielebarchiesi@0:       '#default_value' => $this->options['limit'],
danielebarchiesi@0:       '#dependency' => array('edit-options-glossary' => array(TRUE)),
danielebarchiesi@0:       '#fieldset' => 'more',
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $form['case'] = array(
danielebarchiesi@0:       '#type' => 'select',
danielebarchiesi@0:       '#title' => t('Case'),
danielebarchiesi@0:       '#description' => t('When printing the title and summary, how to transform the case of the filter value.'),
danielebarchiesi@0:       '#options' => array(
danielebarchiesi@0:         'none' => t('No transform'),
danielebarchiesi@0:         'upper' => t('Upper case'),
danielebarchiesi@0:         'lower' => t('Lower case'),
danielebarchiesi@0:         'ucfirst' => t('Capitalize first letter'),
danielebarchiesi@0:         'ucwords' => t('Capitalize each word'),
danielebarchiesi@0:       ),
danielebarchiesi@0:       '#default_value' => $this->options['case'],
danielebarchiesi@0:       '#fieldset' => 'more',
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $form['path_case'] = array(
danielebarchiesi@0:       '#type' => 'select',
danielebarchiesi@0:       '#title' => t('Case in path'),
danielebarchiesi@0:       '#description' => t('When printing url paths, how to transform the case of the filter value. Do not use this unless with Postgres as it uses case sensitive comparisons.'),
danielebarchiesi@0:       '#options' => array(
danielebarchiesi@0:         'none' => t('No transform'),
danielebarchiesi@0:         'upper' => t('Upper case'),
danielebarchiesi@0:         'lower' => t('Lower case'),
danielebarchiesi@0:         'ucfirst' => t('Capitalize first letter'),
danielebarchiesi@0:         'ucwords' => t('Capitalize each word'),
danielebarchiesi@0:       ),
danielebarchiesi@0:       '#default_value' => $this->options['path_case'],
danielebarchiesi@0:       '#fieldset' => 'more',
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $form['transform_dash'] = array(
danielebarchiesi@0:       '#type' => 'checkbox',
danielebarchiesi@0:       '#title' => t('Transform spaces to dashes in URL'),
danielebarchiesi@0:       '#default_value' => $this->options['transform_dash'],
danielebarchiesi@0:       '#fieldset' => 'more',
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     if (!empty($this->definition['many to one'])) {
danielebarchiesi@0:       $form['add_table'] = array(
danielebarchiesi@0:         '#type' => 'checkbox',
danielebarchiesi@0:         '#title' => t('Allow multiple filter values to work together'),
danielebarchiesi@0:         '#description' => t('If selected, multiple instances of this filter can work together, as though multiple values were supplied to the same filter. This setting is not compatible with the "Reduce duplicates" setting.'),
danielebarchiesi@0:         '#default_value' => !empty($this->options['add_table']),
danielebarchiesi@0:         '#fieldset' => 'more',
danielebarchiesi@0:       );
danielebarchiesi@0: 
danielebarchiesi@0:       $form['require_value'] = array(
danielebarchiesi@0:         '#type' => 'checkbox',
danielebarchiesi@0:         '#title' => t('Do not display items with no value in summary'),
danielebarchiesi@0:         '#default_value' => !empty($this->options['require_value']),
danielebarchiesi@0:         '#fieldset' => 'more',
danielebarchiesi@0:       );
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // allow + for or, , for and
danielebarchiesi@0:     $form['break_phrase'] = array(
danielebarchiesi@0:       '#type' => 'checkbox',
danielebarchiesi@0:       '#title' => t('Allow multiple values'),
danielebarchiesi@0:       '#description' => t('If selected, users can enter multiple values in the form of 1+2+3 (for OR) or 1,2,3 (for AND).'),
danielebarchiesi@0:       '#default_value' => !empty($this->options['break_phrase']),
danielebarchiesi@0:       '#fieldset' => 'more',
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Build the summary query based on a string
danielebarchiesi@0:    */
danielebarchiesi@0:   function summary_query() {
danielebarchiesi@0:     if (empty($this->definition['many to one'])) {
danielebarchiesi@0:       $this->ensure_my_table();
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $this->table_alias = $this->helper->summary_join();
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (empty($this->options['glossary'])) {
danielebarchiesi@0:       // Add the field.
danielebarchiesi@0:       $this->base_alias = $this->query->add_field($this->table_alias, $this->real_field);
danielebarchiesi@0:       $this->query->set_count_field($this->table_alias, $this->real_field);
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       // Add the field.
danielebarchiesi@0:       $formula = $this->get_formula();
danielebarchiesi@0:       $this->base_alias = $this->query->add_field(NULL, $formula, $this->field . '_truncated');
danielebarchiesi@0:       $this->query->set_count_field(NULL, $formula, $this->field, $this->field . '_truncated');
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $this->summary_name_field();
danielebarchiesi@0:     return $this->summary_basics(FALSE);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Get the formula for this argument.
danielebarchiesi@0:    *
danielebarchiesi@0:    * $this->ensure_my_table() MUST have been called prior to this.
danielebarchiesi@0:    */
danielebarchiesi@0:   function get_formula() {
danielebarchiesi@0:     return "SUBSTRING($this->table_alias.$this->real_field, 1, " . intval($this->options['limit']) . ")";
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Build the query based upon the formula
danielebarchiesi@0:    */
danielebarchiesi@0:   function query($group_by = FALSE) {
danielebarchiesi@0:     $argument = $this->argument;
danielebarchiesi@0:     if (!empty($this->options['transform_dash'])) {
danielebarchiesi@0:       $argument = strtr($argument, '-', ' ');
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (!empty($this->options['break_phrase'])) {
danielebarchiesi@0:       views_break_phrase_string($argument, $this);
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $this->value = array($argument);
danielebarchiesi@0:       $this->operator = 'or';
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (!empty($this->definition['many to one'])) {
danielebarchiesi@0:       if (!empty($this->options['glossary'])) {
danielebarchiesi@0:         $this->helper->formula = TRUE;
danielebarchiesi@0:       }
danielebarchiesi@0:       $this->helper->ensure_my_table();
danielebarchiesi@0:       $this->helper->add_filter();
danielebarchiesi@0:       return;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $this->ensure_my_table();
danielebarchiesi@0:     $formula = FALSE;
danielebarchiesi@0:     if (empty($this->options['glossary'])) {
danielebarchiesi@0:       $field = "$this->table_alias.$this->real_field";
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $formula = TRUE;
danielebarchiesi@0:       $field = $this->get_formula();
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (count($this->value) > 1) {
danielebarchiesi@0:       $operator = 'IN';
danielebarchiesi@0:       $argument = $this->value;
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $operator = '=';
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if ($formula) {
danielebarchiesi@0:       $placeholder = $this->placeholder();
danielebarchiesi@0:       if ($operator == 'IN') {
danielebarchiesi@0:         $field .= " IN($placeholder)";
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         $field .= ' = ' . $placeholder;
danielebarchiesi@0:       }
danielebarchiesi@0:       $placeholders = array(
danielebarchiesi@0:         $placeholder => $argument,
danielebarchiesi@0:       );
danielebarchiesi@0:       $this->query->add_where_expression(0, $field, $placeholders);
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $this->query->add_where(0, $field, $argument, $operator);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function summary_argument($data) {
danielebarchiesi@0:     $value = $this->case_transform($data->{$this->base_alias}, $this->options['path_case']);
danielebarchiesi@0:     if (!empty($this->options['transform_dash'])) {
danielebarchiesi@0:       $value = strtr($value, ' ', '-');
danielebarchiesi@0:     }
danielebarchiesi@0:     return $value;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function get_sort_name() {
danielebarchiesi@0:     return t('Alphabetical', array(), array('context' => 'Sort order'));
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function title() {
danielebarchiesi@0:     $this->argument = $this->case_transform($this->argument, $this->options['case']);
danielebarchiesi@0:     if (!empty($this->options['transform_dash'])) {
danielebarchiesi@0:       $this->argument = strtr($this->argument, '-', ' ');
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (!empty($this->options['break_phrase'])) {
danielebarchiesi@0:       views_break_phrase_string($this->argument, $this);
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $this->value = array($this->argument);
danielebarchiesi@0:       $this->operator = 'or';
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (empty($this->value)) {
danielebarchiesi@0:       return !empty($this->definition['empty field name']) ? $this->definition['empty field name'] : t('Uncategorized');
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if ($this->value === array(-1)) {
danielebarchiesi@0:       return !empty($this->definition['invalid input']) ? $this->definition['invalid input'] : t('Invalid input');
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     return implode($this->operator == 'or' ? ' + ' : ', ', $this->title_query());
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Override for specific title lookups.
danielebarchiesi@0:    */
danielebarchiesi@0:   function title_query() {
danielebarchiesi@0:     return drupal_map_assoc($this->value, 'check_plain');
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function summary_name($data) {
danielebarchiesi@0:     return $this->case_transform(parent::summary_name($data), $this->options['case']);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0: }