You are here

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

class ColorFieldFormatterSwatch in Color Field 8.2

Plugin implementation of the color_field swatch formatter.

Plugin annotation


@FieldFormatter(
  id = "color_field_formatter_swatch",
  module = "color_field",
  label = @Translation("Color swatch"),
  field_types = {
    "color_field_type"
  }
)

Hierarchy

Expanded class hierarchy of ColorFieldFormatterSwatch

File

src/Plugin/Field/FieldFormatter/ColorFieldFormatterSwatch.php, line 24

Namespace

Drupal\color_field\Plugin\Field\FieldFormatter
View source 
class ColorFieldFormatterSwatch extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'shape' => 'square',
      'width' => 50,
      'height' => 50,
      'opacity' => TRUE,
      'data_attribute' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $opacity = $this
      ->getFieldSetting('opacity');
    $elements = [];
    $elements['shape'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Shape'),
      '#options' => $this
        ->getShape(),
      '#default_value' => $this
        ->getSetting('shape'),
      '#description' => '',
    ];
    $elements['width'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Width'),
      '#default_value' => $this
        ->getSetting('width'),
      '#min' => 1,
      '#description' => $this
        ->t('Defaults to pixels (px) if a number is entered, otherwise, you can enter any unit (ie %, em, vw)'),
    ];
    $elements['height'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Height'),
      '#default_value' => $this
        ->getSetting('height'),
      '#min' => 1,
      '#description' => $this
        ->t('Defaults to pixels (px) if a number is entered, otherwise, you can enter any unit (ie %, em, vh)'),
    ];
    if ($opacity) {
      $elements['opacity'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Display opacity'),
        '#default_value' => $this
          ->getSetting('opacity'),
      ];
    }
    $elements['data_attribute'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use HTML5 data attribute'),
      '#description' => $this
        ->t('Render a data-color HTML 5 data attribute to allow css selectors based on color'),
      '#default_value' => $this
        ->getSetting('data_attribute'),
    ];
    return $elements;
  }

  /**
   * This is used to get the shape.
   *
   * @param string|null $shape
   *   The specific shape name to get.
   *
   * @return array|string
   *   An array of shape ids/names or translated name of the specified shape.
   */
  protected function getShape($shape = NULL) {
    $formats = [];
    $formats['square'] = $this
      ->t('Square');
    $formats['circle'] = $this
      ->t('Circle');
    $formats['parallelogram'] = $this
      ->t('Parallelogram');
    $formats['triangle'] = $this
      ->t('Triangle');
    if ($shape) {
      return $formats[$shape];
    }
    return $formats;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $opacity = $this
      ->getFieldSetting('opacity');
    $settings = $this
      ->getSettings();
    $summary = [];
    $summary[] = $this
      ->t('@shape', [
      '@shape' => $this
        ->getShape($settings['shape']),
    ]);
    $summary[] = $this
      ->t('Width: @width Height: @height', [
      '@width' => $settings['width'],
      '@height' => $settings['height'],
    ]);
    if ($opacity && $settings['opacity']) {
      $summary[] = $this
        ->t('Display with opacity.');
    }
    if ($settings['data_attribute']) {
      $summary[] = $this
        ->t('Use HTML5 data attribute.');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $settings = $this
      ->getSettings();
    $elements = [];
    $elements['#attached']['library'][] = 'color_field/color-field-formatter-swatch';
    foreach ($items as $delta => $item) {
      $elements[$delta] = [
        '#theme' => 'color_field_formatter_swatch',
        '#color' => $this
          ->viewValue($item),
        '#shape' => $settings['shape'],
        '#width' => is_numeric($settings['width']) ? "{$settings['width']}px" : $settings['width'],
        '#height' => is_numeric($settings['height']) ? "{$settings['height']}px" : $settings['height'],
        '#attributes' => new Attribute([
          'class' => [
            'color_field__swatch',
            "color_field__swatch--{$settings['shape']}",
          ],
        ]),
      ];
      if ($settings['data_attribute']) {
        $color = new ColorHex($item->color, $item->opacity);
        $elements[$delta]['#attributes']['data-color'] = $color
          ->toString(FALSE);
      }
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  protected function viewValue(ColorFieldType $item) {
    $opacity = $this
      ->getFieldSetting('opacity');
    $settings = $this
      ->getSettings();
    $color_hex = new ColorHex($item->color, $item->opacity);
    if ($opacity && $settings['opacity']) {
      $rgbtext = $color_hex
        ->toRgb()
        ->toString(TRUE);
    }
    else {
      $rgbtext = $color_hex
        ->toRgb()
        ->toString(FALSE);
    }
    return $rgbtext;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ColorFieldFormatterSwatch::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
ColorFieldFormatterSwatch::getShape protected function This is used to get the shape.
ColorFieldFormatterSwatch::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
ColorFieldFormatterSwatch::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
ColorFieldFormatterSwatch::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements 1
ColorFieldFormatterSwatch::viewValue protected function
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
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
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::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
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::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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.