annotate core/lib/Drupal/Core/Authentication/AuthenticationProviderChallengeInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Core\Authentication;
Chris@0 4
Chris@0 5 use Symfony\Component\HttpFoundation\Request;
Chris@0 6
Chris@0 7 /**
Chris@0 8 * Generate a challenge when access is denied for unauthenticated users.
Chris@0 9 *
Chris@0 10 * On a 403 (access denied), if there are no credentials on the request, some
Chris@0 11 * authentication methods (e.g. basic auth) require that a challenge is sent to
Chris@0 12 * the client.
Chris@0 13 */
Chris@0 14 interface AuthenticationProviderChallengeInterface {
Chris@0 15
Chris@0 16 /**
Chris@0 17 * Constructs an exception which is used to generate the challenge.
Chris@0 18 *
Chris@0 19 * @param \Symfony\Component\HttpFoundation\Request $request
Chris@0 20 * The request.
Chris@0 21 * @param \Exception $previous
Chris@0 22 * The previous exception.
Chris@0 23 *
Chris@0 24 * @return \Symfony\Component\HttpKernel\Exception\HttpExceptionInterface|null
Chris@0 25 * An exception to be used in order to generate an authentication challenge.
Chris@0 26 */
Chris@0 27 public function challengeException(Request $request, \Exception $previous);
Chris@0 28
Chris@0 29 }