You are here

Home » API reference » Accelerated Mobile Pages (AMP) 8.3 » AmpSocialPostFormatter.php

class AmpSocialPostFormatter in Accelerated Mobile Pages (AMP) 8.3

Plugin implementation of the 'amp_social_post' formatter.

Plugin annotation


@FieldFormatter(
  id = "amp_social_post_formatter",
  label = @Translation("AMP SocialPost"),
  description = @Translation("Display an amp-social_post post."),
  field_types = {
    "link",
    "string",
    "string_long"
  }
)

Hierarchy

Expanded class hierarchy of AmpSocialPostFormatter

File

src/Plugin/Field/FieldFormatter/AmpSocialPostFormatter.php, line 25

Namespace

Drupal\amp\Plugin\Field\FieldFormatter
View source 
class AmpSocialPostFormatter extends FormatterBase {
  use AmpFormTrait;

  /**
   * AMP layouts.
   *
   * Expected by AmpFormTrait.
   *
   * @return array
   *   Array of layout options allowed by this component.
   */
  private function getLayouts() {
    $options = $this
      ->allLayouts();
    unset($options['intrinsic']);
    unset($options['container']);
    return $options;
  }

  /**
   * AMP libraries.
   *
   * Expected by AmpFormTrait.
   *
   * @return array
   *   The names of the AMP libraries used by this formatter.
   */
  private function getLibraries() {
    return AmpSocialPost::getLibraries();
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'layout' => 'responsive',
      'width' => '',
      'height' => '',
      'provider' => [],
      'data-embed-as' => 'post',
      'data-align-center' => '',
      'placeholder' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $provider_selector = str_replace('[layout]', '[provider]', $this
      ->layoutSelector());
    $form['provider'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Provider'),
      '#options' => AmpSocialPost::getProviders(),
      '#default_value' => $this
        ->getSetting('provider'),
      '#description' => $this
        ->t('Select the allowed social providers for the post url in this field. Posts from other providers will not display.'),
      '#multiple' => TRUE,
    ];
    $form['data-embed-as'] = [
      '#type' => 'select',
      '#options' => [
        'post' => $this
          ->t('Post'),
        'video' => $this
          ->t('Video'),
      ],
      '#title' => $this
        ->t('Facebook: Embed as'),
      '#default_value' => $this
        ->getSetting('data-embed-as'),
      '#states' => [
        'visible' => [
          [
            $provider_selector => [
              'value' => 'facebook',
            ],
          ],
        ],
      ],
    ];
    $form['data-align-center'] = [
      '#type' => 'select',
      '#options' => [
        '' => $this
          ->t('False'),
        'true' => $this
          ->t('True'),
      ],
      '#title' => $this
        ->t('Facebook: Center'),
      '#default_value' => $this
        ->getSetting('data-align-center'),
      '#states' => [
        'visible' => [
          [
            $provider_selector => [
              'value' => 'facebook',
            ],
          ],
        ],
      ],
    ];
    $form['placeholder'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Twitter: Placeholder'),
      '#default_value' => $this
        ->getSetting('placeholder'),
      '#description' => $this
        ->t('Placeholder text to appear until the Tweet is retrieved.'),
      '#states' => [
        'visible' => [
          [
            $provider_selector => [
              'value' => 'facebook',
            ],
          ],
        ],
      ],
    ];
    $form['layout'] = $this
      ->layoutElement();
    $form['width'] = $this
      ->widthElement();
    $form['height'] = $this
      ->heightElement();
    $form['#prefix'] = '<div class="description">' . $this
      ->libraryDescription() . '</div>';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $summary[] = $this
      ->t('Provider: :provider', [
      ':provider' => implode(', ', $this
        ->getSetting('provider')),
    ]);
    $settings = [
      'data-align-center' => $this
        ->t('Facebook centered'),
      'data-embed-as' => $this
        ->t('Facebook embed as'),
    ];
    foreach ($settings as $setting => $label) {
      $value = $this
        ->getSetting($setting);
      if (isset($value)) {
        $summary[] = $label . $this
          ->t(': :value', [
          ':value' => $value,
        ]);
      }
    }
    $summary[] = $this
      ->t('Twitter placeholder: :placeholder', [
      ':placeholder' => !empty($this
        ->getSetting('placeholder')) ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    $summary = $this
      ->addToSummary($summary);
    return [
      implode('; ', $summary),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $layout = $this
      ->getSetting('layout');
    $width = $this
      ->validWidth($this
      ->getSetting('width'), $this
      ->getSetting('layout'));
    $height = $this
      ->validHeight($this
      ->getSetting('height'), $this
      ->getSetting('layout'));
    $data_embed_as = $this
      ->getSetting('data-embed-as');
    $data_align_center = $this
      ->getSetting('data-align-center');
    $placeholder = $this
      ->getSetting('placeholder');
    foreach ($items as $delta => $item) {
      $elements[$delta]['#type'] = 'amp_social_post';
      $elements[$delta]['#url'] = !empty($item->value) ? $item->value : $item->uri;
      $elements[$delta]['#placeholder'] = $placeholder;
      $elements[$delta]['#attributes']['layout'] = $layout;
      $elements[$delta]['#attributes']['data-embed-as'] = $data_embed_as;
      $elements[$delta]['#attributes']['data-align-center'] = $data_align_center;
      $elements[$delta]['#attributes']['height'] = $height;
      $elements[$delta]['#attributes']['width'] = $width;
    }
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AmpFormTrait::addToSummary public function Update the summary.
AmpFormTrait::allLayouts public function AMP Layouts.
AmpFormTrait::allSettings public function All settings.
AmpFormTrait::autoplayElement public function The autoplay form element.
AmpFormTrait::controlsElement public function The controls form element.
AmpFormTrait::heightElement public function The height form element.
AmpFormTrait::heightError public function See if selected height is invalid based on the selected layout.
AmpFormTrait::layoutElement public function The layout form element.
AmpFormTrait::layoutSelector public function The #states layout selector.
AmpFormTrait::libraryDescription public function LibraryDescription.
AmpFormTrait::loopElement public function The loop form element.
AmpFormTrait::validAutoplay public function The autoplay setting, taking into account user permissions.
AmpFormTrait::validHeight public function Limit the height based on the layout.
AmpFormTrait::validWidth public function Limit the width based on the layout.
AmpFormTrait::widthElement public function The width form element.
AmpFormTrait::widthError public function See if selected width is invalid based on the selected layout.
AmpSocialPostFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
AmpSocialPostFormatter::getLayouts private function AMP layouts.
AmpSocialPostFormatter::getLibraries private function AMP libraries.
AmpSocialPostFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
AmpSocialPostFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
AmpSocialPostFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
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
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
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.