class SubtitleFormatter in Facebook Instant Articles 3.x
Same name and namespace in other branches
- 8.2 src/Plugin/Field/FieldFormatter/SubtitleFormatter.php \Drupal\fb_instant_articles\Plugin\Field\FieldFormatter\SubtitleFormatter
Plugin implementation of the 'fbia_subtitle' formatter.
Plugin annotation
@FieldFormatter(
id = "fbia_subtitle",
label = @Translation("FBIA Subtitle"),
field_types = {
"string",
"string_long",
"text",
"text_long",
"text_with_summary",
}
)
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\fb_instant_articles\Plugin\Field\FieldFormatter\FormatterBase implements InstantArticleFormatterInterface
- class \Drupal\fb_instant_articles\Plugin\Field\FieldFormatter\SubtitleFormatter implements ContainerFactoryPluginInterface
- class \Drupal\fb_instant_articles\Plugin\Field\FieldFormatter\FormatterBase implements InstantArticleFormatterInterface
- 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 SubtitleFormatter
File
- src/
Plugin/ Field/ FieldFormatter/ SubtitleFormatter.php, line 37
Namespace
Drupal\fb_instant_articles\Plugin\Field\FieldFormatterView source
class SubtitleFormatter extends FormatterBase implements ContainerFactoryPluginInterface {
/**
* Renderer service.
*
* @var \Drupal\Core\Render\RendererInterface
*/
protected $renderer;
/**
* Transformer factory.
*
* @var \Drupal\fb_instant_articles\Transformer
*/
protected $transformerFactory;
/**
* Create a new instance of TransformerFormatter.
*
* @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\Render\RendererInterface $renderer
* The renderer service.
* @param \Drupal\fb_instant_articles\TransformerFactory $transformer_factory
* Facebook transformer factory.
*/
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, RendererInterface $renderer, TransformerFactory $transformer_factory) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
$this->renderer = $renderer;
$this->transformerFactory = $transformer_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('renderer'), $container
->get('fb_instant_articles.transformer_factory'));
}
/**
* {@inheritdoc}
*/
public function viewInstantArticle(FieldItemListInterface $items, InstantArticle $article, $region, NormalizerInterface $normalizer, $langcode = NULL) {
// Subtitles only go in the header. Create one if it doesn't exist yet and
// ignore the given $region.
$header = $article
->getHeader();
if (!$header) {
$header = Header::create();
$article
->withHeader($header);
}
// Note that there can only be one subtitle. We use the first value as the
// subtitle.
if (!$items
->isEmpty()) {
$item = $items
->get(0);
// For formatted text, pass the text through the filters and then through
// the FBIA transformer, before adding it to the article.
// in the subtitle.
if (in_array($items
->getFieldDefinition()
->getType(), [
'text',
'text_long',
'text_with_summary',
])) {
$subtitle_render_array = [
'#type' => 'processed_text',
'#text' => $item->value,
'#format' => $item->format,
'#langcode' => $item
->getLangcode(),
];
$subtitle_string = (string) $this->renderer
->renderPlain($subtitle_render_array);
// Here we create a Facebook H2 element, passing it as context to the
// transformer. It will therefore append any allowed elements, per the
// rules defined in the constructor (only a, i, b, em and strong tags),
// to the header. What that means is that tags will be stripped from the
// input string except a, i, b, em and strong.
$subtitle = H2::create();
$transformer = $this
->getTransformer();
$transformer
->transformString($subtitle, $subtitle_string);
$this->transformerFactory
->flushTransformerLogs($transformer);
}
else {
$subtitle = $item
->getString();
}
$header
->withSubTitle($subtitle);
}
}
/**
* Get a transformer with a custom rule set specifically for subtitles.
*
* @return \Facebook\InstantArticles\Transformer\Transformer
* Transformer with our ruleset for subtitles.
*
* @throws \ReflectionException
*/
protected function getTransformer() : Transformer {
$transformer = $this->transformerFactory
->getTransformer();
$transformer
->setRules([
TextNodeRule::createFrom([]),
PassThroughRule::createFrom([
'selector' => '//html|//body|//p|//div|//blockquote|//h1|//h2|//h3|//h4',
]),
ItalicRule::createFrom([
'selector' => 'i',
]),
ItalicRule::createFrom([
'selector' => 'em',
]),
BoldRule::createFrom([
'selector' => 'b',
]),
BoldRule::createFrom([
'selector' => 'strong',
]),
AnchorRule::createFrom([
'selector' => 'a',
'properties' => [
AnchorRule::PROPERTY_ANCHOR_HREF => [
'type' => 'string',
'selector' => 'a',
'attribute' => 'href',
],
AnchorRule::PROPERTY_ANCHOR_REL => [
'type' => 'string',
'selector' => 'a',
'attribute' => 'rel',
],
],
]),
]);
return $transformer;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
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 |
Returns a form to configure settings for the formatter. Overrides FormatterInterface:: |
24 |
FormatterBase:: |
public | function |
Returns a short summary for the current formatter settings. Overrides FormatterInterface:: |
22 |
FormatterBase:: |
constant | |||
FormatterBase:: |
constant | |||
FormatterBase:: |
public | function |
Builds a renderable array for a fully themed field. Overrides FormatterInterface:: |
1 |
FormatterBase:: |
public | function |
Builds a renderable array for a field value. Overrides FormatterInterface:: |
|
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
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:: |
2 |
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 static | function |
Defines the default settings for this plugin. Overrides PluginSettingsInterface:: |
42 |
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. | 4 |
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. | |
SubtitleFormatter:: |
protected | property | Renderer service. | |
SubtitleFormatter:: |
protected | property | Transformer factory. | |
SubtitleFormatter:: |
public static | function |
Creates an instance of the plugin. Overrides FormatterBase:: |
|
SubtitleFormatter:: |
protected | function | Get a transformer with a custom rule set specifically for subtitles. | |
SubtitleFormatter:: |
public | function |
Modifies the given instant article with the contents of this field. Overrides InstantArticleFormatterInterface:: |
|
SubtitleFormatter:: |
public | function |
Create a new instance of TransformerFormatter. Overrides FormatterBase:: |