You are here

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

class ColorFieldFormatterCss in Color Field 8.2

Plugin implementation of the color_field css declaration formatter.

Plugin annotation


@FieldFormatter(
  id = "color_field_formatter_css",
  module = "color_field",
  label = @Translation("Color CSS declaration"),
  field_types = {
    "color_field_type"
  }
)

Hierarchy

Expanded class hierarchy of ColorFieldFormatterCss

File

src/Plugin/Field/FieldFormatter/ColorFieldFormatterCss.php, line 27

Namespace

Drupal\color_field\Plugin\Field\FieldFormatter
View source 
class ColorFieldFormatterCss extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The token service.
   *
   * @var \Drupal\token\TokenInterface
   */
  protected $tokenService;

  /**
   * Constructs an ColorFieldFormatterCss object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\Core\Utility\Token $token_service
   *   The token service.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, Token $token_service) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->tokenService = $token_service;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    // @see \Drupal\Core\Field\FormatterPluginManager::createInstance().
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('token'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'selector' => 'body',
      'property' => 'background-color',
      'important' => TRUE,
      'opacity' => TRUE,
      'advanced' => FALSE,
      'css' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = [];
    $elements['selector'] = [
      '#title' => $this
        ->t('Selector'),
      '#description' => $this
        ->t('A valid CSS selector such as <code>.links > li > a, #logo</code>. You can use tokens as shown below.'),
      '#type' => 'textarea',
      '#rows' => '1',
      '#default_value' => $this
        ->getSetting('selector'),
      '#required' => TRUE,
      '#placeholder' => 'body > div > a',
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldDefinition
            ->getName() . '][settings_edit_form][settings][advanced]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $elements['property'] = [
      '#title' => $this
        ->t('Property'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('property'),
      '#required' => TRUE,
      '#options' => [
        'background-color' => $this
          ->t('Background color'),
        'color' => $this
          ->t('Text color'),
      ],
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldDefinition
            ->getName() . '][settings_edit_form][settings][advanced]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $elements['important'] = [
      '#title' => $this
        ->t('Important'),
      '#description' => $this
        ->t('Whenever this declaration is more important than others.'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('important'),
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldDefinition
            ->getName() . '][settings_edit_form][settings][advanced]"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    if ($this
      ->getFieldSetting('opacity')) {
      $elements['opacity'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Display opacity'),
        '#default_value' => $this
          ->getSetting('opacity'),
        '#states' => [
          'visible' => [
            ':input[name="fields[' . $this->fieldDefinition
              ->getName() . '][settings_edit_form][settings][advanced]"]' => [
              'checked' => FALSE,
            ],
          ],
        ],
      ];
    }
    $elements['advanced'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Advanced Mode'),
      '#default_value' => $this
        ->getSetting('advanced'),
      '#description' => t('Switch to advanced mode and build the css yourself.'),
    ];
    $elements['css'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('CSS'),
      '#default_value' => $this
        ->getSetting('css'),
      '#description' => t('Create the css statement yourself. This lets you for example, control multiple element aspects at once. You can use tokens as shown below.'),
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $this->fieldDefinition
            ->getName() . '][settings_edit_form][settings][advanced]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
      '#element_validate' => [
        'token_element_validate',
      ],
      '#token_types' => [
        $this->fieldDefinition
          ->getTargetEntityTypeId(),
        'color_field',
      ],
    ];
    $elements['token_help'] = [
      '#theme' => 'token_tree_link',
      '#token_types' => [
        $this->fieldDefinition
          ->getTargetEntityTypeId(),
        'color_field',
      ],
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $opacity = $this
      ->getFieldSetting('opacity');
    $settings = $this
      ->getSettings();
    $summary = [];
    if ($settings['advanced']) {
      $summary[] = $this
        ->t('Using advanced mode');
      $summary[] = $this
        ->t("CSS statement:\n@css", [
        '@css' => $settings['css'],
      ]);
    }
    else {
      $summary[] = $this
        ->t('CSS selector : @css_selector', [
        '@css_selector' => $settings['selector'],
      ]);
      $summary[] = $this
        ->t('CSS property : @css_property', [
        '@css_property' => $settings['property'],
      ]);
      $summary[] = $this
        ->t('!important declaration : @important_declaration', [
        '@important_declaration' => $settings['important'] ? $this
          ->t('Yes') : $this
          ->t('No'),
      ]);
      if ($opacity && $settings['opacity']) {
        $summary[] = $this
          ->t('Display with opacity.');
      }
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $settings = $this
      ->getSettings();
    $elements = [];
    $entity = $items
      ->getEntity();
    $tokens = [
      $entity
        ->getEntityType()
        ->id() => $entity,
    ];
    foreach ($items as $item) {
      $value = $this
        ->viewValue($item);
      $tokens['color_field'] = $item;
      if ($settings['advanced']) {
        $inline_css = $this->tokenService
          ->replace($settings['css'], $tokens);
      }
      else {
        $selector = $this->tokenService
          ->replace($settings['selector'], $tokens);
        $important = $settings['important'] ? ' !important' : '';
        $property = $settings['property'];
        $inline_css = $selector . ' { ' . $property . ': ' . $value . $important . '; }';
      }
      $elements['#attached']['html_head'][] = [
        [
          '#tag' => 'style',
          '#value' => $inline_css,
        ],
        sha1($inline_css),
      ];
    }
    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
ColorFieldFormatterCss::$tokenService protected property The token service.
ColorFieldFormatterCss::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
ColorFieldFormatterCss::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
ColorFieldFormatterCss::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
ColorFieldFormatterCss::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
ColorFieldFormatterCss::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
ColorFieldFormatterCss::viewValue protected function
ColorFieldFormatterCss::__construct public function Constructs an ColorFieldFormatterCss object. Overrides FormatterBase::__construct
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::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
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.