You are here

Home » API reference » Facebook Instant Articles 3.x » InteractiveFormatter.php

class InteractiveFormatter in Facebook Instant Articles 3.x

Same name and namespace in other branches
  1. 8.2 src/Plugin/Field/FieldFormatter/InteractiveFormatter.php \Drupal\fb_instant_articles\Plugin\Field\FieldFormatter\InteractiveFormatter

Plugin implementation of the 'fbia_interactive' formatter.

Plugin annotation


@FieldFormatter(
  id = "fbia_interactive",
  label = @Translation("FBIA Interactive"),
  field_types = {
    "string",
    "string_long"
  }
)

Hierarchy

Expanded class hierarchy of InteractiveFormatter

File

src/Plugin/Field/FieldFormatter/InteractiveFormatter.php, line 24

Namespace

Drupal\fb_instant_articles\Plugin\Field\FieldFormatter
View source 
class InteractiveFormatter extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'source_type' => self::SOURCE_TYPE_URL,
      'width' => NULL,
      'height' => NULL,
      'margin' => Interactive::NO_MARGIN,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['source_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Source type'),
      '#description' => $this
        ->t('Add your tracker specifying the URL or embed the full unescaped HTML'),
      '#default_value' => $this
        ->getSetting('source_type'),
      '#options' => [
        self::SOURCE_TYPE_URL => $this
          ->t('URL'),
        self::SOURCE_TYPE_HTML => $this
          ->t('Embedded HTML'),
      ],
    ];
    $element['width'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Width'),
      '#description' => $this
        ->t('The width of your interactive graphic.'),
      '#default_value' => $this
        ->getSetting('width'),
    ];
    $element['height'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Height'),
      '#description' => $this
        ->t('The height of your interactive graphic.'),
      '#default_value' => $this
        ->getSetting('height'),
    ];
    $element['margin'] = [
      '#type' => 'select',
      '#title' => t('Margin'),
      '#description' => t('The margin setting of your intereactive graphic.'),
      '#default_value' => $this
        ->getSetting('margin'),
      '#options' => [
        Interactive::NO_MARGIN => $this
          ->t('No margin'),
        Interactive::COLUMN_WIDTH => t('Column width'),
      ],
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    if ($source_type = $this
      ->getSetting('source_type')) {
      $summary[] = $source_type === self::SOURCE_TYPE_URL ? $this
        ->t('URL') : $this
        ->t('Embedded HTML');
    }
    if ($width = $this
      ->getSetting('width')) {
      $summary[] = $this
        ->t('Width: @width', [
        '@width' => $width,
      ]);
    }
    if ($height = $this
      ->getSetting('height')) {
      $summary[] = $this
        ->t('Height: @height', [
        '@height' => $height,
      ]);
    }
    $margin = $this
      ->getSetting('margin');
    $summary[] = $this
      ->t('Margin setting: @margin', [
      '@margin' => $margin === Interactive::NO_MARGIN ? $this
        ->t('No margin') : $this
        ->t('Column width'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewInstantArticle(FieldItemListInterface $items, InstantArticle $article, $region, NormalizerInterface $normalizer, $langcode = NULL) {
    foreach ($items as $delta => $item) {

      // Create the interactive object per the field settings.
      $interactive = Interactive::create();
      if ($width = $this
        ->getSetting('width')) {
        $interactive
          ->withWidth((int) $width);
      }
      if ($height = $this
        ->getSetting('height')) {
        $interactive
          ->withHeight((int) $height);
      }
      if ($this
        ->getSetting('source_type') === self::SOURCE_TYPE_HTML) {
        $interactive
          ->withHTML($this
          ->getItemValue($item));
      }
      else {
        $interactive
          ->withSource($this
          ->getItemValue($item));
      }

      // Interactive elements can only be added to the content of the article,
      // ignore $region setting and add to the Body.
      $article
        ->addChild($interactive);
    }
  }

  /**
   * Return the value for the interactive embed that we are interested in.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   Field item.
   *
   * @return mixed
   *   The value of the given field item that stores the Ad value we're
   *   interested in.
   */
  protected function getItemValue(FieldItemInterface $item) {
    return $item->value;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
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 12
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::SOURCE_TYPE_HTML constant
FormatterBase::SOURCE_TYPE_URL constant
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
FormatterBase::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 12
InteractiveFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings 1
InteractiveFormatter::getItemValue protected function Return the value for the interactive embed that we are interested in. 1
InteractiveFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm 1
InteractiveFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary 1
InteractiveFormatter::viewInstantArticle public function Modifies the given instant article with the contents of this field. Overrides InstantArticleFormatterInterface::viewInstantArticle
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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. 4
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.