class CasRedirectData in CAS 8

Class CasRedirectData.

Hierarchy

• class \Drupal\cas\CasRedirectData

6 files declare their use of CasRedirectData

CasPreRedirectEvent.php in src/Event/CasPreRedirectEvent.php

CasRedirectDataTest.php in tests/src/Unit/CasRedirectDataTest.php

CasRedirector.php in src/Service/CasRedirector.php

CasRedirectorTest.php in tests/src/Unit/Service/CasRedirectorTest.php

CasSubscriber.php in src/Subscriber/CasSubscriber.php

... See full list

File

src/CasRedirectData.php, line 8

Namespace

Drupal\cas

class CasRedirectData {

  /**
   * Parameters used when redirecting to the cas server.
   *
   * @var array
   */
  protected $redirectParameters = [];

  /**
   * Parameters to add to the service_url when requesting redirect.
   *
   * @var array
   */
  protected $serviceParameters = [];

  /**
   * Indicates whether the redirect will occur.
   *
   * @var bool
   */
  protected $willRedirect = TRUE;

  /**
   * Indicates whether the redirect response can be cached.
   *
   * @var bool
   */
  protected $isCacheable = FALSE;

  /**
   * Cache tags to apply to cachable redirect responses.
   *
   * @var array
   */
  protected $cacheTags = [
    'config:cas.settings',
  ];

  /**
   * Cache contexts to apply to cacheable redirect responses.
   *
   * We need to vary the redirect response based on the URL because:
   * 1. The site domain is included in the service parameter in the redirect.
   * 2. Paramters on the URL are passed along as query params to the service
   * URL as well.
   *
   * @var array
   */
  protected $cacheContexts = [
    'url',
  ];

  /**
   * CasRedirectData constructor.
   *
   * @param array $service_parameters
   *   Default service parameters.
   * @param array $redirect_parameters
   *   Default redirect parameters.
   */
  public function __construct(array $service_parameters = [], array $redirect_parameters = []) {
    $this->serviceParameters = $service_parameters;
    $this->redirectParameters = $redirect_parameters;
  }

  /**
   * Set a redirection parameter.
   *
   * Sets a redirect parameter that will later be used in the redirection
   * request. NULL values will cause the parameter to be unset, but not
   * when they are required.
   *
   * @param string $key
   *   Key of parameter to set.
   * @param mixed $value
   *   Value of parramter to set.
   */
  public function setParameter($key, $value) {
    if (empty($value)) {
      unset($this->redirectParameters[$key]);
    }
    else {
      $this->redirectParameters[$key] = $value;
    }
  }

  /**
   * Returns the redirect parameter specified by $key.
   *
   * @param string $key
   *   Parameter to select.
   *
   * @return mixed
   *   Value of the parameter.
   */
  public function getParameter($key) {
    return isset($this->redirectParameters[$key]) ? $this->redirectParameters[$key] : NULL;
  }

  /**
   * Returns all parameters that will be used in redirect.
   *
   * @return array
   *   Array representation of all redirect parameters.
   */
  public function getAllParameters() {
    return $this->redirectParameters;
  }

  /**
   * Set a service paramater.
   *
   * @param string $key
   *   Service parameter to set.
   * @param mixed $value
   *   Value of service parmaeter to set.
   */
  public function setServiceParameter($key, $value) {
    if (empty($value)) {
      unset($this->serviceParameters[$key]);
    }
    else {
      $this->serviceParameters[$key] = $value;
    }
  }

  /**
   * Returns the redirect parameter specified by $key.
   *
   * @param string $key
   *   Parameter to select.
   *
   * @return string
   *   Value of the attribute.
   */
  public function getServiceParameter($key) {
    return isset($this->serviceParameters[$key]) ? $this->serviceParameters[$key] : NULL;
  }

  /**
   * Get all service parameters.
   *
   * @return array
   *   Array containing all service parameters.
   */
  public function getAllServiceParameters() {
    return $this->serviceParameters;
  }

  /**
   * Indicate that the redirect response is cacheable.
   *
   * @param bool $cacheable
   *   TRUE to set the redirect as cacheable, FALSE otherwise.
   */
  public function setIsCacheable($cacheable) {
    if ($cacheable) {
      $this->isCacheable = TRUE;
    }
    else {
      $this->isCacheable = FALSE;
    }
  }

  /**
   * Return if the redirect response is cacheable or not.
   *
   * @return bool
   *   TRUE if the redirect response is cacheable, FALSE otherwise.
   */
  public function getIsCacheable() {
    return $this->isCacheable;
  }

  /**
   * Check if a redirect is be allowed.
   *
   * @return bool
   *   TRUE implies that a redirectwill occur.
   *   FALSE implies that no redirect will occur.
   */
  public function willRedirect() {
    return $this->willRedirect;
  }

  /**
   * Force the redirection to occur (may still be prevented).
   */
  public function forceRedirection() {
    $this->willRedirect = TRUE;
  }

  /**
   * Prevent Redirection form occuring (may still be foreced).
   */
  public function preventRedirection() {
    $this->willRedirect = FALSE;
  }

  /**
   * Set the cache tags that will be added to the redirect response.
   *
   * @param array $cache_tags
   *   The cache tags.
   */
  public function setCacheTags(array $cache_tags) {
    $this->cacheTags = $cache_tags;
  }

  /**
   * Get the cache tags for the redirect response.
   *
   * @return array
   *   The cache tags.
   */
  public function getCacheTags() {
    return $this->cacheTags;
  }

  /**
   * Set the cache contexts for the redirect response.
   *
   * @param array $cache_contexts
   *   The cache contexts.
   */
  public function setCacheContexts(array $cache_contexts) {
    $this->cacheContexts = $cache_contexts;
  }

  /**
   * Get the cache contexts for the redirect response.
   *
   * @return array
   *   The cache contexts.
   */
  public function getCacheContexts() {
    return $this->cacheContexts;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CasRedirectData::$cacheContexts	protected	property	Cache contexts to apply to cacheable redirect responses.
CasRedirectData::$cacheTags	protected	property	Cache tags to apply to cachable redirect responses.
CasRedirectData::$isCacheable	protected	property	Indicates whether the redirect response can be cached.
CasRedirectData::$redirectParameters	protected	property	Parameters used when redirecting to the cas server.
CasRedirectData::$serviceParameters	protected	property	Parameters to add to the service_url when requesting redirect.
CasRedirectData::$willRedirect	protected	property	Indicates whether the redirect will occur.
CasRedirectData::forceRedirection	public	function	Force the redirection to occur (may still be prevented).
CasRedirectData::getAllParameters	public	function	Returns all parameters that will be used in redirect.
CasRedirectData::getAllServiceParameters	public	function	Get all service parameters.
CasRedirectData::getCacheContexts	public	function	Get the cache contexts for the redirect response.
CasRedirectData::getCacheTags	public	function	Get the cache tags for the redirect response.
CasRedirectData::getIsCacheable	public	function	Return if the redirect response is cacheable or not.
CasRedirectData::getParameter	public	function	Returns the redirect parameter specified by $key.
CasRedirectData::getServiceParameter	public	function	Returns the redirect parameter specified by $key.
CasRedirectData::preventRedirection	public	function	Prevent Redirection form occuring (may still be foreced).
CasRedirectData::setCacheContexts	public	function	Set the cache contexts for the redirect response.
CasRedirectData::setCacheTags	public	function	Set the cache tags that will be added to the redirect response.
CasRedirectData::setIsCacheable	public	function	Indicate that the redirect response is cacheable.
CasRedirectData::setParameter	public	function	Set a redirection parameter.
CasRedirectData::setServiceParameter	public	function	Set a service paramater.
CasRedirectData::willRedirect	public	function	Check if a redirect is be allowed.
CasRedirectData::__construct	public	function	CasRedirectData constructor.