Drupal 8  8.0.2
MigrateTemplateStorage Class Reference
Inheritance diagram for MigrateTemplateStorage:

Public Member Functions

 __construct (ModuleHandlerInterface $module_handler, $directory=self::MIGRATION_TEMPLATE_DIRECTORY)
 
 findTemplatesByTag ($tag)
 
 getTemplateByName ($name)
 
 getAllTemplates ()
 

Data Fields

const MIGRATION_TEMPLATE_DIRECTORY = 'migration_templates'
 

Protected Attributes

 $directory
 
 $moduleHandler
 

Detailed Description

Storage to access migration template configuration in enabled extensions.

Constructor & Destructor Documentation

__construct ( ModuleHandlerInterface  $module_handler,
  $directory = self::MIGRATION_TEMPLATE_DIRECTORY 
)

{}

References Drupal\moduleHandler().

Here is the call graph for this function:

Member Function Documentation

findTemplatesByTag (   $tag)

{Find all migration templates with the specified tag.

Parameters
$tagThe tag to match.
Returns
array Any templates (parsed YAML config) that matched, keyed by the ID.
}

Implements MigrateTemplateStorageInterface.

References MigrateTemplateStorage\getAllTemplates().

Here is the call graph for this function:

getAllTemplates ( )

{Retrieves all migration templates belonging to enabled extensions.

Returns
array Array of parsed templates, keyed by the fully-qualified id.
}

Implements MigrateTemplateStorageInterface.

References Yaml\decode(), and Drupal\moduleHandler().

Referenced by MigrateTemplateStorage\findTemplatesByTag(), and MigrateTemplateStorage\getTemplateByName().

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplateByName (   $name)

{Retrieve a template given a specific name.

Parameters
string$nameA migration template name.
Returns
NULL|array A parsed migration template, or NULL if it doesn't exist.
}

Implements MigrateTemplateStorageInterface.

References MigrateTemplateStorage\getAllTemplates().

Here is the call graph for this function:

Field Documentation

const MIGRATION_TEMPLATE_DIRECTORY = 'migration_templates'

Extension sub-directory containing default configuration for migrations.


The documentation for this class was generated from the following file: