class SocialEmbedUrlFilter in Open Social 8.8

Provides a filter to display embedded entities based on data attributes.

Plugin annotation

@Filter(
  id = "social_embed_convert_url",
  title = @Translation("Convert SUPPORTED URLs to URL embeds"),
  description = @Translation("Convert only URLs that are supported to URL embeds."),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_REVERSIBLE,
  settings = {
    "url_prefix" = "",
  },
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\filter\Plugin\FilterBase implements FilterInterface
      • class \Drupal\url_embed\Plugin\Filter\ConvertUrlToEmbedFilter
        • class \Drupal\social_embed\Plugin\Filter\SocialEmbedUrlFilter

File

modules/social_features/social_embed/src/Plugin/Filter/SocialEmbedUrlFilter.php, line 22

Namespace

Drupal\social_embed\Plugin\Filter

class SocialEmbedUrlFilter extends ConvertUrlToEmbedFilter {

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function process($text, $langcode) {

    // Check for whitelisted URL.
    if ($this
      ->whiteList($text)) {
      return parent::process($text, $langcode);
    }

    // Not whitelisted is return the string as is.
    return new FilterProcessResult($text);
  }

  /**
   * Checks if item is on the whitelist.
   *
   * @param string $text
   *   The item to check for.
   *
   * @return bool
   *   Return if the item is on the whitelist or not.
   */
  public function whiteList($text) {

    // Fetch allowed patterns.
    $patterns = $this
      ->getPatterns();

    // Check if the URL provided is from a whitelisted site.
    foreach ($patterns as $pattern) {

      // Testing pattern.
      $testing_pattern = '/' . $pattern . '/';

      // Check if it matches.
      if (preg_match($testing_pattern, $text)) {
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * A list of whitelisted patterns.
   *
   * @return array
   *   The list of patterns.
   */
  private function getPatterns() {
    return [
      'facebook.com\\/(.*)\\/videos\\/(.*)',
      'facebook.com\\/(.*)\\/photos\\/(.*)',
      'facebook.com\\/(.*)\\/posts\\/(.*)',
      'flickr.com\\/photos\\/(.*)',
      'flic.kr\\/p\\/(.*)',
      'instagram.com\\/p\\/(.*)',
      'open.spotify.com\\/track\\/(.*)',
      'twitter.com\\/(.*)\\/status\\/(.*)',
      'vimeo.com\\/\\d{7,9}',
      'youtube.com\\/watch[?]v=(.*)',
      'youtu.be\\/(.*)',
      'ted.com\\/talks\\/(.*)',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConvertUrlToEmbedFilter::convertUrls	public static	function	Replaces appearances of supported URLs with <drupal-url> embed elements.
ConvertUrlToEmbedFilter::tips	public	function	Generates a filter's tip. Overrides FilterBase::tips
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
FilterBase::$provider	public	property	The name of the provider that owns this filter.
FilterBase::$settings	public	property	An associative array containing the configured settings of this filter.
FilterBase::$status	public	property	A Boolean indicating whether this filter is enabled.
FilterBase::$weight	public	property	The weight of this filter compared to others in a filter collection.
FilterBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	1
FilterBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
FilterBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FilterBase::getDescription	public	function	Returns the administrative description for this filter plugin. Overrides FilterInterface::getDescription
FilterBase::getHTMLRestrictions	public	function	Returns HTML allowed by this filter's configuration. Overrides FilterInterface::getHTMLRestrictions	4
FilterBase::getLabel	public	function	Returns the administrative label for this filter plugin. Overrides FilterInterface::getLabel
FilterBase::getType	public	function	Returns the processing type of this filter plugin. Overrides FilterInterface::getType
FilterBase::prepare	public	function	Prepares the text for processing. Overrides FilterInterface::prepare
FilterBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	1
FilterBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	4
FilterInterface::TYPE_HTML_RESTRICTOR		constant	HTML tag and attribute restricting filters to prevent XSS attacks.
FilterInterface::TYPE_MARKUP_LANGUAGE		constant	Non-HTML markup language filters that generate HTML.
FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE		constant	Irreversible transformation filters.
FilterInterface::TYPE_TRANSFORM_REVERSIBLE		constant	Reversible transformation filters.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	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.
SocialEmbedUrlFilter::getPatterns	private	function	A list of whitelisted patterns.
SocialEmbedUrlFilter::process	public	function	Performs the filter processing. Overrides ConvertUrlToEmbedFilter::process
SocialEmbedUrlFilter::settingsForm	public	function	Generates a filter's settings form. Overrides ConvertUrlToEmbedFilter::settingsForm
SocialEmbedUrlFilter::whiteList	public	function	Checks if item is on the whitelist.
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.