class ColorItem in Color API 8

Provides the Color field.

Plugin annotation


@FieldType(
  id = "colorapi_color_field",
  label = @Translation("Color"),
  default_formatter = "colorapi_color_display",
  default_widget = "colorapi_color_widget",
)

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\colorapi\Plugin\Field\FieldType\ColorItem implements ColorItemInterface

Expanded class hierarchy of ColorItem

1 file declares its use of ColorItem

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

File

src/Plugin/Field/FieldType/ColorItem.php, line 18

Namespace

Drupal\colorapi\Plugin\Field\FieldType

View source

class ColorItem extends FieldItemBase implements ColorItemInterface {

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    return [
      'columns' => [
        'name' => [
          'type' => 'varchar',
          'length' => 255,
          'not null' => FALSE,
        ],
        'color' => [
          'type' => 'varchar',
          'length' => 7,
          'not null' => FALSE,
        ],
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function isEmpty() {
    $hex_value = $this
      ->getHexadecimal();
    return $hex_value === NULL || $hex_value === '' || $hex_value === FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {

    // Retrieve the Typed Data Plugin Manager. This will be used to retrieve
    // the data definitions for the properties of this Field type.
    $typed_data_manager = \Drupal::typedDataManager();

    // The Plugin ID of the Typed Data data type the name property will store:
    $string_data_type = 'string';

    // Retrieve the data definition for String Simple Data types.
    $string_definition_info = $typed_data_manager
      ->getDefinition($string_data_type);

    // Use the definition class for the data type to create a new String object
    // and set some values on it.
    $properties['name'] = $string_definition_info['definition_class']::create($string_data_type)
      ->setLabel(t('Name'))
      ->setDescription(t('The human readable name of the color'));

    // The Plugin ID of the Typed Data data type the color property will store:
    $color_data_type = 'colorapi_color';

    // Retrieve the data definition for Color complex Data types.
    $color_definition_info = $typed_data_manager
      ->getDefinition($color_data_type);

    // Use the definition class for the data type to create a new Color object
    // and set some values on it.
    $properties['color'] = $color_definition_info['definition_class']::create($color_data_type)
      ->setLabel(t('Color'))
      ->setDescription(t('The color, in hexadecimal and RGB format.'))
      ->setRequired(TRUE);
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public function setValue($values, $notify = TRUE) {
    $values['name'] = isset($values['name']) ? $values['name'] : '';
    $this
      ->setName($values['name'], $notify);
    $color_string = isset($values['color']['hexadecimal']) ? $values['color']['hexadecimal'] : $values['color'];
    $this
      ->setHexadecimal($color_string, $notify);
    $service = \Drupal::service('colorapi.service');
    $this
      ->setRed($service
      ->hexToRgb($color_string, 'red'), $notify);
    $this
      ->setGreen($service
      ->hexToRgb($color_string, 'green'), $notify);
    $this
      ->setBlue($service
      ->hexToRgb($color_string, 'blue'), $notify);
  }

  /**
   * {@inheritdoc}
   */
  public function setName($name, $notify = TRUE) {
    $this
      ->get('name')
      ->setValue($name, $notify);
  }

  /**
   * {@inheritdoc}
   */
  public function getColorName() {
    return $this
      ->get('name')
      ->getValue();
  }

  /**
   * {@inheritdoc}
   */
  public function setColor(array $color, $notify = TRUE) {
    $this
      ->get('color')
      ->setValue($color, $notify);
  }

  /**
   * {@inheritdoc}
   */
  public function getColor() {
    return $this
      ->get('color')
      ->getValue();
  }

  /**
   * {@inheritdoc}
   */
  public function setHexadecimal($color, $notify = TRUE) {
    $this
      ->get('color')
      ->setHexadecimal($color, $notify);
  }

  /**
   * {@inheritdoc}
   */
  public function getHexadecimal() {
    return $this
      ->get('color')
      ->getHexadecimal();
  }

  /**
   * {@inheritdoc}
   */
  public function setRgb(array $rgb, $notify = TRUE) {
    $this
      ->get('color')
      ->setRgb($rgb, $notify);
  }

  /**
   * {@inheritdoc}
   */
  public function getRgb() {
    return $this
      ->get('color')
      ->getRgb();
  }

  /**
   * {@inheritdoc}
   */
  public function setRed($red, $notify = TRUE) {
    $this
      ->get('color')
      ->setRed($red, $notify);
  }

  /**
   * {@inheritdoc}
   */
  public function getRed() {
    return $this
      ->get('color')
      ->getRed();
  }

  /**
   * {@inheritdoc}
   */
  public function setGreen($green, $notify = TRUE) {
    $this
      ->get('color')
      ->setGreen($green, $notify);
  }

  /**
   * {@inheritdoc}
   */
  public function getGreen() {
    return $this
      ->get('color')
      ->getGreen();
  }

  /**
   * {@inheritdoc}
   */
  public function setBlue($blue, $notify = TRUE) {
    $this
      ->get('color')
      ->setBlue($blue, $notify);
  }

  /**
   * {@inheritdoc}
   */
  public function getBlue() {
    return $this
      ->get('color')
      ->getBlue();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ColorItem::getBlue	public	function	Retrieve 'Blue' value of the Color Field Color data object RGB property. Overrides ColorItemInterface::getBlue
ColorItem::getColor	public	function	Retrieve the color array for the Color Field item. Overrides ColorItemInterface::getColor
ColorItem::getColorName	public	function	Retrieve the human-readable name of the color. Overrides ColorItemInterface::getColorName
ColorItem::getGreen	public	function	Retrieve 'Green' value of the Color Field Color data object RGB property. Overrides ColorItemInterface::getGreen
ColorItem::getHexadecimal	public	function	Retrieve the hexadecimal color string representation of the color. Overrides ColorItemInterface::getHexadecimal
ColorItem::getRed	public	function	Retrieve 'Red' value of the Color Field Color data object RGB property. Overrides ColorItemInterface::getRed
ColorItem::getRgb	public	function	Retrieve RGB value array of the Color Field Color data object. Overrides ColorItemInterface::getRgb
ColorItem::isEmpty	public	function	Determines whether the data structure is empty. Overrides Map::isEmpty
ColorItem::propertyDefinitions	public static	function	Defines field item properties. Overrides FieldItemInterface::propertyDefinitions
ColorItem::schema	public static	function	Returns the schema for the field. Overrides FieldItemInterface::schema
ColorItem::setBlue	public	function	Set 'blue' property of the Color Field 'Color' property's 'RGB' property. Overrides ColorItemInterface::setBlue
ColorItem::setColor	public	function	Set the human-readable 'name' proprty of the Color Field item. Overrides ColorItemInterface::setColor
ColorItem::setGreen	public	function	Set 'green' property of the Color Field 'Color' property's 'RGB' property. Overrides ColorItemInterface::setGreen
ColorItem::setHexadecimal	public	function	Set the 'hexadecimal' property of the Color Field 'Color' property. Overrides ColorItemInterface::setHexadecimal
ColorItem::setName	public	function	Set the human-readable 'name' proprty of the Color Field item. Overrides ColorItemInterface::setName
ColorItem::setRed	public	function	Set 'red' property of the Color Field 'Color' property's 'RGB' property. Overrides ColorItemInterface::setRed
ColorItem::setRgb	public	function	Set the 'rgb' property of the Color Field 'Color' property. Overrides ColorItemInterface::setRgb
ColorItem::setValue	public	function	Sets the data value. Overrides FieldItemBase::setValue
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::defaultFieldSettings	public static	function	Defines the field-level settings for this plugin. Overrides FieldItemInterface::defaultFieldSettings	7
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::fieldSettingsForm	public	function	Returns a form for the field-level settings. Overrides FieldItemInterface::fieldSettingsForm	7
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::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::preSave	public	function	Defines custom presave behavior for field values. Overrides FieldItemInterface::preSave	7
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
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.
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

class ColorItem in Color API 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation