class DayDate in Zircon Profile 8
Same name in this branch
- 8 core/modules/views/src/Plugin/views/argument/DayDate.php \Drupal\views\Plugin\views\argument\DayDate
- 8 core/modules/datetime/src/Plugin/views/argument/DayDate.php \Drupal\datetime\Plugin\views\argument\DayDate
Same name and namespace in other branches
- 8.0 core/modules/views/src/Plugin/views/argument/DayDate.php \Drupal\views\Plugin\views\argument\DayDate
Argument handler for a day (DD)
Plugin annotation
@ViewsArgument("date_day");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, ViewsPluginInterface
- class \Drupal\views\Plugin\views\HandlerBase implements ViewsHandlerInterface
- class \Drupal\views\Plugin\views\argument\ArgumentPluginBase implements CacheableDependencyInterface
- class \Drupal\views\Plugin\views\argument\Formula
- class \Drupal\views\Plugin\views\argument\Date implements ContainerFactoryPluginInterface
- class \Drupal\views\Plugin\views\argument\DayDate
- class \Drupal\views\Plugin\views\argument\Date implements ContainerFactoryPluginInterface
- class \Drupal\views\Plugin\views\argument\Formula
- class \Drupal\views\Plugin\views\argument\ArgumentPluginBase implements CacheableDependencyInterface
- class \Drupal\views\Plugin\views\HandlerBase implements ViewsHandlerInterface
- class \Drupal\views\Plugin\views\PluginBase implements DependentPluginInterface, ContainerFactoryPluginInterface, ViewsPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
Expanded class hierarchy of DayDate
File
- core/
modules/ views/ src/ Plugin/ views/ argument/ DayDate.php, line 15 - Contains \Drupal\views\Plugin\views\argument\DayDate.
Namespace
Drupal\views\Plugin\views\argumentView source
class DayDate extends Date {
/**
* {@inheritdoc}
*/
protected $format = 'j';
/**
* {@inheritdoc}
*/
protected $argFormat = 'd';
/**
* Provide a link to the next level of the view
*/
public function summaryName($data) {
$day = str_pad($data->{$this->name_alias}, 2, '0', STR_PAD_LEFT);
// strtotime respects server timezone, so we need to set the time fixed as utc time
return format_date(strtotime("2005" . "05" . $day . " 00:00:00 UTC"), 'custom', $this->format, 'UTC');
}
/**
* Provide a link to the next level of the view
*/
function title() {
$day = str_pad($this->argument, 2, '0', STR_PAD_LEFT);
return format_date(strtotime("2005" . "05" . $day . " 00:00:00 UTC"), 'custom', $this->format, 'UTC');
}
public function summaryArgument($data) {
// Make sure the argument contains leading zeroes.
return str_pad($data->{$this->base_alias}, 2, '0', STR_PAD_LEFT);
}
}
Members
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 |
Provide a form to edit options for this plugin. Overrides HandlerBase:: |
6 |
ArgumentPluginBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides PluginBase:: |
|
ArgumentPluginBase:: |
public static | function | Revert sanitized validator options. | |
ArgumentPluginBase:: |
public | function | Default action: access denied. | |
ArgumentPluginBase:: |
public | function | Handle the default action, which means our argument wasn't present. | |
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:: |
protected | function |
Information about options for all kinds of purposes will be held here. Overrides HandlerBase:: |
5 |
ArgumentPluginBase:: |
public static | function | Sanitize validator options including derivatives with : for js. | |
ArgumentPluginBase:: |
public | function | ||
ArgumentPluginBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyInterface:: |
|
ArgumentPluginBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
|
ArgumentPluginBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyInterface:: |
|
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:: |
protected | function | Provide token help information for the argument. | |
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 | Moves argument options into their place. | |
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 |
Handle any special handling on the validate form. Overrides PluginBase:: |
|
ArgumentPluginBase:: |
public | function | Some basic summary behavior that doesn't need to be repeated as much as code that goes into summaryQuery() | |
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 adequate. | |
ArgumentPluginBase:: |
protected | function | Splits an argument into value and operator properties on this instance. | |
ArgumentPluginBase:: |
public | function | Validate that this argument works. By default, all arguments are valid. | |
ArgumentPluginBase:: |
public | function | How to act if validation fails. | |
ArgumentPluginBase:: |
public | function | Called by the menu system to validate an argument. | |
ArgumentPluginBase:: |
public | function |
Validate the options form. Overrides PluginBase:: |
|
Date:: |
property | |||
Date:: |
protected | property | The route match. | |
Date:: |
public static | function |
Creates an instance of the plugin. Overrides PluginBase:: |
|
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 Formula:: |
|
Date:: |
public | function |
Return a description of how the argument would normally be sorted. Overrides ArgumentPluginBase:: |
|
Date:: |
public | function |
Constructs a new Date instance. Overrides HandlerBase:: |
|
DayDate:: |
protected | property |
The date format used in the query. Overrides Date:: |
|
DayDate:: |
protected | property |
The date format used in the title. Overrides Date:: |
|
DayDate:: |
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(). Overrides ArgumentPluginBase:: |
|
DayDate:: |
public | function |
Provide a link to the next level of the view Overrides ArgumentPluginBase:: |
|
DayDate:: |
function |
Provide a link to the next level of the view Overrides ArgumentPluginBase:: |
||
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
Formula:: |
property | |||
Formula:: |
public | function |
Overrides Drupal\views\Plugin\views\HandlerBase: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:: |
protected | property | The module handler. | 3 |
HandlerBase:: |
public | property | Where the $query object will reside: | 7 |
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:: |
protected | property | The views data service. | |
HandlerBase:: |
public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
HandlerBase:: |
public | function |
Check whether given user has access to this handler. Overrides ViewsHandlerInterface:: |
2 |
HandlerBase:: |
public | function |
Return a string representing this handler's name in the UI. Overrides ViewsHandlerInterface:: |
4 |
HandlerBase:: |
public | function |
Provide text for the administrative summary. Overrides ViewsHandlerInterface:: |
4 |
HandlerBase:: |
public static | function |
Breaks x,y,z and x+y+z into an array. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function |
Determines if the handler is considered 'broken', meaning it's a
a placeholder used when a handler can't be found. Overrides ViewsHandlerInterface:: |
|
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. Overrides ViewsHandlerInterface:: |
2 |
HandlerBase:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
HandlerBase:: |
public | function | Creates cross-database SQL dates. | 2 |
HandlerBase:: |
public | function | Creates cross-database SQL date formatting. | 2 |
HandlerBase:: |
public | function |
Determines the entity type used by this handler. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function |
Shortcut to get a handler's raw field value. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function |
Get the join object that should be used for this handler. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
protected | function | Gets the module handler. | |
HandlerBase:: |
public static | function |
Fetches a handler to join one table to a primary table from the data cache. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
protected | function | Gets views data service. | |
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. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function |
Run before the view is built. Overrides ViewsHandlerInterface:: |
1 |
HandlerBase:: |
public | function |
Sanitize the value for output. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function | Sets the module handler. | |
HandlerBase:: |
public | function |
Called just prior to query(), this lets a handler set up any relationship
it needs. Overrides ViewsHandlerInterface:: |
|
HandlerBase:: |
public | function | ||
HandlerBase:: |
public | function | Shortcut to display the expose/hide button. | 2 |
HandlerBase:: |
public | function |
Shortcut to display the exposed options form. Overrides ViewsHandlerInterface:: |
|
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. | 12 |
HandlerBase:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides PluginBase:: |
2 |
HandlerBase:: |
public | function | Validate the exposed handler form | 4 |
HandlerBase:: |
public | function | Validate the options form. | 1 |
HandlerBase:: |
public | function | Validate the options form. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 2 |
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 | Stores the render API renderer. | 2 |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Clears a plugin. Overrides ViewsPluginInterface:: |
2 |
PluginBase:: |
protected | function | Do the work to filter out stored options depending on the defined options. | |
PluginBase:: |
public | function |
Filter out stored options depending on the defined options. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns an array of available token replacements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin provider. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
protected | function | Returns the render API renderer. | 1 |
PluginBase:: |
public | function |
Adds elements for available core tokens to a form. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns a string with any core tokens replaced. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
constant | Include entity row languages when listing languages. | ||
PluginBase:: |
constant | Include negotiated languages when listing languages. | ||
PluginBase:: |
protected | function | Makes an array of languages, optionally including special languages. | |
PluginBase:: |
public | function |
Return the human readable name of the display. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function |
Flattens the structure of form elements. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public static | function | Returns substitutions for Views queries for languages. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function |
Returns the summary of the settings in the display. Overrides ViewsPluginInterface:: |
6 |
PluginBase:: |
public | function |
Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface:: |
1 |
PluginBase:: |
public | function |
Unpack options over our existing defaults, drilling down into arrays
so that defaults don't get totally blown away. Overrides ViewsPluginInterface:: |
|
PluginBase:: |
public | function |
Returns the usesOptions property. Overrides ViewsPluginInterface:: |
8 |
PluginBase:: |
protected | function | Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. | 1 |
PluginBase:: |
constant | Query string to indicate the site default language. | ||
StringTranslationTrait:: |
protected | property | The string translation service. | |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |