class FileUri

Same name and namespace in other branches
  1. 9 core/modules/file/src/Plugin/migrate/process/d6/FileUri.php \Drupal\file\Plugin\migrate\process\d6\FileUri
  2. 8.9.x core/modules/file/src/Plugin/migrate/process/d6/FileUri.php \Drupal\file\Plugin\migrate\process\d6\FileUri
  3. 11.x core/modules/file/src/Plugin/migrate/process/d6/FileUri.php \Drupal\file\Plugin\migrate\process\d6\FileUri

Process the file URL into a D8 compatible URL.

Hierarchy

Expanded class hierarchy of FileUri

1 file declares its use of FileUri
FileUriTest.php in core/modules/file/tests/src/Unit/Plugin/migrate/process/d6/FileUriTest.php

File

core/modules/file/src/Plugin/migrate/process/d6/FileUri.php, line 13

Namespace

Drupal\file\Plugin\migrate\process\d6
View source
class FileUri extends ProcessPluginBase {
  
  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    // If we're stubbing a file entity, return a uri of NULL so it will get
    // stubbed by the general process.
    if ($row->isStub()) {
      return NULL;
    }
    [
      $filepath,
      $file_directory_path,
      $temp_directory_path,
      $is_public,
    ] = $value;
    // Specific handling using $temp_directory_path for temporary files.
    if (str_starts_with($filepath, $temp_directory_path)) {
      $uri = preg_replace('/^' . preg_quote($temp_directory_path, '/') . '/', '', $filepath);
      return 'temporary://' . ltrim($uri, '/');
    }
    // Strip the files path from the uri instead of using basename
    // so any additional folders in the path are preserved.
    $uri = preg_replace('/^' . preg_quote($file_directory_path, '/') . '/', '', $filepath);
    return ($is_public ? 'public' : 'private') . '://' . ltrim($uri, '/');
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
FileUri::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
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
ProcessPluginBase::$stopPipeline protected property Determines if processing of the pipeline is stopped.
ProcessPluginBase::isPipelineStopped public function Determines if the pipeline should stop processing. Overrides MigrateProcessInterface::isPipelineStopped
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
ProcessPluginBase::reset public function Resets the internal data of a plugin. Overrides MigrateProcessInterface::reset
ProcessPluginBase::stopPipeline protected function Stops pipeline processing after this plugin finishes.

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