class SmartDateFormat in Smart Date 3.0.x

Defines the Smart date format entity.

Plugin annotation

@ConfigEntityType(
  id = "smart_date_format",
  label = @Translation("Smart date format"),
  handlers = {
    "list_builder" = "Drupal\smart_date\Entity\SmartDateFormatListBuilder",
    "form" = {
      "default" = "Drupal\smart_date\Form\SmartDateFormatForm",
      "add" = "Drupal\smart_date\Form\SmartDateFormatForm",
      "edit" = "Drupal\smart_date\Form\SmartDateFormatForm",
      "delete" = "Drupal\smart_date\Form\SmartDateFormatDeleteForm",
    },
    "access" = "Drupal\smart_date\Entity\SmartDateFormatAccessControlHandler",
    "route_provider" = {
      "html" = "Drupal\smart_date\Entity\SmartDateFormatHtmlRouteProvider",
    },
  },
  admin_permission = "administer site configuration",
  list_cache_tags = { "rendered" },
  entity_keys = {
    "id" = "id",
    "label" = "label",
  },
  links = {
    "canonical" = "/admin/config/regional/smart-date/{smart_date_format}",
    "add-form" = "/admin/config/regional/smart-date/add",
    "edit-form" = "/admin/config/regional/smart-date/{smart_date_format}/configure",
    "delete-form" = "/admin/config/regional/smart-date/{smart_date_format}/delete",
    "collection" = "/admin/config/regional/smart-date",
  },
  config_export = {
    "id",
    "label",
    "date_format",
    "time_format",
    "time_hour_format",
    "allday_label",
    "separator",
    "join",
    "ampm_reduce",
    "date_first",
    "site_time_toggle",
  },
)

Hierarchy

• class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
  • class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
    • class \Drupal\smart_date\Entity\SmartDateFormat implements SmartDateFormatInterface

5 files declare their use of SmartDateFormat

SmartDateDailyRangeFormatter.php in modules/smart_date_recur/src/Plugin/Field/FieldFormatter/SmartDateDailyRangeFormatter.php

SmartDateDefaultFormatter.php in src/Plugin/Field/FieldFormatter/SmartDateDefaultFormatter.php

SmartDateRecurrenceFormatter.php in modules/smart_date_recur/src/Plugin/Field/FieldFormatter/SmartDateRecurrenceFormatter.php

SmartDateRule.php in modules/smart_date_recur/src/Entity/SmartDateRule.php

smart_date.tokens.inc in ./smart_date.tokens.inc

Provides tokens for the smart_date module.

File

src/Entity/SmartDateFormat.php, line 56

Namespace

Drupal\smart_date\Entity

class SmartDateFormat extends ConfigEntityBase implements SmartDateFormatInterface {

  /**
   * The Smart date format ID.
   *
   * @var string
   */
  protected $id;

  /**
   * The Smart date format label.
   *
   * @var string
   */
  protected $label;

  /**
   * The Smart date time format.
   *
   * @var string
   */
  protected $date_format;

  /**
   * The Smart date time format.
   *
   * @var string
   */
  protected $time_format;

  /**
   * The Smart date time format to use for times on the hour.
   *
   * @var string
   */
  protected $time_hour_format;

  /**
   * The Smart date time format label for all day events.
   *
   * @var string
   */
  protected $allday_label;

  /**
   * The Smart date time format separator to use in ranges.
   *
   * @var string
   */
  protected $separator;

  /**
   * The Smart date time format join to use between date and time.
   *
   * @var string
   */
  protected $join;

  /**
   * Whether or not to remove the first am/pm when appropriate.
   *
   * @var bool
   */
  protected $ampm_reduce;

  /**
   * Whether the date or time should be rendered first.
   *
   * @var int
   */
  protected $date_first;

  /**
   * Whether or not to show the time in the site's timezone, if overridden.
   *
   * @var bool
   */
  protected $site_time_toggle;

  /**
   * {@inheritdoc}
   */
  public function getDateFormat() {
    return $this
      ->get('date_format')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setDateFormat($date_format) {
    $this
      ->set('date_format', $date_format);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getTimeFormat() {
    return $this
      ->get('time_format')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setTimeFormat($time_format) {
    $this
      ->set('time_format', $time_format);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getTimeHourFormat() {
    return $this
      ->get('time_hour_format')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setTimeHourFormat($time_hour_format) {
    $this
      ->set('time_hour_format', $time_hour_format);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getAlldayLabel() {
    return $this
      ->get('allday_label')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setAlldayLabel($allday_label) {
    $this
      ->set('allday_label', $allday_label);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getSeparator() {
    return $this
      ->get('separator')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setSeparator($separator) {
    $this
      ->set('separator', $separator);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getJoin() {
    return $this
      ->get('join')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setJoin($join) {
    $this
      ->set('join', $join);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getAmpmReduce() {
    return $this
      ->get('ampm_reduce')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setAmpmReduce($ampm_reduce) {
    $this
      ->set('ampm_reduce', $ampm_reduce);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getDateFirst() {
    return $this
      ->get('date_first')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setDateFirst($date_first) {
    $this
      ->set('date_first', $date_first);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getSiteTimeToggle() {
    return $this
      ->get('site_time_toggle')->value;
  }

  /**
   * {@inheritdoc}
   */
  public function setSiteTimeToggle($site_time_toggle) {
    $this
      ->set('site_time_toggle', $site_time_toggle);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getOptions() {
    $keys = $this
      ->getAllKeys();
    $values = [];
    foreach ($keys as $key) {
      $values[$key] = $this
        ->get($key);
    }
    return $values;
  }

  /**
   * {@inheritdoc}
   */
  public function setOptions(array $values) {
    $keys = $this
      ->getAllKeys();
    foreach ($keys as $key) {
      if (isset($values[$key])) {
        $this
          ->set($key, $values[$key]);
      }
    }
    return $values;
  }

  /**
   * Return an array of the keys used by Smart Date Formats.
   */
  protected function getAllKeys() {
    return [
      'date_format',
      'time_format',
      'time_hour_format',
      'allday_label',
      'separator',
      'join',
      'ampm_reduce',
      'date_first',
      'site_time_toggle',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTagsToInvalidate() {
    return [
      'rendered',
    ];
  }

}

Members

Name	Modifiers	Type	Description	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.	4
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
ConfigEntityBase::addDependency	protected	function	Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies	14
ConfigEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides EntityBase::createDuplicate	1
ConfigEntityBase::disable	public	function	Disables the configuration entity. Overrides ConfigEntityInterface::disable	1
ConfigEntityBase::enable	public	function	Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get	public	function	Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager	protected static	function	Gets the configuration manager.
ConfigEntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies	public	function	Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId	public	function	Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig	protected	function	Gets the typed config manager.
ConfigEntityBase::hasTrustedData	public	function	Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete	protected static	function	Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave	protected	function	Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable	public	function	Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable	2
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval	8
ConfigEntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete	8
ConfigEntityBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave	13
ConfigEntityBase::save	public	function	Saves an entity permanently. Overrides EntityBase::save	1
ConfigEntityBase::set	public	function	Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId	public	function	Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus	public	function	Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling	public	function
ConfigEntityBase::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label.	6
ConfigEntityBase::status	public	function	Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status	4
ConfigEntityBase::toArray	public	function	Gets an array of all property values. Overrides EntityBase::toArray	2
ConfigEntityBase::toUrl	public	function	Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData	public	function	Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__construct	public	function	Constructs an Entity object. Overrides EntityBase::__construct	10
ConfigEntityBase::__sleep	public	function	Overrides EntityBase::__sleep	4
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	2
DependencySerializationTrait::__wakeup	public	function		2
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	Checks data value access. Overrides AccessibleInterface::access	1
EntityBase::bundle	public	function	Gets the bundle of the entity. Overrides EntityInterface::bundle	1
EntityBase::create	public static	function	Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
EntityBase::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo	protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager	protected	function	Gets the entity type manager.
EntityBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate	protected	function	The list cache tags to invalidate for this entity.
EntityBase::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id	public	function	Gets the identifier. Overrides EntityInterface::id	11
EntityBase::label	public	function	Gets the label of the entity. Overrides EntityInterface::label	6
EntityBase::language	public	function	Gets the language of the entity. Overrides EntityInterface::language	1
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::linkTemplates	protected	function	Gets an array link templates.	1
EntityBase::load	public static	function	Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple	public static	function	Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate	4
EntityBase::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete	18
EntityBase::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
EntityBase::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave	14
EntityBase::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	7
EntityBase::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities	1
EntityBase::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships	public	function	Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	2
EntityBase::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid	1
EntityBase::uuidGenerator	protected	function	Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler.	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler.	1
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
SmartDateFormat::$allday_label	protected	property	The Smart date time format label for all day events.
SmartDateFormat::$ampm_reduce	protected	property	Whether or not to remove the first am/pm when appropriate.
SmartDateFormat::$date_first	protected	property	Whether the date or time should be rendered first.
SmartDateFormat::$date_format	protected	property	The Smart date time format.
SmartDateFormat::$id	protected	property	The Smart date format ID.
SmartDateFormat::$join	protected	property	The Smart date time format join to use between date and time.
SmartDateFormat::$label	protected	property	The Smart date format label.
SmartDateFormat::$separator	protected	property	The Smart date time format separator to use in ranges.
SmartDateFormat::$site_time_toggle	protected	property	Whether or not to show the time in the site's timezone, if overridden.
SmartDateFormat::$time_format	protected	property	The Smart date time format.
SmartDateFormat::$time_hour_format	protected	property	The Smart date time format to use for times on the hour.
SmartDateFormat::getAlldayLabel	public	function
SmartDateFormat::getAllKeys	protected	function	Return an array of the keys used by Smart Date Formats.
SmartDateFormat::getAmpmReduce	public	function
SmartDateFormat::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides ConfigEntityBase::getCacheTagsToInvalidate
SmartDateFormat::getDateFirst	public	function
SmartDateFormat::getDateFormat	public	function
SmartDateFormat::getJoin	public	function
SmartDateFormat::getOptions	public	function	Gets the array of options for this format. Overrides SmartDateFormatInterface::getOptions
SmartDateFormat::getSeparator	public	function
SmartDateFormat::getSiteTimeToggle	public	function
SmartDateFormat::getTimeFormat	public	function
SmartDateFormat::getTimeHourFormat	public	function
SmartDateFormat::setAlldayLabel	public	function
SmartDateFormat::setAmpmReduce	public	function
SmartDateFormat::setDateFirst	public	function
SmartDateFormat::setDateFormat	public	function
SmartDateFormat::setJoin	public	function
SmartDateFormat::setOptions	public	function	Sets the array of options for this format. Overrides SmartDateFormatInterface::setOptions
SmartDateFormat::setSeparator	public	function
SmartDateFormat::setSiteTimeToggle	public	function
SmartDateFormat::setTimeFormat	public	function
SmartDateFormat::setTimeHourFormat	public	function
SynchronizableEntityTrait::$isSyncing	protected	property	Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing	public	function
SynchronizableEntityTrait::setSyncing	public	function