class TextimageTextFieldFormatter in Textimage 8.3
Same name and namespace in other branches
- 8.4 src/Plugin/Field/FieldFormatter/TextimageTextFieldFormatter.php \Drupal\textimage\Plugin\Field\FieldFormatter\TextimageTextFieldFormatter
Plugin implementation of the Textimage text field formatter.
Plugin annotation
@FieldFormatter(
id = "textimage_text_field_formatter",
label = @Translation("Textimage"),
field_types = {
"string",
"string_long",
"text",
"text_with_summary",
"text_long"
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\textimage\Plugin\Field\FieldFormatter\TextimageTextFieldFormatter implements ContainerFactoryPluginInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of TextimageTextFieldFormatter
File
- src/
Plugin/ Field/ FieldFormatter/ TextimageTextFieldFormatter.php, line 35
Namespace
Drupal\textimage\Plugin\Field\FieldFormatterView source
class TextimageTextFieldFormatter extends FormatterBase implements ContainerFactoryPluginInterface {
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $currentUser;
/**
* The Textimage factory service.
*
* @var \Drupal\textimage\TextimageFactory
*/
protected $textimageFactory;
/**
* The image style entity storage.
*
* @var \Drupal\Core\Entity\EntityStorageInterface
*/
protected $imageStyleStorage;
/**
* A logger instance.
*
* @var \Psr\Log\LoggerInterface
*/
protected $logger;
/**
* Constructs a TextimageTextFieldFormatter 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 settings.
* @param \Drupal\Core\Session\AccountInterface $current_user
* The current user.
* @param \Drupal\textimage\TextimageFactory $textimage_factory
* The Textimage factory service.
* @param \Drupal\Core\Entity\EntityStorageInterface $image_style_storage
* The image style entity storage.
* @param \Psr\Log\LoggerInterface $logger
* A logger instance.
*/
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, AccountInterface $current_user, TextimageFactory $textimage_factory, EntityStorageInterface $image_style_storage, LoggerInterface $logger) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
$this->currentUser = $current_user;
$this->textimageFactory = $textimage_factory;
$this->imageStyleStorage = $image_style_storage;
$this->logger = $logger;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
->get('current_user'), $container
->get('textimage.factory'), $container
->get('entity_type.manager')
->getStorage('image_style'), $container
->get('textimage.logger'));
}
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return [
'image_style' => '',
'image_text_values' => 'merge',
'image_link' => '',
'image_alt' => '',
'image_title' => '',
'image_build_deferred' => TRUE,
] + parent::defaultSettings();
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
// Image style setting.
$image_styles = $this->textimageFactory
->getTextimageStyleOptions(TRUE);
if (empty($image_styles)) {
$image_styles[''] = $this
->t('No Textimage style available');
}
$description_link = Link::fromTextAndUrl($this
->t('Configure Image Styles'), Url::fromRoute('entity.image_style.collection'));
$element['image_style'] = [
'#title' => $this
->t('Image style'),
'#type' => 'select',
'#default_value' => $this
->getSetting('image_style'),
'#options' => $image_styles,
'#required' => TRUE,
'#description' => $description_link
->toRenderable() + [
'#access' => $this->currentUser
->hasPermission('administer image styles'),
],
];
// Multi-value text field image generation settings.
if ($this->fieldDefinition
->getFieldStorageDefinition()
->getCardinality() != 1) {
$options = [
'merge' => $this
->t("Build one single image, styling together text values."),
'itemize' => $this
->t("Build multiple images, styling each text value in a separate image."),
];
$element['image_text_values'] = [
'#title' => $this
->t('Multiple values text field'),
'#type' => 'radios',
'#default_value' => $this
->getSetting('image_text_values'),
'#options' => $options,
'#required' => TRUE,
'#description' => $this
->t("Text values are styled following the sequence of 'Text overlay' effects in the image style."),
];
}
// Link setting.
$link_types = [
'content' => $this
->t('Content'),
'file' => $this
->t('Styled image'),
];
$element['image_link'] = [
'#title' => $this
->t('Link image to'),
'#type' => 'select',
'#default_value' => $this
->getSetting('image_link'),
'#empty_option' => $this
->t('Nothing'),
'#options' => $link_types,
];
// Image alt and title attribute settings.
$description = $this
->t('This text will be used by screen readers, search engines, or when the image cannot be loaded.');
$description .= ' ' . $this
->t('Tokens can be used.');
if ($this->fieldDefinition
->getType() == 'image') {
$description .= ' ' . $this
->t('Leave empty to use the alternative text set on content level.');
}
$element['image_alt'] = [
'#title' => $this
->t('Alternative text'),
'#type' => 'textfield',
'#default_value' => $this
->getSetting('image_alt'),
'#description' => $description,
'#maxlength' => 512,
];
$description = $this
->t('The title is used as a tool tip when the user hovers the mouse over the image.');
$description .= ' ' . $this
->t('Tokens can be used.');
if ($this->fieldDefinition
->getType() == 'image') {
$description .= ' ' . $this
->t('Leave empty to use the title set on content level.');
}
$element['image_title'] = [
'#type' => 'textfield',
'#title' => $this
->t('Title'),
'#default_value' => $this
->getSetting('image_title'),
'#description' => $description,
'#maxlength' => 1024,
];
return $element;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = [];
$image_styles = $this->textimageFactory
->getTextimageStyleOptions();
// Unset possible 'No defined styles' option.
unset($image_styles['']);
// Styles could be lost because of enabled/disabled modules that defines
// their styles in code.
$image_style_setting = $this
->getSetting('image_style');
if (isset($image_styles[$image_style_setting])) {
$summary[] = $this
->t('Image style: @style', [
'@style' => $image_styles[$image_style_setting],
]);
}
else {
$summary[] = $this
->t('Image style: undefined');
}
// Multi-value text field image generation settings.
if ($this->fieldDefinition
->getFieldStorageDefinition()
->getCardinality() != 1) {
$options = [
'merge' => $this
->t("Build one image"),
'itemize' => $this
->t("Build multiple images"),
];
$summary[] = $this
->t('Multiple text values: @option', [
'@option' => $options[$this
->getSetting('image_text_values')],
]);
}
// Display link setting only if image is linked.
$link_types = [
'content' => $this
->t('Linked to content'),
'file' => $this
->t('Linked to styled image'),
];
if (isset($link_types[$this
->getSetting('image_link')])) {
$summary[] = $link_types[$this
->getSetting('image_link')];
}
// Display this setting only if alt text is specified.
if ($this
->getSetting('image_alt')) {
$summary[] = $this
->t('Alternative text: @image_alt', [
'@image_alt' => $this
->getSetting('image_alt'),
]);
}
// Display this setting only if title is specified.
if ($this
->getSetting('image_title')) {
$summary[] = $this
->t('Title: @image_title', [
'@image_title' => $this
->getSetting('image_title'),
]);
}
return $summary;
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
// Get image style.
$image_style = $this->imageStyleStorage
->load($this
->getSetting('image_style'));
// Collect bubbleable metadata.
$bubbleable_metadata = new BubbleableMetadata();
// Provide token data for the displayed entity.
$instance = $items
->getFieldDefinition();
$field = $instance
->getFieldStorageDefinition();
$token_data = [
$instance
->getTargetEntityTypeId() => $items
->getEntity(),
];
// Get text strings from the text field.
$text = $this->textimageFactory
->getTextFieldText($items);
// Get alt and title text from the formatter settings, and resolve tokens.
if ($image_alt = $this
->getSetting('image_alt')) {
$image_alt = $this->textimageFactory
->processTextString($image_alt, NULL, $token_data, $bubbleable_metadata);
}
if ($image_title = $this
->getSetting('image_title')) {
$image_title = $this->textimageFactory
->processTextString($image_title, NULL, $token_data, $bubbleable_metadata);
}
// Check if the formatter involves a link to the parent entity.
$entity_url = $this
->getSetting('image_link') == 'content' ? $items
->getEntity()
->toUrl() : NULL;
$elements = [];
if ($field
->getCardinality() != 1 && $this
->getSetting('image_text_values') == 'itemize') {
// Build separate image for each text value.
foreach ($text as $text_value) {
$textimage = $this->textimageFactory
->get($bubbleable_metadata)
->setStyle($image_style)
->setTokenData($token_data)
->process($text_value);
if (!$this
->getSetting('image_build_deferred')) {
$textimage
->buildImage();
}
// Check if the formatter involves a link to the derived image.
if (!$entity_url && $this
->getSetting('image_link') == 'file') {
$url = $textimage
->getUrl();
}
else {
$url = NULL;
}
$element = [
'#theme' => 'textimage_formatter',
'#uri' => $textimage
->getUri(),
'#width' => $textimage
->getWidth(),
'#height' => $textimage
->getHeight(),
'#alt' => $image_alt,
'#title' => $image_title,
'#anchor_url' => $entity_url ?: $url,
];
$bubbleable_metadata
->applyTo($element);
$elements[] = $element;
}
}
else {
// Build single image with all text values.
$textimage = $this->textimageFactory
->get($bubbleable_metadata)
->setStyle($image_style)
->setTokenData($token_data)
->process($text);
if (!$this
->getSetting('image_build_deferred')) {
$textimage
->buildImage();
}
// Check if the formatter involves a link to the derived image.
if (!$entity_url && $this
->getSetting('image_link') == 'file') {
$url = $textimage
->getUrl();
}
else {
$url = NULL;
}
$element = [
'#theme' => 'textimage_formatter',
'#uri' => $textimage
->getUri(),
'#width' => $textimage
->getWidth(),
'#height' => $textimage
->getHeight(),
'#alt' => $image_alt,
'#title' => $image_title,
'#anchor_url' => $entity_url ?: $url,
];
$bubbleable_metadata
->applyTo($element);
$elements[] = $element;
}
return $elements;
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
$dependencies = parent::calculateDependencies();
$style_id = $this
->getSetting('image_style');
/** @var \Drupal\image\ImageStyleInterface $style */
if ($style_id && ($style = ImageStyle::load($style_id))) {
// If this formatter uses a valid image style to display the image, add
// the image style configuration entity as dependency of this formatter.
$dependencies[$style
->getConfigDependencyKey()][] = $style
->getConfigDependencyName();
}
return $dependencies;
}
/**
* {@inheritdoc}
*/
public function onDependencyRemoval(array $dependencies) {
$changed = parent::onDependencyRemoval($dependencies);
$style_id = $this
->getSetting('image_style');
/** @var \Drupal\image\ImageStyleInterface $style */
if ($style_id && ($style = ImageStyle::load($style_id))) {
if (!empty($dependencies[$style
->getConfigDependencyKey()][$style
->getConfigDependencyName()])) {
$replacement_id = $this->imageStyleStorage
->getReplacementId($style_id);
// If a valid replacement has been provided in the storage, replace the
// image style with the replacement and signal that the formatter plugin
// settings were updated.
if ($replacement_id && ($image_style = ImageStyle::load($replacement_id))) {
if ($this->textimageFactory
->isTextimage($image_style)) {
$this
->setSetting('image_style', $replacement_id);
$changed = TRUE;
}
else {
$this->logger
->warning('The style %replacement indicated for replacement is not valid for Textimage. The dependent configurations might need manual reconfiguration.', [
'%replacement' => $replacement_id,
]);
}
}
}
}
return $changed;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormatterBase:: |
protected | property | The field definition. | |
FormatterBase:: |
protected | property | The label display setting. | |
FormatterBase:: |
protected | property |
The formatter settings. Overrides PluginSettingsBase:: |
|
FormatterBase:: |
protected | property | The view mode. | |
FormatterBase:: |
protected | function | Returns the value of a field setting. | |
FormatterBase:: |
protected | function | Returns the array of field settings. | |
FormatterBase:: |
public static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterInterface:: |
14 |
FormatterBase:: |
public | function |
Allows formatters to load information for field values being displayed. Overrides FormatterInterface:: |
2 |
FormatterBase:: |
public | function |
Builds a renderable array for a fully themed field. Overrides FormatterInterface:: |
1 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TextimageTextFieldFormatter:: |
protected | property | The current user. | |
TextimageTextFieldFormatter:: |
protected | property | The image style entity storage. | |
TextimageTextFieldFormatter:: |
protected | property | A logger instance. | |
TextimageTextFieldFormatter:: |
protected | property | The Textimage factory service. | |
TextimageTextFieldFormatter:: |
public | function |
Calculates dependencies for the configured plugin. Overrides PluginSettingsBase:: |
|
TextimageTextFieldFormatter:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
|
TextimageTextFieldFormatter:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsBase:: |
|
TextimageTextFieldFormatter:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase:: |
|
TextimageTextFieldFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides FormatterBase:: |
|
TextimageTextFieldFormatter:: |
public | function |
Returns a short summary for the current formatter settings. Overrides FormatterBase:: |
|
TextimageTextFieldFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides FormatterInterface:: |
|
TextimageTextFieldFormatter:: |
public | function |
Constructs a TextimageTextFieldFormatter object. Overrides FormatterBase:: |