Same name and namespace in other branches
- 6.x-3.x handlers/views_handler_argument_string.inc \views_handler_argument_string
Argument handler to implement string arguments that may have length limits.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_argument
- class \views_handler
Expanded class hierarchy of views_handler_argument_string
Related topics
11 string references to 'views_handler_argument_string'
- aggregator_views_data in modules/
aggregator.views.inc - Implements hook_views_data().
- comment_views_data in modules/
comment.views.inc - Implements hook_views_data().
- field_views_field_default_views_data in modules/
field.views.inc - Default views data implementation for a field.
- hook_views_data in ./
views.api.php - Describes data tables (or the equivalent) to Views.
- locale_views_data in modules/
locale.views.inc - Implements hook_views_data().
File
- handlers/
views_handler_argument_string.inc, line 13 - Definition of views_handler_argument_string.
View source
class views_handler_argument_string extends views_handler_argument {
/**
* {@inheritdoc}
*/
public 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();
}
}
/**
* {@inheritdoc}
*/
public function option_definition() {
$options = parent::option_definition();
$options['glossary'] = array(
'default' => FALSE,
'bool' => TRUE,
);
$options['limit'] = array(
'default' => 0,
);
$options['case'] = array(
'default' => 'none',
);
$options['path_case'] = array(
'default' => 'none',
);
$options['transform_dash'] = array(
'default' => FALSE,
'bool' => TRUE,
);
$options['break_phrase'] = array(
'default' => FALSE,
'bool' => TRUE,
);
$options['not'] = array(
'default' => FALSE,
'bool' => TRUE,
);
if (!empty($this->definition['many to one'])) {
$options['add_table'] = array(
'default' => FALSE,
'bool' => TRUE,
);
$options['require_value'] = array(
'default' => FALSE,
'bool' => TRUE,
);
}
return $options;
}
/**
* {@inheritdoc}
*/
public 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 filter value, which allows the summary view to act as a glossary.'),
'#default_value' => $this->options['glossary'],
'#fieldset' => 'more',
);
$form['limit'] = array(
'#type' => 'textfield',
'#title' => t('Character limit'),
'#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.'),
'#default_value' => $this->options['limit'],
'#dependency' => array(
'edit-options-glossary' => array(
TRUE,
),
),
'#fieldset' => 'more',
);
$form['case'] = array(
'#type' => 'select',
'#title' => t('Case'),
'#description' => t('When printing the title and summary, how to transform the case of the filter value.'),
'#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'],
'#fieldset' => 'more',
);
$form['path_case'] = array(
'#type' => 'select',
'#title' => t('Case in path'),
'#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.'),
'#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'],
'#fieldset' => 'more',
);
$form['transform_dash'] = array(
'#type' => 'checkbox',
'#title' => t('Transform spaces to dashes in URL'),
'#default_value' => $this->options['transform_dash'],
'#fieldset' => 'more',
);
if (!empty($this->definition['many to one'])) {
$form['add_table'] = array(
'#type' => 'checkbox',
'#title' => t('Allow multiple filter values to work together'),
'#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.'),
'#default_value' => !empty($this->options['add_table']),
'#fieldset' => 'more',
);
$form['require_value'] = array(
'#type' => 'checkbox',
'#title' => t('Do not display items with no value in summary'),
'#default_value' => !empty($this->options['require_value']),
'#fieldset' => 'more',
);
}
// allow + for or, , for and
$form['break_phrase'] = array(
'#type' => 'checkbox',
'#title' => t('Allow multiple values'),
'#description' => t('If selected, users can enter multiple values in the form of 1+2+3 (for OR) or 1,2,3 (for AND).'),
'#default_value' => !empty($this->options['break_phrase']),
'#fieldset' => 'more',
);
$form['not'] = array(
'#type' => 'checkbox',
'#title' => t('Exclude'),
'#description' => t('If selected, the numbers entered for the filter will be excluded rather than limiting the view.'),
'#default_value' => !empty($this->options['not']),
'#fieldset' => 'more',
);
}
/**
* Build the summary query based on a string.
*/
public 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.
$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 {
// Add the field.
$formula = $this
->get_formula();
$this->base_alias = $this->query
->add_field(NULL, $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.
*/
public function get_formula() {
return "SUBSTRING({$this->table_alias}.{$this->real_field}, 1, " . intval($this->options['limit']) . ")";
}
/**
* Build the query based upon the formula
*/
public function query($group_by = FALSE) {
$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();
$formula = FALSE;
if (empty($this->options['glossary'])) {
$field = "{$this->table_alias}.{$this->real_field}";
}
else {
$formula = TRUE;
$field = $this
->get_formula();
}
if (count($this->value) > 1) {
$operator = empty($this->options['not']) ? 'IN' : 'NOT IN';
$argument = $this->value;
}
else {
$operator = empty($this->options['not']) ? '=' : '!=';
}
if ($formula) {
$placeholder = $this
->placeholder();
if (count($this->value) > 1) {
$field .= " {$operator} ({$placeholder})";
}
else {
$field .= " {$operator} {$placeholder}";
}
$placeholders = array(
$placeholder => $argument,
);
$this->query
->add_where_expression(0, $field, $placeholders);
}
else {
$this->query
->add_where(0, $field, $argument, $operator);
}
}
/**
* {@inheritdoc}
*/
public function summary_argument($data) {
$value = $this
->case_transform($data->{$this->base_alias}, $this->options['path_case']);
if (!empty($this->options['transform_dash'])) {
$value = strtr($value, ' ', '-');
}
return $value;
}
/**
* {@inheritdoc}
*/
public function get_sort_name() {
return t('Alphabetical', array(), array(
'context' => 'Sort order',
));
}
/**
* {@inheritdoc}
*/
public function title() {
$this->argument = $this
->case_transform($this->argument, $this->options['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.
*/
public function title_query() {
return drupal_map_assoc($this->value, 'check_plain');
}
/**
* {@inheritdoc}
*/
public function summary_name($data) {
return $this
->case_transform(parent::summary_name($data), $this->options['case']);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
views_handler:: |
public | property | The type of the handler, for example filter/footer/field. | |
views_handler:: |
public | property | Where the $query object will reside:. | 1 |
views_handler:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
views_handler:: |
public | property | The relationship used for this field. | |
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. | |
views_handler:: |
public | property |
The top object of a view. Overrides views_object:: |
|
views_handler:: |
public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
views_handler:: |
public | function | Check whether current user has access to this handler. | 10 |
views_handler:: |
public | function | Provide text for the administrative summary. | 4 |
views_handler:: |
public | function | Determine if the handler is considered 'broken'. | 6 |
views_handler:: |
public | function | Determine if a handler can be exposed. | 2 |
views_handler:: |
public | function | Transform a string by a certain method. | |
views_handler:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
views_handler:: |
public | function | Render our chunk of the exposed handler form when selecting. | 1 |
views_handler:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
views_handler:: |
public | function | Submit the exposed handler form. | |
views_handler:: |
public | function | Validate the exposed handler form. | 4 |
views_handler:: |
public | function | Form for exposed handler options. | 2 |
views_handler:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
views_handler:: |
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:: |
public | function | Validate the options form. | 1 |
views_handler:: |
public | function | Provide defaults for the handler. | |
views_handler:: |
public | function | Provide a form for setting options. | 1 |
views_handler:: |
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:: |
public | function | Validate the options form. | |
views_handler:: |
public | function | Shortcut to get a handler's raw field value. | |
views_handler:: |
public | function | Get the join object that should be used for this handler. | |
views_handler:: |
public | function | Provide a form for aggregation settings. | 1 |
views_handler:: |
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:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
views_handler:: |
public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 |
views_handler:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
public | function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | 1 |
views_handler:: |
public | function | Provides a unique placeholders for handlers. | |
views_handler:: |
public | function | Run after the view is executed, before the result is cached. | 1 |
views_handler:: |
public | function | Run before the view is built. | 1 |
views_handler:: |
public | function | Sanitize the value for output. | |
views_handler:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
public | function | Shortcut to display the expose/hide button. | 2 |
views_handler:: |
public | function | Shortcut to display the exposed options form. | |
views_handler:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
views_handler:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
views_handler:: |
public | function | Provides the handler some groupby. | 2 |
views_handler:: |
public | function | Validates the handler against the complete View. | 1 |
views_handler_argument:: |
public | property | ||
views_handler_argument:: |
public | property | The field to use for the name to use in the summary. | |
views_handler_argument:: |
public | property | The table to use for the name, if not the same table as the argument. | |
views_handler_argument:: |
public | property | ||
views_handler_argument:: |
public | property | 1 | |
views_handler_argument:: |
public | function |
Views handlers use a special construct function. Overrides views_object:: |
5 |
views_handler_argument:: |
public | function | Default action: access denied. | |
views_handler_argument:: |
public | function | Handle the default action, which means our argument wasn't present. | |
views_handler_argument:: |
public | function | List of default behaviors for this argument if the argument is not present. | 4 |
views_handler_argument:: |
public | function | Provide a form for selecting the default argument. | 1 |
views_handler_argument:: |
public | function | This just returns true. | |
views_handler_argument:: |
public | function | Default action: empty. | |
views_handler_argument:: |
public | function | Default action: ignore. | |
views_handler_argument:: |
public | function | Default action: not found. | |
views_handler_argument:: |
public | function | Default action: summary. | |
views_handler_argument:: |
public | function | Form for selecting further summary options. | |
views_handler_argument:: |
public | function | Work out which title to use. | |
views_handler_argument:: |
public | function | Generic plugin export handler. | 1 |
views_handler_argument:: |
public | function | Export handler for summary export. | |
views_handler_argument:: |
public | function | Export handler for validation export. | |
views_handler_argument:: |
public | function | Get a default argument, if available. | 1 |
views_handler_argument:: |
public | function | Get the display or row plugin, if it exists. | |
views_handler_argument:: |
public | function | Called by the view object to get the title. | |
views_handler_argument:: |
public | function | Get the value of this argument. | |
views_handler_argument:: |
public | function | Determine if the argument is set to provide a default argument. | |
views_handler_argument:: |
public | function | ||
views_handler_argument:: |
public | function |
Determine if the argument needs a style plugin. Overrides views_handler:: |
|
views_handler_argument:: |
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. Overrides views_handler:: |
|
views_handler_argument:: |
public | function |
Validate the options form. Overrides views_handler:: |
|
views_handler_argument:: |
public | function | Process the summary arguments for display. | |
views_handler_argument:: |
public | function | Set the input for this argument. | |
views_handler_argument:: |
public | function | Give an argument the opportunity to modify the breadcrumb, if it wants. | 3 |
views_handler_argument:: |
public | function | Some basic summary behavior. | |
views_handler_argument:: |
public | function | Add the name field, which is the field displayed in summary queries. | |
views_handler_argument:: |
public | function | Sorts the summary based upon the user's selection. | |
views_handler_argument:: |
public | function | Determine if the argument can generate a breadcrumb. | |
views_handler_argument:: |
public | function | Validate that this argument works. By default, all arguments are valid. | |
views_handler_argument:: |
public | function | Called by the menu system to validate an argument. | |
views_handler_argument:: |
public | function | Provide a basic argument validation. | 1 |
views_handler_argument:: |
public | function | How to act if validation fails. | |
views_handler_argument_string:: |
public | function | Get the formula for this argument. | |
views_handler_argument_string:: |
public | function |
Return a description of how the argument would normally be sorted. Overrides views_handler_argument:: |
|
views_handler_argument_string:: |
public | function |
Init the handler with necessary data. Overrides views_handler_argument:: |
1 |
views_handler_argument_string:: |
public | function |
Build the options form. Overrides views_handler_argument:: |
1 |
views_handler_argument_string:: |
public | function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_argument:: |
1 |
views_handler_argument_string:: |
public | function |
Build the query based upon the formula Overrides views_handler_argument:: |
|
views_handler_argument_string:: |
public | function |
Provide the argument to use to link from the summary to the next level. Overrides views_handler_argument:: |
|
views_handler_argument_string:: |
public | function |
Provides the name to use for the summary. Overrides views_handler_argument:: |
2 |
views_handler_argument_string:: |
public | function |
Build the summary query based on a string. Overrides views_handler_argument:: |
|
views_handler_argument_string:: |
public | function |
Get the title this argument will assign the view, given the argument. Overrides views_handler_argument:: |
2 |
views_handler_argument_string:: |
public | function | Override for specific title lookups. | |
views_object:: |
public | property | Handler's definition. | |
views_object:: |
public | property | Except for displays, options for the object will be held here. | 1 |
views_object:: |
function | Collect this handler's option definition and alter them, ready for use. | ||
views_object:: |
public | function | Destructor. | 2 |
views_object:: |
public | function | 1 | |
views_object:: |
public | function | ||
views_object:: |
public | function | Always exports the option, regardless of the default value. | |
views_object:: |
public | function | Set default options on this object. | 1 |
views_object:: |
public | function | Set default options. | |
views_object:: |
public | function | Let the handler know what its full definition is. | |
views_object:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
public | function | Unpack a single option definition. | |
views_object:: |
public | function | Unpacks each handler to store translatable texts. | |
views_object:: |
public | function |