abstract class RangeItemBase in Range 8

Base class for 'range' configurable field types.

Hierarchy

class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ComplexDataInterface
  - class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
    class \Drupal\range\Plugin\Field\FieldType\RangeItemBase implements RangeItemInterface

Expanded class hierarchy of RangeItemBase

File

src/Plugin/Field/FieldType/RangeItemBase.php, line 14

Namespace

Drupal\range\Plugin\Field\FieldType

View source

abstract class RangeItemBase extends FieldItemBase implements RangeItemInterface {

  /**
   * {@inheritdoc}
   */
  public static function mainPropertyName() {
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    return [
      'columns' => [
        'from' => static::getColumnSpecification($field_definition),
        'to' => static::getColumnSpecification($field_definition),
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultFieldSettings() {
    return [
      'min' => '',
      'max' => '',
      'field' => [
        'prefix' => '',
        'suffix' => '',
      ],
      'from' => [
        'prefix' => '',
        'suffix' => '',
      ],
      'to' => [
        'prefix' => '',
        'suffix' => '',
      ],
      'combined' => [
        'prefix' => '',
        'suffix' => '',
      ],
    ] + parent::defaultFieldSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
    $element = [];
    $element['min'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Minimum'),
      '#default_value' => $this
        ->getSetting('min'),
      '#description' => $this
        ->t('The minimum value that should be allowed in this field. Leave blank for no minimum.'),
    ];
    $element['max'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Maximum'),
      '#default_value' => $this
        ->getSetting('max'),
      '#description' => $this
        ->t('The maximum value that should be allowed in this field. Leave blank for no maximum.'),
    ];
    $element += $this
      ->fieldSettingsFormSubElementPrefixSuffix($this
      ->t('FIELD'), 'field');
    $element += $this
      ->fieldSettingsFormSubElementPrefixSuffix($this
      ->t('FROM'), 'from');
    $element += $this
      ->fieldSettingsFormSubElementPrefixSuffix($this
      ->t('TO'), 'to');
    $element += $this
      ->fieldSettingsFormSubElementPrefixSuffix($this
      ->t('COMBINED'), 'combined');
    return $element;
  }

  /**
   * Helper function. Returns field properties based on the given type.
   *
   * @param string $type
   *   Range field data type. Either 'integer', 'float' or 'string'.
   *
   * @return \Drupal\Core\TypedData\DataDefinitionInterface[]
   *   An array of property definitions of contained properties, keyed by
   *   property name.
   */
  protected static function propertyDefinitionsByType($type) {
    $properties = [];
    $properties['from'] = DataDefinition::create($type)
      ->setLabel(t('From value'))
      ->setRequired(TRUE);
    $properties['to'] = DataDefinition::create($type)
      ->setLabel(t('To value'))
      ->setRequired(TRUE);
    return $properties;
  }

  /**
   * Helper method. Builds settings fieldsets for the FROM/TO values.
   *
   * @param string $title
   *   Fieldset title.
   * @param string $element_name
   *   Form element machine name.
   *
   * @return array
   *   FROM/TO instance settings fieldset.
   */
  protected function fieldSettingsFormSubElementPrefixSuffix($title, $element_name) {
    $element = [];
    $element[$element_name] = [
      '#type' => 'fieldset',
      '#title' => $title,
    ];
    $element[$element_name]['prefix'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Prefix'),
      '#default_value' => $this
        ->getSetting($element_name)['prefix'],
      '#size' => 60,
      '#description' => $this
        ->t("Define a string that should be prefixed to the value, like '\$ ' or '&euro; '. Leave blank for none."),
    ];
    $element[$element_name]['suffix'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Suffix'),
      '#default_value' => $this
        ->getSetting($element_name)['suffix'],
      '#size' => 60,
      '#description' => $this
        ->t("Define a string that should be suffixed to the value, like ' m', ' kb/s'. Leave blank for none."),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function isEmpty() {
    if (empty($this->from) && (string) $this->from !== '0' && empty($this->to) && (string) $this->to !== '0') {
      return TRUE;
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	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	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::defaultStorageSettings	public static	function	Defines the storage-level settings for this plugin. Overrides FieldItemInterface::defaultStorageSettings	10
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::generateSampleValue	public static	function	Generates placeholder field values. Overrides FieldItemInterface::generateSampleValue	18
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::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::preSave	public	function	Defines custom presave behavior for field values. Overrides FieldItemInterface::preSave	7
FieldItemBase::setValue	public	function	Sets the data value. Overrides Map::setValue	4
FieldItemBase::storageSettingsForm	public	function	Returns a form for the storage-level settings. Overrides FieldItemInterface::storageSettingsForm	8
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
FieldItemInterface::propertyDefinitions	public static	function	Defines field item properties.	28
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.
RangeItemBase::defaultFieldSettings	public static	function	Defines the field-level settings for this plugin. Overrides FieldItemBase::defaultFieldSettings
RangeItemBase::fieldSettingsForm	public	function	Returns a form for the field-level settings. Overrides FieldItemBase::fieldSettingsForm	2
RangeItemBase::fieldSettingsFormSubElementPrefixSuffix	protected	function	Helper method. Builds settings fieldsets for the FROM/TO values.
RangeItemBase::isEmpty	public	function	Determines whether the data structure is empty. Overrides Map::isEmpty
RangeItemBase::mainPropertyName	public static	function	Returns the name of the main property, if any. Overrides FieldItemBase::mainPropertyName
RangeItemBase::propertyDefinitionsByType	protected static	function	Helper function. Returns field properties based on the given type.
RangeItemBase::schema	public static	function	Returns the schema for the field. Overrides FieldItemInterface::schema
RangeItemInterface::getColumnSpecification	public static	function	Helper function. Returns Schema API column specification.	3
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::getConstraints	public	function	Gets a list of validation constraints. Overrides TypedDataInterface::getConstraints	9
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

You are here

abstract class RangeItemBase in Range 8

Hierarchy

File

Namespace

Members

API Navigation