class DefaultContentSubscriber

Same name in this branch
  1. 11.x core/modules/media/src/EventSubscriber/DefaultContentSubscriber.php \Drupal\media\EventSubscriber\DefaultContentSubscriber
  2. 11.x core/modules/layout_builder/src/EventSubscriber/DefaultContentSubscriber.php \Drupal\layout_builder\EventSubscriber\DefaultContentSubscriber
  3. 11.x core/modules/content_moderation/src/EventSubscriber/DefaultContentSubscriber.php \Drupal\content_moderation\EventSubscriber\DefaultContentSubscriber
  4. 11.x core/modules/link/src/EventSubscriber/DefaultContentSubscriber.php \Drupal\link\EventSubscriber\DefaultContentSubscriber
  5. 11.x core/modules/path/src/EventSubscriber/DefaultContentSubscriber.php \Drupal\path\EventSubscriber\DefaultContentSubscriber

Subscribes to default content-related events.

@internal Event subscribers are internal.

Hierarchy

  • class \Drupal\file\EventSubscriber\DefaultContentSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface uses \Psr\Log\LoggerAwareTrait

Expanded class hierarchy of DefaultContentSubscriber

File

core/modules/file/src/EventSubscriber/DefaultContentSubscriber.php, line 18

Namespace

Drupal\file\EventSubscriber
View on git.drupalcode.org
View source 
class DefaultContentSubscriber implements EventSubscriberInterface {
  use LoggerAwareTrait;
  
  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() : array {
    return [
      PreExportEvent::class => 'preExport',
    ];
  }
  
  /**
   * Reacts before an entity is exported.
   *
   * @param \Drupal\Core\DefaultContent\PreExportEvent $event
   *   The event object.
   */
  public function preExport(PreExportEvent $event) : void {
    $entity = $event->entity;
    if ($entity instanceof FileInterface) {
      $uri = $entity->getFileUri();
      // Ensure the file has a name (`getFilename()` may return NULL).
      $name = $entity->getFilename() ?? basename($uri);
      $entity->setFilename($name);
      if (file_exists($uri)) {
        $event->metadata
          ->addAttachment($uri, $name);
      }
      else {
        $this->logger?->warning('The file (%uri) associated with file entity %name does not exist.', [
          '%uri' => $uri,
          '%name' => $entity->label(),
        ]);
      }
    }
  }

}

Members

Title Modifiers Object type Summary
DefaultContentSubscriber::getSubscribedEvents public static function
DefaultContentSubscriber::preExport public function Reacts before an entity is exported.

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