You are here

Home » API reference » Language Selection Page 8.2 » LanguageSelectionPageController.php

final class LanguageSelectionPageController in Language Selection Page 8.2

The LanguageSelectionPageController class.

Hierarchy

Expanded class hierarchy of LanguageSelectionPageController

1 file declares its use of LanguageSelectionPageController
LanguageSelectionPageBlock.php in src/Plugin/Block/LanguageSelectionPageBlock.php
1 string reference to 'LanguageSelectionPageController'
language_selection_page.services.yml in ./language_selection_page.services.yml
language_selection_page.services.yml
1 service uses LanguageSelectionPageController
language_selection_page_controller in ./language_selection_page.services.yml
\Drupal\language_selection_page\Controller\LanguageSelectionPageController

File

src/Controller/LanguageSelectionPageController.php, line 16

Namespace

Drupal\language_selection_page\Controller
View source 
final class LanguageSelectionPageController extends ControllerBase {

  /**
   * The plugin manager.
   *
   * @var \Drupal\Core\Executable\ExecutableManagerInterface
   */
  protected $pluginManager;

  /**
   * PageController constructor.
   *
   * @param \Drupal\Core\Executable\ExecutableManagerInterface $plugin_manager
   *   The plugin manager service.
   */
  public function __construct(ExecutableManagerInterface $plugin_manager) {
    $this->pluginManager = $plugin_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new self($container
      ->get('plugin.manager.language_selection_page_condition'));
  }

  /**
   * Get the destination.
   *
   * Loop through each plugins to find it.
   *
   * @param string $destination
   *   The destination.
   *
   * @return string
   *   The destination.
   */
  public function getDestination($destination = NULL) {
    $config = $this
      ->config('language_selection_page.negotiation');
    foreach ($this->pluginManager
      ->getDefinitions() as $def) {
      $destination = $this->pluginManager
        ->createInstance($def['id'], $config
        ->get())
        ->getDestination($destination);
    }
    return $destination;
  }

  /**
   * Get the content of the Language Selection Page.
   *
   * Method used in LanguageSelectionPageController::main().
   *
   * @param string $destination
   *   The destination.
   *
   * @return array
   *   A render array.
   */
  public function getPageContent($destination = '<front>') {
    $config = $this
      ->config('language_selection_page.negotiation');
    $content = [];

    // Alter the render array.
    foreach ($this->pluginManager
      ->getDefinitions() as $def) {
      $this->pluginManager
        ->createInstance($def['id'], $config
        ->get())
        ->alterPageContent($content, $destination);
    }
    return $content;
  }

  /**
   * Get the response.
   *
   * @param array $response
   *   The content array.
   *
   * @return array|\Symfony\Component\HttpFoundation\Response
   *   A response or a render array.
   */
  public function getPageResponse(array $response) {
    $config = $this
      ->config('language_selection_page.negotiation');
    foreach ($this->pluginManager
      ->getDefinitions() as $def) {
      $this->pluginManager
        ->createInstance($def['id'], $config
        ->get())
        ->alterPageResponse($response);
    }
    return $response;
  }

  /**
   * Page callback.
   */
  public function main() {
    $config = $this
      ->config('language_selection_page.negotiation');
    $destination = $this
      ->getDestination();

    // Check $destination is valid.
    // If the path is set to $destination, redirect the user to the
    // front page to avoid infinite loops.
    if (empty($destination) || trim($destination, '/') === trim($config
      ->get('path'), '/')) {
      return new RedirectResponse(Url::fromRoute('<front>')
        ->setAbsolute()
        ->toString());
    }
    return $this
      ->getPageResponse($this
      ->getPageContent($destination));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 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.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
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::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LanguageSelectionPageController::$pluginManager protected property The plugin manager.
LanguageSelectionPageController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
LanguageSelectionPageController::getDestination public function Get the destination.
LanguageSelectionPageController::getPageContent public function Get the content of the Language Selection Page.
LanguageSelectionPageController::getPageResponse public function Get the response.
LanguageSelectionPageController::main public function Page callback.
LanguageSelectionPageController::__construct public function PageController constructor.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
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. 1
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 Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.