ConfigNamesMapper.php 12.9 KB
Newer Older
1 2 3 4 5 6 7 8 9
<?php

/**
 * @file
 * Contains \Drupal\config_translation\ConfigNamesMapper.
 */

namespace Drupal\config_translation;

10
use Drupal\Core\Config\ConfigFactoryInterface;
11
use Drupal\Core\Language\Language;
12
use Drupal\Core\Language\LanguageInterface;
13 14 15 16 17 18 19 20
use Drupal\Core\Plugin\PluginBase;
use Drupal\Core\Routing\RouteProviderInterface;
use Drupal\Core\StringTranslation\TranslationInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\locale\LocaleConfigManager;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Routing\Route;
21
use Symfony\Component\Routing\RouteCollection;
22 23 24 25 26 27 28 29 30

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

  /**
   * The configuration factory.
   *
31
   * @var \Drupal\Core\Config\ConfigFactoryInterface
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
   */
  protected $configFactory;

  /**
   * The typed configuration manager.
   *
   * @var \Drupal\locale\LocaleConfigManager
   */
  protected $localeConfigManager;

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

49 50 51 52 53 54 55
  /**
   * The route provider.
   *
   * @var \Drupal\Core\Routing\RouteProviderInterface
   */
  protected $routeProvider;

56 57 58 59 60 61 62
  /**
   * The base route object that the mapper is attached to.
   *
   * @return \Symfony\Component\Routing\Route
   */
  protected $baseRoute;

63 64 65 66 67 68 69
  /**
   * The available routes.
   *
   * @var \Symfony\Component\Routing\RouteCollection
   */
  protected $routeCollection;

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

  /**
   * Constructs a ConfigNamesMapper.
   *
   * @param $plugin_id
   *   The config mapper plugin ID.
82
   * @param mixed $plugin_definition
83 84 85 86 87 88 89 90 91
   *   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.
92
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
93 94 95 96 97 98 99
   *   The configuration factory.
   * @param \Drupal\locale\LocaleConfigManager $locale_config_manager
   *   The locale configuration manager.
   * @param \Drupal\config_translation\ConfigMapperManagerInterface $config_mapper_manager
   *   The mapper plugin discovery service.
   * @param \Drupal\Core\Routing\RouteProviderInterface
   *   The route provider.
100
   * @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
101 102 103 104 105 106
   *   The string translation manager.
   *
   * @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.
   */
107
  public function __construct($plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory, LocaleConfigManager $locale_config_manager, ConfigMapperManagerInterface $config_mapper_manager, RouteProviderInterface $route_provider, TranslationInterface $string_translation) {
108 109
    $this->pluginId = $plugin_id;
    $this->pluginDefinition = $plugin_definition;
110
    $this->routeProvider = $route_provider;
111 112 113 114 115

    $this->configFactory = $config_factory;
    $this->localeConfigManager = $locale_config_manager;
    $this->configMapperManager = $config_mapper_manager;

116
    $this->stringTranslation = $string_translation;
117 118 119 120 121
  }

  /**
   * {@inheritdoc}
   */
122
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
123 124 125 126 127 128 129 130 131 132 133 134 135
    // 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'),
      $container->get('locale.config.typed'),
      $container->get('plugin.manager.config_translation.mapper'),
      $container->get('router.route_provider'),
      $container->get('string_translation')
    );
  }

136 137 138 139 140 141 142
  /**
   * {@inheritdoc}
   */
  public function setRouteCollection(RouteCollection $collection) {
    $this->routeCollection = $collection;
  }

143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
  /**
   * {@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() {
170 171 172 173 174 175
    if ($this->routeCollection) {
      return $this->routeCollection->get($this->getBaseRouteName());
    }
    else {
      return $this->routeProvider->getRouteByName($this->getBaseRouteName());
    }
176 177
  }

178 179 180 181 182 183 184 185 186
  /**
   * Allows to process all config translation routes.
   *
   * @param \Symfony\Component\Routing\Route $route
   *   The route object to process.
   */
  protected function processRoute(Route $route) {
  }

187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
  /**
   * {@inheritdoc}
   */
  public function getBasePath() {
    return $this->getPathFromRoute($this->getBaseRoute(), $this->getBaseRouteParameters());
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getOverviewRoute() {
212
    $route = new Route(
213 214
      $this->getBaseRoute()->getPath() . '/translate',
      array(
215
        '_content' => '\Drupal\config_translation\Controller\ConfigTranslationController::itemPage',
216 217 218 219
        'plugin_id' => $this->getPluginId(),
      ),
      array('_config_translation_overview_access' => 'TRUE')
    );
220 221
    $this->processRoute($route);
    return $route;
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
  }

  /**
   * {@inheritdoc}
   */
  public function getOverviewPath() {
    return $this->getPathFromRoute($this->getOverviewRoute(), $this->getOverviewRouteParameters());
  }

  /**
   * {@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() {
253
    $route = new Route(
254 255 256 257 258 259 260
      $this->getBaseRoute()->getPath() . '/translate/{langcode}/add',
      array(
        '_form' => '\Drupal\config_translation\Form\ConfigTranslationAddForm',
        'plugin_id' => $this->getPluginId(),
      ),
      array('_config_translation_form_access' => 'TRUE')
    );
261 262
    $this->processRoute($route);
    return $route;
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getEditRoute() {
283
    $route = new Route(
284 285 286 287 288 289 290
      $this->getBaseRoute()->getPath() . '/translate/{langcode}/edit',
      array(
        '_form' => '\Drupal\config_translation\Form\ConfigTranslationEditForm',
        'plugin_id' => $this->getPluginId(),
      ),
      array('_config_translation_form_access' => 'TRUE')
    );
291 292
    $this->processRoute($route);
    return $route;
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getDeleteRoute() {
313
    $route = new Route(
314 315 316 317 318 319 320
      $this->getBaseRoute()->getPath() . '/translate/{langcode}/delete',
      array(
        '_form' => '\Drupal\config_translation\Form\ConfigTranslationDeleteForm',
        'plugin_id' => $this->getPluginId(),
      ),
      array('_config_translation_form_access' => 'TRUE')
    );
321 322
    $this->processRoute($route);
    return $route;
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 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 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
  }

  /**
   * Gets the path for a certain route, given a set of route parameters.
   *
   * @param \Symfony\Component\Routing\Route $route
   *   The route object.
   * @param array $parameters
   *   An array of route parameters.
   *
   * @return string
   *   Processed path with placeholders replaced.
   */
  public function getPathFromRoute(Route $route, array $parameters) {
    $path = $route->getPath();
    foreach ($parameters as $key => $value) {
      $path = str_replace('{' . $key . '}', $value, $path);
    }
    return $path;
  }

  /**
   * {@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}
   */
  public function populateFromRequest(Request $request) {
    if ($request->attributes->has('langcode')) {
      $this->langcode = $request->attributes->get('langcode');
    }
    else {
      $this->langcode = NULL;
    }
  }

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

  /**
   * {@inheritdoc}
   */
  public function getLangcode() {
    $config_factory = $this->configFactory;
    $langcodes = array_map(function($name) use ($config_factory) {
      // 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 $config_factory->get($name)->get('langcode') ?: 'en';
    }, $this->getConfigNames());

    if (count(array_unique($langcodes)) > 1) {
      throw new \RuntimeException('A config mapper can only contain configuration for a single language.');
    }

    return reset($langcodes);
  }

  /**
   * {@inheritdoc}
   */
  public function getLanguageWithFallback() {
    $langcode = $this->getLangcode();
    $language = language_load($langcode);
    // If the language of the file is English but English is not a configured
    // language on the site, create a mock language object to represent this
    // language run-time. In this case, the title of the language is
    // 'Built-in English' because we assume such configuration is shipped with
    // core and the modules and not custom created. (In the later case an
    // English language configured on the site is assumed.)
    if (empty($language) && $langcode == 'en') {
      $language = new Language(array('id' => 'en', 'name' => $this->t('Built-in English')));
    }
    return $language;
  }

  /**
   * {@inheritdoc}
   */
  public function getConfigData() {
    $config_data = array();
    foreach ($this->getConfigNames() as $name) {
      $config_data[$name] = $this->configFactory->get($name)->get();
    }
    return $config_data;
  }

  /**
   * {@inheritdoc}
   */
  public function hasSchema() {
    foreach ($this->getConfigNames() as $name) {
      if (!$this->localeConfigManager->hasConfigSchema($name)) {
        return FALSE;
      }
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function hasTranslatable() {
    foreach ($this->getConfigNames() as $name) {
      if (!$this->configMapperManager->hasTranslatable($name)) {
        return FALSE;
      }
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
460
  public function hasTranslation(LanguageInterface $language) {
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
    foreach ($this->getConfigNames() as $name) {
      if ($this->localeConfigManager->hasTranslation($name, $language)) {
        return TRUE;
      }
    }
    return FALSE;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getOperations() {
    return array(
      'translate' => array(
        'title' => $this->t('Translate'),
        'href' => $this->getOverviewPath(),
      ),
    );
  }

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

}