class FileProcessBase

Same name in other branches
  1. 9 core/modules/migrate/src/Plugin/migrate/process/FileProcessBase.php \Drupal\migrate\Plugin\migrate\process\FileProcessBase
  2. 8.9.x core/modules/migrate/src/Plugin/migrate/process/FileProcessBase.php \Drupal\migrate\Plugin\migrate\process\FileProcessBase
  3. 10 core/modules/migrate/src/Plugin/migrate/process/FileProcessBase.php \Drupal\migrate\Plugin\migrate\process\FileProcessBase

Provides functionality for file process plugins.

Available configuration keys:

  • file_exists: (optional) Replace behavior when the destination file already exists:

    • 'replace' - (default) Replace the existing file.
    • 'rename' - Append _{incrementing number} until the filename is unique.
    • 'use existing' - Do nothing and return FALSE.

Hierarchy

Expanded class hierarchy of FileProcessBase

File

core/modules/migrate/src/Plugin/migrate/process/FileProcessBase.php, line 19

Namespace

Drupal\migrate\Plugin\migrate\process
View source 
abstract class FileProcessBase extends ProcessPluginBase {
    
    /**
     * Constructs a file process plugin.
     *
     * @param array $configuration
     *   The plugin configuration.
     * @param string $plugin_id
     *   The plugin ID.
     * @param array $plugin_definition
     *   The plugin definition.
     */
    public function __construct(array $configuration, $plugin_id, array $plugin_definition) {
        if (array_key_exists('file_exists', $configuration)) {
            switch ($configuration['file_exists']) {
                case 'use existing':
                    $configuration['file_exists'] = FileExists::Error;
                    break;
                case 'rename':
                    $configuration['file_exists'] = FileExists::Rename;
                    break;
                default:
                    $configuration['file_exists'] = FileExists::Replace;
            }
        }
        $configuration += [
            'file_exists' => FileExists::Replace,
        ];
        parent::__construct($configuration, $plugin_id, $plugin_definition);
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
FileProcessBase::__construct public function Constructs a file process plugin. 2
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.
ProcessPluginBase::transform public function Performs the associated process. Overrides MigrateProcessInterface::transform 74

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