Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
Total | |
0.00% |
0 / 1 |
|
37.50% |
3 / 8 |
CRAP | |
34.78% |
16 / 46 |
ConfigMapperManager | |
0.00% |
0 / 1 |
|
37.50% |
3 / 8 |
198.37 | |
34.78% |
16 / 46 |
__construct | |
100.00% |
1 / 1 |
1 | |
100.00% |
8 / 8 |
|||
getDiscovery | |
0.00% |
0 / 1 |
20 | |
0.00% |
0 / 10 |
|||
getMappers | |
0.00% |
0 / 1 |
12 | |
0.00% |
0 / 6 |
|||
processDefinition | |
0.00% |
0 / 1 |
6 | |
0.00% |
0 / 4 |
|||
buildDataDefinition | |
0.00% |
0 / 1 |
2 | |
0.00% |
0 / 1 |
|||
findDefinitions | |
0.00% |
0 / 1 |
72 | |
0.00% |
0 / 9 |
|||
hasTranslatable | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
findTranslatable | |
100.00% |
1 / 1 |
5 | |
100.00% |
7 / 7 |
<?php | |
/** | |
* @file | |
* Contains \Drupal\config_translation\ConfigMapperManager. | |
*/ | |
namespace Drupal\config_translation; | |
use Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException; | |
use Drupal\Core\Cache\CacheBackendInterface; | |
use Drupal\Core\Config\TypedConfigManagerInterface; | |
use Drupal\Core\Extension\ModuleHandlerInterface; | |
use Drupal\Core\Extension\ThemeHandlerInterface; | |
use Drupal\Core\Language\LanguageManagerInterface; | |
use Drupal\Core\Plugin\DefaultPluginManager; | |
use Drupal\Core\Plugin\Discovery\InfoHookDecorator; | |
use Drupal\Core\Plugin\Discovery\YamlDiscovery; | |
use Drupal\Core\Plugin\Discovery\ContainerDerivativeDiscoveryDecorator; | |
use Drupal\Core\Plugin\Factory\ContainerFactory; | |
use Drupal\Core\TypedData\TraversableTypedDataInterface; | |
use Drupal\Core\TypedData\TypedDataInterface; | |
use Symfony\Component\Routing\RouteCollection; | |
/** | |
* Manages plugins for configuration translation mappers. | |
*/ | |
class ConfigMapperManager extends DefaultPluginManager implements ConfigMapperManagerInterface { | |
/** | |
* The typed config manager. | |
* | |
* @var \Drupal\Core\Config\TypedConfigManagerInterface | |
*/ | |
protected $typedConfigManager; | |
/** | |
* The theme handler. | |
* | |
* @var \Drupal\Core\Extension\ThemeHandlerInterface | |
*/ | |
protected $themeHandler; | |
/** | |
* {@inheritdoc} | |
*/ | |
protected $defaults = array( | |
'title' => '', | |
'names' => array(), | |
'weight' => 20, | |
'class' => '\Drupal\config_translation\ConfigNamesMapper', | |
); | |
/** | |
* Constructs a ConfigMapperManager. | |
* | |
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend | |
* The cache backend. | |
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager | |
* The language manager. | |
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler | |
* The module handler. | |
* @param \Drupal\Core\Config\TypedConfigManagerInterface $typed_config_manager | |
* The typed config manager. | |
* @param \Drupal\Core\Extension\ThemeHandlerInterface $theme_handler | |
* The theme handler. | |
*/ | |
public function __construct(CacheBackendInterface $cache_backend, LanguageManagerInterface $language_manager, ModuleHandlerInterface $module_handler, TypedConfigManagerInterface $typed_config_manager, ThemeHandlerInterface $theme_handler) { | |
$this->typedConfigManager = $typed_config_manager; | |
$this->factory = new ContainerFactory($this, '\Drupal\config_translation\ConfigMapperInterface'); | |
// Let others alter definitions with hook_config_translation_info_alter(). | |
$this->moduleHandler = $module_handler; | |
$this->themeHandler = $theme_handler; | |
$this->alterInfo('config_translation_info'); | |
// Config translation only uses an info hook discovery, cache by language. | |
$cache_key = 'config_translation_info_plugins' . ':' . $language_manager->getCurrentLanguage()->getId(); | |
$this->setCacheBackend($cache_backend, $cache_key, array('config_translation_info_plugins')); | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
protected function getDiscovery() { | |
if (!isset($this->discovery)) { | |
// Look at all themes and modules. | |
// @todo If the list of installed modules and themes is changed, new | |
// definitions are not picked up immediately and obsolete definitions | |
// are not removed, because the list of search directories is only | |
// compiled once in this constructor. The current code only works due to | |
// coincidence: The request that installs (for instance, a new theme) | |
// does not instantiate this plugin manager at the beginning of the | |
// request; when routes are being rebuilt at the end of the request, | |
// this service only happens to get instantiated with the updated list | |
// of installed themes. | |
$directories = array(); | |
foreach ($this->moduleHandler->getModuleList() as $name => $module) { | |
$directories[$name] = $module->getPath(); | |
} | |
foreach ($this->themeHandler->listInfo() as $theme) { | |
$directories[$theme->getName()] = $theme->getPath(); | |
} | |
// Check for files named MODULE.config_translation.yml and | |
// THEME.config_translation.yml in module/theme roots. | |
$this->discovery = new YamlDiscovery('config_translation', $directories); | |
$this->discovery = new InfoHookDecorator($this->discovery, 'config_translation_info'); | |
$this->discovery = new ContainerDerivativeDiscoveryDecorator($this->discovery); | |
} | |
return $this->discovery; | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
public function getMappers(RouteCollection $collection = NULL) { | |
$mappers = array(); | |
foreach($this->getDefinitions() as $id => $definition) { | |
$mappers[$id] = $this->createInstance($id); | |
if ($collection) { | |
$mappers[$id]->setRouteCollection($collection); | |
} | |
} | |
return $mappers; | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
public function processDefinition(&$definition, $plugin_id) { | |
parent::processDefinition($definition, $plugin_id); | |
if (!isset($definition['base_route_name'])) { | |
throw new InvalidPluginDefinitionException($plugin_id, "The plugin definition of the mapper '$plugin_id' does not contain a base_route_name."); | |
} | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
public function buildDataDefinition(array $definition, $value = NULL, $name = NULL, $parent = NULL) { | |
return $this->typedConfigManager->buildDataDefinition($definition, $value, $name, $parent); | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
protected function findDefinitions() { | |
$definitions = $this->getDiscovery()->getDefinitions(); | |
foreach ($definitions as $plugin_id => &$definition) { | |
$this->processDefinition($definition, $plugin_id); | |
} | |
if ($this->alterHook) { | |
$this->moduleHandler->alter($this->alterHook, $definitions); | |
} | |
// If this plugin was provided by a module that does not exist, remove the | |
// plugin definition. | |
foreach ($definitions as $plugin_id => $plugin_definition) { | |
if (isset($plugin_definition['provider']) && !in_array($plugin_definition['provider'], array('core', 'component')) && (!$this->moduleHandler->moduleExists($plugin_definition['provider']) && !in_array($plugin_definition['provider'], array_keys($this->themeHandler->listInfo())))) { | |
unset($definitions[$plugin_id]); | |
} | |
} | |
return $definitions; | |
} | |
/** | |
* {@inheritdoc} | |
*/ | |
public function hasTranslatable($name) { | |
return $this->findTranslatable($this->typedConfigManager->get($name)); | |
} | |
/** | |
* Returns TRUE if at least one translatable element is found. | |
* | |
* @param \Drupal\Core\TypedData\TypedDataInterface $element | |
* Configuration schema element. | |
* | |
* @return bool | |
* A boolean indicating if there is at least one translatable element. | |
*/ | |
protected function findTranslatable(TypedDataInterface $element) { | |
// In case this is a sequence or a mapping check whether any child element | |
// is translatable. | |
if ($element instanceof TraversableTypedDataInterface) { | |
foreach ($element as $child_element) { | |
if ($this->findTranslatable($child_element)) { | |
return TRUE; | |
} | |
} | |
// If none of the child elements are translatable, return FALSE. | |
return FALSE; | |
} | |
else { | |
$definition = $element->getDataDefinition(); | |
return isset($definition['translatable']) && $definition['translatable']; | |
} | |
} | |
} |