Commit 6ac3bcd3 authored by catch's avatar catch
Browse files

Issue #3200809 by Matroskeen, quietone: Add documentation for d6 field source plugins

parent 2b33b1f8
...@@ -8,6 +8,10 @@ ...@@ -8,6 +8,10 @@
/** /**
* Drupal 6 field source from database. * 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( * @MigrateSource(
* id = "d6_field", * id = "d6_field",
* source_module = "content" * source_module = "content"
......
...@@ -10,6 +10,26 @@ ...@@ -10,6 +10,26 @@
/** /**
* Drupal 6 field instances source from database. * 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( * @MigrateSource(
* id = "d6_field_instance", * id = "d6_field_instance",
* source_module = "content" * source_module = "content"
......
...@@ -3,7 +3,11 @@ ...@@ -3,7 +3,11 @@
namespace Drupal\field\Plugin\migrate\source\d6; 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( * @MigrateSource(
* id = "d6_field_instance_option_translation", * id = "d6_field_instance_option_translation",
......
...@@ -5,7 +5,11 @@ ...@@ -5,7 +5,11 @@
use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase; 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( * @MigrateSource(
* id = "d6_field_instance_per_form_display", * id = "d6_field_instance_per_form_display",
......
...@@ -5,7 +5,11 @@ ...@@ -5,7 +5,11 @@
use Drupal\node\Plugin\migrate\source\d6\ViewModeBase; 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( * @MigrateSource(
* id = "d6_field_instance_per_view_mode", * id = "d6_field_instance_per_view_mode",
......
...@@ -5,7 +5,11 @@ ...@@ -5,7 +5,11 @@
use Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase; 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( * @MigrateSource(
* id = "d6_field_instance_label_description_translation", * id = "d6_field_instance_label_description_translation",
......
...@@ -3,7 +3,11 @@ ...@@ -3,7 +3,11 @@
namespace Drupal\field\Plugin\migrate\source\d6; 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( * @MigrateSource(
* id = "d6_field_option_translation", * id = "d6_field_option_translation",
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment