Same name and namespace in other branches
- 8.x-2.x src/Plugin/Field/FieldFormatter/ColorFieldFormatterCss.php \Drupal\color_field\Plugin\Field\FieldFormatter\ColorFieldFormatterCss
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
- class \Drupal\color_field\Plugin\Field\FieldFormatter\ColorFieldFormatterCss extends \Drupal\Core\Field\FormatterBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
Expanded class hierarchy of ColorFieldFormatterCss
Fichier
-
src/
Plugin/ Field/ FieldFormatter/ ColorFieldFormatterCss.php, line 30
Namespace
Drupal\color_field\Plugin\Field\FieldFormatterView source
class ColorFieldFormatterCss extends FormatterBase implements ContainerFactoryPluginInterface {
/**
* The token service.
*
* @var \Drupal\Core\Utility\Token
*/
protected Token $tokenService;
/**
* The token entity mapper service.
*
* @var \Drupal\token\TokenEntityMapperInterface|null
*/
protected ?TokenEntityMapperInterface $tokenEntityMapper = NULL;
/**
* 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 mixed[] $settings
* The formatter settings.
* @param string $label
* The formatter label display setting.
* @param string $view_mode
* The view mode.
* @param mixed[] $third_party_settings
* Any third party settings.
* @param \Drupal\Core\Utility\Token $token_service
* The token service.
* @param \Drupal\token\TokenEntityMapperInterface|null $token_entity_mapper
* Optional token entity mapper service.
*/
public function __construct(string $plugin_id, mixed $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, string $label, string $view_mode, array $third_party_settings, Token $token_service, ?TokenEntityMapperInterface $token_entity_mapper = NULL) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
$this->tokenService = $token_service;
$this->tokenEntityMapper = $token_entity_mapper;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) : ColorFieldFormatterCss {
// @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'), $container->has('token.entity_mapper') ? $container->get('token.entity_mapper') : NULL);
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) : array {
$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->getTokenType(),
'color_field',
],
];
$elements['token_help'] = [
'#theme' => 'token_tree_link',
'#token_types' => [
$this->getTokenType(),
'color_field',
],
];
return $elements;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() : array {
$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) : array {
$settings = $this->getSettings();
$elements = [];
$tokens = [
$this->getTokenType() => $items->getEntity(),
];
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),
];
// If rendered in a view entity field, the #attached only propagates if
// there is some markup set.
$elements[0] = [
'#markup' => "<div class='hidden'>{$value}</div>",
];
}
return $elements;
}
/**
* {@inheritdoc}
*/
public static function defaultSettings() : array {
return [
'selector' => 'body',
'property' => 'background-color',
'important' => TRUE,
'opacity' => TRUE,
'advanced' => FALSE,
'css' => '',
] + parent::defaultSettings();
}
/**
* Gets the token type of the target entity.
*
* If the token entity mapper service is available, it will be used to get
* the token type. If that service is not available, the target entity type id
* will be used as a fallback.
*
* @return string
* Token type of the target entity.
*/
protected function getTokenType() : string {
$entity_type_id = $this->fieldDefinition
->getTargetEntityTypeId();
if (!$this->tokenEntityMapper) {
return $entity_type_id;
}
return $this->tokenEntityMapper
->getTokenTypeForEntityType($entity_type_id, TRUE);
}
/**
* View an individual field value.
*
* @param \Drupal\color_field\Plugin\Field\FieldType\ColorFieldType $item
* The field item.
*
* @return string
* The field value as rgb/rgba string.
*/
protected function viewValue(ColorFieldType $item) : string {
$opacity = $this->getFieldSetting('opacity');
$settings = $this->getSettings();
$color_hex = new ColorHex($item->color, $item->opacity);
return $opacity && $settings['opacity'] ? $color_hex->toRgb()
->toString(TRUE) : $color_hex->toRgb()
->toString(FALSE);
}
}
Members
Titre Trier par ordre décroissant | Modifiers | Object type | Résumé |
---|---|---|---|
ColorFieldFormatterCss::$tokenEntityMapper | protected | property | The token entity mapper service. |
ColorFieldFormatterCss::$tokenService | protected | property | The token service. |
ColorFieldFormatterCss::create | public static | function | |
ColorFieldFormatterCss::defaultSettings | public static | function | |
ColorFieldFormatterCss::getTokenType | protected | function | Gets the token type of the target entity. |
ColorFieldFormatterCss::settingsForm | public | function | |
ColorFieldFormatterCss::settingsSummary | public | function | |
ColorFieldFormatterCss::viewElements | public | function | |
ColorFieldFormatterCss::viewValue | protected | function | View an individual field value. |
ColorFieldFormatterCss::__construct | public | function | Constructs an ColorFieldFormatterCss object. |