class InstagramEmbedFormatter in Media entity Instagram 3.x

Same name and namespace in other branches

8.2 src/Plugin/Field/FieldFormatter/InstagramEmbedFormatter.php \Drupal\media_entity_instagram\Plugin\Field\FieldFormatter\InstagramEmbedFormatter
8 src/Plugin/Field/FieldFormatter/InstagramEmbedFormatter.php \Drupal\media_entity_instagram\Plugin\Field\FieldFormatter\InstagramEmbedFormatter

Plugin implementation of the 'instagram_embed' formatter.

Plugin annotation


@FieldFormatter(
  id = "instagram_embed",
  label = @Translation("Instagram embed"),
  field_types = {
    "link", "string", "string_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\media\Plugin\Field\FieldFormatter\OEmbedFormatter
    class \Drupal\media_entity_instagram\Plugin\Field\FieldFormatter\InstagramEmbedFormatter

Expanded class hierarchy of InstagramEmbedFormatter

File

src/Plugin/Field/FieldFormatter/InstagramEmbedFormatter.php, line 28

Namespace

Drupal\media_entity_instagram\Plugin\Field\FieldFormatter

View source

class InstagramEmbedFormatter extends OEmbedFormatter {

  /**
   * {@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('messenger'), $container
      ->get('media.oembed.resource_fetcher'), $container
      ->get('media_entity_instagram.oembed.url_resolver'), $container
      ->get('logger.factory'), $container
      ->get('config.factory'), $container
      ->get('media.oembed.iframe_url_helper'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $settings = parent::defaultSettings();
    $settings['hidecaption'] = FALSE;
    unset($settings['max_height']);
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = [];
    $max_width = $this
      ->getSetting('max_width');
    foreach ($items as $delta => $item) {
      $main_property = $item
        ->getFieldDefinition()
        ->getFieldStorageDefinition()
        ->getMainPropertyName();
      $value = $item->{$main_property};
      if (empty($value)) {
        continue;
      }
      try {
        $resource_url = $this->urlResolver
          ->getResourceUrl($value, $max_width, NULL, $this
          ->getSettings());
        $resource = $this->resourceFetcher
          ->fetchResource($resource_url);
      } catch (ResourceException $exception) {
        $this->logger
          ->error("Could not retrieve the remote URL (@url).", [
          '@url' => $value,
        ]);
        continue;
      }
      switch ($resource
        ->getType()) {
        case Resource::TYPE_LINK:
        case Resource::TYPE_PHOTO:
          return parent::viewElements($items, $langcode);
        default:
          $element[$delta] = [
            '#theme' => 'media_oembed_iframe',
            '#resource' => $resource,
            '#media' => IFrameMarkup::create($resource
              ->getHtml()),
            '#attached' => [
              'library' => [
                'media_entity_instagram/integration',
              ],
            ],
          ];
          CacheableMetadata::createFromObject($resource)
            ->addCacheTags($this->config
            ->getCacheTags())
            ->applyTo($element[$delta]);
      }
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $elements['hidecaption'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide caption'),
      '#default_value' => $this
        ->getSetting('hidecaption'),
      '#description' => $this
        ->t('Hide caption of Instagram posts.'),
    ];
    unset($elements['max_height']);
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $summary[] = $this
      ->t('Caption: @hidecaption', [
      '@hidecaption' => $this
        ->getSetting('hidecaption') ? $this
        ->t('Hidden') : $this
        ->t('Visible'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    if (parent::isApplicable($field_definition)) {
      $media_type = $field_definition
        ->getTargetBundle();
      if ($media_type) {
        $media_type = MediaType::load($media_type);
        return $media_type && $media_type
          ->getSource() instanceof Instagram;
      }
    }
    return FALSE;
  }

}

Members

Name	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::getFieldSetting	protected	function	Returns the value of a field setting.
FormatterBase::getFieldSettings	protected	function	Returns the array of field settings.
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
InstagramEmbedFormatter::create	public static	function	Creates an instance of the plugin. Overrides OEmbedFormatter::create
InstagramEmbedFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides OEmbedFormatter::defaultSettings
InstagramEmbedFormatter::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides OEmbedFormatter::isApplicable
InstagramEmbedFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides OEmbedFormatter::settingsForm
InstagramEmbedFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides OEmbedFormatter::settingsSummary
InstagramEmbedFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides OEmbedFormatter::viewElements
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
OEmbedFormatter::$config	protected	property	The media settings config.
OEmbedFormatter::$iFrameUrlHelper	protected	property	The iFrame URL helper service.
OEmbedFormatter::$logger	protected	property	The logger service.
OEmbedFormatter::$messenger	protected	property	The messenger service. Overrides MessengerTrait::$messenger
OEmbedFormatter::$resourceFetcher	protected	property	The oEmbed resource fetcher.
OEmbedFormatter::$urlResolver	protected	property	The oEmbed URL resolver service.
OEmbedFormatter::__construct	public	function	Constructs an OEmbedFormatter instance. Overrides FormatterBase::__construct
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.

You are here

class InstagramEmbedFormatter in Media entity Instagram 3.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation