class Date

Same name in this branch
  1. 9 core/modules/views/src/Plugin/views/sort/Date.php \Drupal\views\Plugin\views\sort\Date
  2. 9 core/modules/views/src/Plugin/views/field/Date.php \Drupal\views\Plugin\views\field\Date
  3. 9 core/modules/views/src/Plugin/views/filter/Date.php \Drupal\views\Plugin\views\filter\Date
  4. 9 core/modules/views/src/Plugin/views/argument/Date.php \Drupal\views\Plugin\views\argument\Date
  5. 9 core/modules/datetime/src/Plugin/views/sort/Date.php \Drupal\datetime\Plugin\views\sort\Date
  6. 9 core/modules/datetime/src/Plugin/views/filter/Date.php \Drupal\datetime\Plugin\views\filter\Date
  7. 9 core/lib/Drupal/Core/Render/Element/Date.php \Drupal\Core\Render\Element\Date
Same name in other branches
  1. 8.9.x core/modules/views/src/Plugin/views/sort/Date.php \Drupal\views\Plugin\views\sort\Date
  2. 8.9.x core/modules/views/src/Plugin/views/field/Date.php \Drupal\views\Plugin\views\field\Date
  3. 8.9.x core/modules/views/src/Plugin/views/filter/Date.php \Drupal\views\Plugin\views\filter\Date
  4. 8.9.x core/modules/views/src/Plugin/views/argument/Date.php \Drupal\views\Plugin\views\argument\Date
  5. 8.9.x core/modules/datetime/src/Plugin/views/sort/Date.php \Drupal\datetime\Plugin\views\sort\Date
  6. 8.9.x core/modules/datetime/src/Plugin/views/filter/Date.php \Drupal\datetime\Plugin\views\filter\Date
  7. 8.9.x core/modules/datetime/src/Plugin/views/argument/Date.php \Drupal\datetime\Plugin\views\argument\Date
  8. 8.9.x core/lib/Drupal/Core/Render/Element/Date.php \Drupal\Core\Render\Element\Date
  9. 10 core/modules/views/src/Plugin/views/sort/Date.php \Drupal\views\Plugin\views\sort\Date
  10. 10 core/modules/views/src/Plugin/views/field/Date.php \Drupal\views\Plugin\views\field\Date
  11. 10 core/modules/views/src/Plugin/views/filter/Date.php \Drupal\views\Plugin\views\filter\Date
  12. 10 core/modules/views/src/Plugin/views/argument/Date.php \Drupal\views\Plugin\views\argument\Date
  13. 10 core/modules/datetime/src/Plugin/views/sort/Date.php \Drupal\datetime\Plugin\views\sort\Date
  14. 10 core/modules/datetime/src/Plugin/views/filter/Date.php \Drupal\datetime\Plugin\views\filter\Date
  15. 10 core/modules/datetime/src/Plugin/views/argument/Date.php \Drupal\datetime\Plugin\views\argument\Date
  16. 10 core/lib/Drupal/Core/Render/Element/Date.php \Drupal\Core\Render\Element\Date
  17. 11.x core/modules/views/src/Plugin/views/sort/Date.php \Drupal\views\Plugin\views\sort\Date
  18. 11.x core/modules/views/src/Plugin/views/field/Date.php \Drupal\views\Plugin\views\field\Date
  19. 11.x core/modules/views/src/Plugin/views/filter/Date.php \Drupal\views\Plugin\views\filter\Date
  20. 11.x core/modules/views/src/Plugin/views/argument/Date.php \Drupal\views\Plugin\views\argument\Date
  21. 11.x core/modules/datetime/src/Plugin/views/sort/Date.php \Drupal\datetime\Plugin\views\sort\Date
  22. 11.x core/modules/datetime/src/Plugin/views/filter/Date.php \Drupal\datetime\Plugin\views\filter\Date
  23. 11.x core/modules/datetime/src/Plugin/views/argument/Date.php \Drupal\datetime\Plugin\views\argument\Date
  24. 11.x core/lib/Drupal/Core/Render/Element/Date.php \Drupal\Core\Render\Element\Date

Abstract argument handler for dates.

Adds an option to set a default argument based on the current date.

Definitions terms:

  • many to one: If true, the "many to one" helper will be used.
  • invalid input: A string to give to the user for obviously invalid input. This is deprecated in favor of argument validators.

Plugin annotation

@ViewsArgument("datetime");

Hierarchy

Expanded class hierarchy of Date

See also

\Drupal\views\ManyToOneHelper

Related topics

168 string references to 'Date'
Callbacks::dateCallback in core/modules/system/tests/modules/ajax_forms_test/src/Callbacks.php
Ajax callback triggered by date.
CallbackTest::providerCallbackArray in core/modules/migrate/tests/src/Unit/process/CallbackTest.php
Data provider for ::testCallbackArray().
claro_preprocess_input in core/themes/claro/claro.theme
Implements template_preprocess_HOOK() for input.
CommentAccessControlHandler::checkFieldAccess in core/modules/comment/src/CommentAccessControlHandler.php
Default field access as determined by this access control handler.
CommentForm::buildEntity in core/modules/comment/src/CommentForm.php
Builds an updated entity object based upon the submitted form values.

... See full list

File

core/modules/datetime/src/Plugin/views/argument/Date.php, line 27

Namespace

Drupal\datetime\Plugin\views\argument
View source
class Date extends NumericDate {
    use FieldAPIHandlerTrait;
    
    /**
     * Determines if the timezone offset is calculated.
     *
     * @var bool
     */
    protected $calculateOffset = TRUE;
    
    /**
     * {@inheritdoc}
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $route_match, DateFormatterInterface $date_formatter) {
        parent::__construct($configuration, $plugin_id, $plugin_definition, $route_match, $date_formatter);
        $definition = $this->getFieldStorageDefinition();
        if ($definition->getSetting('datetime_type') === DateTimeItem::DATETIME_TYPE_DATE) {
            // Timezone offset calculation is not applicable to dates that are stored
            // as date-only.
            $this->calculateOffset = FALSE;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDateField() {
        // Use string date storage/formatting since datetime fields are stored as
        // strings rather than UNIX timestamps.
        return $this->query
            ->getDateField("{$this->tableAlias}.{$this->realField}", TRUE, $this->calculateOffset);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDateFormat($format) {
        // Pass in the string-field option.
        return $this->query
            ->getDateFormat($this->getDateField(), $format, TRUE);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ArgumentPluginBase::$argument public property
ArgumentPluginBase::$name_field public property The field to use for the name to display in the summary.
ArgumentPluginBase::$name_table public property The table to use for the name, should it not be in the same table as the argument.
ArgumentPluginBase::$validator public property
ArgumentPluginBase::$value public property 1
ArgumentPluginBase::buildOptionsForm public function Provide a form to edit options for this plugin. Overrides HandlerBase::buildOptionsForm 6
ArgumentPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides HandlerBase::calculateDependencies
ArgumentPluginBase::decodeValidatorId public static function Revert sanitized validator options.
ArgumentPluginBase::defaultAccessDenied public function Default action: access denied.
ArgumentPluginBase::defaultAction public function Handle the default action, which means our argument wasn't present.
ArgumentPluginBase::defaultActions protected function Default actions. 3
ArgumentPluginBase::defaultDefault protected function Returns true, since the argument builder knows where to find the argument.
ArgumentPluginBase::defaultEmpty public function Default action: empty.
ArgumentPluginBase::defaultIgnore public function Default action: ignore.
ArgumentPluginBase::defaultNotFound protected function Default action: not found.
ArgumentPluginBase::defaultSummary protected function Default action: summary.
ArgumentPluginBase::defaultSummaryForm public function Provides a form for selecting summary options.
ArgumentPluginBase::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides HandlerBase::defineOptions 5
ArgumentPluginBase::encodeValidatorId public static function Sanitize validator options including derivatives with : for js.
ArgumentPluginBase::exceptionTitle public function
ArgumentPluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
ArgumentPluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
ArgumentPluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
ArgumentPluginBase::getContextDefinition public function Returns a context definition for this argument. 2
ArgumentPluginBase::getPlugin public function Get the display or row plugin, if it exists.
ArgumentPluginBase::getTitle public function Determines the title to use for the view.
ArgumentPluginBase::getTokenHelp protected function Provide token help information for the argument.
ArgumentPluginBase::getValue public function Get the value of this argument.
ArgumentPluginBase::hasDefaultArgument public function Determine if the argument is set to provide a default argument.
ArgumentPluginBase::isException public function
ArgumentPluginBase::needsStylePlugin public function Determine if the argument needs a style plugin.
ArgumentPluginBase::preRenderMoveArgumentOptions public static function Moves argument options into their place.
ArgumentPluginBase::processContainerRadios public static function Custom form radios process function.
ArgumentPluginBase::processSummaryArguments public function Process the summary arguments for display.
ArgumentPluginBase::setArgument public function Set the input for this argument.
ArgumentPluginBase::submitOptionsForm public function Handle any special handling on the validate form. Overrides PluginBase::submitOptionsForm
ArgumentPluginBase::summaryArgument public function Provides the argument to use to link from the summary to the next level. 4
ArgumentPluginBase::summaryBasics public function Adds basic information to the summary query.
ArgumentPluginBase::summaryName public function Provides the name to use for the summary, defaults to the name field. 8
ArgumentPluginBase::summaryNameField protected function Adds the name field, which is the field displayed in summary queries.
ArgumentPluginBase::summarySort public function Sorts the summary based upon the user's selection.
ArgumentPluginBase::title public function Get the title this argument will assign the view, given the argument. 10
ArgumentPluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
ArgumentPluginBase::unpackArgumentValue protected function Splits an argument into value and operator properties on this instance.
ArgumentPluginBase::validateArgument public function Validate that this argument works. By default, all arguments are valid.
ArgumentPluginBase::validateFail public function How to act if validation fails.
ArgumentPluginBase::validateMenuArgument public function Called by the menu system to validate an argument.
ArgumentPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm
Date::$argFormat protected property The date format used in the query. 12
Date::$calculateOffset protected property Determines if the timezone offset is calculated.
Date::$dateFormatter protected property The date formatter service.
Date::$format protected property The date format used in the title. 4
Date::$option_name public property
Date::$routeMatch protected property The route match.
Date::create public static function Creates an instance of the plugin. Overrides PluginBase::create
Date::defaultArgumentForm public function Add an option to set the default value to the current date. Overrides ArgumentPluginBase::defaultArgumentForm
Date::getDateField public function Creates cross-database SQL dates. Overrides HandlerBase::getDateField
Date::getDateFormat public function Creates cross-database SQL date formatting. Overrides HandlerBase::getDateFormat
Date::getDefaultArgument public function Gets the date default argument, formatted appropriately for this argument. Overrides ArgumentPluginBase::getDefaultArgument
Date::getFormula public function Overrides Formula::getFormula
Date::getSortName public function Return a description of how the argument would normally be sorted. Overrides ArgumentPluginBase::getSortName
Date::__construct public function Constructs a new Date instance. Overrides Date::__construct
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
FieldAPIHandlerTrait::$entityFieldManager protected property The entity field manager.
FieldAPIHandlerTrait::$fieldDefinition protected property The field definition.
FieldAPIHandlerTrait::$fieldStorageDefinition protected property The field storage definition.
FieldAPIHandlerTrait::getEntityFieldManager protected function Returns the entity field manager.
FieldAPIHandlerTrait::getFieldDefinition protected function Gets the field definition.
FieldAPIHandlerTrait::getFieldStorageDefinition protected function Gets the field storage configuration. 1
Formula::$formula public property
Formula::init public function Overrides Drupal\views\Plugin\views\HandlerBase:init(). Overrides ArgumentPluginBase::init
Formula::query public function Build the query based upon the formula. Overrides ArgumentPluginBase::query
Formula::summaryQuery protected function Build the summary query based on a formula. Overrides ArgumentPluginBase::summaryQuery
HandlerBase::$field public property With field you can override the realField if the real field is not set.
HandlerBase::$moduleHandler protected property The module handler. 3
HandlerBase::$query public property Where the $query object will reside. 7
HandlerBase::$realField public property The real field.
HandlerBase::$relationship public property The relationship used for this field.
HandlerBase::$table public property The table this handler is attached to.
HandlerBase::$tableAlias public property The alias of the table of this handler which is used in the query.
HandlerBase::$viewsData protected property The views data service.
HandlerBase::acceptExposedInput public function Take input from exposed handlers and assign to this handler, if necessary. 1
HandlerBase::access public function Check whether given user has access to this handler. Overrides ViewsHandlerInterface::access 4
HandlerBase::adminLabel public function Return a string representing this handler's name in the UI. Overrides ViewsHandlerInterface::adminLabel 4
HandlerBase::adminSummary public function Provide text for the administrative summary. Overrides ViewsHandlerInterface::adminSummary 4
HandlerBase::breakString public static function Breaks x,y,z and x+y+z into an array. Overrides ViewsHandlerInterface::breakString
HandlerBase::broken public function Determines if the handler is considered 'broken'. Overrides ViewsHandlerInterface::broken
HandlerBase::buildExposedForm public function Render our chunk of the exposed handler form when selecting. 1
HandlerBase::buildExposeForm public function Form for exposed handler options. 2
HandlerBase::buildExtraOptionsForm public function Provide a form for setting options. 1
HandlerBase::buildGroupByForm public function Provide a form for aggregation settings. 1
HandlerBase::canExpose public function Determine if a handler can be exposed. 2
HandlerBase::caseTransform protected function Transform a string by a certain method.
HandlerBase::defaultExposeOptions public function Set new exposed option defaults when exposed setting is flipped on. 2
HandlerBase::defineExtraOptions public function Provide defaults for the handler.
HandlerBase::displayExposedForm public function Displays the Expose form.
HandlerBase::ensureMyTable public function Ensures that the main table for this handler is in the query. Overrides ViewsHandlerInterface::ensureMyTable 2
HandlerBase::exposedInfo public function Get information about the exposed form for the form renderer. 1
HandlerBase::getEntityType public function Determines the entity type used by this handler. Overrides ViewsHandlerInterface::getEntityType
HandlerBase::getField public function Shortcut to get a handler's raw field value. Overrides ViewsHandlerInterface::getField
HandlerBase::getJoin public function Get the join object that should be used for this handler. Overrides ViewsHandlerInterface::getJoin
HandlerBase::getModuleHandler protected function Gets the module handler.
HandlerBase::getTableJoin public static function Fetches a handler to join one table to a primary table from the data cache. Overrides ViewsHandlerInterface::getTableJoin
HandlerBase::getViewsData protected function Gets views data service.
HandlerBase::hasExtraOptions public function Determines if the handler has extra options. 1
HandlerBase::isAGroup public function Returns TRUE if the exposed filter works like a grouped filter. 1
HandlerBase::isExposed public function Determine if this item is 'exposed'.
HandlerBase::multipleExposedInput public function Define if the exposed input has to be submitted multiple times. 1
HandlerBase::placeholder protected function Provides a unique placeholders for handlers.
HandlerBase::postExecute public function Run after the view is executed, before the result is cached. Overrides ViewsHandlerInterface::postExecute
HandlerBase::preQuery public function Run before the view is built. Overrides ViewsHandlerInterface::preQuery 2
HandlerBase::sanitizeValue public function Sanitize the value for output. Overrides ViewsHandlerInterface::sanitizeValue
HandlerBase::setModuleHandler public function Sets the module handler.
HandlerBase::setRelationship public function Sets up any needed relationship. Overrides ViewsHandlerInterface::setRelationship
HandlerBase::setViewsData public function
HandlerBase::showExposeButton public function Shortcut to display the expose/hide button. 2
HandlerBase::showExposeForm public function Shortcut to display the exposed options form. Overrides ViewsHandlerInterface::showExposeForm
HandlerBase::storeExposedInput public function If set to remember exposed input in the session, store it there. 1
HandlerBase::submitExposed public function Submit the exposed handler form.
HandlerBase::submitExposeForm public function Perform any necessary changes to the form exposes prior to storage.
HandlerBase::submitExtraOptionsForm public function Perform any necessary changes to the form values prior to storage.
HandlerBase::submitFormCalculateOptions public function Calculates options stored on the handler. 1
HandlerBase::submitGroupByForm public function Perform any necessary changes to the form values prior to storage. 1
HandlerBase::submitTemporaryForm public function Submits a temporary form.
HandlerBase::usesGroupBy public function Provides the handler some groupby. 13
HandlerBase::validate public function Validate that the plugin is correct and can be saved. Overrides PluginBase::validate 2
HandlerBase::validateExposed public function Validate the exposed handler form. 4
HandlerBase::validateExposeForm public function Validate the options form. 2
HandlerBase::validateExtraOptionsForm public function Validate the options form.
PluginBase::$definition public property Plugins' definition.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::unpackOptions public function Unpacks options over our existing defaults. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.