class GranularityStringData in Duration Field 3.0.x

Provides the Granularity String typed data object.

A granularity string contains any or all of the following keys:

• y (years)
• m (months)
• d (days)
• h (hours)
• i (minutes)
• s (seconds)

Keys are separated by colons. The presence of a key means that degree of granularity is relevant. For example, a granularity string of y:m:d has keys for year, month and day, and therefore any time elements using that granularity would collect values for year, month and day. A granularity of y:s would indicate a granularity of years and seconds. An empty string means no granularity. Full granularity is y:m:d:h:i:s.

Plugin annotation

@DataType(
  id = "granularity_string",
  label = @Translation("Granularity String"),
)

Hierarchy

• class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
  • class \Drupal\Core\TypedData\PrimitiveBase implements PrimitiveInterface
    • class \Drupal\Core\TypedData\Plugin\DataType\StringData implements StringInterface
      • class \Drupal\duration_field\Plugin\DataType\GranularityStringData implements GranularityStringInterface

1 string reference to 'GranularityStringData'

duration_field.data_types.schema.yml in config/schema/duration_field.data_types.schema.yml

config/schema/duration_field.data_types.schema.yml

File

src/Plugin/DataType/GranularityStringData.php, line 30

Namespace

Drupal\duration_field\Plugin\DataType

class GranularityStringData extends StringData implements GranularityStringInterface {

  /**
   * {@inheritdoc}
   */
  public function getConstraints() {
    $constraint_manager = \Drupal::typedDataManager()
      ->getValidationConstraintManager();
    $constraints = parent::getConstraints();

    // Add constraint to ensure that submitted data is a granularity string.
    $constraints[] = $constraint_manager
      ->create('granularity_string', []);
    return $constraints;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
GranularityStringData::getConstraints	public	function	Gets a list of validation constraints. Overrides TypedData::getConstraints
GranularityStringInterface::GRANULARITY_STRING_PATTERN		constant	The Regex used to validate a granularity string.
PrimitiveBase::$value	protected	property	The data value.	1
PrimitiveBase::getValue	public	function	Gets the data value. Overrides TypedData::getValue	1
PrimitiveBase::setValue	public	function	Sets the data value. Overrides TypedData::setValue	1
StringData::getCastedValue	public	function	Gets the primitive data value casted to the correct PHP type. Overrides PrimitiveInterface::getCastedValue
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TypedData::$definition	protected	property	The data definition.	1
TypedData::$name	protected	property	The property name.
TypedData::$parent	protected	property	The parent typed data object.
TypedData::applyDefaultValue	public	function	Applies the default value. Overrides TypedDataInterface::applyDefaultValue	3
TypedData::createInstance	public static	function	Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getDataDefinition	public	function	Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName	public	function	Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent	public	function	Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath	public	function	Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot	public	function	Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::getString	public	function	Returns a string representation of the data. Overrides TypedDataInterface::getString	6
TypedData::setContext	public	function	Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate	public	function	Validates the currently set data value. Overrides TypedDataInterface::validate
TypedData::__construct	public	function	Constructs a TypedData object given its definition and context.	3
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2