Abstract argument handler for dates.
Adds an option to set a default argument based on the current date.
Definitions terms:
@PluginID("date");
Expanded class hierarchy of Date
Drupal\views\ManyTonOneHelper
class Date extends Formula {
/**
* The date format used in the title.
*
* @var string
*/
protected $format;
/**
* The date format used in the query.
*
* @var string
*/
protected $argFormat = 'Y-m-d';
var $option_name = 'default_argument_date';
/**
* Add an option to set the default value to the current date.
*/
public function defaultArgumentForm(&$form, &$form_state) {
parent::defaultArgumentForm($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.
*/
public function getDefaultArgument($raw = FALSE) {
if (!$raw && $this->options['default_argument_type'] == 'date') {
return date($this->argFormat, 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::getDefaultArgument();
}
elseif ($this->options['default_argument_type'] == 'node_created') {
return date($this->argFormat, $node->created);
}
elseif ($this->options['default_argument_type'] == 'node_changed') {
return date($this->argFormat, $node->changed);
}
}
return parent::getDefaultArgument($raw);
}
/**
* {@inheritdoc}
*/
public function getSortName() {
return t('Date', array(), array(
'context' => 'Sort order',
));
}
/**
* Overrides \Drupal\views\Plugin\views\argument\Formula::getFormula().
*/
public function getFormula() {
$this->formula = $this
->getDateFormat($this->argFormat);
return parent::getFormula();
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ArgumentPluginBase:: |
property | |||
ArgumentPluginBase:: |
property | The field to use for the name to use in the summary, which is the displayed output. For example, for the node: nid argument, the argument itself is the nid, but node.title is displayed. | ||
ArgumentPluginBase:: |
property | The table to use for the name, should it not be in the same table as the argument. | ||
ArgumentPluginBase:: |
property | |||
ArgumentPluginBase:: |
property | 1 | ||
ArgumentPluginBase:: |
public | function |
Build the options form. Overrides HandlerBase:: |
7 |
ArgumentPluginBase:: |
public | function | Default action: access denied. | |
ArgumentPluginBase:: |
protected | function | Provide a list of default behaviors for this argument if the argument is not present. | 3 |
ArgumentPluginBase:: |
protected | function | This just returns true. The view argument builder will know where to find the argument from. | |
ArgumentPluginBase:: |
public | function | Default action: empty | |
ArgumentPluginBase:: |
public | function | Default action: ignore. | |
ArgumentPluginBase:: |
protected | function | Default action: not found. | |
ArgumentPluginBase:: |
protected | function | Default action: summary. | |
ArgumentPluginBase:: |
public | function | Provide a form for selecting further summary options when the default action is set to display one. | |
ArgumentPluginBase:: |
function | Handle the default action, which means our argument wasn't present. | ||
ArgumentPluginBase:: |
protected | function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides HandlerBase:: |
6 |
ArgumentPluginBase:: |
public | function | ||
ArgumentPluginBase:: |
public | function | Get the display or row plugin, if it exists. | |
ArgumentPluginBase:: |
public | 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(). | |
ArgumentPluginBase:: |
public | function | Get the value of this argument. | |
ArgumentPluginBase:: |
function | Determine if the argument is set to provide a default argument. | ||
ArgumentPluginBase:: |
public | function | ||
ArgumentPluginBase:: |
public | function | Determine if the argument needs a style plugin. | |
ArgumentPluginBase:: |
public static | function | Custom form radios process function. | |
ArgumentPluginBase:: |
public | function | Process the summary arguments for display. | |
ArgumentPluginBase:: |
public | function | Set the input for this argument | |
ArgumentPluginBase:: |
public | 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 |
ArgumentPluginBase:: |
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 HandlerBase:: |
|
ArgumentPluginBase:: |
public | 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->getUrl(). | 4 |
ArgumentPluginBase:: |
public | function | Some basic summary behavior that doesn't need to be repeated as much as code that goes into summaryQuery() | |
ArgumentPluginBase:: |
public | function | Provides the name to use for the summary. By default this is just the name field. | 8 |
ArgumentPluginBase:: |
protected | function | Add the name field, which is the field displayed in summary queries. This is often used when the argument is numeric. | |
ArgumentPluginBase:: |
public | function | Sorts the summary based upon the user's selection. The base variant of this is usually adequte. | |
ArgumentPluginBase:: |
function | Get the title this argument will assign the view, given the argument. | 10 | |
ArgumentPluginBase:: |
public | function | Determine if the argument can generate a breadcrumb | |
ArgumentPluginBase:: |
public | function | Validate that this argument works. By default, all arguments are valid. | |
ArgumentPluginBase:: |
public | function | How to act if validation failes | |
ArgumentPluginBase:: |
public | function | Called by the menu system to validate an argument. | |
ArgumentPluginBase:: |
public | function |
Validate the options form. Overrides HandlerBase:: |
|
ContainerFactoryPluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
11 |
Date:: |
protected | property | The date format used in the query. | 6 |
Date:: |
protected | property | The date format used in the title. | 4 |
Date:: |
property | |||
Date:: |
public | function |
Add an option to set the default value to the current date. Overrides ArgumentPluginBase:: |
|
Date:: |
public | function |
Set the empty argument value to the current date,
formatted appropriately for this argument. Overrides ArgumentPluginBase:: |
|
Date:: |
public | function |
Overrides \Drupal\views\Plugin\views\argument\Formula::getFormula(). Overrides Formula:: |
|
Date:: |
public | function |
Return a description of how the argument would normally be sorted. Overrides ArgumentPluginBase:: |
|
Formula:: |
property | |||
Formula:: |
public | function |
Overrides Drupal\views\Plugin\views\argument\ArgumentPluginBase::init(). Overrides ArgumentPluginBase:: |
|
Formula:: |
public | function |
Build the query based upon the formula Overrides ArgumentPluginBase:: |
|
Formula:: |
protected | function |
Build the summary query based on a formula Overrides ArgumentPluginBase:: |
|
HandlerBase:: |
public | property | When a field has been moved this property is set. | |
HandlerBase:: |
public | property | When a table has been moved this property is set. | |
HandlerBase:: |
public | property | With field you can override the realField if the real field is not set. | |
HandlerBase:: |
public | property | Where the $query object will reside: | 1 |
HandlerBase:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
HandlerBase:: |
public | property | The relationship used for this field. | |
HandlerBase:: |
public | property | The table this handler is attached to. | |
HandlerBase:: |
public | property | The alias of the table of this handler which is used in the query. | |
HandlerBase:: |
public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
HandlerBase:: |
public | function | Check whether current user has access to this handler. | 6 |
HandlerBase:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
HandlerBase:: |
public | function | Provide text for the administrative summary | 4 |
HandlerBase:: |
public static | function | Breaks x,y,z and x+y+z into an array. Numeric only. | |
HandlerBase:: |
public static | function | Breaks x,y,z and x+y+z into an array. Works for strings. | |
HandlerBase:: |
public | function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | 6 |
HandlerBase:: |
public | function | Render our chunk of the exposed handler form when selecting | 1 |
HandlerBase:: |
public | function | Form for exposed handler options. | 2 |
HandlerBase:: |
public | function | Provide a form for setting options. | 1 |
HandlerBase:: |
public | function | Provide a form for aggregation settings. | 1 |
HandlerBase:: |
public | function | Determine if a handler can be exposed. | 2 |
HandlerBase:: |
protected | function | Transform a string by a certain method. | |
HandlerBase:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
HandlerBase:: |
public | function | Provide defaults for the handler. | |
HandlerBase:: |
public | function | Displays the Expose form. | |
HandlerBase:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
HandlerBase:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
HandlerBase:: |
public | function | Creates cross-database SQL dates. | |
HandlerBase:: |
public | function | Creates cross-database SQL date formatting. | |
HandlerBase:: |
public | function | Determines the entity type used by this handler. | |
HandlerBase:: |
public | function | Shortcut to get a handler's raw field value. | |
HandlerBase:: |
public | function | Get the join object that should be used for this handler. | |
HandlerBase:: |
public static | function | Fetches a handler to join one table to a primary table from the data cache. | |
HandlerBase:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
HandlerBase:: |
public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 |
HandlerBase:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
HandlerBase:: |
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 |
HandlerBase:: |
protected | function | Provides a unique placeholders for handlers. | |
HandlerBase:: |
public | function | Run after the view is executed, before the result is cached. | |
HandlerBase:: |
public | function | Run before the view is built. | 1 |
HandlerBase:: |
public | function | Sanitize the value for output. | |
HandlerBase:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
HandlerBase:: |
public | function | Shortcut to display the expose/hide button. | 2 |
HandlerBase:: |
public | function | Shortcut to display the exposed options form. | |
HandlerBase:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
HandlerBase:: |
public | function | Submit the exposed handler form | |
HandlerBase:: |
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. | |
HandlerBase:: |
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. | |
HandlerBase:: |
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 |
HandlerBase:: |
public | function | A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests. | |
HandlerBase:: |
public | function | Provides the handler some groupby. | 2 |
HandlerBase:: |
public | function |
Validates the handler against the complete View. Overrides PluginBase:: |
1 |
HandlerBase:: |
public | function | Validate the exposed handler form | 4 |
HandlerBase:: |
public | function | Validate the options form. | 1 |
HandlerBase:: |
public | function | Validate the options form. | |
HandlerBase:: |
public | function |
Constructs a Handler object. Overrides PluginBase:: |
3 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Returns the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |