class HighContrastController in High contrast 8

This class handles the enabling and disabling of high contrast mode.

@todo This feels somewhat hackish... There is probably a proper core implementation for this.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\high_contrast\HighContrastController uses HighContrastTrait

File

src/HighContrastController.php, line 13

Namespace

Drupal\high_contrast

class HighContrastController extends ControllerBase {
  use HighContrastTrait;

  /**
   * Holds the redirect path for after enabling high contrast.
   *
   * @var string
   */
  protected $redirectDestination;

  /**
   * Fetch and store the redirect path.
   */
  public function __construct() {
    $this->redirectDestination = \Drupal::request()->query
      ->get('destination');
  }

  /**
   * Enable high contrast.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   RedirectResponse object.
   */
  public function enable() {
    $this
      ->enableHighContrast();
    return $this
      ->goBack();
  }

  /**
   * Disable high contrast.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   RedirectResponse object.
   */
  public function disable() {
    $this
      ->disableHighContrast();
    return $this
      ->goBack();
  }

  /**
   * Perform the redirect to the set path.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   RedirectResponse object.
   */
  protected function goBack() {
    return new RedirectResponse($this->redirectDestination);
  }

}

Members

Name	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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	40
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.
HighContrastController::$redirectDestination	protected	property	Holds the redirect path for after enabling high contrast. Overrides RedirectDestinationTrait::$redirectDestination
HighContrastController::disable	public	function	Disable high contrast.
HighContrastController::enable	public	function	Enable high contrast.
HighContrastController::goBack	protected	function	Perform the redirect to the set path.
HighContrastController::__construct	public	function	Fetch and store the redirect path.
HighContrastTrait::disableHighContrast	public	function	Disables high contrast mode.
HighContrastTrait::enableHighContrast	public	function	Enables high contrast mode.
HighContrastTrait::highContrastEnabled	public static	function	Return if high contrast is enabled or not.
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::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.