Unverified Commit 0921d71e authored by alexpott's avatar alexpott

Issue #3189587 by Matroskeen: Add documentation for taxonomy terms source plugins

parent 536c255d
......@@ -8,6 +8,35 @@
/**
* Taxonomy term source from database.
*
* Available configuration keys:
* - bundle: (optional) The taxonomy vocabulary (vid) to filter terms retrieved
* from the source - can be an integer or an array. If omitted, all terms are
* retrieved.
*
* Examples:
*
* @code
* source:
* plugin: d6_taxonomy_term
* bundle: 0
* @endcode
*
* In this example terms of vocabulary with 'vid' equal to 0 are retrieved from
* the source database.
*
* @code
* source:
* plugin: d6_taxonomy_term
* bundle: [1, 3, 5]
* @endcode
*
* In this example terms of vocabularies with 'vid' one of 1, 3, 5 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
*
* @todo Support term_relation, term_synonym table if possible.
*
* @MigrateSource(
......
......@@ -7,6 +7,11 @@
/**
* Gets i18n taxonomy terms from source database.
*
* For available configuration keys, refer to the parent classes:
* @see \Drupal\taxonomy\Plugin\migrate\source\d6\Term
* @see \Drupal\migrate\Plugin\migrate\source\SqlBase
* @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
*
* @MigrateSource(
* id = "d6_term_localized_translation",
* source_module = "i18ntaxonomy"
......
......@@ -8,6 +8,35 @@
/**
* Taxonomy term source from database.
*
* Available configuration keys:
* - bundle: (optional) The taxonomy vocabulary (machine name) to filter terms
* retrieved from the source - can be a string or an array. If omitted, all
* terms are retrieved.
*
* Examples:
*
* @code
* source:
* plugin: d7_taxonomy_term
* bundle: tags
* @endcode
*
* In this example terms of 'tags' vocabulary are retrieved from the source
* database.
*
* @code
* source:
* plugin: d7_taxonomy_term
* bundle: [tags, forums]
* @endcode
*
* In this example terms of 'tags' and 'forums' vocabularies 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
*
* @todo Support term_relation, term_synonym table if possible.
*
* @MigrateSource(
......
......@@ -8,6 +8,35 @@
/**
* Provides Drupal 7 taxonomy term entity translation source plugin.
*
* Available configuration keys:
* - bundle: (optional) The taxonomy vocabulary (machine name) to filter terms
* retrieved from the source - can be a string or an array. If omitted, all
* terms are retrieved.
*
* Examples:
*
* @code
* source:
* plugin: d7_taxonomy_term
* bundle: tags
* @endcode
*
* In this example terms of 'tags' vocabulary are retrieved from the source
* database.
*
* @code
* source:
* plugin: d7_taxonomy_term
* bundle: [tags, forums]
* @endcode
*
* In this example terms of 'tags' and 'forums' vocabularies 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 = "d7_taxonomy_term_entity_translation",
* source_module = "entity_translation"
......
......@@ -8,6 +8,11 @@
/**
* Gets i18n taxonomy terms from source database.
*
* For available configuration keys, refer to the parent classes:
* @see \Drupal\taxonomy\Plugin\migrate\source\d7\Term
* @see \Drupal\migrate\Plugin\migrate\source\SqlBase
* @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
*
* @MigrateSource(
* id = "d7_term_localized_translation",
* source_module = "i18n_taxonomy"
......
......@@ -7,6 +7,11 @@
/**
* Gets i18n taxonomy terms from source database.
*
* For available configuration keys, refer to the parent classes:
* @see \Drupal\taxonomy\Plugin\migrate\source\d7\Term
* @see \Drupal\migrate\Plugin\migrate\source\SqlBase
* @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
*
* @MigrateSource(
* id = "d7_taxonomy_term_translation",
* source_module = "i18n_taxonomy"
......
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