Commit 2909a5d0 authored by jhodgdon's avatar jhodgdon

Issue #2290275 by chx: Add information to migrate plugin classes and interfaces for developers

parent f4d8d09e
...@@ -12,6 +12,18 @@ ...@@ -12,6 +12,18 @@
/** /**
* Defines a migration destination plugin annotation object. * Defines a migration destination plugin annotation object.
* *
* Plugin Namespace: Plugin\migrate\destination
*
* For a working example, see
* \Drupal\migrate\Plugin\migrate\destination\UrlAlias
*
* @see \Drupal\migrate\Plugin\MigrateDestinationInterface
* @see \Drupal\migrate\Plugin\destination\DestinationBase
* @see \Drupal\migrate\Plugin\MigrateDestinationPluginManager
* @see \Drupal\migrate\Annotation\MigrateSource
* @see \Drupal\migrate\Annotation\MigrateProcessPlugin
* @see plugin_api
*
* @Annotation * @Annotation
*/ */
class MigrateDestination extends Plugin { class MigrateDestination extends Plugin {
......
...@@ -12,6 +12,18 @@ ...@@ -12,6 +12,18 @@
/** /**
* Defines a migration process plugin annotation object. * Defines a migration process plugin annotation object.
* *
* Plugin Namespace: Plugin\migrate\process
*
* For a working example, see
* \Drupal\migrate\Plugin\migrate\process\DefaultValue
*
* @see \Drupal\migrate\Plugin\MigratePluginManager
* @see \Drupal\migrate\Plugin\MigrateProcessInterface
* @see \Drupal\migrate\Plugin\migrate\process\ProcessPluginBase
* @see \Drupal\migrate\Annotation\MigrateSource
* @see \Drupal\migrate\Annotation\MigrateDestination
* @see plugin_api
*
* @Annotation * @Annotation
*/ */
class MigrateProcessPlugin extends Plugin { class MigrateProcessPlugin extends Plugin {
......
...@@ -10,7 +10,20 @@ ...@@ -10,7 +10,20 @@
use Drupal\Component\Annotation\Plugin; use Drupal\Component\Annotation\Plugin;
/** /**
* Defines a migration destination plugin annotation object. * Defines a migration source plugin annotation object.
*
* Plugin Namespace: Plugin\migrate\source
*
* For a working example, check
* \Drupal\migrate\Plugin\migrate\source\EmptySource
* \Drupal\migrate_drupal\Plugin\migrate\source\UrlAlias
*
* @see \Drupal\migrate\Plugin\MigratePluginManager
* @see \Drupal\migrate\Plugin\MigrateSourceInterface
* @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
* @see \Drupal\migrate\Annotation\MigrateProcessPlugin
* @see \Drupal\migrate\Annotation\MigrateDestination
* @see plugin_api
* *
* @Annotation * @Annotation
*/ */
......
...@@ -8,13 +8,17 @@ ...@@ -8,13 +8,17 @@
namespace Drupal\migrate\Plugin; namespace Drupal\migrate\Plugin;
use Drupal\Component\Plugin\PluginInspectionInterface; use Drupal\Component\Plugin\PluginInspectionInterface;
use Drupal\migrate\Entity\Migration;
use Drupal\migrate\Entity\MigrationInterface; use Drupal\migrate\Entity\MigrationInterface;
use Drupal\migrate\Row; use Drupal\migrate\Row;
/** /**
* Destinations are responsible for persisting source data into the destination * Destinations are responsible for persisting source data into the destination
* Drupal. * Drupal.
*
* @see \Drupal\migrate\Plugin\destination\DestinationBase
* @see \Drupal\migrate\Plugin\MigrateDestinationPluginManager
* @see \Drupal\migrate\Annotation\MigrateDestination
* @see plugin_api
*/ */
interface MigrateDestinationInterface extends PluginInspectionInterface { interface MigrateDestinationInterface extends PluginInspectionInterface {
......
...@@ -13,6 +13,14 @@ ...@@ -13,6 +13,14 @@
use Drupal\Core\Extension\ModuleHandlerInterface; use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\migrate\Entity\MigrationInterface; use Drupal\migrate\Entity\MigrationInterface;
/**
* Plugin manager for migrate destination plugins.
*
* @see \Drupal\migrate\Plugin\MigrateDestinationInterface
* @see \Drupal\migrate\Plugin\destination\DestinationBase
* @see \Drupal\migrate\Annotation\MigrateDestination
* @see plugin_api
*/
class MigrateDestinationPluginManager extends MigratePluginManager { class MigrateDestinationPluginManager extends MigratePluginManager {
/** /**
......
...@@ -17,6 +17,13 @@ ...@@ -17,6 +17,13 @@
* Manages migrate plugins. * Manages migrate plugins.
* *
* @see hook_migrate_info_alter() * @see hook_migrate_info_alter()
* @see \Drupal\migrate\Annotation\MigrateSource
* @see \Drupal\migrate\Plugin\MigrateSourceInterface
* @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
* @see \Drupal\migrate\Annotation\MigrateProcessPlugin
* @see \Drupal\migrate\Plugin\MigrateProcessInterface
* @see \Drupal\migrate\Plugin\migrate\process\ProcessPluginBase
* @see plugin_api
*/ */
class MigratePluginManager extends DefaultPluginManager { class MigratePluginManager extends DefaultPluginManager {
......
...@@ -12,7 +12,12 @@ ...@@ -12,7 +12,12 @@
use Drupal\migrate\Row; use Drupal\migrate\Row;
/** /**
* An interface for migrate processes. * An interface for migrate process plugins.
*
* @see \Drupal\migrate\Plugin\MigratePluginManager
* @see \Drupal\migrate\Plugin\migrate\process\ProcessPluginBase
* @see \Drupal\migrate\Annotation\MigrateProcessPlugin
* @see plugin_api
*/ */
interface MigrateProcessInterface extends PluginInspectionInterface { interface MigrateProcessInterface extends PluginInspectionInterface {
......
...@@ -11,6 +11,11 @@ ...@@ -11,6 +11,11 @@
/** /**
* Defines an interface for migrate sources. * Defines an interface for migrate sources.
*
* @see \Drupal\migrate\Plugin\MigratePluginManager
* @see \Drupal\migrate\Annotation\MigrateSource
* @see \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
* @see plugin_api
*/ */
interface MigrateSourceInterface extends \Countable, PluginInspectionInterface { interface MigrateSourceInterface extends \Countable, PluginInspectionInterface {
......
...@@ -13,6 +13,14 @@ ...@@ -13,6 +13,14 @@
use Drupal\migrate\Plugin\MigrateDestinationInterface; use Drupal\migrate\Plugin\MigrateDestinationInterface;
use Drupal\migrate\Plugin\RequirementsInterface; use Drupal\migrate\Plugin\RequirementsInterface;
/**
* Base class for migrate destination classes.
*
* @see \Drupal\migrate\Plugin\MigrateDestinationInterface
* @see \Drupal\migrate\Plugin\MigrateDestinationPluginManager
* @see \Drupal\migrate\Annotation\MigrateDestination
* @see plugin_api
*/
abstract class DestinationBase extends PluginBase implements MigrateDestinationInterface, RequirementsInterface { abstract class DestinationBase extends PluginBase implements MigrateDestinationInterface, RequirementsInterface {
/** /**
......
...@@ -14,6 +14,11 @@ ...@@ -14,6 +14,11 @@
/** /**
* The base class for all source plugins. * The base class for all source plugins.
*
* @see \Drupal\migrate\Plugin\MigratePluginManager
* @see \Drupal\migrate\Annotation\MigrateSource
* @see \Drupal\migrate\Plugin\MigrateSourceInterface
* @see plugin_api
*/ */
abstract class SourcePluginBase extends PluginBase implements MigrateSourceInterface { abstract class SourcePluginBase extends PluginBase implements MigrateSourceInterface {
......
...@@ -18,6 +18,10 @@ ...@@ -18,6 +18,10 @@
* in a previous migration and so on. * in a previous migration and so on.
* *
* @see https://drupal.org/node/2129651 * @see https://drupal.org/node/2129651
* @see \Drupal\migrate\Plugin\MigratePluginManager
* @see \Drupal\migrate\Plugin\MigrateProcessInterface
* @see \Drupal\migrate\Annotation\MigrateProcessPlugin
* @see plugin_api
*/ */
abstract class ProcessPluginBase extends PluginBase implements MigrateProcessInterface { abstract class ProcessPluginBase extends PluginBase implements MigrateProcessInterface {
......
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