diff --git a/core/modules/migrate/src/Plugin/migrate/process/FileCopy.php b/core/modules/migrate/src/Plugin/migrate/process/FileCopy.php index db9fd10..87b3d6a 100644 --- a/core/modules/migrate/src/Plugin/migrate/process/FileCopy.php +++ b/core/modules/migrate/src/Plugin/migrate/process/FileCopy.php @@ -16,26 +16,31 @@ /** * Copies or moves a local file from one place into another. * - * The file_copy process plugin ... + * The file_copy process plugin copies a file from one location to another. + * Optionally, the file can be moved, reused, or set to be automatically renamed + * if a duplicate exists. * * The source value is an array of two values - * - source: The source path or URI. - * - destination: The destination path or URI. + * - source: The source path or URI, e.g. /path/to/foo.txt or + * public://bar.txt. + * - destination: The destination path or URI, e.g. /path/to/bar.txt or + * public://foo.txt. * * Available configuration keys - * - move: (optional) If set the move the file otherwise copy the file. - * - rename: (optional) If set rename the file. + * - move: (optional) Boolean, if TRUE, move the file otherwise copy the file. + * Defaults to FALSE. + * - rename: (optional) Boolean, if TRUE, rename the file. Defaults to FALSE. + * - reuse: (optional) Boolean, if TRUE, file can be reused. Defaults to + * FALSE. * * Examples: * * @code * process: - * new_text_field: - * plugin: concat - * source: - * - foo - * - bar - * delimiter: / + * path_to_file: + * plugin: file_copy + * source: /path/to/file.png + * destination: /new/path/to/file.png * @endcode * * @see \Drupal\migrate\Plugin\MigrateProcessInterface