class DateFormat
Same name in this branch
- 9 core/modules/config_translation/src/FormElement/DateFormat.php \Drupal\config_translation\FormElement\DateFormat
Same name and namespace in other branches
- 11.x core/modules/config_translation/src/FormElement/DateFormat.php \Drupal\config_translation\FormElement\DateFormat
- 11.x core/lib/Drupal/Core/Datetime/Entity/DateFormat.php \Drupal\Core\Datetime\Entity\DateFormat
- 10 core/modules/config_translation/src/FormElement/DateFormat.php \Drupal\config_translation\FormElement\DateFormat
- 10 core/lib/Drupal/Core/Datetime/Entity/DateFormat.php \Drupal\Core\Datetime\Entity\DateFormat
- 8.9.x core/modules/config_translation/src/FormElement/DateFormat.php \Drupal\config_translation\FormElement\DateFormat
- 8.9.x core/lib/Drupal/Core/Datetime/Entity/DateFormat.php \Drupal\Core\Datetime\Entity\DateFormat
Defines the Date Format configuration entity class.
Plugin annotation
@ConfigEntityType(
id = "date_format",
label = @Translation("Date format"),
handlers = {
"access" = "Drupal\system\DateFormatAccessControlHandler",
},
entity_keys = {
"id" = "id",
"label" = "label"
},
admin_permission = "administer site configuration",
list_cache_tags = { "rendered" },
config_export = {
"id",
"label",
"locked",
"pattern",
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
- class \Drupal\Core\Datetime\Entity\DateFormat implements \Drupal\Core\Datetime\DateFormatInterface extends \Drupal\Core\Config\Entity\ConfigEntityBase
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
Expanded class hierarchy of DateFormat
21 files declare their use of DateFormat
- comment.tokens.inc in core/
modules/ comment/ comment.tokens.inc - Builds placeholder replacement tokens for comment-related data.
- CommentActionsTest.php in core/
modules/ comment/ tests/ src/ Kernel/ CommentActionsTest.php - CommentOrphanTest.php in core/
modules/ comment/ tests/ src/ Kernel/ CommentOrphanTest.php - DateFormatAccessControlHandlerTest.php in core/
modules/ system/ tests/ src/ Kernel/ DateFormatAccessControlHandlerTest.php - DateFormatResourceTestBase.php in core/
tests/ Drupal/ FunctionalTests/ Rest/ DateFormatResourceTestBase.php
File
-
core/
lib/ Drupal/ Core/ Datetime/ Entity/ DateFormat.php, line 32
Namespace
Drupal\Core\Datetime\EntityView source
class DateFormat extends ConfigEntityBase implements DateFormatInterface {
/**
* The date format machine name.
*
* @var string
*/
protected $id;
/**
* The human-readable name of the date format entity.
*
* @var string
*/
protected $label;
/**
* The date format pattern.
*
* @var string
*/
protected $pattern;
/**
* The locked status of this date format.
*
* @var bool
*/
protected $locked = FALSE;
/**
* {@inheritdoc}
*/
public function getPattern() {
return $this->pattern;
}
/**
* {@inheritdoc}
*/
public function setPattern($pattern) {
$this->pattern = $pattern;
return $this;
}
/**
* {@inheritdoc}
*/
public function isLocked() {
return (bool) $this->locked;
}
/**
* {@inheritdoc}
*/
public static function sort(ConfigEntityInterface $a, ConfigEntityInterface $b) {
if ($a->isLocked() == $b->isLocked()) {
$a_label = $a->label();
$b_label = $b->label();
return strnatcasecmp($a_label, $b_label);
}
return $a->isLocked() ? 1 : -1;
}
/**
* {@inheritdoc}
*/
public function getCacheTagsToInvalidate() {
return [
'rendered',
];
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|
CacheableDependencyTrait::$cacheContexts | protected | property | Cache contexts. | |||
CacheableDependencyTrait::$cacheMaxAge | protected | property | Cache max-age. | |||
CacheableDependencyTrait::$cacheTags | protected | property | Cache tags. | |||
CacheableDependencyTrait::setCacheability | protected | function | Sets cacheability; useful for value object constructors. | |||
ConfigEntityBase::$isUninstalling | private | property | Whether the config is being deleted by the uninstall process. | |||
ConfigEntityBase::$langcode | protected | property | The language code of the entity's default language. | |||
ConfigEntityBase::$originalId | protected | property | The original ID of the configuration entity. | |||
ConfigEntityBase::$status | protected | property | The enabled/disabled status of the configuration entity. | 1 | ||
ConfigEntityBase::$status | protected | property | The enabled/disabled status of the configuration entity. | 1 | ||
ConfigEntityBase::$third_party_settings | protected | property | Third party entity settings. | |||
ConfigEntityBase::$trustedData | protected | property | Trust supplied data and not use configuration schema on save. | |||
ConfigEntityBase::$uuid | protected | property | The UUID for this entity. | |||
ConfigEntityBase::$_core | protected | property | Information maintained by Drupal core about configuration. | |||
ConfigEntityBase::addDependency | protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |||
ConfigEntityBase::calculateDependencies | public | function | 3 | |||
ConfigEntityBase::calculateDependencies | public | function | 3 | |||
ConfigEntityBase::createDuplicate | public | function | ||||
ConfigEntityBase::disable | public | function | ||||
ConfigEntityBase::enable | public | function | ||||
ConfigEntityBase::get | public | function | ||||
ConfigEntityBase::getConfigDependencyName | public | function | ||||
ConfigEntityBase::getConfigManager | protected static | function | Gets the configuration manager. | |||
ConfigEntityBase::getConfigTarget | public | function | ||||
ConfigEntityBase::getDependencies | public | function | ||||
ConfigEntityBase::getOriginalId | public | function | ||||
ConfigEntityBase::getThirdPartyProviders | public | function | ||||
ConfigEntityBase::getThirdPartySetting | public | function | ||||
ConfigEntityBase::getThirdPartySettings | public | function | ||||
ConfigEntityBase::getTypedConfig | protected | function | Gets the typed config manager. | |||
ConfigEntityBase::hasTrustedData | public | function | ||||
ConfigEntityBase::invalidateTagsOnDelete | protected static | function | Override to never invalidate the individual entities' cache tags; the config system already invalidates them. |
|||
ConfigEntityBase::invalidateTagsOnSave | protected | function | Override to never invalidate the entity's cache tag; the config system already invalidates it. |
|||
ConfigEntityBase::isInstallable | public | function | ||||
ConfigEntityBase::isNew | public | function | Overrides Entity::isNew(). | |||
ConfigEntityBase::isUninstalling | public | function | ||||
ConfigEntityBase::onDependencyRemoval | public | function | ||||
ConfigEntityBase::preDelete | public static | function | 3 | |||
ConfigEntityBase::preDelete | public static | function | 3 | |||
ConfigEntityBase::preSave | public | function | 4 | |||
ConfigEntityBase::preSave | public | function | 4 | |||
ConfigEntityBase::save | public | function | ||||
ConfigEntityBase::set | public | function | ||||
ConfigEntityBase::setOriginalId | public | function | ||||
ConfigEntityBase::setStatus | public | function | ||||
ConfigEntityBase::setThirdPartySetting | public | function | ||||
ConfigEntityBase::setUninstalling | public | function | ||||
ConfigEntityBase::status | public | function | 1 | |||
ConfigEntityBase::status | public | function | 1 | |||
ConfigEntityBase::toArray | public | function | ||||
ConfigEntityBase::toUrl | public | function | ||||
ConfigEntityBase::trustData | public | function | ||||
ConfigEntityBase::unsetThirdPartySetting | public | function | ||||
ConfigEntityBase::__construct | public | function | 4 | |||
ConfigEntityBase::__construct | public | function | 4 | |||
ConfigEntityBase::__sleep | public | function | 1 | |||
ConfigEntityBase::__sleep | public | function | 1 | |||
DateFormat::$id | protected | property | The date format machine name. | |||
DateFormat::$label | protected | property | The human-readable name of the date format entity. | |||
DateFormat::$locked | protected | property | The locked status of this date format. | |||
DateFormat::$pattern | protected | property | The date format pattern. | |||
DateFormat::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | Overrides ConfigEntityBase::getCacheTagsToInvalidate | ||
DateFormat::getPattern | public | function | Gets the date pattern string for this format. | Overrides DateFormatInterface::getPattern | ||
DateFormat::isLocked | public | function | Determines if this date format is locked. | Overrides DateFormatInterface::isLocked | ||
DateFormat::setPattern | public | function | Sets the date pattern for this format. | Overrides DateFormatInterface::setPattern | ||
DateFormat::sort | public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | Overrides ConfigEntityBase::sort | ||
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
DependencySerializationTrait::__sleep | public | function | Aliased as: traitSleep | |||
DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | |||
DependencyTrait::$dependencies | protected | property | The object's dependencies. | |||
DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | |||
DependencyTrait::addDependency | protected | function | Adds a dependency. | Aliased as: addDependencyTrait | ||
EntityBase::$enforceIsNew | protected | property | Boolean indicating whether the entity should be forced to be new. | |||
EntityBase::$entityTypeId | protected | property | The entity type. | |||
EntityBase::$typedData | protected | property | A typed data object wrapping this entity. | |||
EntityBase::access | public | function | ||||
EntityBase::bundle | public | function | ||||
EntityBase::create | public static | function | ||||
EntityBase::delete | public | function | ||||
EntityBase::enforceIsNew | public | function | ||||
EntityBase::entityTypeBundleInfo | protected | function | Gets the entity type bundle info service. | |||
EntityBase::entityTypeManager | protected | function | Gets the entity type manager. | |||
EntityBase::getCacheContexts | public | function | ||||
EntityBase::getCacheMaxAge | public | function | ||||
EntityBase::getCacheTags | public | function | ||||
EntityBase::getConfigDependencyKey | public | function | ||||
EntityBase::getEntityType | public | function | ||||
EntityBase::getEntityTypeId | public | function | ||||
EntityBase::getListCacheTagsToInvalidate | protected | function | The list cache tags to invalidate for this entity. | |||
EntityBase::getTypedData | public | function | ||||
EntityBase::getTypedDataClass | private | function | Returns the typed data class name for this entity. | |||
EntityBase::hasLinkTemplate | public | function | ||||
EntityBase::id | public | function | 2 | |||
EntityBase::id | public | function | 2 | |||
EntityBase::label | public | function | 1 | |||
EntityBase::label | public | function | 1 | |||
EntityBase::language | public | function | ||||
EntityBase::languageManager | protected | function | Gets the language manager. | |||
EntityBase::linkTemplates | protected | function | Gets an array link templates. | 1 | ||
EntityBase::linkTemplates | protected | function | Gets an array link templates. | 1 | ||
EntityBase::load | public static | function | ||||
EntityBase::loadMultiple | public static | function | ||||
EntityBase::postCreate | public | function | ||||
EntityBase::postDelete | public static | function | 4 | |||
EntityBase::postDelete | public static | function | 4 | |||
EntityBase::postLoad | public static | function | ||||
EntityBase::postSave | public | function | 2 | |||
EntityBase::postSave | public | function | 2 | |||
EntityBase::preCreate | public static | function | 2 | |||
EntityBase::preCreate | public static | function | 2 | |||
EntityBase::referencedEntities | public | function | ||||
EntityBase::toLink | public | function | ||||
EntityBase::uriRelationships | public | function | ||||
EntityBase::urlRouteParameters | protected | function | Gets an array of placeholders for this entity. | 1 | ||
EntityBase::urlRouteParameters | protected | function | Gets an array of placeholders for this entity. | 1 | ||
EntityBase::uuid | public | function | ||||
EntityBase::uuidGenerator | protected | function | Gets the UUID generator. | |||
PluginDependencyTrait::calculatePluginDependencies | protected | function | Calculates and adds dependencies of a specific plugin instance. | |||
PluginDependencyTrait::getPluginDependencies | protected | function | Calculates and returns dependencies of a specific plugin instance. | |||
PluginDependencyTrait::moduleHandler | protected | function | Wraps the module handler. | |||
PluginDependencyTrait::themeHandler | protected | function | Wraps the theme handler. | |||
RefinableCacheableDependencyTrait::addCacheableDependency | public | function | ||||
RefinableCacheableDependencyTrait::addCacheContexts | public | function | ||||
RefinableCacheableDependencyTrait::addCacheTags | public | function | ||||
RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | ||||
SynchronizableEntityTrait::$isSyncing | protected | property | Is entity being created updated or deleted through synchronization process. | |||
SynchronizableEntityTrait::isSyncing | public | function | ||||
SynchronizableEntityTrait::setSyncing | public | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.