You are here

Home » API reference » Media entity Pinterest 8.2 » Pinterest.php

class Pinterest in Media entity Pinterest 8.2

Provides media type plugin for Pinterest.

Plugin annotation


@MediaSource(
  id = "pinterest",
  label = @Translation("Pinterest"),
  description = @Translation("Provides business logic and metadata for Pinterest."),
  default_thumbnail_filename = "pinterest.png",
  allowed_field_types = {
    "link", "string", "string_long"
  }
)

Hierarchy

Expanded class hierarchy of Pinterest

2 files declare their use of Pinterest
PinEmbedCodeConstraintValidator.php in src/Plugin/Validation/Constraint/PinEmbedCodeConstraintValidator.php
PinterestEmbedFormatter.php in src/Plugin/Field/FieldFormatter/PinterestEmbedFormatter.php

File

src/Plugin/media/Source/Pinterest.php, line 22

Namespace

Drupal\media_entity_pinterest\Plugin\media\Source
View source 
class Pinterest extends MediaSourceBase implements MediaSourceFieldConstraintsInterface {

  /**
   * List of validation regular expressions.
   *
   * @var array
   *
   * possible hostnames:
   *   www.pinterest.com,
   *   pinterest.com,
   *   jp.pinterest.com,
   *   pinterest.jp,
   *   pinterest.co.uk
   */
  public static $validationRegexp = [
    // Match PIN_URL_RE.
    '@^\\s*(https?://)?(\\w+\\.)?pinterest\\.([a-zA-Z]+\\.)?([a-zA-Z]+)/pin/(?P<id>\\d+)/?\\s*$$@i' => 'id',
    // Match BOARD_URL_RE.
    '@^\\s*(https?://)?(\\w+\\.)?pinterest\\.([a-zA-Z]+\\.)?([a-zA-Z]+)/(?P<username>\\w+)/(?P<slug>[\\w\\-_\\~%]+)/?\\s*$@iu' => 'board',
    // Match BOARD_SECTION_URL_RE.
    '@^\\s*(https?://)?(\\w+\\.)?pinterest\\.([a-zA-Z]+\\.)?([a-zA-Z]+)/(?P<username>\\w+)/(?P<slug>[\\w\\-_\\~%]+)/(?P<section>[\\w\\-_\\~%]+)/?\\s*$@iu' => 'section',
    // Match USER_URL_RE.
    '@^\\s*(https?://)?(\\w+\\.)?pinterest\\.([a-zA-Z]+\\.)?([a-zA-Z]+)/(?P<username>\\w+)/?\\s*$@iu' => 'user',
  ];

  /**
   * {@inheritdoc}
   */
  public function getMetadataAttributes() {
    $fields = [
      'id' => $this
        ->t('Pin ID'),
      'board' => $this
        ->t('Board name'),
      'section' => $this
        ->t('Section name'),
      'user' => $this
        ->t('Pinterest user'),
    ];
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public function getMetadata(MediaInterface $media, $name) {
    $matches = $this
      ->matchRegexp($media);
    if (empty($matches)) {
      return NULL;
    }

    // First we return the fields that are available from regex.
    switch ($name) {
      case 'thumbnail_uri':
        if ($local_image = $this
          ->getMetadata($media, 'thumbnail_local')) {
          return $local_image;
        }
        return parent::getMetadata($media, 'thumbnail_uri');
      case 'default_name':
        $id = $this
          ->getMetadata($media, 'id');
        $board = $this
          ->getMetadata($media, 'board');
        $section = $this
          ->getMetadata($media, 'section');
        $user = $this
          ->getMetadata($media, 'user');

        // The default name will be the Pin ID for Pins.
        if (!empty($id)) {
          return $id;
        }

        // The default name will be the username, board slug, and section
        // for Sections.
        if (!empty($user) && !empty($board) && !empty($section)) {
          return $user . ' - ' . $board . ' - ' . $section;
        }

        // The default name will be the username and board slug for Boards.
        if (!empty($user) && !empty($board)) {
          return $user . ' - ' . $board;
        }

        // The default name will be the username for Profiles.
        if (!empty($user) && empty($board)) {
          return $user;
        }
        return parent::getMetadata($media, 'default_name');
      case 'id':
        if (!empty($matches['id'])) {
          return $matches['id'];
        }
        return NULL;
      case 'section':
        if (!empty($matches['section'])) {
          return $matches['section'];
        }
        return NULL;
      case 'board':
        if (!empty($matches['slug'])) {
          return $matches['slug'];
        }
        return NULL;
      case 'user':
        if (!empty($matches['username'])) {
          return $matches['username'];
        }
        return NULL;
      default:
        return parent::getMetadata($media, $name);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getSourceFieldConstraints() {
    return [
      'PinEmbedCode' => [],
    ];
  }

  /**
   * Runs preg_match on embed code/URL.
   *
   * @param \Drupal\media\MediaInterface $media
   *   Media object.
   *
   * @return array|bool
   *   Array of preg matches or FALSE if no match.
   *
   * @see preg_match()
   */
  protected function matchRegexp(MediaInterface $media) {
    $matches = [];
    $source_field = $this
      ->getSourceFieldDefinition($media->bundle->entity)
      ->getName();
    if ($media
      ->hasField($source_field)) {
      $property_name = $media->{$source_field}
        ->first()
        ->mainPropertyName();
      foreach (static::$validationRegexp as $pattern => $key) {

        // URLs will sometimes have urlencoding, so we decode for matching.
        if (preg_match($pattern, urldecode($media->{$source_field}->{$property_name}), $matches)) {
          return $matches;
        }
      }
    }
    return FALSE;
  }

}

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
MediaSourceBase::$configFactory protected property The config factory service.
MediaSourceBase::$entityFieldManager protected property The entity field manager service.
MediaSourceBase::$entityTypeManager protected property The entity type manager service.
MediaSourceBase::$fieldTypeManager protected property The field type plugin manager service.
MediaSourceBase::$label protected property Plugin label.
MediaSourceBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 2
MediaSourceBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
MediaSourceBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 2
MediaSourceBase::createSourceField public function Creates the source field definition for a type. Overrides MediaSourceInterface::createSourceField 2
MediaSourceBase::createSourceFieldStorage protected function Creates the source field storage definition.
MediaSourceBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 2
MediaSourceBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
MediaSourceBase::getSourceFieldDefinition public function Get the source field definition for a media type. Overrides MediaSourceInterface::getSourceFieldDefinition
MediaSourceBase::getSourceFieldName protected function Determine the name of the source field. 2
MediaSourceBase::getSourceFieldOptions protected function Get the source field options for the media type form.
MediaSourceBase::getSourceFieldStorage protected function Returns the source field storage definition.
MediaSourceBase::getSourceFieldValue public function Get the primary value stored in the source field. Overrides MediaSourceInterface::getSourceFieldValue
MediaSourceBase::prepareFormDisplay public function Prepares the media type fields for this source in the form display. Overrides MediaSourceInterface::prepareFormDisplay 3
MediaSourceBase::prepareViewDisplay public function Prepares the media type fields for this source in the view display. Overrides MediaSourceInterface::prepareViewDisplay 6
MediaSourceBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
MediaSourceBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 1
MediaSourceBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 1
MediaSourceBase::__construct public function Constructs a new class instance. Overrides PluginBase::__construct 2
MediaSourceInterface::METADATA_FIELD_EMPTY constant Default empty value for metadata fields.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
Pinterest::$validationRegexp public static property List of validation regular expressions.
Pinterest::getMetadata public function Gets the value for a metadata attribute for a given media item. Overrides MediaSourceBase::getMetadata
Pinterest::getMetadataAttributes public function Gets a list of metadata attributes provided by this plugin. Overrides MediaSourceInterface::getMetadataAttributes
Pinterest::getSourceFieldConstraints public function Gets media source-specific validation constraints for a source field. Overrides MediaSourceFieldConstraintsInterface::getSourceFieldConstraints
Pinterest::matchRegexp protected function Runs preg_match on embed code/URL.
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.
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.