You are here

Home » API reference » YAML Content 8 » File.php

class File in YAML Content 8

Plugin for processing and loading a file attachment.

Plugin annotation


@YamlContentProcess(
  id = "file",
  title = @Translation("File Processor"),
  description = @Translation("Processing and loading a file attachment.")
)

Hierarchy

Expanded class hierarchy of File

2 files declare their use of File
FileTest.php in tests/src/Functional/Plugin/yaml_content/process/FileTest.php
FileTest.php in tests/src/Unit/Plugin/yaml_content/process/FileTest.php

File

src/Plugin/yaml_content/process/File.php, line 20

Namespace

Drupal\yaml_content\Plugin\yaml_content\process
View source 
class File extends YamlContentProcessBase implements YamlContentProcessInterface {

  /**
   * {@inheritdoc}
   */
  public function process(ProcessingContext $context, array &$field_data) {
    $entity_type = $this->configuration[0];
    $filter_params = $this->configuration[1];
    $filename = $filter_params['filename'];
    $directory = '/data_files/';

    // If the entity type is an image, look in to the /images directory.
    if ($entity_type == 'image') {
      $directory = '/images/';
    }

    // TODO path not set.
    $output = file_get_contents($context
      ->getContentLoader()
      ->getContentPath() . $directory . $filename);
    if ($output !== FALSE) {
      $destination = 'public://';

      // Look-up the field's directory configuation.
      if ($directory = $context
        ->getField()
        ->getSetting('file_directory')) {
        $directory = trim($directory, '/');
        $directory = PlainTextOutput::renderFromHtml(\Drupal::token()
          ->replace($directory));
        if ($directory) {
          $destination .= $directory . '/';
        }
      }

      // Create the destination directory if it does not already exist.
      \Drupal::service('file_system')
        ->prepareDirectory($destination, FileSystemInterface::CREATE_DIRECTORY);

      // Save the file data or return an existing file.
      $file = file_save_data($output, $destination . $filename, FileSystemInterface::EXISTS_REPLACE);

      // Use the newly created file id as the value.
      $field_data['target_id'] = $file
        ->id();

      // Remove process data to avoid issues when setting the value.
      unset($field_data['#process']);
      return $file
        ->id();
    }
    $this
      ->throwParamError('Unable to process file content', $entity_type, $filter_params);
  }

}

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
File::process public function Processes field data. Overrides YamlContentProcessInterface::process
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
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.
YamlContentProcessBase::throwParamError protected function Prepare an error message and throw error.