You are here

Home » API reference » Acquia Content Hub 8.2 » PrivateFileSchemeHandler.php

class PrivateFileSchemeHandler in Acquia Content Hub 8.2

File scheme handler for private files.

Plugin annotation


@FileSchemeHandler(
  id = "private",
  label = @Translation("Private file handler")
)

Hierarchy

Expanded class hierarchy of PrivateFileSchemeHandler

File

src/Plugin/FileSchemeHandler/PrivateFileSchemeHandler.php, line 26

Namespace

Drupal\acquia_contenthub\Plugin\FileSchemeHandler
View source 
class PrivateFileSchemeHandler extends PluginBase implements FileSchemeHandlerInterface, ContainerFactoryPluginInterface {

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

  /**
   * Common actions for Content Hub.
   *
   * @var \Drupal\acquia_contenthub\ContentHubCommonActions
   */
  private $contentHubCommonActions;

  /**
   * PrivateFileSchemeHandler constructor.
   *
   * @param array $configuration
   *   The plugin configuration.
   * @param string $plugin_id
   *   The plugin id.
   * @param mixed $plugin_definition
   *   The definition.
   * @param \Drupal\Core\File\FileSystemInterface $file_system
   *   The file system.
   * @param \Drupal\acquia_contenthub\ContentHubCommonActions $common_actions
   *   Content Hub Common Actions.
   */
  public function __construct(array $configuration, string $plugin_id, $plugin_definition, FileSystemInterface $file_system, ContentHubCommonActions $common_actions) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->fileSystem = $file_system;
    $this->contentHubCommonActions = $common_actions;
  }

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

  /**
   * {@inheritdoc}
   *
   * @throws \Exception
   */
  public function addAttributes(CDFObject $object, FileInterface $file) {
    $uri = $file
      ->getFileUri();
    $webhook_url = Url::fromUri('internal:/acquia-contenthub/webhook', [
      'absolute' => TRUE,
    ])
      ->toString();
    $object
      ->addAttribute('file_scheme', CDFAttribute::TYPE_STRING, 'private');
    $object
      ->addAttribute('file_location', CDFAttribute::TYPE_STRING, $webhook_url);
    $object
      ->addAttribute('file_uri', CDFAttribute::TYPE_STRING, $uri);
  }

  /**
   * {@inheritdoc}
   */
  public function getFile(CDFObject $object) {
    if ($object
      ->getAttribute('file_location') && $object
      ->getAttribute('file_uri') && $object
      ->getUuid()) {
      $url = $object
        ->getAttribute('file_location')
        ->getValue()[LanguageInterface::LANGCODE_NOT_SPECIFIED];
      $uri = $object
        ->getAttribute('file_uri')
        ->getValue()[LanguageInterface::LANGCODE_NOT_SPECIFIED];
      $uuid = $object
        ->getUuid();
      $dirname = $this->fileSystem
        ->dirname($uri);
      if ($this->fileSystem
        ->prepareDirectory($dirname, FileSystemInterface::CREATE_DIRECTORY)) {
        try {
          $contents = $this->contentHubCommonActions
            ->requestRemoteEntity($url, $uri, $uuid, 'private');
        } catch (\Exception $exception) {
          \Drupal::messenger()
            ->addError(t('Unable to request file.'));
        }
        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

Namesort descending 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.
PrivateFileSchemeHandler::$contentHubCommonActions private property Common actions for Content Hub.
PrivateFileSchemeHandler::$fileSystem protected property The file system object.
PrivateFileSchemeHandler::addAttributes public function Overrides FileSchemeHandlerInterface::addAttributes
PrivateFileSchemeHandler::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PrivateFileSchemeHandler::getFile public function Makes file available to Drupal through the correct stream wrapper. Overrides FileSchemeHandlerInterface::getFile
PrivateFileSchemeHandler::saveData private function Save the data to file system.
PrivateFileSchemeHandler::__construct public function PrivateFileSchemeHandler 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.