You are here

Home » API reference » External Links Extra 8 » ExtlinkExtraController.php

class ExtlinkExtraController in External Links Extra 8

Hierarchy

Expanded class hierarchy of ExtlinkExtraController

File

src/Controller/ExtlinkExtraController.php, line 14

Namespace

Drupal\extlink_extra\Controller
View source 
class ExtlinkExtraController extends ControllerBase {

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

  /**
   * The token service.
   *
   * @var \Drupal\Core\Utility\Token
   */
  protected $token;

  /**
   * The request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory, Token $token, RequestStack $request_stack, RendererInterface $renderer) {
    $this->configFactory = $config_factory;
    $this->token = $token;
    $this->requestStack = $request_stack;
    $this->renderer = $renderer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('token'), $container
      ->get('request_stack'), $container
      ->get('renderer'));
  }

  /**
   * Title callback.
   *
   * @return string
   */
  public function getTitle() {

    // Get configuration.
    $config = $this->configFactory
      ->get('extlink_extra.settings');

    // Prepare token replacement values.
    $extlink_token_data = [
      'extlink' => [
        'external_url' => isset($_COOKIE['external_url']) ? $_COOKIE['external_url'] : NULL,
        'back_url' => isset($_COOKIE['back_url']) ? $_COOKIE['back_url'] : NULL,
      ],
    ];

    // Fetch the page title and return it after replacing the tokens.
    $page_title = $config
      ->get('extlink_page_title') ?: NULL;
    return $this->token
      ->replace($page_title, $extlink_token_data);
  }

  /**
   * Render the markup for the exit modal.
   *
   * @see extlink_extra_preprocess_extlink_extra_leaving()
   *
   * @return array
   */
  public function leave() {

    // Just return the template. Variables will be inserted
    // in extlink_extra_preprocess_extlink_extra_leaving().
    $output = [
      '#theme' => 'extlink_extra_leaving',
    ];

    // If we are using Colorbox we will add colorbox=1 to the query string of the
    // alert page. This causes a premature exit which saves execution time and
    // does not render the rest of the page.
    if ($this->requestStack
      ->getCurrentRequest()->request
      ->get('colorbox')) {
      $html = $this->renderer
        ->render($output);
      return new HtmlResponse($html);
    }
    return $output;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
ExtlinkExtraController::$configFactory protected property The configuration factory. Overrides ControllerBase::$configFactory
ExtlinkExtraController::$renderer protected property The renderer service.
ExtlinkExtraController::$requestStack protected property The request stack.
ExtlinkExtraController::$token protected property The token service.
ExtlinkExtraController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
ExtlinkExtraController::getTitle public function Title callback.
ExtlinkExtraController::leave public function Render the markup for the exit modal.
ExtlinkExtraController::__construct public function
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.