class FileUri

Same name in other branches
  1. 9 core/modules/file/src/Plugin/migrate/process/d6/FileUri.php \Drupal\file\Plugin\migrate\process\d6\FileUri
  2. 10 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.

Plugin annotation


@MigrateProcessPlugin(
  id = "file_uri"
)

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 16

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;
        }
        list($filepath, $file_directory_path, $temp_directory_path, $is_public) = $value;
        // Specific handling using $temp_directory_path for temporary files.
        if (substr($filepath, 0, strlen($temp_directory_path)) === $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::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3

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