class PublicFileSchemeHandler in Acquia Content Hub 8.2

The handler for files with a public file scheme.

Plugin annotation

@FileSchemeHandler(
  id = "public",
  label = @Translation("Public file handler")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\acquia_contenthub\Plugin\FileSchemeHandler\PublicFileSchemeHandler implements FileSchemeHandlerInterface, ContainerFactoryPluginInterface

1 file declares its use of PublicFileSchemeHandler

PublicFileSchemeHandler.php in tests/src/Kernel/Stubs/PublicFileSchemeHandler.php

File

src/Plugin/FileSchemeHandler/PublicFileSchemeHandler.php, line 27

Namespace

Drupal\acquia_contenthub\Plugin\FileSchemeHandler

class PublicFileSchemeHandler extends PluginBase implements FileSchemeHandlerInterface, ContainerFactoryPluginInterface {

  /**
   * The stream wrapper manager.
   *
   * @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface
   */
  protected $streamWrapperManager;

  /**
   * The file system object.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * PublicFileSchemeHandler constructor.
   *
   * @param array $configuration
   *   The plugin configuration.
   * @param string $plugin_id
   *   The plugin id.
   * @param mixed $plugin_definition
   *   The definition.
   * @param \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager
   *   The stream wrapper manager service.
   * @param \Drupal\Core\File\FileSystemInterface $file_system
   *   The file system.
   */
  public function __construct(array $configuration, string $plugin_id, $plugin_definition, StreamWrapperManagerInterface $stream_wrapper_manager, FileSystemInterface $file_system) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->streamWrapperManager = $stream_wrapper_manager;
    $this->fileSystem = $file_system;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('stream_wrapper_manager'), $container
      ->get('file_system'));
  }

  /**
   * {@inheritdoc}
   *
   * @throws \Exception
   */
  public function addAttributes(CDFObject $object, FileInterface $file) {
    $uri = $file
      ->getFileUri();
    $directory_path = $this->streamWrapperManager
      ->getViaUri($uri)
      ->getDirectoryPath();
    if (version_compare(\Drupal::VERSION, '8.8.0', '>=')) {
      $url = Url::fromUri('base:' . $directory_path . '/' . StreamWrapperManager::getTarget($uri), [
        'absolute' => TRUE,
      ])
        ->toString();
    }
    else {
      $url = Url::fromUri('base:' . $directory_path . '/' . file_uri_target($uri), [
        'absolute' => TRUE,
      ])
        ->toString();
    }
    $object
      ->addAttribute('file_scheme', CDFAttribute::TYPE_STRING, 'public');
    $object
      ->addAttribute('file_location', CDFAttribute::TYPE_STRING, $url);
    $object
      ->addAttribute('file_uri', CDFAttribute::TYPE_STRING, $uri);
  }

  /**
   * {@inheritdoc}
   */
  public function getFile(CDFObject $object) {
    if ($object
      ->getAttribute('file_location') && $object
      ->getAttribute('file_uri')) {
      $url = $object
        ->getAttribute('file_location')
        ->getValue()[LanguageInterface::LANGCODE_NOT_SPECIFIED];
      $uri = $object
        ->getAttribute('file_uri')
        ->getValue()[LanguageInterface::LANGCODE_NOT_SPECIFIED];
      $dirname = $this->fileSystem
        ->dirname($uri);
      if ($this->fileSystem
        ->prepareDirectory($dirname, FileSystemInterface::CREATE_DIRECTORY)) {
        $contents = file_get_contents($url);
        return $this
          ->saveData($contents, $uri, FileSystemInterface::EXISTS_REPLACE);
      }
    }
    return FALSE;
  }

  /**
   * Save the data to file system.
   *
   * @param string $data
   *   Data to save.
   * @param string $destination
   *   Destination of data.
   * @param int $replace
   *   Replacement option.
   *
   * @return bool|string
   *   String saved or bool if failed.
   */
  private function saveData(string $data, string $destination, int $replace) {
    try {
      return $this->fileSystem
        ->saveData($data, $destination, $replace);
    } catch (FileWriteException $e) {
      \Drupal::messenger()
        ->addError(t('The file could not be created.'));
      return FALSE;
    } catch (FileException $e) {
      return FALSE;
    }
  }

}

Members

Name	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
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.
PublicFileSchemeHandler::$fileSystem	protected	property	The file system object.
PublicFileSchemeHandler::$streamWrapperManager	protected	property	The stream wrapper manager.
PublicFileSchemeHandler::addAttributes	public	function	Overrides FileSchemeHandlerInterface::addAttributes
PublicFileSchemeHandler::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PublicFileSchemeHandler::getFile	public	function	Makes file available to Drupal through the correct stream wrapper. Overrides FileSchemeHandlerInterface::getFile	1
PublicFileSchemeHandler::saveData	private	function	Save the data to file system.
PublicFileSchemeHandler::__construct	public	function	PublicFileSchemeHandler constructor. Overrides PluginBase::__construct
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.