class Date
Same name in this branch
- 10 core/modules/views/src/Plugin/views/sort/Date.php \Drupal\views\Plugin\views\sort\Date
- 10 core/modules/views/src/Plugin/views/field/Date.php \Drupal\views\Plugin\views\field\Date
- 10 core/modules/views/src/Plugin/views/filter/Date.php \Drupal\views\Plugin\views\filter\Date
- 10 core/modules/views/src/Plugin/views/argument/Date.php \Drupal\views\Plugin\views\argument\Date
- 10 core/modules/datetime/src/Plugin/views/filter/Date.php \Drupal\datetime\Plugin\views\filter\Date
- 10 core/modules/datetime/src/Plugin/views/argument/Date.php \Drupal\datetime\Plugin\views\argument\Date
- 10 core/lib/Drupal/Core/Render/Element/Date.php \Drupal\Core\Render\Element\Date
Same name in other branches
- 9 core/modules/views/src/Plugin/views/sort/Date.php \Drupal\views\Plugin\views\sort\Date
- 9 core/modules/views/src/Plugin/views/field/Date.php \Drupal\views\Plugin\views\field\Date
- 9 core/modules/views/src/Plugin/views/filter/Date.php \Drupal\views\Plugin\views\filter\Date
- 9 core/modules/views/src/Plugin/views/argument/Date.php \Drupal\views\Plugin\views\argument\Date
- 9 core/modules/datetime/src/Plugin/views/sort/Date.php \Drupal\datetime\Plugin\views\sort\Date
- 9 core/modules/datetime/src/Plugin/views/filter/Date.php \Drupal\datetime\Plugin\views\filter\Date
- 9 core/modules/datetime/src/Plugin/views/argument/Date.php \Drupal\datetime\Plugin\views\argument\Date
- 9 core/lib/Drupal/Core/Render/Element/Date.php \Drupal\Core\Render\Element\Date
- 8.9.x core/modules/views/src/Plugin/views/sort/Date.php \Drupal\views\Plugin\views\sort\Date
- 8.9.x core/modules/views/src/Plugin/views/field/Date.php \Drupal\views\Plugin\views\field\Date
- 8.9.x core/modules/views/src/Plugin/views/filter/Date.php \Drupal\views\Plugin\views\filter\Date
- 8.9.x core/modules/views/src/Plugin/views/argument/Date.php \Drupal\views\Plugin\views\argument\Date
- 8.9.x core/modules/datetime/src/Plugin/views/sort/Date.php \Drupal\datetime\Plugin\views\sort\Date
- 8.9.x core/modules/datetime/src/Plugin/views/filter/Date.php \Drupal\datetime\Plugin\views\filter\Date
- 8.9.x core/modules/datetime/src/Plugin/views/argument/Date.php \Drupal\datetime\Plugin\views\argument\Date
- 8.9.x core/lib/Drupal/Core/Render/Element/Date.php \Drupal\Core\Render\Element\Date
- 11.x core/modules/views/src/Plugin/views/sort/Date.php \Drupal\views\Plugin\views\sort\Date
- 11.x core/modules/views/src/Plugin/views/field/Date.php \Drupal\views\Plugin\views\field\Date
- 11.x core/modules/views/src/Plugin/views/filter/Date.php \Drupal\views\Plugin\views\filter\Date
- 11.x core/modules/views/src/Plugin/views/argument/Date.php \Drupal\views\Plugin\views\argument\Date
- 11.x core/modules/datetime/src/Plugin/views/sort/Date.php \Drupal\datetime\Plugin\views\sort\Date
- 11.x core/modules/datetime/src/Plugin/views/filter/Date.php \Drupal\datetime\Plugin\views\filter\Date
- 11.x core/modules/datetime/src/Plugin/views/argument/Date.php \Drupal\datetime\Plugin\views\argument\Date
- 11.x core/lib/Drupal/Core/Render/Element/Date.php \Drupal\Core\Render\Element\Date
Basic sort handler for datetime fields.
This handler enables granularity, which is the ability to make dates equivalent based upon nearness.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\sort\SortPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\Core\Cache\CacheableDependencyInterface
- class \Drupal\views\Plugin\views\sort\Date extends \Drupal\views\Plugin\views\sort\SortPluginBase
- class \Drupal\datetime\Plugin\views\sort\Date extends \Drupal\views\Plugin\views\sort\Date uses \Drupal\views\FieldAPIHandlerTrait
- class \Drupal\views\Plugin\views\sort\Date extends \Drupal\views\Plugin\views\sort\SortPluginBase
- class \Drupal\views\Plugin\views\sort\SortPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\Core\Cache\CacheableDependencyInterface
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of Date
167 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 - CommentForm::buildEntity in core/
modules/ comment/ src/ CommentForm.php
File
-
core/
modules/ datetime/ src/ Plugin/ views/ sort/ Date.php, line 16
Namespace
Drupal\datetime\Plugin\views\sortView 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) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$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}
*
* Override to account for dates stored as strings.
*/
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}
*
* Overridden in order to pass in the string date flag.
*/
public function getDateFormat($format) {
return $this->query
->getDateFormat($this->getDateField(), $format, TRUE);
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
Date::$calculateOffset | protected | property | Determines if the timezone offset is calculated. | |||
Date::buildOptionsForm | public | function | Overrides SortPluginBase::buildOptionsForm | |||
Date::defineOptions | protected | function | Overrides SortPluginBase::defineOptions | |||
Date::getDateField | public | function | Override to account for dates stored as strings. | Overrides HandlerBase::getDateField | ||
Date::getDateFormat | public | function | Overridden in order to pass in the string date flag. | Overrides HandlerBase::getDateFormat | ||
Date::query | public | function | Called to add the sort to a query. | Overrides SortPluginBase::query | 1 | |
Date::__construct | public | function | Overrides HandlerBase::__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 | ||
HandlerBase::$field | public | property | With field you can override the realField if the real field is not set. | |||
HandlerBase::$is_handler | public | property | ||||
HandlerBase::$moduleHandler | protected | property | The module handler. | 2 | ||
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 | Overrides ViewsHandlerInterface::access | 5 | ||
HandlerBase::adminLabel | public | function | Overrides ViewsHandlerInterface::adminLabel | 4 | ||
HandlerBase::breakString | public static | function | Overrides ViewsHandlerInterface::breakString | |||
HandlerBase::broken | public | function | Overrides ViewsHandlerInterface::broken | |||
HandlerBase::buildExposedForm | public | function | Render our chunk of the exposed handler form when selecting. | 1 | ||
HandlerBase::buildExtraOptionsForm | public | function | Provide a form for setting options. | 1 | ||
HandlerBase::buildGroupByForm | public | function | Provide a form for aggregation settings. | 1 | ||
HandlerBase::calculateDependencies | public | function | Overrides PluginBase::calculateDependencies | 10 | ||
HandlerBase::caseTransform | protected | function | Transform a string by a certain method. | |||
HandlerBase::defineExtraOptions | public | function | Provide defaults for the handler. | |||
HandlerBase::displayExposedForm | public | function | Displays the Expose form. | |||
HandlerBase::ensureMyTable | public | function | Overrides ViewsHandlerInterface::ensureMyTable | 2 | ||
HandlerBase::exposedInfo | public | function | Get information about the exposed form for the form renderer. | 1 | ||
HandlerBase::getEntityType | public | function | Overrides ViewsHandlerInterface::getEntityType | |||
HandlerBase::getField | public | function | Overrides ViewsHandlerInterface::getField | |||
HandlerBase::getJoin | public | function | Overrides ViewsHandlerInterface::getJoin | |||
HandlerBase::getModuleHandler | protected | function | Gets the module handler. | |||
HandlerBase::getTableJoin | public static | function | Overrides ViewsHandlerInterface::getTableJoin | |||
HandlerBase::getViewsData | protected | function | Gets views data service. | |||
HandlerBase::hasExtraOptions | public | function | Determines if the handler has extra options. | 1 | ||
HandlerBase::init | public | function | Overrides PluginBase::init | 6 | ||
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 | Overrides ViewsHandlerInterface::postExecute | |||
HandlerBase::preQuery | public | function | Overrides ViewsHandlerInterface::preQuery | 2 | ||
HandlerBase::sanitizeValue | public | function | Overrides ViewsHandlerInterface::sanitizeValue | |||
HandlerBase::setModuleHandler | public | function | Sets the module handler. | |||
HandlerBase::setRelationship | public | function | Overrides ViewsHandlerInterface::setRelationship | |||
HandlerBase::setViewsData | public | function | ||||
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 | Overrides PluginBase::validate | 2 | ||
HandlerBase::validateExposed | public | function | Validate the exposed handler form. | 4 | ||
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::$position | public | property | The handler position. | |||
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::create | public static | function | Overrides ContainerFactoryPluginInterface::create | 60 | ||
PluginBase::destroy | public | function | 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 | Overrides ViewsPluginInterface::filterByDefinedOptions | |||
PluginBase::getAvailableGlobalTokens | public | function | Overrides ViewsPluginInterface::getAvailableGlobalTokens | |||
PluginBase::getProvider | public | function | Overrides ViewsPluginInterface::getProvider | |||
PluginBase::getRenderer | protected | function | Returns the render API renderer. | 1 | ||
PluginBase::globalTokenForm | public | function | Overrides ViewsPluginInterface::globalTokenForm | |||
PluginBase::globalTokenReplace | public | function | 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 | Overrides ViewsPluginInterface::pluginTitle | |||
PluginBase::preRenderAddFieldsetMarkup | public static | function | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | |||
PluginBase::preRenderFlattenData | public static | function | 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 | Overrides ViewsPluginInterface::summaryTitle | 6 | ||
PluginBase::themeFunctions | public | function | Overrides ViewsPluginInterface::themeFunctions | 1 | ||
PluginBase::unpackOptions | public | function | Overrides ViewsPluginInterface::unpackOptions | |||
PluginBase::usesOptions | public | function | 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 | ||
SortPluginBase::adminSummary | public | function | Display whether or not the sort order is ascending or descending. | Overrides HandlerBase::adminSummary | ||
SortPluginBase::buildExposeForm | public | function | Overrides HandlerBase::buildExposeForm | |||
SortPluginBase::canExpose | public | function | Determine if a sort can be exposed. | Overrides HandlerBase::canExpose | ||
SortPluginBase::defaultExposeOptions | public | function | Provide default options for exposed sorts. | Overrides HandlerBase::defaultExposeOptions | ||
SortPluginBase::getCacheContexts | public | function | Overrides CacheableDependencyInterface::getCacheContexts | |||
SortPluginBase::getCacheMaxAge | public | function | Overrides CacheableDependencyInterface::getCacheMaxAge | |||
SortPluginBase::getCacheTags | public | function | Overrides CacheableDependencyInterface::getCacheTags | |||
SortPluginBase::showExposeButton | public | function | Shortcut to display the expose/hide button. | Overrides HandlerBase::showExposeButton | ||
SortPluginBase::showSortForm | protected | function | Shortcut to display the value form. | |||
SortPluginBase::sortOptions | protected | function | Provide a list of options for the default sort form. | |||
SortPluginBase::sortSubmit | public | function | ||||
SortPluginBase::sortValidate | protected | function | ||||
SortPluginBase::submitOptionsForm | public | function | Simple submit handler. | Overrides PluginBase::submitOptionsForm | ||
SortPluginBase::trustedCallbacks | public static | function | Overrides PluginBase::trustedCallbacks | |||
SortPluginBase::validateExposeForm | public | function | Validate the options form. | Overrides HandlerBase::validateExposeForm | ||
SortPluginBase::validateOptionsForm | public | function | Simple validate handler. | Overrides PluginBase::validateOptionsForm | ||
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | ||||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||||
TrustedCallbackInterface::TRIGGER_WARNING | Deprecated | 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.