class views_handler_argument_date in Views (for Drupal 7) 7.3
Same name and namespace in other branches
- 6.3 handlers/views_handler_argument_date.inc \views_handler_argument_date
- 6.2 handlers/views_handler_argument_date.inc \views_handler_argument_date
Abstract argument handler for dates.
Adds an option to set a default argument based on the current date.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_argument
- class \views_handler
Expanded class hierarchy of views_handler_argument_date
See also
views_many_to_one_helper()
Related topics
2 string references to 'views_handler_argument_date'
- aggregator_views_data in modules/
aggregator.views.inc - Implements hook_views_data().
- ViewsSqlTest::viewsData in tests/
views_query.test - The views data definition.
File
- handlers/
views_handler_argument_date.inc, line 26 - Definition of views_handler_argument_date.
View source
class views_handler_argument_date extends views_handler_argument_formula {
/**
* @var string
*/
public $option_name = 'default_argument_date';
/**
* @var string
*/
public $arg_format = 'Y-m-d';
/**
* Add an option to set the default value to the current date.
*/
public function default_argument_form(&$form, &$form_state) {
parent::default_argument_form($form, $form_state);
$form['default_argument_type']['#options'] += array(
'date' => t('Current date'),
);
$form['default_argument_type']['#options'] += array(
'node_created' => t("Current node's creation time"),
);
$form['default_argument_type']['#options'] += array(
'node_changed' => t("Current node's update time"),
);
}
/**
* Set the empty argument value to the current date.
*
* Formatted appropriately for this argument.
*
* @return string
* The default argument.
*/
public function get_default_argument($raw = FALSE) {
if (!$raw && $this->options['default_argument_type'] == 'date') {
return date($this->arg_format, REQUEST_TIME);
}
elseif (!$raw && in_array($this->options['default_argument_type'], array(
'node_created',
'node_changed',
))) {
foreach (range(1, 3) as $i) {
$node = menu_get_object('node', $i);
if (!empty($node)) {
continue;
}
}
if (arg(0) == 'node' && is_numeric(arg(1))) {
$node = node_load(arg(1));
}
if (empty($node)) {
return parent::get_default_argument();
}
elseif ($this->options['default_argument_type'] == 'node_created') {
return date($this->arg_format, $node->created);
}
elseif ($this->options['default_argument_type'] == 'node_changed') {
return date($this->arg_format, $node->changed);
}
}
return parent::get_default_argument($raw);
}
/**
* Adapt the export mechanism.
*
* The date handler provides some default argument types, which aren't
* argument default plugins.
*/
public function export_plugin($indent, $prefix, $storage, $option, $definition, $parents) {
// Only use a special behaviour for the special argument types, else just
// use the default behaviour.
if ($option == 'default_argument_type') {
$type = 'argument default';
$option_name = 'default_argument_options';
$plugin = $this
->get_plugin($type);
$name = $this->options[$option];
if (in_array($name, array(
'date',
'node_created',
'node_changed',
))) {
// Write which plugin to use.
$output = $indent . $prefix . "['{$option}'] = '{$name}';\n";
return $output;
}
}
return parent::export_plugin($indent, $prefix, $storage, $option, $definition, $parents);
}
/**
* {@inheritdoc}
*/
public function get_sort_name() {
return t('Date', array(), array(
'context' => 'Sort order',
));
}
}
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 | 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 | 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 | Export handler for summary export. | |
views_handler_argument:: |
public | function | Export handler for validation export. | |
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 |
Init the handler with necessary data. Overrides views_handler:: |
3 |
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 |
Build the options form. Overrides views_handler:: |
8 |
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 |
Information about options for all kinds of purposes will be held here. Overrides views_handler:: |
6 |
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 | Provide the argument to use to link from the summary to the next level. | 4 |
views_handler_argument:: |
public | function | Some basic summary behavior. | |
views_handler_argument:: |
public | function | Provides the name to use for the summary. | 10 |
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 | Get the title this argument will assign the view, given the argument. | 13 |
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_date:: |
public | property | ||
views_handler_argument_date:: |
public | property | ||
views_handler_argument_date:: |
public | function |
Add an option to set the default value to the current date. Overrides views_handler_argument:: |
|
views_handler_argument_date:: |
public | function |
Adapt the export mechanism. Overrides views_handler_argument:: |
|
views_handler_argument_date:: |
public | function |
Set the empty argument value to the current date. Overrides views_handler_argument:: |
|
views_handler_argument_date:: |
public | function |
Return a description of how the argument would normally be sorted. Overrides views_handler_argument:: |
|
views_handler_argument_formula:: |
public | property | ||
views_handler_argument_formula:: |
public | function |
Views handlers use a special construct function. Overrides views_handler_argument:: |
6 |
views_handler_argument_formula:: |
public | function | ||
views_handler_argument_formula:: |
public | function |
Build the query based upon the formula Overrides views_handler_argument:: |
|
views_handler_argument_formula:: |
public | function |
Build the summary query based on a formula Overrides views_handler_argument:: |
|
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 |