class FontAwesomeIconFormatter in Font Awesome Icons 8.2
Implementation of Font Awesome icon formatter.
Plugin annotation
@FieldFormatter(
id = "fontawesome_icon_formatter",
label = @Translation("Font Awesome Icon"),
field_types = {
"fontawesome_icon"
}
)
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\fontawesome\Plugin\Field\FieldFormatter\FontAwesomeIconFormatter 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 FontAwesomeIconFormatter
File
- src/
Plugin/ Field/ FieldFormatter/ FontAwesomeIconFormatter.php, line 26
Namespace
Drupal\fontawesome\Plugin\Field\FieldFormatterView source
class FontAwesomeIconFormatter extends FormatterBase implements ContainerFactoryPluginInterface {
/**
* Drupal configuration service container.
*
* @var \Drupal\Core\Config\ConfigFactory
*/
protected $configFactory;
/**
* {@inheritdoc}
*/
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, ConfigFactory $config_factory) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
$this->configFactory = $config_factory;
}
/**
* {@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('config.factory'));
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
// Load the configuration settings.
$configuration_settings = $this->configFactory
->get('fontawesome.settings');
// Setting for optional download link.
$elements['layers'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Display multi-value fields as layers?'),
'#default_value' => $this
->getSetting('layers'),
'#description' => $this
->t('Layers are the new way to place icons and text visually on top of each other, replacing the Font Awesome classic icons stacks. With this new approach you can use more than 2 icons. Layers are awesome when you don’t want your page’s background to show through, or when you do want to use multiple colors, layer several icons, layer text, or layer counters onto an icon. Note that layers only work with the SVG version of Font Awesome. For more information, see @layersLink.', [
'@layersLink' => Link::fromTextAndUrl($this
->t('the Font Awesome guide to layers'), Url::fromUri('https://fontawesome.com/how-to-use/on-the-web/styling/layering'))
->toString(),
]),
// Disable power transforms for webfonts.
'#disabled' => $configuration_settings
->get('method') == 'webfonts',
];
return $elements;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$settings = $this
->getSettings();
$summary = [];
// Load the configuration settings.
$configuration_settings = $this->configFactory
->get('fontawesome.settings');
// Show whether or not we are layering the icons.
$summary[] = $this
->t('Display multi-value fields as layers: <strong>@layersSetting</strong>', [
'@layersSetting' => $settings['layers'] && $configuration_settings
->get('method') != 'webfonts' ? 'Yes' : 'No',
]);
return $summary;
}
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return [
'layers' => FALSE,
] + parent::defaultSettings();
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
// Early opt-out if the field is empty.
if (count($items) <= 0) {
return [];
}
// Load the configuration settings.
$configurationSettings = $this->configFactory
->get('fontawesome.settings');
// Loop over each icon and build data.
$icons = [];
foreach ($items as $item) {
// Get the icon settings.
$iconSettings = unserialize($item
->get('settings')
->getValue());
$cssStyles = [];
// Format mask.
$iconMask = '';
if (!empty($iconSettings['masking']['mask'])) {
$iconMask = $iconSettings['masking']['style'] . ' fa-' . $iconSettings['masking']['mask'];
}
unset($iconSettings['masking']);
// Format power transforms.
$iconTransforms = [];
$powerTransforms = $iconSettings['power_transforms'];
foreach ($powerTransforms as $transform) {
if (!empty($transform['type'])) {
$iconTransforms[] = $transform['type'] . '-' . $transform['value'];
}
}
unset($iconSettings['power_transforms']);
// Move duotone settings into the render.
if (isset($iconSettings['duotone'])) {
// Handle swap opacity flag.
if (!empty($iconSettings['duotone']['swap-opacity'])) {
$iconSettings['swap-opacity'] = $iconSettings['duotone']['swap-opacity'];
}
// Handle custom CSS styles.
if (!empty($iconSettings['duotone']['opacity']['primary'])) {
$cssStyles[] = '--fa-primary-opacity: ' . $iconSettings['duotone']['opacity']['primary'] . ';';
}
if (!empty($iconSettings['duotone']['opacity']['secondary'])) {
$cssStyles[] = '--fa-secondary-opacity: ' . $iconSettings['duotone']['opacity']['secondary'] . ';';
}
if (!empty($iconSettings['duotone']['color']['primary'])) {
$cssStyles[] = '--fa-primary-color: ' . $iconSettings['duotone']['color']['primary'] . ';';
}
if (!empty($iconSettings['duotone']['color']['secondary'])) {
$cssStyles[] = '--fa-secondary-color: ' . $iconSettings['duotone']['color']['secondary'] . ';';
}
unset($iconSettings['duotone']);
}
// Add additional CSS styles if needed.
if (isset($iconSettings['additional_classes'])) {
$cssStyles[] = $iconSettings['additional_classes'];
}
$icons[] = [
'#theme' => 'fontawesomeicon',
'#tag' => $configurationSettings
->get('tag'),
'#name' => 'fa-' . $item
->get('icon_name')
->getValue(),
'#style' => $item
->get('style')
->getValue(),
'#settings' => implode(' ', array_filter($iconSettings)),
'#transforms' => implode(' ', $iconTransforms),
'#mask' => $iconMask,
'#css' => implode(' ', $cssStyles),
];
}
// Get the icon settings.
$settings = $this
->getSettings();
return [
[
'#theme' => 'fontawesomeicons',
'#icons' => $icons,
'#layers' => $settings['layers'],
],
];
}
}
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 | |
FontAwesomeIconFormatter:: |
protected | property | Drupal configuration service container. | |
FontAwesomeIconFormatter:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
|
FontAwesomeIconFormatter:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsBase:: |
|
FontAwesomeIconFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides FormatterBase:: |
|
FontAwesomeIconFormatter:: |
public | function |
Returns a short summary for the current formatter settings. Overrides FormatterBase:: |
|
FontAwesomeIconFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides FormatterInterface:: |
|
FontAwesomeIconFormatter:: |
public | function |
Constructs a FormatterBase object. Overrides FormatterBase:: |
|
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 |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
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 |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
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. |