class ColorData in Color API 8

Provides the Color Typed Data type.

This data type is a wrapper for colors. It has the following properties:

hexadecimal: A Simple Data hexadecimal_color object holding the color in the format #XXXXXX, where X is a hexadecimal character (0-9 or a-f).
rgb: A complex data object with the properties:
- red: an integer with a value between 0 and 255.
- green: an integer with a value between 0 and 255.
- blue: an integer with a value between 0 and 255.

Plugin annotation


@DataType(
  id = "colorapi_color",
  label = @Translation("Color"),
  description = @Translation("A Complex Data object containing a color in hexadecimal and RGB formats"),
  definition_class = "\Drupal\colorapi\TypedData\Definition\ColorDataDefinition"
)

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\colorapi\Plugin\DataType\ColorData implements ColorInterface

Expanded class hierarchy of ColorData

1 string reference to 'ColorData'

colorapi.data_types.schema.yml in config/schema/colorapi.data_types.schema.yml: config/schema/colorapi.data_types.schema.yml

File

src/Plugin/DataType/ColorData.php, line 25

Namespace

Drupal\colorapi\Plugin\DataType

View source

class ColorData extends Map implements ColorInterface {

  /**
   * {@inheritdoc}
   */
  public function setValue($values, $notify = TRUE) {
    $this
      ->setHexadecimal($values['hexadecimal'], $notify);
    $this
      ->setRgb($values['rgb'], $notify);
  }

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

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

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

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

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

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

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

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

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

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

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

}

Members

Name	Modifiers	Type	Description	Overrides
ColorData::getBlue	public	function	Retrieve 'Blue' value of the Color data object RGB property. Overrides ColorInterface::getBlue
ColorData::getGreen	public	function	Retrieve 'Green' value of the Color data object RGB property. Overrides ColorInterface::getGreen
ColorData::getHexadecimal	public	function	Retrieve the hexadecimal color string representation of the color. Overrides ColorInterface::getHexadecimal
ColorData::getRed	public	function	Retrieve 'Red' value of the Color data object RGB property. Overrides ColorInterface::getRed
ColorData::getRgb	public	function	Retrieve RGB value array of the Color data ojbect.. Overrides ColorInterface::getRgb
ColorData::getValue	public	function	Gets the data value. Overrides Map::getValue
ColorData::setBlue	public	function	Set 'blue' property of the Color Data's 'RGB' property. Overrides ColorInterface::setBlue
ColorData::setGreen	public	function	Set 'green' property of the Color Data's 'RGB' property. Overrides ColorInterface::setGreen
ColorData::setHexadecimal	public	function	Set the 'hexadecimal' property of the Color Data. Overrides ColorInterface::setHexadecimal
ColorData::setRed	public	function	Set 'red' property of the Color Data's 'RGB' property. Overrides ColorInterface::setRed
ColorData::setRgb	public	function	Set the 'rgb' property of the Color Data. Overrides ColorInterface::setRgb
ColorData::setValue	public	function	Overrides \Drupal\Core\TypedData\TypedData::setValue(). Overrides Map::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
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::isEmpty	public	function	Determines whether the data structure is empty. Overrides ComplexDataInterface::isEmpty	17
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::writePropertyValue	protected	function	Writes the value of a property without handling changes.	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
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

You are here

class ColorData in Color API 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation