You are here

Home » API reference » Views (for Drupal 7) 6.3 » views_handler_argument_string.inc

class views_handler_argument_string in Views (for Drupal 7) 6.3

Same name and namespace in other branches
  1. 6.2 handlers/views_handler_argument_string.inc \views_handler_argument_string
  2. 7.3 handlers/views_handler_argument_string.inc \views_handler_argument_string

Basic argument handler to implement string arguments that may have length limits.

Hierarchy

Expanded class hierarchy of views_handler_argument_string

Related topics

Handlers for arguments
13 string references to 'views_handler_argument_string'
aggregator_views_data in modules/aggregator.views.inc
Implementation of hook_views_data()
comment_views_data in modules/comment.views.inc
Implementation of hook_views_data()
hook_views_data in docs/docs.php
Describe table structure to Views.
locale_views_data in modules/locale.views.inc
Implementation of hook_views_data().
node_views_data in modules/node.views.inc
Implementation of hook_views_data()

... See full list

File

handlers/views_handler_argument_string.inc, line 9

View source 
class views_handler_argument_string extends views_handler_argument {
  function init(&$view, $options) {
    parent::init($view, $options);
    if (!empty($this->definition['many to one'])) {
      $this->helper = new views_many_to_one_helper($this);

      // Ensure defaults for these, during summaries and stuff:
      $this->operator = 'or';
      $this->value = array();
    }
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['glossary'] = array(
      'default' => FALSE,
    );
    $options['ignorecase'] = array(
      'default' => FALSE,
    );
    $options['limit'] = array(
      'default' => 0,
    );
    $options['case'] = array(
      'default' => 'none',
    );
    $options['path_case'] = array(
      'default' => 'none',
    );
    $options['transform_dash'] = array(
      'default' => FALSE,
    );
    $options['break_phrase'] = array(
      'default' => FALSE,
    );
    if (!empty($this->definition['many to one'])) {
      $options['add_table'] = array(
        'default' => FALSE,
      );
      $options['require_value'] = array(
        'default' => FALSE,
      );
    }
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['glossary'] = array(
      '#type' => 'checkbox',
      '#title' => t('Glossary mode'),
      '#description' => t('Glossary mode applies a limit to the number of characters used in the argument, which allows the summary view to act as a glossary.'),
      '#default_value' => $this->options['glossary'],
    );
    $form['ignorecase'] = array(
      '#type' => 'checkbox',
      '#title' => t('Ignore case'),
      '#description' => t('Ignore case allows for doing database searches without case sensitivity. MySQL already works in lower-case mode, so MySQL users should leave this unchecked to improve performance.'),
      '#default_value' => $this->options['ignorecase'],
    );
    $form['limit'] = array(
      '#type' => 'textfield',
      '#title' => t('Character limit'),
      '#description' => t('How many characters of the argument to filter against. If set to 1, all fields starting with the letter in the argument would be matched.'),
      '#default_value' => $this->options['limit'],
      '#process' => array(
        'views_process_dependency',
      ),
      '#dependency' => array(
        'edit-options-glossary' => array(
          TRUE,
        ),
      ),
    );
    $form['case'] = array(
      '#type' => 'select',
      '#title' => t('Case'),
      '#description' => t('When printing the argument result, how to transform the case.'),
      '#options' => array(
        'none' => t('No transform'),
        'upper' => t('Upper case'),
        'lower' => t('Lower case'),
        'ucfirst' => t('Capitalize first letter'),
        'ucwords' => t('Capitalize each word'),
      ),
      '#default_value' => $this->options['case'],
    );
    $form['path_case'] = array(
      '#type' => 'select',
      '#title' => t('Case in path'),
      '#description' => t('When printing url paths, how to transform the case of the argument. Do not use this unless with Postgres as it uses case sensitive comparisons.'),
      '#options' => array(
        'none' => t('No transform'),
        'upper' => t('Upper case'),
        'lower' => t('Lower case'),
        'ucfirst' => t('Capitalize first letter'),
        'ucwords' => t('Capitalize each word'),
      ),
      '#default_value' => $this->options['path_case'],
    );
    $form['transform_dash'] = array(
      '#type' => 'checkbox',
      '#title' => t('Transform spaces to dashes in URL'),
      '#default_value' => $this->options['transform_dash'],
    );
    if (!empty($this->definition['many to one'])) {
      $form['add_table'] = array(
        '#type' => 'checkbox',
        '#title' => t('Allow multiple arguments to work together'),
        '#description' => t('If selected, multiple instances of this argument can work together, as though multiple terms were supplied to the same argument. This setting is not compatible with the "Reduce duplicates" setting.'),
        '#default_value' => !empty($this->options['add_table']),
      );
      $form['require_value'] = array(
        '#type' => 'checkbox',
        '#title' => t('Do not display items with no value in summary'),
        '#default_value' => !empty($this->options['require_value']),
      );
    }

    // allow + for or, , for and
    $form['break_phrase'] = array(
      '#type' => 'checkbox',
      '#title' => t('Allow multiple terms per argument'),
      '#description' => t('If selected, users can enter multiple arguments in the form of 1+2+3 or 1,2,3.'),
      '#default_value' => !empty($this->options['break_phrase']),
    );
  }

  /**
   * Build the summary query based on a string
   */
  function summary_query() {
    if (empty($this->definition['many to one'])) {
      $this
        ->ensure_my_table();
    }
    else {
      $this->table_alias = $this->helper
        ->summary_join();
    }
    if (empty($this->options['glossary'])) {

      // Add the field.
      if (empty($this->options['ignorecase'])) {
        $this->base_alias = $this->query
          ->add_field($this->table_alias, $this->real_field);
        $this->query
          ->set_count_field($this->table_alias, $this->real_field);
      }
      else {
        $this->base_alias = $this->query
          ->add_field($this->table_alias, 'LOWER(' . $this->real_field . ')');
        $this->query
          ->set_count_field($this->table_alias, 'LOWER(' . $this->real_field . ')');
      }
    }
    else {

      // Add the field.
      $formula = $this
        ->get_formula();
      if (empty($this->options['ignorecase'])) {
        $this->base_alias = $this->query
          ->add_field(NULL, $formula, $this->field . '_truncated');
        $this->query
          ->set_count_field(NULL, $formula, $this->field, $this->field . '_truncated');
      }
      else {
        $this->base_alias = $this->query
          ->add_field(NULL, 'LOWER(' . $formula . ')', $this->field . '_truncated');
        $this->query
          ->set_count_field(NULL, $formula, $this->field, $this->field . '_truncated');
      }
    }
    $this
      ->summary_name_field();
    return $this
      ->summary_basics(FALSE);
  }

  /**
   * Get the formula for this argument.
   *
   * $this->ensure_my_table() MUST have been called prior to this.
   */
  function get_formula() {
    return "SUBSTR({$this->table_alias}.{$this->real_field}, 1, " . intval($this->options['limit']) . ")";
  }

  /**
   * Build the query based upon the formula
   */
  function query() {
    $argument = $this->argument;
    if (!empty($this->options['transform_dash'])) {
      $argument = strtr($argument, '-', ' ');
    }
    if (!empty($this->options['break_phrase'])) {
      views_break_phrase_string($argument, $this);
    }
    else {
      $this->value = array(
        $argument,
      );
      $this->operator = 'or';
    }
    if (!empty($this->definition['many to one'])) {
      if (!empty($this->options['glossary'])) {
        $this->helper->formula = TRUE;
      }
      $this->helper
        ->ensure_my_table();
      $this->helper
        ->add_filter();
      return;
    }
    $this
      ->ensure_my_table();
    if (empty($this->options['glossary'])) {
      $field = "{$this->table_alias}.{$this->real_field}";
    }
    else {
      $field = $this
        ->get_formula();
    }
    if (count($this->value) > 1) {
      $operator = 'IN';
      $placeholders = '(' . implode(', ', array_fill(0, sizeof($this->value), "'%s'")) . ')';
      $argument = $this->value;
    }
    else {
      $placeholders = "'%s'";
      $operator = '=';
    }
    if (empty($this->options['ignorecase'])) {
      $this->query
        ->add_where(0, "{$field} {$operator} {$placeholders}", $argument);
    }
    else {
      $this->query
        ->add_where(0, "LOWER({$field}) {$operator} LOWER({$placeholders})", $argument);
    }
  }
  function summary_argument($data) {
    $value = $this
      ->case_transform($data->{$this->base_alias}, 'path_case');
    if (!empty($this->options['transform_dash'])) {
      $value = strtr($value, ' ', '-');
    }
    return $value;
  }
  function case_transform($string, $option) {
    global $multibyte;
    switch ($this->options[$option]) {
      default:
        return $string;
      case 'upper':
        return drupal_strtoupper($string);
      case 'lower':
        return drupal_strtolower($string);
      case 'ucfirst':
        return drupal_strtoupper(drupal_substr($string, 0, 1)) . drupal_substr($string, 1);
      case 'ucwords':
        if ($multibyte == UNICODE_MULTIBYTE) {
          return mb_convert_case($string, MB_CASE_TITLE);
        }
        else {
          return ucwords($string);
        }
    }
  }
  function title() {
    $this->argument = $this
      ->case_transform($this->argument, 'case');
    if (!empty($this->options['transform_dash'])) {
      $this->argument = strtr($this->argument, '-', ' ');
    }
    if (!empty($this->options['break_phrase'])) {
      views_break_phrase_string($this->argument, $this);
    }
    else {
      $this->value = array(
        $this->argument,
      );
      $this->operator = 'or';
    }
    if (empty($this->value)) {
      return !empty($this->definition['empty field name']) ? $this->definition['empty field name'] : t('Uncategorized');
    }
    if ($this->value === array(
      -1,
    )) {
      return !empty($this->definition['invalid input']) ? $this->definition['invalid input'] : t('Invalid input');
    }
    return implode($this->operator == 'or' ? ' + ' : ', ', $this
      ->title_query());
  }

  /**
   * Override for specific title lookups.
   */
  function title_query() {
    return drupal_map_assoc($this->value, 'check_plain');
  }
  function summary_name($data) {
    return $this
      ->case_transform(parent::summary_name($data), 'case');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_handler::$handler_type property The type of the handler, for example filter/footer/field.
views_handler::$query property Where the $query object will reside: 6
views_handler::$view property The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input function Take input from exposed handlers and assign to this handler, if necessary. 1
views_handler::access function Check whether current user has access to this handler. 6
views_handler::admin_summary function Provide text for the administrative summary 4
views_handler::broken function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. 6
views_handler::can_expose function Determine if a handler can be exposed. 2
views_handler::ensure_my_table function Ensure the main table for this handler is in the query. This is used a lot. 8
views_handler::exposed_form function Render our chunk of the exposed handler form when selecting 2
views_handler::exposed_info function Get information about the exposed form for the form renderer. 1
views_handler::exposed_submit function Submit the exposed handler form
views_handler::exposed_validate function Validate the exposed handler form 4
views_handler::expose_form function Overridable form for exposed handler options.
views_handler::expose_form_left function 2
views_handler::expose_form_right function 2
views_handler::expose_options function Set new exposed option defaults when exposed setting is flipped on. 2
views_handler::expose_submit 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::expose_validate function Validate the options form. 1
views_handler::extra_options function Provide defaults for the handler.
views_handler::extra_options_form function Provide a form for setting options. 1
views_handler::extra_options_submit 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 function Validate the options form.
views_handler::get_field function Shortcut to get a handler's raw field value.
views_handler::get_join function Get the join object that should be used for this handler.
views_handler::has_extra_options 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 function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::pre_query function Run before the view is built. 1
views_handler::sanitize_value function Sanitize the value for output.
views_handler::set_relationship function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_button function Shortcut to display the expose/hide button.
views_handler::show_expose_form function Shortcut to display the exposed options form.
views_handler::store_exposed_input function If set to remember exposed input in the session, store it there. 1
views_handler::ui_name function Return a string representing this handler's name in the UI. 10
views_handler::use_group_by function Provides the handler some groupby. 2
views_handler::validate function Validates the handler against the complete View. 1
views_handler_argument::$name_field property
views_handler_argument::construct function Constructor Overrides views_object::construct 6
views_handler_argument::default_action function Handle the default action, which means our argument wasn't present.
views_handler_argument::default_actions function Provide a list of default behaviors for this argument if the argument is not present. 3
views_handler_argument::default_argument_form function Provide a form for selecting the default argument when the default action is set to provide default argument. 1
views_handler_argument::default_default function This just returns true. The view argument builder will know where to find the argument from.
views_handler_argument::default_empty function Default action: empty
views_handler_argument::default_ignore function Default action: ignore.
views_handler_argument::default_not_found function Default action: not found.
views_handler_argument::default_summary function Default action: summary.
views_handler_argument::export_plugin function Special handling for the style export. 1
views_handler_argument::export_style function Special handling for the style export.
views_handler_argument::get_default_argument function Get a default argument, if available. 1
views_handler_argument::get_plugin function Get the display or row plugin, if it exists.
views_handler_argument::get_title function Called by the view object to get the title. This may be set by a validator so we don't necessarily call through to title().
views_handler_argument::get_value function Get the value of this argument.
views_handler_argument::has_default_argument function Determine if the argument is set to provide a default argument.
views_handler_argument::is_wildcard function
views_handler_argument::needs_style_plugin function Determine if the argument needs a style plugin. Overrides views_handler::needs_style_plugin
views_handler_argument::options_submit function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides views_handler::options_submit
views_handler_argument::options_validate function Validate the options form. Overrides views_handler::options_validate
views_handler_argument::set_argument function Set the input for this argument
views_handler_argument::set_breadcrumb function Give an argument the opportunity to modify the breadcrumb, if it wants. This only gets called on displays where a breadcrumb is actually used. 2
views_handler_argument::summary_basics function Some basic summary behavior that doesn't need to be repeated as much as code that goes into summary_query()
views_handler_argument::summary_name_field function Add the name field, which is the field displayed in summary queries. This is often used when the argument is numeric.
views_handler_argument::summary_sort function Sorts the summary based upon the user's selection. The base variant of this is usually adequte.
views_handler_argument::uses_breadcrumb function Determine if the argument can generate a breadcrumb
views_handler_argument::validate_arg function Validate that this argument works. By default, all arguments are valid.
views_handler_argument::validate_argument function Called by the menu system to validate an argument.
views_handler_argument::validate_argument_basic function Provide a basic argument validation. 1
views_handler_argument::validate_fail function How to act if validation failes
views_handler_argument::wildcard_title function
views_handler_argument_string::case_transform function
views_handler_argument_string::get_formula function Get the formula for this argument.
views_handler_argument_string::init function init the handler with necessary data. Overrides views_handler_argument::init
views_handler_argument_string::options_form function Overrides views_handler_argument::options_form
views_handler_argument_string::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_argument::option_definition
views_handler_argument_string::query function Build the query based upon the formula Overrides views_handler_argument::query
views_handler_argument_string::summary_argument function Provide the argument to use to link from the summary to the next level; this will be called once per row of a summary, and used as part of $view->get_url(). Overrides views_handler_argument::summary_argument
views_handler_argument_string::summary_name function Provides the name to use for the summary. By default this is just the name field. Overrides views_handler_argument::summary_name 1
views_handler_argument_string::summary_query function Build the summary query based on a string Overrides views_handler_argument::summary_query
views_handler_argument_string::title function Get the title this argument will assign the view, given the argument. Overrides views_handler_argument::title 1
views_handler_argument_string::title_query function Override for specific title lookups.
views_object::$definition property Handler's definition
views_object::$options property Except for displays, options for the object will be held here. 1
views_object::destroy function 2
views_object::export_option function 1
views_object::export_options function
views_object::options function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. 1
views_object::set_default_options function Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition function Let the handler know what its full definition is.
views_object::unpack_options function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable function Unpack a single option definition.
views_object::unpack_translatables function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults function