You are here

Home » API reference » Zircon Profile 8 » ConfigTranslationController.php

class ConfigTranslationController in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/config_translation/src/Controller/ConfigTranslationController.php \Drupal\config_translation\Controller\ConfigTranslationController

Provides page callbacks for the configuration translation interface.

Hierarchy

Expanded class hierarchy of ConfigTranslationController

File

core/modules/config_translation/src/Controller/ConfigTranslationController.php, line 27
Contains \Drupal\config_translation\Controller\ConfigTranslationController.

Namespace

Drupal\config_translation\Controller
View source 
class ConfigTranslationController extends ControllerBase {

  /**
   * The configuration mapper manager.
   *
   * @var \Drupal\config_translation\ConfigMapperManagerInterface
   */
  protected $configMapperManager;

  /**
   * The menu link access service.
   *
   * @var \Drupal\Core\Access\AccessManagerInterface
   */
  protected $accessManager;

  /**
   * The dynamic router service.
   *
   * @var \Symfony\Component\Routing\Matcher\RequestMatcherInterface
   */
  protected $router;

  /**
   * The path processor service.
   *
   * @var \Drupal\Core\PathProcessor\InboundPathProcessorInterface
   */
  protected $pathProcessor;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $account;

  /**
   * The language manager.
   *
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   */
  protected $languageManager;

  /**
   * Constructs a ConfigTranslationController.
   *
   * @param \Drupal\config_translation\ConfigMapperManagerInterface $config_mapper_manager
   *   The configuration mapper manager.
   * @param \Drupal\Core\Access\AccessManagerInterface $access_manager
   *   The menu link access service.
   * @param \Symfony\Component\Routing\Matcher\RequestMatcherInterface $router
   *   The dynamic router service.
   * @param \Drupal\Core\PathProcessor\InboundPathProcessorInterface $path_processor
   *   The inbound path processor.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The current user.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   */
  public function __construct(ConfigMapperManagerInterface $config_mapper_manager, AccessManagerInterface $access_manager, RequestMatcherInterface $router, InboundPathProcessorInterface $path_processor, AccountInterface $account, LanguageManagerInterface $language_manager) {
    $this->configMapperManager = $config_mapper_manager;
    $this->accessManager = $access_manager;
    $this->router = $router;
    $this->pathProcessor = $path_processor;
    $this->account = $account;
    $this->languageManager = $language_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.config_translation.mapper'), $container
      ->get('access_manager'), $container
      ->get('router'), $container
      ->get('path_processor_manager'), $container
      ->get('current_user'), $container
      ->get('language_manager'));
  }

  /**
   * Language translations overview page for a configuration name.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   Page request object.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   * @param string $plugin_id
   *   The plugin ID of the mapper.
   *
   * @return array
   *   Page render array.
   */
  public function itemPage(Request $request, RouteMatchInterface $route_match, $plugin_id) {

    /** @var \Drupal\config_translation\ConfigMapperInterface $mapper */
    $mapper = $this->configMapperManager
      ->createInstance($plugin_id);
    $mapper
      ->populateFromRouteMatch($route_match);
    $page = array();
    $page['#title'] = $this
      ->t('Translations for %label', array(
      '%label' => $mapper
        ->getTitle(),
    ));
    $languages = $this->languageManager
      ->getLanguages();
    if (count($languages) == 1) {
      drupal_set_message($this
        ->t('In order to translate configuration, the website must have at least two <a href=":url">languages</a>.', array(
        ':url' => $this
          ->url('entity.configurable_language.collection'),
      )), 'warning');
    }
    $original_langcode = $mapper
      ->getLangcode();
    if (!isset($languages[$original_langcode])) {

      // If the language is not configured on the site, create a dummy language
      // object for this listing only to ensure the user gets useful info.
      $language_name = $this->languageManager
        ->getLanguageName($original_langcode);
      $languages[$original_langcode] = new Language(array(
        'id' => $original_langcode,
        'name' => $language_name,
      ));
    }

    // We create a fake request object to pass into
    // ConfigMapperInterface::populateFromRouteMatch() for the different languages.
    // Creating a separate request for each language and route is neither easily
    // possible nor performant.
    $fake_request = $request
      ->duplicate();
    $page['languages'] = array(
      '#type' => 'table',
      '#header' => array(
        $this
          ->t('Language'),
        $this
          ->t('Operations'),
      ),
    );
    foreach ($languages as $language) {
      $langcode = $language
        ->getId();

      // This is needed because
      // ConfigMapperInterface::getAddRouteParameters(), for example,
      // needs to return the correct language code for each table row.
      $fake_route_match = RouteMatch::createFromRequest($fake_request);
      $mapper
        ->populateFromRouteMatch($fake_route_match);
      $mapper
        ->setLangcode($langcode);

      // Prepare the language name and the operations depending on whether this
      // is the original language or not.
      if ($langcode == $original_langcode) {
        $language_name = '<strong>' . $this
          ->t('@language (original)', array(
          '@language' => $language
            ->getName(),
        )) . '</strong>';

        // Check access for the path/route for editing, so we can decide to
        // include a link to edit or not.
        $edit_access = $this->accessManager
          ->checkNamedRoute($mapper
          ->getBaseRouteName(), $route_match
          ->getRawParameters()
          ->all(), $this->account);

        // Build list of operations.
        $operations = array();
        if ($edit_access) {
          $operations['edit'] = array(
            'title' => $this
              ->t('Edit'),
            'url' => Url::fromRoute($mapper
              ->getBaseRouteName(), $mapper
              ->getBaseRouteParameters(), [
              'query' => [
                'destination' => $mapper
                  ->getOverviewPath(),
              ],
            ]),
          );
        }
      }
      else {
        $language_name = $language
          ->getName();
        $operations = array();

        // If no translation exists for this language, link to add one.
        if (!$mapper
          ->hasTranslation($language)) {
          $operations['add'] = array(
            'title' => $this
              ->t('Add'),
            'url' => Url::fromRoute($mapper
              ->getAddRouteName(), $mapper
              ->getAddRouteParameters()),
          );
        }
        else {

          // Otherwise, link to edit the existing translation.
          $operations['edit'] = array(
            'title' => $this
              ->t('Edit'),
            'url' => Url::fromRoute($mapper
              ->getEditRouteName(), $mapper
              ->getEditRouteParameters()),
          );
          $operations['delete'] = array(
            'title' => $this
              ->t('Delete'),
            'url' => Url::fromRoute($mapper
              ->getDeleteRouteName(), $mapper
              ->getDeleteRouteParameters()),
          );
        }
      }
      $page['languages'][$langcode]['language'] = array(
        '#markup' => $language_name,
      );
      $page['languages'][$langcode]['operations'] = array(
        '#type' => 'operations',
        '#links' => $operations,
      );
    }
    return $page;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigTranslationController::$accessManager protected property The menu link access service.
ConfigTranslationController::$account protected property The current user.
ConfigTranslationController::$configMapperManager protected property The configuration mapper manager.
ConfigTranslationController::$languageManager protected property The language manager. Overrides ControllerBase::$languageManager
ConfigTranslationController::$pathProcessor protected property The path processor service.
ConfigTranslationController::$router protected property The dynamic router service.
ConfigTranslationController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
ConfigTranslationController::itemPage public function Language translations overview page for a configuration name.
ConfigTranslationController::__construct public function Constructs a ConfigTranslationController.
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager. 1
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 3
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service. 1
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 3
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator protected function Returns the link generator.
LinkGeneratorTrait::l protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator public function Sets the link generator service.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service.
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator protected function Returns the URL generator service.
UrlGeneratorTrait::redirect protected function Returns a redirect response object for the specified route.
UrlGeneratorTrait::setUrlGenerator public function Sets the URL generator service.
UrlGeneratorTrait::url protected function Generates a URL or path for a specific route based on the given parameters.