Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
Total | |
0.00% |
0 / 1 |
|
62.50% |
5 / 8 |
CRAP | |
61.54% |
24 / 39 |
DrupalSqlBase | |
0.00% |
0 / 1 |
|
62.50% |
5 / 8 |
46.09 | |
61.54% |
24 / 39 |
__construct | |
100.00% |
1 / 1 |
1 | |
100.00% |
3 / 3 |
|||
getSystemData | |
100.00% |
1 / 1 |
4 | |
100.00% |
9 / 9 |
|||
create | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 3 |
|||
checkRequirements | |
0.00% |
0 / 1 |
42 | |
0.00% |
0 / 7 |
|||
getModuleSchemaVersion | |
100.00% |
1 / 1 |
2 | |
100.00% |
2 / 2 |
|||
moduleExists | |
100.00% |
1 / 1 |
1 | |
100.00% |
2 / 2 |
|||
variableGet | |
100.00% |
1 / 1 |
3 | |
100.00% |
8 / 8 |
|||
calculateDependencies | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 5 |
<?php | |
/** | |
* @file | |
* Contains \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase. | |
*/ | |
namespace Drupal\migrate_drupal\Plugin\migrate\source; | |
use Drupal\Component\Plugin\DependentPluginInterface; | |
use Drupal\Core\Entity\DependencyTrait; | |
use Drupal\Core\Entity\EntityManagerInterface; | |
use Drupal\Core\Plugin\ContainerFactoryPluginInterface; | |
use Drupal\Core\State\StateInterface; | |
use Drupal\migrate\Entity\MigrationInterface; | |
use Drupal\migrate\Exception\RequirementsException; | |
use Drupal\migrate\Plugin\migrate\source\SqlBase; | |
use Drupal\migrate\Plugin\RequirementsInterface; | |
use Symfony\Component\DependencyInjection\ContainerInterface; | |
/** | |
* A base source class for Drupal migrate sources. | |
* | |
* Mainly to let children retrieve information from the origin system in an | |
* easier way. | |
*/ | |
abstract class DrupalSqlBase extends SqlBase implements ContainerFactoryPluginInterface, RequirementsInterface, DependentPluginInterface { | |
use DependencyTrait; | |
/** | |
* The contents of the system table. | |
* | |
* @var array | |
*/ | |
protected $systemData; | |
/** | |
* If the source provider is missing. | |
* | |
* @var bool | |
*/ | |
protected $requirements = TRUE; | |
/** | |
* The entity manager. | |
* | |
* @var \Drupal\Core\Entity\EntityManagerInterface | |
*/ | |
protected $entityManager; | |
/** | |
* {@inheritdoc} | |
*/ | |
public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, StateInterface $state, EntityManagerInterface $entity_manager) { | |
parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $state); | |
$this->entityManager = $entity_manager; | |
} | |
/** | |
* Retrieves all system data information from origin system. | |
* | |
* @return array | |
* List of system table information keyed by type and name. | |
*/ | |
public function getSystemData() { | |
if (!isset($this->systemData)) { | |
$this->systemData = array(); | |
try { | |
$results = $this->select('system', 's') | |
->fields('s') | |
->execute(); | |
foreach ($results as $result) { | |
$this->systemData[$result['type']][$result['name']] = $result; | |
} | |
} | |
catch (\Exception $e) { | |
// The table might not exist for example in tests. | |
} | |
} | |
return $this->systemData; | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) { | |
return new static( | |
$configuration, | |
$plugin_id, | |
$plugin_definition, | |
$migration, | |
$container->get('state'), | |
$container->get('entity.manager') | |
); | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
public function checkRequirements() { | |
if ($this->pluginDefinition['requirements_met'] === TRUE) { | |
if (isset($this->pluginDefinition['source_provider'])) { | |
if ($this->moduleExists($this->pluginDefinition['source_provider'])) { | |
if (isset($this->pluginDefinition['minimum_schema_version']) && !$this->getModuleSchemaVersion($this->pluginDefinition['source_provider']) < $this->pluginDefinition['minimum_schema_version']) { | |
throw new RequirementsException('Required minimum schema version ' . $this->pluginDefinition['minimum_schema_version'], ['minimum_schema_version' => $this->pluginDefinition['minimum_schema_version']]); | |
} | |
} | |
else { | |
throw new RequirementsException('Missing source provider ' . $this->pluginDefinition['source_provider'], ['source_provider' => $this->pluginDefinition['source_provider']]); | |
} | |
} | |
} | |
} | |
/** | |
* Get a module schema_version value in the source installation. | |
* | |
* @param string $module | |
* Name of module. | |
* | |
* @return mixed | |
* The current module schema version on the origin system table or FALSE if | |
* not found. | |
*/ | |
protected function getModuleSchemaVersion($module) { | |
$system_data = $this->getSystemData(); | |
return isset($system_data['module'][$module]['schema_version']) ? $system_data['module'][$module]['schema_version'] : FALSE; | |
} | |
/** | |
* Check to see if a given module is enabled in the source installation. | |
* | |
* @param string $module | |
* Name of module to check. | |
* | |
* @return bool | |
* TRUE if module is enabled on the origin system, FALSE if not. | |
*/ | |
protected function moduleExists($module) { | |
$system_data = $this->getSystemData(); | |
return !empty($system_data['module'][$module]['status']); | |
} | |
/** | |
* Read a variable from a Drupal database. | |
* | |
* @param $name | |
* Name of the variable. | |
* @param $default | |
* The default value. | |
* @return mixed | |
*/ | |
protected function variableGet($name, $default) { | |
try { | |
$result = $this->select('variable', 'v') | |
->fields('v', array('value')) | |
->condition('name', $name) | |
->execute() | |
->fetchField(); | |
} | |
// The table might not exist. | |
catch (\Exception $e) { | |
$result = FALSE; | |
} | |
return $result !== FALSE ? unserialize($result) : $default; | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
public function calculateDependencies() { | |
// Generic handling for Drupal source plugin constants. | |
if (isset($this->configuration['constants']['entity_type'])) { | |
$this->addDependency('module', $this->entityManager->getDefinition($this->configuration['constants']['entity_type'])->getProvider()); | |
} | |
if (isset($this->configuration['constants']['module'])) { | |
$this->addDependency('module', $this->configuration['constants']['module']); | |
} | |
return $this->dependencies; | |
} | |
} |