class Instagram in Media entity Instagram 3.x

Same name and namespace in other branches

8.2 src/Plugin/media/Source/Instagram.php \Drupal\media_entity_instagram\Plugin\media\Source\Instagram

Implementation of an oEmbed Instagram source.

Plugin annotation


@MediaSource(
  id = "oembed:instagram",
  label = @Translation("Instagram"),
  description = @Translation("Use Facebooks graph API for reusable instagrams."),
  allowed_field_types = {"string", "link"},
  default_thumbnail_filename = "instagram.png",
  providers = {"Instagram"},
  forms = {"media_library_add" = "\Drupal\media_entity_instagram\Form\InstagramMediaLibraryAddForm"}
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\media\MediaSourceBase implements ContainerFactoryPluginInterface, MediaSourceInterface
    class \Drupal\media\Plugin\media\Source\OEmbed implements OEmbedInterface
    class \Drupal\media_entity_instagram\Plugin\media\Source\Instagram

Expanded class hierarchy of Instagram

1 file declares its use of Instagram

InstagramEmbedFormatter.php in src/Plugin/Field/FieldFormatter/InstagramEmbedFormatter.php

1 string reference to 'Instagram'

media_entity_instagram_oembed_resource_url_alter in ./media_entity_instagram.module: Implements hook_oembed_resource_url_alter().

File

src/Plugin/media/Source/Instagram.php, line 23

Namespace

Drupal\media_entity_instagram\Plugin\media\Source

View source

class Instagram extends OEmbed {

  /**
   * List of validation regular expressions.
   *
   * @var array
   */
  public static $validationRegexp = [
    '@((http|https):){0,1}//(www\\.){0,1}instagram\\.com/p/(?<shortcode>[a-z0-9_-]+)@i' => 'shortcode',
    '@((http|https):){0,1}//(www\\.){0,1}instagr\\.am/p/(?<shortcode>[a-z0-9_-]+)@i' => 'shortcode',
    '@((http|https):){0,1}//(www\\.){0,1}instagram\\.com/tv/(?<shortcode>[a-z0-9_-]+)@i' => 'shortcode',
    '@((http|https):){0,1}//(www\\.){0,1}instagr\\.am/tv/(?<shortcode>[a-z0-9_-]+)@i' => 'shortcode',
  ];

  /**
   * {@inheritdoc}
   */
  public function getMetadataAttributes() {
    return [
      'shortcode' => $this
        ->t('Instagram shortcode'),
      'type' => $this
        ->t('Resource type'),
      'author_name' => $this
        ->t('The name of the author/owner'),
      'default_name' => $this
        ->t('Default name of the media item'),
      'provider_name' => $this
        ->t("The name of the provider"),
      'provider_url' => $this
        ->t('The URL of the provider'),
      'thumbnail_uri' => $this
        ->t('Local URI of the thumbnail'),
      'thumbnail_width' => $this
        ->t('Thumbnail width'),
      'thumbnail_height' => $this
        ->t('Thumbnail height'),
      'width' => $this
        ->t('The width of the resource'),
      'html' => $this
        ->t('The HTML representation of the resource'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getMetadata(MediaInterface $media, $name) {
    switch ($name) {
      case 'default_name':

        // Try to get some fields that need the API, if not available, just use
        // the shortcode as default name.
        $username = $this
          ->getMetadata($media, 'author_name');
        $shortcode = $this
          ->getMetadata($media, 'shortcode');
        if ($username && $shortcode) {
          return $username . ' - ' . $shortcode;
        }
        else {
          if (!empty($shortcode)) {
            return $shortcode;
          }
        }

        // Fallback to the parent's default name if everything else failed.
        return parent::getMetadata($media, 'default_name');
      case 'shortcode':
        $matches = $this
          ->matchRegexp($media);
        if (is_array($matches) && !empty($matches['shortcode'])) {
          return $matches['shortcode'];
        }
        return FALSE;
    }
    return parent::getMetadata($media, $name);
  }

  /**
   * 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 = [];
    if (isset($this->configuration['source_field'])) {
      $source_field = $this->configuration['source_field'];
      if ($media
        ->hasField($source_field)) {
        $property_name = $media->{$source_field}
          ->first()
          ->mainPropertyName();
        foreach (static::$validationRegexp as $pattern => $key) {
          if (preg_match($pattern, $media->{$source_field}->{$property_name}, $matches)) {
            return $matches;
          }
        }
      }
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareViewDisplay(MediaTypeInterface $type, EntityViewDisplayInterface $display) {
    $display
      ->setComponent($this
      ->getSourceFieldDefinition($type)
      ->getName(), [
      'type' => 'instagram_embed',
      'label' => 'visually_hidden',
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
Instagram::$validationRegexp	public static	property	List of validation regular expressions.
Instagram::getMetadata	public	function	Gets the value for a metadata attribute for a given media item. Overrides OEmbed::getMetadata
Instagram::getMetadataAttributes	public	function	Gets a list of metadata attributes provided by this plugin. Overrides OEmbed::getMetadataAttributes
Instagram::matchRegexp	protected	function	Runs preg_match on embed code/URL.
Instagram::prepareViewDisplay	public	function	Prepares the media type fields for this source in the view display. Overrides OEmbed::prepareViewDisplay
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::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
MediaSourceBase::createSourceFieldStorage	protected	function	Creates the source field storage definition.
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::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
MediaSourceInterface::METADATA_FIELD_EMPTY		constant	Default empty value for metadata fields.
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
OEmbed::$fileSystem	protected	property	The file system.
OEmbed::$httpClient	protected	property	The HTTP client.
OEmbed::$iFrameUrlHelper	protected	property	The iFrame URL helper service.
OEmbed::$logger	protected	property	The logger channel for media.
OEmbed::$messenger	protected	property	The messenger service. Overrides MessengerTrait::$messenger
OEmbed::$resourceFetcher	protected	property	The oEmbed resource fetcher service.
OEmbed::$urlResolver	protected	property	The OEmbed manager service.
OEmbed::buildConfigurationForm	public	function	Form constructor. Overrides MediaSourceBase::buildConfigurationForm
OEmbed::create	public static	function	Creates an instance of the plugin. Overrides MediaSourceBase::create
OEmbed::createSourceField	public	function	Creates the source field definition for a type. Overrides MediaSourceBase::createSourceField
OEmbed::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides MediaSourceBase::defaultConfiguration
OEmbed::getLocalThumbnailUri	protected	function	Returns the local URI for a resource thumbnail.
OEmbed::getProviders	public	function	Returns the oEmbed provider names. Overrides OEmbedInterface::getProviders
OEmbed::getSourceFieldConstraints	public	function	Gets media source-specific validation constraints for a source field. Overrides MediaSourceFieldConstraintsInterface::getSourceFieldConstraints
OEmbed::getThumbnailFileExtensionFromUrl	protected	function	Tries to determine the file extension of a thumbnail.
OEmbed::prepareFormDisplay	public	function	Prepares the media type fields for this source in the form display. Overrides MediaSourceBase::prepareFormDisplay
OEmbed::submitConfigurationForm	public	function	Form submission handler. Overrides MediaSourceBase::submitConfigurationForm
OEmbed::validateConfigurationForm	public	function	Form validation handler. Overrides MediaSourceBase::validateConfigurationForm
OEmbed::__construct	public	function	Constructs a new OEmbed instance. Overrides MediaSourceBase::__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.
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 Instagram in Media entity Instagram 3.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation