Verified Commit 10792e86 authored by Alex Pott's avatar Alex Pott
Browse files

Issue #3189876 by Matroskeen, quietone, benjifisher: Add documentation for file source plugins 

(cherry picked from commit 226cc60a)
parent 6c5a3dca

core/modules/file/migrations/d6_file.yml

+22 −2
Original line number Diff line number Diff line
@@ -11,8 +11,28 @@ source: 
  constants:

    # The tool configuring this migration must set source_base_path. It

    # represents the fully qualified path relative to which URIs in the files

    # table are specified, and must end with a /. See source_full_path

    # configuration in this migration's process pipeline as an example.

    # table are specified. This can be a local file directory containing the

    # source site, e.g. /var/www/docroot, or the site address,

    # e.g. https://example.com. This value will be concatenated with the file

    # path (typically sites/default/files) and used as the source location for

    # the files.

    #

    # Suppose that the source files have been moved by other means to a location

    # on the destination site.

    # Source site:

    #   Location of files: /var/www/html/legacy/sites/default/files

    #   Public scheme: sites/default/files

    # In this example, source_base_path should be '/var/www/html/legacy'.

    #

    # Suppose that the source site is a multisite installation at

    # https://example.com, and you plan to copy the files from there.

    # Source site:

    #   Location of files: https://example.com/sites/example.com/files

    #   Public scheme: sites/example.com/files

    # In this example, source_base_path should be 'https://example.com'.

    #

    # See the configuration for the source_full_path property in the process

    # section below.

    source_base_path: ''

process:

    # If you are using both this migration and d6_user_picture_file in a custom

core/modules/file/migrations/d7_file.yml

+22 −2
Original line number Diff line number Diff line
@@ -12,8 +12,28 @@ source: 
  constants:

    # The tool configuring this migration must set source_base_path. It

    # represents the fully qualified path relative to which URIs in the files

    # table are specified, and must end with a /. See source_full_path

    # configuration in this migration's process pipeline as an example.

    # table are specified. This can be a local file directory containing the

    # source site, e.g. /var/www/docroot, or the site address,

    # e.g. https://example.com. This value will be concatenated with the file

    # path (typically sites/default/files) and used as the source location for

    # the files.

    #

    # Suppose that the source files have been moved by other means to a location

    # on the destination site.

    # Source site:

    #   Location of files: /var/www/html/legacy/sites/default/files

    #   Public scheme: sites/default/files

    # In this example, source_base_path should be '/var/www/html/legacy'.

    #

    # Suppose that the source site is a multisite installation at

    # https://example.com, and you plan to copy the files from there.

    # Source site:

    #   Location of files: https://example.com/sites/example.com/files

    #   Public scheme: sites/example.com/files

    # In this example, source_base_path should be 'https://example.com'.

    #

    # See the configuration for the source_full_path property in the process

    # section below.

    source_base_path: ''

process:

  # If you are using this file to build a custom migration consider removing

core/modules/file/src/Plugin/migrate/source/d6/File.php

+26 −0
Original line number Diff line number Diff line
@@ -8,6 +8,32 @@ 
/**

 * Drupal 6 file source from database.

 *

 * Available configuration keys:

 * - site_path: (optional) The path to the site directory relative to Drupal

 *   root. Defaults to 'sites/default'. This value is ignored if the

 *   'file_directory_path' variable is set in the source Drupal database.

 *

 * Example:

 *

 * @code

 * source:

 *   plugin: d6_file

 *   site_path: sites/example

 * @endcode

 *

 * In this example, public file values are retrieved from the source database.

 * The site path is specified because it's not the default one (sites/default).

 * The final path to the public files will be "sites/example/files/", assuming

 * the 'file_directory_path' variable is not set in the source database.

 *

 * For complete example, refer to the d6_file.yml migration.

 *

 * For additional configuration keys, refer to the parent classes.

 *

 * @see \Drupal\migrate\Plugin\migrate\source\SqlBase

 * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase

 * @see d6_file.yml

 *

 * @MigrateSource(

 *   id = "d6_file",

 *   source_module = "system"

core/modules/file/src/Plugin/migrate/source/d6/Upload.php

+5 −0
Original line number Diff line number Diff line
@@ -8,6 +8,11 @@ 
/**

 * Drupal 6 upload source from database.

 *

 * For available configuration keys, refer to the parent classes.

 *

 * @see \Drupal\migrate\Plugin\migrate\source\SqlBase

 * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase

 *

 * @MigrateSource(

 *   id = "d6_upload",

 *   source_module = "upload"

core/modules/file/src/Plugin/migrate/source/d6/UploadInstance.php

+5 −0
Original line number Diff line number Diff line
@@ -10,6 +10,11 @@ 
/**

 * Drupal 6 upload instance source from database.

 *

 * For available configuration keys, refer to the parent classes.

 *

 * @see \Drupal\migrate\Plugin\migrate\source\SqlBase

 * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase

 *

 * @MigrateSource(

 *   id = "d6_upload_instance",

 *   source_module = "upload"