You are here

class Volume in Dimension 8

Same name in this branch
  1. 8 src/Plugin/Field/FieldFormatter/Volume.php \Drupal\dimension\Plugin\Field\FieldFormatter\Volume
  2. 8 src/Plugin/Field/FieldWidget/Volume.php \Drupal\dimension\Plugin\Field\FieldWidget\Volume
  3. 8 src/Plugin/Field/FieldType/Volume.php \Drupal\dimension\Plugin\Field\FieldType\Volume
Same name and namespace in other branches
  1. 2.1.x src/Plugin/Field/FieldType/Volume.php \Drupal\dimension\Plugin\Field\FieldType\Volume
  2. 2.0.x src/Plugin/Field/FieldType/Volume.php \Drupal\dimension\Plugin\Field\FieldType\Volume

Plugin implementation of the 'volume_field_type' field type.

Plugin annotation


@FieldType(
  id = "volume_field_type",
  label = @Translation("Dimension: Volume"),
  description = @Translation("Define length, width and height"),
  default_widget = "volume_field_widget",
  default_formatter = "volume_field_formatter"
)

Hierarchy

Expanded class hierarchy of Volume

File

src/Plugin/Field/FieldType/Volume.php, line 19

Namespace

Drupal\dimension\Plugin\Field\FieldType
View source
class Volume extends Dimension {
  use VolumeTrait;

  /**
   * {@inheritdoc}
   */
  public static function defaultStorageSettings() {
    return self::_defaultStorageSettings(self::fields());
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultFieldSettings() {
    return self::_defaultFieldSettings(self::fields());
  }

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    return self::_propertyDefinitions($field_definition, self::fields());
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    return self::_schema($field_definition, self::fields());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DecimalItem::generateSampleValue public static function Generates placeholder field values. Overrides FieldItemBase::generateSampleValue
DecimalItem::getDecimalDigits protected static function Helper method to get the number of decimal digits out of a decimal number.
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
Dimension::$value protected property The calculated length, area or volume.
Dimension::calculate public function
Dimension::fieldSettingsForm public function Returns a form for the field-level settings. Overrides DecimalItem::fieldSettingsForm
Dimension::getConstraints public function Gets a list of validation constraints. Overrides DecimalItem::getConstraints
Dimension::isEmpty public function Determines whether the data structure is empty. Overrides NumericItemBase::isEmpty
Dimension::preSave public function Defines custom presave behavior for field values. Overrides DecimalItem::preSave
Dimension::storageSettingsForm public function Returns a form for the storage-level settings. Overrides DecimalItem::storageSettingsForm
Dimension::_defaultFieldSettings protected static function
Dimension::_defaultStorageSettings protected static function
Dimension::_fieldSettings private function
Dimension::_propertyDefinitions protected static function
Dimension::_schema protected static function
Dimension::_storageSettings private function
FieldItemBase::calculateDependencies public static function Calculates dependencies for field items. Overrides FieldItemInterface::calculateDependencies 2
FieldItemBase::calculateStorageDependencies public static function Calculates dependencies for field items on the storage level. Overrides FieldItemInterface::calculateStorageDependencies 1
FieldItemBase::delete public function Defines custom delete behavior for field values. Overrides FieldItemInterface::delete 2
FieldItemBase::deleteRevision public function Defines custom revision delete behavior for field values. Overrides FieldItemInterface::deleteRevision
FieldItemBase::fieldSettingsFromConfigData public static function Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::fieldSettingsFromConfigData 1
FieldItemBase::fieldSettingsToConfigData public static function Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::fieldSettingsToConfigData 1
FieldItemBase::getEntity public function Gets the entity that field belongs to. Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition public function Gets the field definition. Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode public function Gets the langcode of the field values held in the object. 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 Returns the name of the main property, if any. Overrides FieldItemInterface::mainPropertyName 8
FieldItemBase::onDependencyRemoval public static function Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface::onDependencyRemoval 1
FieldItemBase::postSave public function Defines custom post-save behavior for field values. Overrides FieldItemInterface::postSave 2
FieldItemBase::setValue public function Sets the data value. Overrides Map::setValue 4
FieldItemBase::storageSettingsFromConfigData public static function Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::storageSettingsFromConfigData 2
FieldItemBase::storageSettingsToConfigData public static function Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::storageSettingsToConfigData 2
FieldItemBase::view public function Returns a renderable array for a single field item. 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 Constructs a TypedData object given its definition and context. Overrides TypedData::__construct 1
FieldItemBase::__get public function Magic method: Gets a property value. Overrides FieldItemInterface::__get 2
FieldItemBase::__isset public function Magic method: Determines whether a property is set. Overrides FieldItemInterface::__isset
FieldItemBase::__set public function Magic method: Sets a property value. Overrides FieldItemInterface::__set 1
FieldItemBase::__unset public function Magic method: Unsets a property. 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 Applies the default value. Overrides TypedData::applyDefaultValue 4
Map::get public function Gets a property object. Overrides ComplexDataInterface::get
Map::getIterator public function
Map::getProperties public function Gets an array of property objects. Overrides ComplexDataInterface::getProperties
Map::getString public function Returns a string representation of the data. Overrides TypedData::getString
Map::getValue public function Gets the data value. Overrides TypedData::getValue 1
Map::onChange public function Overrides TraversableTypedDataInterface::onChange 4
Map::set public function Sets a property value. Overrides ComplexDataInterface::set
Map::toArray public function Returns an array of all property values. Overrides ComplexDataInterface::toArray 1
Map::__clone public function Magic method: Implements a deep clone.
NumericItemBase::truncateDecimal protected static function Helper method to truncate a decimal number to a given number of decimals.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
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::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
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
Volume::defaultFieldSettings public static function Defines the field-level settings for this plugin. Overrides NumericItemBase::defaultFieldSettings
Volume::defaultStorageSettings public static function Defines the storage-level settings for this plugin. Overrides DecimalItem::defaultStorageSettings
Volume::propertyDefinitions public static function Defines field item properties. Overrides DecimalItem::propertyDefinitions
Volume::schema public static function Returns the schema for the field. Overrides DecimalItem::schema
VolumeTrait::fields public static function