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

namespace Drupal\config_translation;

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

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

  /**
   * The configuration factory.
   *
32
   * @var \Drupal\Core\Config\ConfigFactoryInterface
33 34 35
   */
  protected $configFactory;

36 37 38 39 40 41 42
  /**
   * The typed config manager.
   *
   * @var \Drupal\Core\Config\TypedConfigManagerInterface
   */
  protected $typedConfigManager;

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

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

57 58 59 60 61 62 63
  /**
   * The route provider.
   *
   * @var \Drupal\Core\Routing\RouteProviderInterface
   */
  protected $routeProvider;

64 65 66
  /**
   * The base route object that the mapper is attached to.
   *
67
   * @var \Symfony\Component\Routing\Route
68 69 70
   */
  protected $baseRoute;

71 72 73 74 75 76 77
  /**
   * The available routes.
   *
   * @var \Symfony\Component\Routing\RouteCollection
   */
  protected $routeCollection;

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

85 86 87 88 89 90 91
  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

92 93 94
  /**
   * The event dispatcher.
   *
95
   * @var \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
96 97 98
   */
  protected $eventDispatcher;

99 100 101 102 103
  /**
   * Constructs a ConfigNamesMapper.
   *
   * @param $plugin_id
   *   The config mapper plugin ID.
104
   * @param mixed $plugin_definition
105 106 107 108 109 110 111 112 113
   *   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.
114
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
115
   *   The configuration factory.
116 117
   * @param \Drupal\Core\Config\TypedConfigManagerInterface $typed_config
   *   The typed configuration manager.
118 119 120 121
   * @param \Drupal\locale\LocaleConfigManager $locale_config_manager
   *   The locale configuration manager.
   * @param \Drupal\config_translation\ConfigMapperManagerInterface $config_mapper_manager
   *   The mapper plugin discovery service.
122
   * @param \Drupal\Core\Routing\RouteProviderInterface $route_provider
123
   *   The route provider.
124
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
125
   *   The string translation manager.
126 127
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
128
   * @param \Symfony\Contracts\EventDispatcher\EventDispatcherInterface $event_dispatcher
129
   *   (optional) The event dispatcher.
130 131 132 133 134
   *
   * @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.
   */
135
  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, EventDispatcherInterface $event_dispatcher = NULL) {
136 137
    $this->pluginId = $plugin_id;
    $this->pluginDefinition = $plugin_definition;
138
    $this->routeProvider = $route_provider;
139 140

    $this->configFactory = $config_factory;
141
    $this->typedConfigManager = $typed_config;
142 143 144
    $this->localeConfigManager = $locale_config_manager;
    $this->configMapperManager = $config_mapper_manager;

145
    $this->stringTranslation = $string_translation;
146
    $this->languageManager = $language_manager;
147
    $this->eventDispatcher = $event_dispatcher ?: \Drupal::service('event_dispatcher');
148 149 150 151 152
  }

  /**
   * {@inheritdoc}
   */
153
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
154 155
    // Note that we ignore the plugin $configuration because mappers have
    // nothing to configure in themselves.
156
    return new static(
157 158 159
      $plugin_id,
      $plugin_definition,
      $container->get('config.factory'),
160
      $container->get('config.typed'),
161
      $container->get('locale.config_manager'),
162 163
      $container->get('plugin.manager.config_translation.mapper'),
      $container->get('router.route_provider'),
164
      $container->get('string_translation'),
165 166
      $container->get('language_manager'),
      $container->get('event_dispatcher')
167 168 169
    );
  }

170 171 172 173 174 175 176
  /**
   * {@inheritdoc}
   */
  public function setRouteCollection(RouteCollection $collection) {
    $this->routeCollection = $collection;
  }

177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
  /**
   * {@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() {
197
    return [];
198 199 200 201 202 203
  }

  /**
   * {@inheritdoc}
   */
  public function getBaseRoute() {
204 205 206 207 208 209
    if ($this->routeCollection) {
      return $this->routeCollection->get($this->getBaseRouteName());
    }
    else {
      return $this->routeProvider->getRouteByName($this->getBaseRouteName());
    }
210 211
  }

212 213 214 215 216 217 218 219 220
  /**
   * Allows to process all config translation routes.
   *
   * @param \Symfony\Component\Routing\Route $route
   *   The route object to process.
   */
  protected function processRoute(Route $route) {
  }

221 222 223 224
  /**
   * {@inheritdoc}
   */
  public function getBasePath() {
225
    return Url::fromRoute($this->getBaseRouteName(), $this->getBaseRouteParameters())->getInternalPath();
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getOverviewRoute() {
246
    $route = new Route(
247
      $this->getBaseRoute()->getPath() . '/translate',
248
      [
249
        '_controller' => '\Drupal\config_translation\Controller\ConfigTranslationController::itemPage',
250
        'plugin_id' => $this->getPluginId(),
251 252
      ],
      ['_config_translation_overview_access' => 'TRUE']
253
    );
254 255
    $this->processRoute($route);
    return $route;
256 257 258 259 260 261
  }

  /**
   * {@inheritdoc}
   */
  public function getOverviewPath() {
262
    return Url::fromRoute($this->getOverviewRouteName(), $this->getOverviewRouteParameters())->getInternalPath();
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
  }

  /**
   * {@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() {
287
    $route = new Route(
288
      $this->getBaseRoute()->getPath() . '/translate/{langcode}/add',
289
      [
290 291
        '_form' => '\Drupal\config_translation\Form\ConfigTranslationAddForm',
        'plugin_id' => $this->getPluginId(),
292 293
      ],
      ['_config_translation_form_access' => 'TRUE']
294
    );
295 296
    $this->processRoute($route);
    return $route;
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getEditRoute() {
317
    $route = new Route(
318
      $this->getBaseRoute()->getPath() . '/translate/{langcode}/edit',
319
      [
320 321
        '_form' => '\Drupal\config_translation\Form\ConfigTranslationEditForm',
        'plugin_id' => $this->getPluginId(),
322 323
      ],
      ['_config_translation_form_access' => 'TRUE']
324
    );
325 326
    $this->processRoute($route);
    return $route;
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getDeleteRoute() {
347
    $route = new Route(
348
      $this->getBaseRoute()->getPath() . '/translate/{langcode}/delete',
349
      [
350 351
        '_form' => '\Drupal\config_translation\Form\ConfigTranslationDeleteForm',
        'plugin_id' => $this->getPluginId(),
352 353
      ],
      ['_config_translation_form_access' => 'TRUE']
354
    );
355 356
    $this->processRoute($route);
    return $route;
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
  }

  /**
   * {@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}
   */
383 384
  public function populateFromRouteMatch(RouteMatchInterface $route_match) {
    $this->langcode = $route_match->getParameter('langcode');
385 386

    $event = new ConfigMapperPopulateEvent($this, $route_match);
387
    $this->eventDispatcher->dispatch($event, ConfigTranslationEvents::POPULATE_MAPPER);
388 389 390 391 392 393 394 395 396 397 398 399 400
  }

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

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

    if (count(array_unique($langcodes)) > 1) {
404
      throw new ConfigMapperLanguageException('A config mapper can only contain configuration for a single language.');
405 406 407 408 409
    }

    return reset($langcodes);
  }

410 411 412 413 414 415 416 417 418 419 420
  /**
   * {@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';
  }

421 422 423 424 425 426 427 428
  /**
   * {@inheritdoc}
   */
  public function setLangcode($langcode) {
    $this->langcode = $langcode;
    return $this;
  }

429 430 431 432
  /**
   * {@inheritdoc}
   */
  public function getConfigData() {
433
    $config_data = [];
434
    foreach ($this->getConfigNames() as $name) {
435
      $config_data[$name] = $this->configFactory->getEditable($name)->get();
436 437 438 439 440 441 442 443 444
    }
    return $config_data;
  }

  /**
   * {@inheritdoc}
   */
  public function hasSchema() {
    foreach ($this->getConfigNames() as $name) {
445
      if (!$this->typedConfigManager->hasConfigSchema($name)) {
446 447 448 449 450 451 452 453 454 455 456
        return FALSE;
      }
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function hasTranslatable() {
    foreach ($this->getConfigNames() as $name) {
457 458
      if ($this->configMapperManager->hasTranslatable($name)) {
        return TRUE;
459 460
      }
    }
461
    return FALSE;
462 463 464 465 466
  }

  /**
   * {@inheritdoc}
   */
467
  public function hasTranslation(LanguageInterface $language) {
468
    foreach ($this->getConfigNames() as $name) {
469
      if ($this->localeConfigManager->hasTranslation($name, $language->getId())) {
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
        return TRUE;
      }
    }
    return FALSE;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getOperations() {
487 488
    return [
      'translate' => [
489
        'title' => $this->t('Translate'),
490
        'url' => Url::fromRoute($this->getOverviewRouteName(), $this->getOverviewRouteParameters()),
491 492
      ],
    ];
493 494 495 496 497 498 499 500 501 502
  }

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

}