class TelephoneItem

Same name and namespace in other branches
  1. 9 core/modules/telephone/src/Plugin/Field/FieldType/TelephoneItem.php \Drupal\telephone\Plugin\Field\FieldType\TelephoneItem
  2. 8.9.x core/modules/telephone/src/Plugin/Field/FieldType/TelephoneItem.php \Drupal\telephone\Plugin\Field\FieldType\TelephoneItem
  3. 10 core/modules/telephone/src/Plugin/Field/FieldType/TelephoneItem.php \Drupal\telephone\Plugin\Field\FieldType\TelephoneItem

Plugin implementation of the 'telephone' field type.

Attributes

#[FieldType(id: "telephone", label: new TranslatableMarkup("Telephone number"), description: new TranslatableMarkup("This field stores a telephone number."), default_widget: "telephone_default", default_formatter: "basic_string")]

Hierarchy

Expanded class hierarchy of TelephoneItem

2 files declare their use of TelephoneItem
TelephoneDefaultWidget.php in core/modules/telephone/src/Plugin/Field/FieldWidget/TelephoneDefaultWidget.php
TelephoneFieldTest.php in core/modules/telephone/tests/src/Functional/TelephoneFieldTest.php

File

core/modules/telephone/src/Plugin/Field/FieldType/TelephoneItem.php, line 15

Namespace

Drupal\telephone\Plugin\Field\FieldType
View source
class TelephoneItem extends FieldItemBase {
  
  /**
   * The maximum length for a telephone value.
   */
  const MAX_LENGTH = 256;
  
  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    return [
      'columns' => [
        'value' => [
          'type' => 'varchar',
          'length' => self::MAX_LENGTH,
        ],
      ],
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties['value'] = DataDefinition::create('string')->setLabel(new TranslatableMarkup('Telephone number'))
      ->setRequired(TRUE);
    return $properties;
  }
  
  /**
   * {@inheritdoc}
   */
  public function isEmpty() {
    $value = $this->get('value')
      ->getValue();
    return $value === NULL || $value === '';
  }
  
  /**
   * {@inheritdoc}
   */
  public function getConstraints() {
    $constraint_manager = \Drupal::typedDataManager()->getValidationConstraintManager();
    $constraints = parent::getConstraints();
    $constraints[] = $constraint_manager->create('ComplexData', [
      'value' => [
        'Length' => [
          'max' => self::MAX_LENGTH,
          'maxMessage' => $this->t('%name: the telephone number may not be longer than @max characters.', [
            '%name' => $this->getFieldDefinition()
              ->getLabel(),
            '@max' => self::MAX_LENGTH,
          ]),
        ],
      ],
    ]);
    return $constraints;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
    $values['value'] = rand(pow(10, 8), pow(10, 9) - 1);
    return $values;
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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 1
DependencySerializationTrait::__wakeup public function 2
FieldItemBase::calculateDependencies public static function Overrides FieldItemInterface::calculateDependencies 2
FieldItemBase::calculateStorageDependencies public static function Overrides FieldItemInterface::calculateStorageDependencies
FieldItemBase::defaultFieldSettings public static function Overrides FieldItemInterface::defaultFieldSettings 6
FieldItemBase::defaultStorageSettings public static function Overrides FieldItemInterface::defaultStorageSettings 9
FieldItemBase::delete public function Overrides FieldItemInterface::delete 2
FieldItemBase::deleteRevision public function Overrides FieldItemInterface::deleteRevision
FieldItemBase::fieldSettingsForm public function Overrides FieldItemInterface::fieldSettingsForm 6
FieldItemBase::fieldSettingsFromConfigData public static function Overrides FieldItemInterface::fieldSettingsFromConfigData 1
FieldItemBase::fieldSettingsSummary public static function Overrides FieldItemInterface::fieldSettingsSummary
FieldItemBase::fieldSettingsToConfigData public static function Overrides FieldItemInterface::fieldSettingsToConfigData 1
FieldItemBase::getEntity public function Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition public function Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode public function Overrides FieldItemInterface::getLangcode
FieldItemBase::getSetting protected function Returns the value of a field setting.
FieldItemBase::getSettings protected function Returns the array of field settings.
FieldItemBase::mainPropertyName public static function Overrides FieldItemInterface::mainPropertyName 8
FieldItemBase::onDependencyRemoval public static function Overrides FieldItemInterface::onDependencyRemoval
FieldItemBase::postSave public function Overrides FieldItemInterface::postSave 2
FieldItemBase::preSave public function Overrides FieldItemInterface::preSave 6
FieldItemBase::setValue public function Overrides Map::setValue 3
FieldItemBase::storageSettingsForm public function Overrides FieldItemInterface::storageSettingsForm 7
FieldItemBase::storageSettingsFromConfigData public static function Overrides FieldItemInterface::storageSettingsFromConfigData 2
FieldItemBase::storageSettingsSummary public static function Overrides FieldItemInterface::storageSettingsSummary
FieldItemBase::storageSettingsToConfigData public static function Overrides FieldItemInterface::storageSettingsToConfigData 2
FieldItemBase::view public function Overrides FieldItemInterface::view
FieldItemBase::writePropertyValue protected function Different to the parent Map class, we avoid creating property objects as
far as possible in order to optimize performance. Thus we just update
$this->values if no property object has been created yet.
Overrides Map::writePropertyValue
FieldItemBase::__construct public function Overrides TypedData::__construct 3
FieldItemBase::__get public function Overrides FieldItemInterface::__get 2
FieldItemBase::__isset public function Overrides FieldItemInterface::__isset
FieldItemBase::__set public function Overrides FieldItemInterface::__set 1
FieldItemBase::__unset public function Overrides FieldItemInterface::__unset
Map::$definition protected property The data definition. Overrides TypedData::$definition
Map::$properties protected property The array of properties.
Map::$values protected property An array of values for the contained properties.
Map::applyDefaultValue public function Overrides TypedData::applyDefaultValue 4
Map::get public function Overrides ComplexDataInterface::get
Map::getIterator public function
Map::getProperties public function Overrides ComplexDataInterface::getProperties
Map::getString public function Overrides TypedData::getString
Map::getValue public function Overrides TypedData::getValue
Map::onChange public function Overrides TraversableTypedDataInterface::onChange 3
Map::set public function Overrides ComplexDataInterface::set
Map::toArray public function Overrides ComplexDataInterface::toArray 1
Map::__clone public function Magic method: Implements a deep clone.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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. 1
TelephoneItem::generateSampleValue public static function Overrides FieldItemBase::generateSampleValue
TelephoneItem::getConstraints public function Overrides TypedData::getConstraints
TelephoneItem::isEmpty public function Overrides Map::isEmpty
TelephoneItem::MAX_LENGTH constant The maximum length for a telephone value.
TelephoneItem::propertyDefinitions public static function Overrides FieldItemInterface::propertyDefinitions
TelephoneItem::schema public static function Overrides FieldItemInterface::schema
TypedData::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
TypedData::createInstance public static function Overrides TypedDataInterface::createInstance
TypedData::getDataDefinition public function Overrides TypedDataInterface::getDataDefinition
TypedData::getName public function Overrides TypedDataInterface::getName
TypedData::getParent public function Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition public function Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId public function Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath public function Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot public function Overrides TypedDataInterface::getRoot
TypedData::setContext public function Overrides TypedDataInterface::setContext
TypedData::validate public function Overrides TypedDataInterface::validate
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

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