From 6ac3bcd33c46d3792179c20c4442a58527e930d8 Mon Sep 17 00:00:00 2001 From: catch Date: Tue, 6 Apr 2021 09:31:33 +0100 Subject: [PATCH] Issue #3200809 by Matroskeen, quietone: Add documentation for d6 field source plugins --- .../src/Plugin/migrate/source/d6/Field.php | 4 ++++ .../migrate/source/d6/FieldInstance.php | 20 +++++++++++++++++++ .../d6/FieldInstanceOptionTranslation.php | 6 +++++- .../source/d6/FieldInstancePerFormDisplay.php | 6 +++++- .../source/d6/FieldInstancePerViewMode.php | 6 +++++- .../d6/FieldLabelDescriptionTranslation.php | 6 +++++- .../source/d6/FieldOptionTranslation.php | 6 +++++- 7 files changed, 49 insertions(+), 5 deletions(-) diff --git a/core/modules/field/src/Plugin/migrate/source/d6/Field.php b/core/modules/field/src/Plugin/migrate/source/d6/Field.php index 12dd0d92bf..d2c6392ae2 100644 --- a/core/modules/field/src/Plugin/migrate/source/d6/Field.php +++ b/core/modules/field/src/Plugin/migrate/source/d6/Field.php @@ -8,6 +8,10 @@ /** * Drupal 6 field 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_field", * source_module = "content" diff --git a/core/modules/field/src/Plugin/migrate/source/d6/FieldInstance.php b/core/modules/field/src/Plugin/migrate/source/d6/FieldInstance.php index 263500729e..ed302ea6db 100644 --- a/core/modules/field/src/Plugin/migrate/source/d6/FieldInstance.php +++ b/core/modules/field/src/Plugin/migrate/source/d6/FieldInstance.php @@ -10,6 +10,26 @@ /** * Drupal 6 field instances source from database. * + * Available configuration keys: + * - node_type: (optional) The content type (machine name) to filter field + * instances retrieved from the source. If omitted, all field instances are + * retrieved. + * + * Example: + * + * @code + * source: + * plugin: d6_field_instance + * node_type: page + * @endcode + * + * In this example field instances of type page are retrieved from the source + * database. + * + * For additional configuration keys, refer to the parent classes: + * @see \Drupal\migrate\Plugin\migrate\source\SqlBase + * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase + * * @MigrateSource( * id = "d6_field_instance", * source_module = "content" diff --git a/core/modules/field/src/Plugin/migrate/source/d6/FieldInstanceOptionTranslation.php b/core/modules/field/src/Plugin/migrate/source/d6/FieldInstanceOptionTranslation.php index daaa1d2904..505aa1c9aa 100644 --- a/core/modules/field/src/Plugin/migrate/source/d6/FieldInstanceOptionTranslation.php +++ b/core/modules/field/src/Plugin/migrate/source/d6/FieldInstanceOptionTranslation.php @@ -3,7 +3,11 @@ namespace Drupal\field\Plugin\migrate\source\d6; /** - * Gets field instance option label translations. + * Drupal 6 i18n field instance option labels 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_field_instance_option_translation", diff --git a/core/modules/field/src/Plugin/migrate/source/d6/FieldInstancePerFormDisplay.php b/core/modules/field/src/Plugin/migrate/source/d6/FieldInstancePerFormDisplay.php index b64505a73d..438b2198e6 100644 --- a/core/modules/field/src/Plugin/migrate/source/d6/FieldInstancePerFormDisplay.php +++ b/core/modules/field/src/Plugin/migrate/source/d6/FieldInstancePerFormDisplay.php @@ -5,7 +5,11 @@ use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase; /** - * The field instance per form display source class. + * Drupal 6 field instance per form display 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_field_instance_per_form_display", diff --git a/core/modules/field/src/Plugin/migrate/source/d6/FieldInstancePerViewMode.php b/core/modules/field/src/Plugin/migrate/source/d6/FieldInstancePerViewMode.php index 59346bf0f4..b571991084 100644 --- a/core/modules/field/src/Plugin/migrate/source/d6/FieldInstancePerViewMode.php +++ b/core/modules/field/src/Plugin/migrate/source/d6/FieldInstancePerViewMode.php @@ -5,7 +5,11 @@ use Drupal\node\Plugin\migrate\source\d6\ViewModeBase; /** - * The field instance per view mode source class. + * Drupal 6 field instance per view mode 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_field_instance_per_view_mode", diff --git a/core/modules/field/src/Plugin/migrate/source/d6/FieldLabelDescriptionTranslation.php b/core/modules/field/src/Plugin/migrate/source/d6/FieldLabelDescriptionTranslation.php index cfc28b7ffd..81edff9209 100644 --- a/core/modules/field/src/Plugin/migrate/source/d6/FieldLabelDescriptionTranslation.php +++ b/core/modules/field/src/Plugin/migrate/source/d6/FieldLabelDescriptionTranslation.php @@ -5,7 +5,11 @@ use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase; /** - * Gets field label and description translations. + * Drupal 6 i18n field label and description 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_field_instance_label_description_translation", diff --git a/core/modules/field/src/Plugin/migrate/source/d6/FieldOptionTranslation.php b/core/modules/field/src/Plugin/migrate/source/d6/FieldOptionTranslation.php index 73bebb33c8..94aaeb4368 100644 --- a/core/modules/field/src/Plugin/migrate/source/d6/FieldOptionTranslation.php +++ b/core/modules/field/src/Plugin/migrate/source/d6/FieldOptionTranslation.php @@ -3,7 +3,11 @@ namespace Drupal\field\Plugin\migrate\source\d6; /** - * Gets field option label translations. + * Drupal 6 i18n field option labels 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_field_option_translation", -- GitLab