class EditorFileReference

Same name in other branches
  1. 9 core/modules/editor/src/Plugin/Filter/EditorFileReference.php \Drupal\editor\Plugin\Filter\EditorFileReference
  2. 8.9.x core/modules/editor/src/Plugin/Filter/EditorFileReference.php \Drupal\editor\Plugin\Filter\EditorFileReference
  3. 11.x core/modules/editor/src/Plugin/Filter/EditorFileReference.php \Drupal\editor\Plugin\Filter\EditorFileReference

Provides a filter to track images uploaded via a Text Editor.

Generates file URLs and associates the cache tags of referenced files.

Hierarchy

Expanded class hierarchy of EditorFileReference

File

core/modules/editor/src/Plugin/Filter/EditorFileReference.php, line 22

Namespace

Drupal\editor\Plugin\Filter
View source
class EditorFileReference extends FilterBase implements ContainerFactoryPluginInterface {
    
    /**
     * The entity repository.
     *
     * @var \Drupal\Core\Entity\EntityRepositoryInterface
     */
    protected $entityRepository;
    
    /**
     * The image factory.
     *
     * @var \Drupal\Core\Image\ImageFactory
     */
    protected $imageFactory;
    
    /**
     * Constructs a \Drupal\editor\Plugin\Filter\EditorFileReference object.
     *
     * @param array $configuration
     *   A configuration array containing information about the plugin instance.
     * @param string $plugin_id
     *   The plugin ID for the plugin instance.
     * @param mixed $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
     *   The entity repository.
     * @param \Drupal\Core\Image\ImageFactory $image_factory
     *   The image factory.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityRepositoryInterface $entity_repository, ImageFactory $image_factory) {
        $this->entityRepository = $entity_repository;
        $this->imageFactory = $image_factory;
        parent::__construct($configuration, $plugin_id, $plugin_definition);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity.repository'), $container->get('image.factory'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function process($text, $langcode) {
        $result = new FilterProcessResult($text);
        if (stristr($text, 'data-entity-type="file"') !== FALSE) {
            $dom = Html::load($text);
            $xpath = new \DOMXPath($dom);
            $processed_uuids = [];
            foreach ($xpath->query('//*[@data-entity-type="file" and @data-entity-uuid]') as $node) {
                $uuid = $node->getAttribute('data-entity-uuid');
                // If there is a 'src' attribute, set it to the file entity's current
                // URL. This ensures the URL works even after the file location changes.
                if ($node->hasAttribute('src')) {
                    $file = $this->entityRepository
                        ->loadEntityByUuid('file', $uuid);
                    if ($file instanceof FileInterface) {
                        $node->setAttribute('src', $file->createFileUrl());
                        if ($node->nodeName == 'img') {
                            $image = $this->imageFactory
                                ->get($file->getFileUri());
                            $width = $image->getWidth();
                            $height = $image->getHeight();
                            // Set dimensions to avoid content layout shift (CLS).
                            // @see https://web.dev/cls/
                            if ($width !== NULL && !$node->hasAttribute('width')) {
                                $node->setAttribute('width', (string) $width);
                            }
                            if ($height !== NULL && !$node->hasAttribute('height')) {
                                $node->setAttribute('height', (string) $height);
                            }
                        }
                    }
                }
                // Only process the first occurrence of each file UUID.
                if (!isset($processed_uuids[$uuid])) {
                    $processed_uuids[$uuid] = TRUE;
                    $file = $this->entityRepository
                        ->loadEntityByUuid('file', $uuid);
                    if ($file instanceof FileInterface) {
                        $result->addCacheTags($file->getCacheTags());
                    }
                }
            }
            $result->setProcessedText(Html::serialize($dom));
        }
        return $result;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
EditorFileReference::$entityRepository protected property The entity repository.
EditorFileReference::$imageFactory protected property The image factory.
EditorFileReference::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
EditorFileReference::process public function Performs the filter processing. Overrides FilterInterface::process
EditorFileReference::__construct public function Constructs a \Drupal\editor\Plugin\Filter\EditorFileReference object. Overrides FilterBase::__construct
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::settingsForm public function Generates a filter's settings form. Overrides FilterInterface::settingsForm 3
FilterBase::tips public function Generates a filter's tip. Overrides FilterInterface::tips 9
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.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.