You are here

Home » API reference » Color Field 8.2 » Color.php

class Color in Color Field 8.2

Defines a color field mapper.

Plugin annotation


@FeedsTarget(
  id = "color",
  field_types = {
    "color_field_type"
  }
)

Hierarchy

Expanded class hierarchy of Color

2 string references to 'Color'
ColorFieldType::propertyDefinitions in src/Plugin/Field/FieldType/ColorFieldType.php
Defines field item properties.
ColorFieldWidgetBase::formElement in src/Plugin/Field/FieldWidget/ColorFieldWidgetBase.php
Returns the form for a single field widget.

File

src/Feeds/Target/Color.php, line 21

Namespace

Drupal\color_field\Feeds\Target
View source 
class Color extends FieldTargetBase implements ConfigurableTargetInterface {

  /**
   * {@inheritdoc}
   */
  protected static function prepareTarget(FieldDefinitionInterface $field_definition) {
    return FieldTargetDefinition::createFromFieldDefinition($field_definition)
      ->addProperty('color')
      ->addProperty('opacity');
  }

  /**
   * {@inheritdoc}
   */
  protected function prepareValue($delta, array &$values) {

    // Clean up data and format it.
    $color = trim($values['color']);
    if (substr($color, 0, 1) === '#') {
      $color = substr($color, 1);
    }
    switch ($this->configuration['format']) {
      case '#HEXHEX':
        $color = '#' . strtoupper($color);
        break;
      case 'HEXHEX':
        $color = strtoupper($color);
        break;
      case '#hexhex':
        $color = '#' . strtolower($color);
        break;
      case 'hexhex':
        $color = strtolower($color);
        break;
    }
    $values['color'] = $color;
    $values['opacity'] = $values['opacity'] ? (double) $values['opacity'] : 0.0;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + [
      'format' => '#hexhex',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['format'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Format'),
      '#options' => [
        '#HEXHEX' => $this
          ->t('#123ABC'),
        'HEXHEX' => $this
          ->t('123ABC'),
        '#hexhex' => $this
          ->t('#123abc'),
        'hexhex' => $this
          ->t('123abc'),
      ],
      '#default_value' => $this->configuration['format'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $summary = parent::getSummary();
    $summary[] = $this->configuration['format'] ? $summary[] = $this
      ->t('Color with format: %format', [
      '%format' => $this->configuration['format'],
    ]) : $this
      ->t('Color by default');
    return $summary;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Color::buildConfigurationForm public function Form constructor. Overrides FieldTargetBase::buildConfigurationForm
Color::defaultConfiguration public function Gets default configuration for this plugin. Overrides FieldTargetBase::defaultConfiguration
Color::getSummary public function Returns the summary for a target. Overrides FieldTargetBase::getSummary
Color::prepareTarget protected static function Prepares a target definition. Overrides FieldTargetBase::prepareTarget
Color::prepareValue protected function Prepares a single value. Overrides FieldTargetBase::prepareValue
ConfigurablePluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
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
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
FieldTargetBase::$fieldSettings protected property The field settings.
FieldTargetBase::$languageManager protected property The language manager.
FieldTargetBase::addMessage protected function Adds a message.
FieldTargetBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies
FieldTargetBase::getEntityTarget public function Get entity, or entity translation to set the map.
FieldTargetBase::getLangcode public function Gets the configured language. Overrides TranslatableTargetInterface::getLangcode
FieldTargetBase::getLanguageManager protected function Gets the language manager.
FieldTargetBase::getMessenger protected function Returns the messenger to use.
FieldTargetBase::getUniqueQuery protected function Constructs a base query which is used to find an existing entity.
FieldTargetBase::getUniqueValue public function Looks for an existing entity and returns an entity ID if found.
FieldTargetBase::isEmpty public function Returns if the value for the target is empty. Overrides TargetInterface::isEmpty
FieldTargetBase::isMutable public function Returns if the target is mutable. Overrides TargetInterface::isMutable 1
FieldTargetBase::isTargetFieldTranslatable protected function Checks if the targeted field is translatable.
FieldTargetBase::isTargetTranslatable public function Checks if the target is translatable. Overrides TranslatableTargetInterface::isTargetTranslatable
FieldTargetBase::languageExists public function Checks if the language selected on the target exists. Overrides TranslatableTargetInterface::languageExists
FieldTargetBase::onDependencyRemoval public function Allows a plugin to define whether it should be removed. Overrides TargetBase::onDependencyRemoval
FieldTargetBase::prepareValues protected function Prepares the the values that will be mapped to an entity.
FieldTargetBase::setLanguageManager public function Sets the language manager.
FieldTargetBase::setTarget public function Sets the values on an object. Overrides TargetInterface::setTarget 4
FieldTargetBase::targets public static function Returns the targets defined by this plugin. Overrides TargetInterface::targets 1
FieldTargetBase::__construct public function Constructs a TargetBase object. Overrides TargetBase::__construct 5
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$feedType protected property The importer this plugin is working for.
PluginBase::$linkGenerator protected property The link generator.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$urlGenerator protected property The url generator.
PluginBase::container private function Returns the service container.
PluginBase::defaultFeedConfiguration public function Returns default feed configuration. Overrides FeedsPluginInterface::defaultFeedConfiguration 3
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::l protected function Renders a link to a route given a route name and its parameters.
PluginBase::linkGenerator protected function Returns the link generator service.
PluginBase::onFeedDeleteMultiple public function A feed is being deleted. 3
PluginBase::onFeedSave public function A feed is being saved.
PluginBase::onFeedTypeDelete public function The feed type is being deleted. 1
PluginBase::onFeedTypeSave public function The feed type is being saved. 1
PluginBase::pluginType public function Returns the type of plugin. Overrides FeedsPluginInterface::pluginType
PluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration 1
PluginBase::url protected function Generates a URL or path for a specific route based on the given parameters.
PluginBase::urlGenerator protected function Returns the URL generator service.
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.
TargetBase::$targetDefinition protected property The target definition.
TargetBase::getTargetDefinition public function Returns the target's definition. Overrides TargetInterface::getTargetDefinition
TargetBase::submitConfigurationForm public function Form submission handler. Overrides ConfigurablePluginBase::submitConfigurationForm