ConfigNamesMapper.php 12.6 KB
Newer Older
1 2 3 4
<?php

namespace Drupal\config_translation;

5
use Drupal\config_translation\Exception\ConfigMapperLanguageException;
6
use Drupal\Core\Config\ConfigFactoryInterface;
7
use Drupal\Core\Config\TypedConfigManagerInterface;
8
use Drupal\Core\Language\LanguageInterface;
9
use Drupal\Core\Language\LanguageManagerInterface;
10
use Drupal\Core\Plugin\PluginBase;
11
use Drupal\Core\Routing\RouteMatchInterface;
12 13 14
use Drupal\Core\Routing\RouteProviderInterface;
use Drupal\Core\StringTranslation\TranslationInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
15
use Drupal\Core\Url;
16 17 18
use Drupal\locale\LocaleConfigManager;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Routing\Route;
19
use Symfony\Component\Routing\RouteCollection;
20 21 22 23 24 25 26 27 28

/**
 * Configuration mapper base implementation.
 */
class ConfigNamesMapper extends PluginBase implements ConfigMapperInterface, ContainerFactoryPluginInterface {

  /**
   * The configuration factory.
   *
29
   * @var \Drupal\Core\Config\ConfigFactoryInterface
30 31 32
   */
  protected $configFactory;

33 34 35 36 37 38 39
  /**
   * The typed config manager.
   *
   * @var \Drupal\Core\Config\TypedConfigManagerInterface
   */
  protected $typedConfigManager;

40 41 42 43 44 45 46 47 48 49 50 51 52 53
  /**
   * The typed configuration manager.
   *
   * @var \Drupal\locale\LocaleConfigManager
   */
  protected $localeConfigManager;

  /**
   * The mapper plugin discovery service.
   *
   * @var \Drupal\config_translation\ConfigMapperManagerInterface
   */
  protected $configMapperManager;

54 55 56 57 58 59 60
  /**
   * The route provider.
   *
   * @var \Drupal\Core\Routing\RouteProviderInterface
   */
  protected $routeProvider;

61 62 63 64 65 66 67
  /**
   * The base route object that the mapper is attached to.
   *
   * @return \Symfony\Component\Routing\Route
   */
  protected $baseRoute;

68 69 70 71 72 73 74
  /**
   * The available routes.
   *
   * @var \Symfony\Component\Routing\RouteCollection
   */
  protected $routeCollection;

75 76 77 78 79 80 81
  /**
   * The language code of the language this mapper, if any.
   *
   * @var string|null
   */
  protected $langcode = NULL;

82 83 84 85 86 87 88
  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

89 90 91 92 93
  /**
   * Constructs a ConfigNamesMapper.
   *
   * @param $plugin_id
   *   The config mapper plugin ID.
94
   * @param mixed $plugin_definition
95 96 97 98 99 100 101 102 103
   *   An array of plugin information with the following keys:
   *   - title: The title of the mapper, used for generating page titles.
   *   - base_route_name: The route name of the base route this mapper is
   *     attached to.
   *   - names: (optional) An array of configuration names.
   *   - weight: (optional) The weight of this mapper, used in mapper listings.
   *     Defaults to 20.
   *   - list_controller: (optional) Class name for list controller used to
   *     generate lists of this type of configuration.
104
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
105
   *   The configuration factory.
106 107
   * @param \Drupal\Core\Config\TypedConfigManagerInterface $typed_config
   *   The typed configuration manager.
108 109 110 111
   * @param \Drupal\locale\LocaleConfigManager $locale_config_manager
   *   The locale configuration manager.
   * @param \Drupal\config_translation\ConfigMapperManagerInterface $config_mapper_manager
   *   The mapper plugin discovery service.
112
   * @param \Drupal\Core\Routing\RouteProviderInterface $route_provider
113
   *   The route provider.
114
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
115
   *   The string translation manager.
116 117
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
118 119 120 121 122
   *
   * @throws \Symfony\Component\Routing\Exception\RouteNotFoundException
   *   Throws an exception if the route specified by the 'base_route_name' in
   *   the plugin definition could not be found by the route provider.
   */
123
  public function __construct($plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory, TypedConfigManagerInterface $typed_config, LocaleConfigManager $locale_config_manager, ConfigMapperManagerInterface $config_mapper_manager, RouteProviderInterface $route_provider, TranslationInterface $string_translation, LanguageManagerInterface $language_manager) {
124 125
    $this->pluginId = $plugin_id;
    $this->pluginDefinition = $plugin_definition;
126
    $this->routeProvider = $route_provider;
127 128

    $this->configFactory = $config_factory;
129
    $this->typedConfigManager = $typed_config;
130 131 132
    $this->localeConfigManager = $locale_config_manager;
    $this->configMapperManager = $config_mapper_manager;

133
    $this->stringTranslation = $string_translation;
134
    $this->languageManager = $language_manager;
135 136 137 138 139
  }

  /**
   * {@inheritdoc}
   */
140
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
141 142 143 144 145 146
    // Note that we ignore the plugin $configuration because mappers have
    // nothing to configure in themselves.
    return new static (
      $plugin_id,
      $plugin_definition,
      $container->get('config.factory'),
147
      $container->get('config.typed'),
148
      $container->get('locale.config_manager'),
149 150
      $container->get('plugin.manager.config_translation.mapper'),
      $container->get('router.route_provider'),
151 152
      $container->get('string_translation'),
      $container->get('language_manager')
153 154 155
    );
  }

156 157 158 159 160 161 162
  /**
   * {@inheritdoc}
   */
  public function setRouteCollection(RouteCollection $collection) {
    $this->routeCollection = $collection;
  }

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
  /**
   * {@inheritdoc}
   */
  public function getTitle() {
    // A title from a *.config_translation.yml. Should be translated for
    // display in the current page language.
    return $this->t($this->pluginDefinition['title']);
  }

  /**
   * {@inheritdoc}
   */
  public function getBaseRouteName() {
    return $this->pluginDefinition['base_route_name'];
  }

  /**
   * {@inheritdoc}
   */
  public function getBaseRouteParameters() {
    return array();
  }

  /**
   * {@inheritdoc}
   */
  public function getBaseRoute() {
190 191 192 193 194 195
    if ($this->routeCollection) {
      return $this->routeCollection->get($this->getBaseRouteName());
    }
    else {
      return $this->routeProvider->getRouteByName($this->getBaseRouteName());
    }
196 197
  }

198 199 200 201 202 203 204 205 206
  /**
   * Allows to process all config translation routes.
   *
   * @param \Symfony\Component\Routing\Route $route
   *   The route object to process.
   */
  protected function processRoute(Route $route) {
  }

207 208 209 210
  /**
   * {@inheritdoc}
   */
  public function getBasePath() {
211
    return Url::fromRoute($this->getBaseRouteName(), $this->getBaseRouteParameters())->getInternalPath();
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
  }

  /**
   * {@inheritdoc}
   */
  public function getOverviewRouteName() {
    return 'config_translation.item.overview.' . $this->getBaseRouteName();
  }

  /**
   * {@inheritdoc}
   */
  public function getOverviewRouteParameters() {
    return $this->getBaseRouteParameters();
  }

  /**
   * {@inheritdoc}
   */
  public function getOverviewRoute() {
232
    $route = new Route(
233 234
      $this->getBaseRoute()->getPath() . '/translate',
      array(
235
        '_controller' => '\Drupal\config_translation\Controller\ConfigTranslationController::itemPage',
236 237 238 239
        'plugin_id' => $this->getPluginId(),
      ),
      array('_config_translation_overview_access' => 'TRUE')
    );
240 241
    $this->processRoute($route);
    return $route;
242 243 244 245 246 247
  }

  /**
   * {@inheritdoc}
   */
  public function getOverviewPath() {
248
    return Url::fromRoute($this->getOverviewRouteName(), $this->getOverviewRouteParameters())->getInternalPath();
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
  }

  /**
   * {@inheritdoc}
   */
  public function getAddRouteName() {
    return 'config_translation.item.add.' . $this->getBaseRouteName();
  }

  /**
   * {@inheritdoc}
   */
  public function getAddRouteParameters() {
    // If sub-classes provide route parameters in getBaseRouteParameters(), they
    // probably also want to provide those for the add, edit, and delete forms.
    $parameters = $this->getBaseRouteParameters();
    $parameters['langcode'] = $this->langcode;
    return $parameters;
  }

  /**
   * {@inheritdoc}
   */
  public function getAddRoute() {
273
    $route = new Route(
274 275 276 277 278 279 280
      $this->getBaseRoute()->getPath() . '/translate/{langcode}/add',
      array(
        '_form' => '\Drupal\config_translation\Form\ConfigTranslationAddForm',
        'plugin_id' => $this->getPluginId(),
      ),
      array('_config_translation_form_access' => 'TRUE')
    );
281 282
    $this->processRoute($route);
    return $route;
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
  }

  /**
   * {@inheritdoc}
   */
  public function getEditRouteName() {
    return 'config_translation.item.edit.' . $this->getBaseRouteName();
  }

  /**
   * {@inheritdoc}
   */
  public function getEditRouteParameters() {
    return $this->getAddRouteParameters();
  }

  /**
   * {@inheritdoc}
   */
  public function getEditRoute() {
303
    $route = new Route(
304 305 306 307 308 309 310
      $this->getBaseRoute()->getPath() . '/translate/{langcode}/edit',
      array(
        '_form' => '\Drupal\config_translation\Form\ConfigTranslationEditForm',
        'plugin_id' => $this->getPluginId(),
      ),
      array('_config_translation_form_access' => 'TRUE')
    );
311 312
    $this->processRoute($route);
    return $route;
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
  }

  /**
   * {@inheritdoc}
   */
  public function getDeleteRouteName() {
    return 'config_translation.item.delete.' . $this->getBaseRouteName();
  }

  /**
   * {@inheritdoc}
   */
  public function getDeleteRouteParameters() {
    return $this->getAddRouteParameters();
  }

  /**
   * {@inheritdoc}
   */
  public function getDeleteRoute() {
333
    $route = new Route(
334 335 336 337 338 339 340
      $this->getBaseRoute()->getPath() . '/translate/{langcode}/delete',
      array(
        '_form' => '\Drupal\config_translation\Form\ConfigTranslationDeleteForm',
        'plugin_id' => $this->getPluginId(),
      ),
      array('_config_translation_form_access' => 'TRUE')
    );
341 342
    $this->processRoute($route);
    return $route;
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
  }

  /**
   * {@inheritdoc}
   */
  public function getConfigNames() {
    return $this->pluginDefinition['names'];
  }

  /**
   * {@inheritdoc}
   */
  public function addConfigName($name) {
    $this->pluginDefinition['names'][] = $name;
  }

  /**
   * {@inheritdoc}
   */
  public function getWeight() {
    return $this->pluginDefinition['weight'];
  }

  /**
   * {@inheritdoc}
   */
369 370
  public function populateFromRouteMatch(RouteMatchInterface $route_match) {
    $this->langcode = $route_match->getParameter('langcode');
371 372 373 374 375 376 377 378 379 380 381 382 383
  }

  /**
   * {@inheritdoc}
   */
  public function getTypeLabel() {
    return $this->getTitle();
  }

  /**
   * {@inheritdoc}
   */
  public function getLangcode() {
384
    $langcodes = array_map([$this, 'getLangcodeFromConfig'], $this->getConfigNames());
385 386

    if (count(array_unique($langcodes)) > 1) {
387
      throw new ConfigMapperLanguageException('A config mapper can only contain configuration for a single language.');
388 389 390 391 392
    }

    return reset($langcodes);
  }

393 394 395 396 397 398 399 400 401 402 403
  /**
   * {@inheritdoc}
   */
  public function getLangcodeFromConfig($config_name) {
    // Default to English if no language code was provided in the file.
    // Although it is a best practice to include a language code, if the
    // developer did not think about a multilingual use case, we fall back
    // on assuming the file is English.
    return $this->configFactory->get($config_name)->get('langcode') ?: 'en';
  }

404 405 406 407 408 409 410 411
  /**
   * {@inheritdoc}
   */
  public function setLangcode($langcode) {
    $this->langcode = $langcode;
    return $this;
  }

412 413 414 415 416 417
  /**
   * {@inheritdoc}
   */
  public function getConfigData() {
    $config_data = array();
    foreach ($this->getConfigNames() as $name) {
418
      $config_data[$name] = $this->configFactory->getEditable($name)->get();
419 420 421 422 423 424 425 426 427
    }
    return $config_data;
  }

  /**
   * {@inheritdoc}
   */
  public function hasSchema() {
    foreach ($this->getConfigNames() as $name) {
428
      if (!$this->typedConfigManager->hasConfigSchema($name)) {
429 430 431 432 433 434 435 436 437 438 439
        return FALSE;
      }
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function hasTranslatable() {
    foreach ($this->getConfigNames() as $name) {
440 441
      if ($this->configMapperManager->hasTranslatable($name)) {
        return TRUE;
442 443
      }
    }
444
    return FALSE;
445 446 447 448 449
  }

  /**
   * {@inheritdoc}
   */
450
  public function hasTranslation(LanguageInterface $language) {
451
    foreach ($this->getConfigNames() as $name) {
452
      if ($this->localeConfigManager->hasTranslation($name, $language->getId())) {
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getTypeName() {
    return $this->t('Settings');
  }

  /**
   * {@inheritdoc}
   */
  public function getOperations() {
    return array(
      'translate' => array(
        'title' => $this->t('Translate'),
473
        'url' => Url::fromRoute($this->getOverviewRouteName(), $this->getOverviewRouteParameters()),
474 475 476 477 478 479 480 481 482 483 484 485
      ),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function getContextualLinkGroup() {
    return NULL;
  }

}