summaryrefslogtreecommitdiffstats
path: root/core/modules/migrate_drupal
diff options
context:
space:
mode:
authorNathaniel Catchpole2017-12-21 10:52:32 (GMT)
committerNathaniel Catchpole2017-12-21 10:52:32 (GMT)
commitaee6bea5cd929088daa019639fae1b9ddda452f1 (patch)
tree5c970562a6677dc7f5b7dc2e2aada1d53a38f920 /core/modules/migrate_drupal
parent4851f311e25ef59dc0b0742fe05e7560e4b1b79d (diff)
Issue #2921033 by Jo Fitzgerald, masipila, phenaproxima, xjm, Wim Leers: Improve API documentation of DrupalSqlBase source plugin
Diffstat (limited to 'core/modules/migrate_drupal')
-rw-r--r--core/modules/migrate_drupal/src/Plugin/migrate/source/DrupalSqlBase.php23
1 files changed, 16 insertions, 7 deletions
diff --git a/core/modules/migrate_drupal/src/Plugin/migrate/source/DrupalSqlBase.php b/core/modules/migrate_drupal/src/Plugin/migrate/source/DrupalSqlBase.php
index 445441b..c8b44f8 100644
--- a/core/modules/migrate_drupal/src/Plugin/migrate/source/DrupalSqlBase.php
+++ b/core/modules/migrate_drupal/src/Plugin/migrate/source/DrupalSqlBase.php
@@ -13,10 +13,19 @@ use Drupal\migrate\Plugin\migrate\source\SqlBase;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
- * A base source class for Drupal migrate sources.
+ * A base class for source plugins using a Drupal database as a source.
*
- * Mainly to let children retrieve information from the origin system in an
- * easier way.
+ * Provides general purpose helper methods that are commonly needed
+ * when writing source plugins that use a Drupal database as a source, for
+ * example:
+ * - Check if the given module exists in the source database.
+ * - Read Drupal configuration variables from the source database.
+ *
+ * For a full list, refer to the methods of this class.
+ *
+ * For available configuration keys, refer to the parent classes:
+ * @see \Drupal\migrate\Plugin\migrate\source\SqlBase
+ * @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
*/
abstract class DrupalSqlBase extends SqlBase implements ContainerFactoryPluginInterface, DependentPluginInterface {
@@ -52,7 +61,7 @@ abstract class DrupalSqlBase extends SqlBase implements ContainerFactoryPluginIn
}
/**
- * Retrieves all system data information from origin system.
+ * Retrieves all system data information from the source Drupal database.
*
* @return array
* List of system table information keyed by type and name.
@@ -109,7 +118,7 @@ abstract class DrupalSqlBase extends SqlBase implements ContainerFactoryPluginIn
}
/**
- * Get a module schema_version value in the source installation.
+ * Retrieves a module schema_version from the source Drupal database.
*
* @param string $module
* Name of module.
@@ -124,7 +133,7 @@ abstract class DrupalSqlBase extends SqlBase implements ContainerFactoryPluginIn
}
/**
- * Check to see if a given module is enabled in the source installation.
+ * Checks if a given module is enabled in the source Drupal database.
*
* @param string $module
* Name of module to check.
@@ -138,7 +147,7 @@ abstract class DrupalSqlBase extends SqlBase implements ContainerFactoryPluginIn
}
/**
- * Read a variable from a Drupal database.
+ * Reads a variable from a source Drupal database.
*
* @param $name
* Name of the variable.