You are here

Home » API reference » Media entity Pinterest 8 » PinterestEmbedFormatter.php

class PinterestEmbedFormatter in Media entity Pinterest 8

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

Plugin implementation of the 'pinterest_embed' formatter.

Plugin annotation


@FieldFormatter(
  id = "pinterest_embed",
  label = @Translation("Pinterest embed"),
  field_types = {
    "link", "string", "string_long"
  }
)

Hierarchy

Expanded class hierarchy of PinterestEmbedFormatter

File

src/Plugin/Field/FieldFormatter/PinterestEmbedFormatter.php, line 21

Namespace

Drupal\media_entity_pinterest\Plugin\Field\FieldFormatter
View source 
class PinterestEmbedFormatter extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = [];
    foreach ($items as $delta => $item) {
      $matches = [];
      foreach (Pinterest::$validationRegexp as $pattern => $key) {

        // URLs will sometimes have urlencoding, so we decode for matching.
        if (preg_match($pattern, urldecode($this
          ->getEmbedCode($item)), $item_matches)) {
          $matches[] = $item_matches;
        }
      }
      if (!empty($matches)) {
        $matches = reset($matches);
      }

      // PIN_URL_RE matched.
      if (!empty($matches['id']) && isset($matches[2]) && isset($matches[3]) && isset($matches[4])) {
        $element[$delta] = [
          '#theme' => 'media_entity_pinterest_pin',
          '#path' => 'https://' . $matches[2] . 'pinterest.' . $matches[3] . $matches[4] . '/pin/' . $matches['id'],
          '#attributes' => [
            'class' => [],
            'data-conversation' => 'none',
            'lang' => $langcode,
          ],
        ];
      }

      // BOARD_SECTION_URL_RE matched.
      if (!empty($matches['username']) && !empty($matches['slug']) && !empty($matches['section']) && isset($matches[2]) && isset($matches[3]) && isset($matches[4])) {
        $element[$delta] = [
          '#theme' => 'media_entity_pinterest_board_section',
          '#path' => 'https://' . $matches[2] . 'pinterest.' . $matches[3] . $matches[4] . '/' . $matches['username'] . '/' . $matches['slug'] . '/' . $matches['section'],
          '#attributes' => [
            'class' => [],
            'data-conversation' => 'none',
            'lang' => $langcode,
          ],
        ];
      }

      // BOARD_URL_RE matched.
      if (!empty($matches['username']) && !empty($matches['slug']) && empty($matches['section']) && isset($matches[2]) && isset($matches[3]) && isset($matches[4])) {
        $element[$delta] = [
          '#theme' => 'media_entity_pinterest_board',
          '#path' => 'https://' . $matches[2] . 'pinterest.' . $matches[3] . $matches[4] . '/' . $matches['username'] . '/' . $matches['slug'],
          '#attributes' => [
            'class' => [],
            'data-conversation' => 'none',
            'lang' => $langcode,
          ],
        ];
      }

      // USER_URL_RE matched.
      if (!empty($matches['username']) && empty($matches['slug']) && empty($matches['section']) && isset($matches[2]) && isset($matches[3]) && isset($matches[4])) {
        $element[$delta] = [
          '#theme' => 'media_entity_pinterest_profile',
          '#path' => 'https://' . $matches[2] . 'pinterest.' . $matches[3] . $matches[4] . '/' . $matches['username'],
          '#attributes' => [
            'class' => [],
            'data-conversation' => 'none',
            'lang' => $langcode,
          ],
        ];
      }
    }
    if (!empty($element)) {
      $element['#attached'] = [
        'library' => [
          'media_entity_pinterest/integration',
        ],
      ];
    }
    return $element;
  }

  /**
   * Extracts the embed code from a field item.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   The field item.
   *
   * @return string|null
   *   The embed code, or NULL if the field type is not supported.
   */
  protected function getEmbedCode(FieldItemInterface $item) {
    switch ($item
      ->getFieldDefinition()
      ->getType()) {
      case 'link':
        return $item->uri;
      case 'string':
      case 'string_long':
        return $item->value;
      default:
        break;
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterInterface::settingsForm 24
FormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterInterface::settingsSummary 22
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.
PinterestEmbedFormatter::getEmbedCode protected function Extracts the embed code from a field item.
PinterestEmbedFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
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::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
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.