class CsrfTokenController in Drupal 9

Returns responses for CSRF token routes.

Hierarchy

• class \Drupal\system\Controller\CsrfTokenController implements ContainerInjectionInterface

File

core/modules/system/src/Controller/CsrfTokenController.php, line 14

Namespace

Drupal\system\Controller

class CsrfTokenController implements ContainerInjectionInterface {

  /**
   * The CSRF token generator.
   *
   * @var \Drupal\Core\Access\CsrfTokenGenerator
   */
  protected $tokenGenerator;

  /**
   * Constructs a new CsrfTokenController object.
   *
   * @param \Drupal\Core\Access\CsrfTokenGenerator $token_generator
   *   The CSRF token generator.
   */
  public function __construct(CsrfTokenGenerator $token_generator) {
    $this->tokenGenerator = $token_generator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('csrf_token'));
  }

  /**
   * Returns a CSRF protecting session token.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   The response object.
   */
  public function csrfToken() {
    return new Response($this->tokenGenerator
      ->get(CsrfRequestHeaderAccessCheck::TOKEN_KEY), 200, [
      'Content-Type' => 'text/plain',
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CsrfTokenController::$tokenGenerator	protected	property	The CSRF token generator.
CsrfTokenController::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
CsrfTokenController::csrfToken	public	function	Returns a CSRF protecting session token.
CsrfTokenController::__construct	public	function	Constructs a new CsrfTokenController object.