class views_handler_argument_date
- 3.x handlers/views_handler_argument_date.inc views_handler_argument_date
- 2.x 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 $option_name = 'default_argument_date';
var $arg_format = 'Y-m-d';
/**
* Add an option to set the default value to the current date.
*/
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.
*/
function get_default_argument($raw = FALSE) {
if (!$raw && $this->options['default_argument_type'] == 'date') {
return date($this->arg_format, REQUEST_TIME);
}
else if (!$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);
}
/**
* The date handler provides some default argument types, which aren't argument default plugins,
* so addapt the export mechanism.
*/
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);
}
function get_sort_name() {
return t('Date', array(), array('context' => 'Sort order'));
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. |
views_handler:: |
function | Take input from exposed handlers and assign to this handler, if necessary. | |
views_handler:: |
function | Check whether current user has access to this handler. | |
views_handler:: |
function | Provide text for the administrative summary | |
views_handler:: |
function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | |
views_handler:: |
function | Determine if a handler can be exposed. | |
views_handler:: |
function | Transform a string by a certain method. | |
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | |
views_handler:: |
function | Render our chunk of the exposed handler form when selecting | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | |
views_handler:: |
function | Submit the exposed handler form | |
views_handler:: |
function | Validate the exposed handler form | |
views_handler:: |
function | Form for exposed handler options. | |
views_handler:: |
function | Set new exposed option defaults when exposed setting is flipped on. | |
views_handler:: |
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:: |
function | Validate the options form. | |
views_handler:: |
function | Provide defaults for the handler. | |
views_handler:: |
function | Provide a form for setting options. | |
views_handler:: |
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:: |
function | Validate the options form. | |
views_handler:: |
function | Shortcut to get a handler's raw field value. | |
views_handler:: |
function | Get the join object that should be used for this handler. | |
views_handler:: |
function | Provide a form for aggregation settings. | |
views_handler:: |
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:: |
function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | |
views_handler:: |
function | Returns TRUE if the exposed filter works like a grouped filter. | |
views_handler:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | |
views_handler:: |
function | Provides a unique placeholders for handlers. | |
views_handler:: |
function | Run after the view is executed, before the result is cached. | |
views_handler:: |
function | Run before the view is built. | |
views_handler:: |
function | Sanitize the value for output. | |
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
function | Shortcut to display the expose/hide button. | |
views_handler:: |
function | Shortcut to display the exposed options form. | |
views_handler:: |
function | If set to remember exposed input in the session, store it there. | |
views_handler:: |
function | Return a string representing this handler's name in the UI. | |
views_handler:: |
function | Provides the handler some groupby. | |
views_handler:: |
function | Validates the handler against the complete View. | |
views_handler_argument:: |
function | Default action: access denied. | |
views_handler_argument:: |
function | Handle the default action, which means our argument wasn't present. | |
views_handler_argument:: |
function | Provide a list of default behaviors for this argument if the argument is not present. | |
views_handler_argument:: |
function | This just returns true. The view argument builder will know where to find the argument from. | |
views_handler_argument:: |
function | Default action: empty | |
views_handler_argument:: |
function | Default action: ignore. | |
views_handler_argument:: |
function | Default action: not found. | |
views_handler_argument:: |
function | Default action: summary. | |
views_handler_argument:: |
function | Provide a form for selecting further summary options when the default action is set to display one. | |
views_handler_argument:: |
function | ||
views_handler_argument:: |
function | Export handler for summary export. | |
views_handler_argument:: |
function | Export handler for validation export. | |
views_handler_argument:: |
function | Get the display or row plugin, if it exists. | |
views_handler_argument:: |
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:: |
function | Get the value of this argument. | |
views_handler_argument:: |
function | Determine if the argument is set to provide a default argument. | |
views_handler_argument:: |
function |
init the handler with necessary data. Overrides views_handler:: |
|
views_handler_argument:: |
function | ||
views_handler_argument:: |
function |
Determine if the argument needs a style plugin. Overrides views_handler:: |
|
views_handler_argument:: |
function |
Build the options form. Overrides views_handler:: |
|
views_handler_argument:: |
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:: |
function |
Validate the options form. Overrides views_handler:: |
|
views_handler_argument:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_handler:: |
|
views_handler_argument:: |
function | Process the summary arguments for display. | |
views_handler_argument:: |
function | Set the input for this argument | |
views_handler_argument:: |
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. | |
views_handler_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(). | |
views_handler_argument:: |
function | Some basic summary behavior that doesn't need to be repeated as much as code that goes into summary_query() | |
views_handler_argument:: |
function | Provides the name to use for the summary. By default this is just the name field. | |
views_handler_argument:: |
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:: |
function | Sorts the summary based upon the user's selection. The base variant of this is usually adequte. | |
views_handler_argument:: |
function | Get the title this argument will assign the view, given the argument. | |
views_handler_argument:: |
function | Determine if the argument can generate a breadcrumb | |
views_handler_argument:: |
function | Validate that this argument works. By default, all arguments are valid. | |
views_handler_argument:: |
function | Called by the menu system to validate an argument. | |
views_handler_argument:: |
function | Provide a basic argument validation. | |
views_handler_argument:: |
function | How to act if validation failes | |
views_handler_argument_date:: |
function |
Add an option to set the default value to the current date. Overrides views_handler_argument:: |
|
views_handler_argument_date:: |
function |
The date handler provides some default argument types, which aren't argument default plugins,
so addapt the export mechanism. Overrides views_handler_argument:: |
|
views_handler_argument_date:: |
function |
Set the empty argument value to the current date,
formatted appropriately for this argument. Overrides views_handler_argument:: |
|
views_handler_argument_date:: |
function |
Return a description of how the argument would normally be sorted. Overrides views_handler_argument:: |
|
views_handler_argument_formula:: |
function |
Constructor Overrides views_handler_argument:: |
|
views_handler_argument_formula:: |
function | ||
views_handler_argument_formula:: |
function |
Build the query based upon the formula Overrides views_handler_argument:: |
|
views_handler_argument_formula:: |
function |
Build the summary query based on a formula Overrides views_handler_argument:: |
|
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | Always exports the option, regardless of the default value. | |
views_object:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | |
views_object:: |
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:: |
function | Let the handler know what its full definition is. | |
views_object:: |
function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
function | Unpack a single option definition. | |
views_object:: |
function | Unpacks each handler to store translatable texts. | |
views_object:: |
function |