1. class
  2. Illuminate
  3. \
  4. Foundation
  5. \
  6. Http
  7. \
  8. Middleware
  9. \
  10. VerifyCsrfToken

VerifyCsrfToken

class VerifyCsrfToken (View source)

Traits

InteractsWithTime
ExcludesPaths

Properties

protected Application $app

The application instance.
protected Encrypter $encrypter

The encrypter implementation.
protected array<int,string> $except

The URIs that should be excluded.
static protected array $neverVerify

The globally ignored URIs that should be excluded from CSRF verification.
protected bool $addHttpCookie

Indicates whether the XSRF-TOKEN cookie should be set on the response.

Methods

int
secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

from  InteractsWithTime
int
availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

from  InteractsWithTime
DateTimeInterface|int
parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

from  InteractsWithTime
int
currentTime()

Get the current system time as a UNIX timestamp.

from  InteractsWithTime
string
runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

from  InteractsWithTime
bool
inExceptArray(Request $request)

Determine if the request has a URI that should be excluded.

from  ExcludesPaths
array
getExcludedPaths()

Get the URIs that should be excluded.

__construct(Application $app, Encrypter $encrypter)

Create a new middleware instance.

mixed
handle(Request $request, Closure $next)

Handle an incoming request.

bool
isReading(Request $request)

Determine if the HTTP request uses a ‘read’ verb.

bool
runningUnitTests()

Determine if the application is running unit tests.

bool
tokensMatch(Request $request)

Determine if the session and input CSRF tokens match.

string|null
getTokenFromRequest(Request $request)

Get the CSRF token from the request.

bool
shouldAddXsrfTokenCookie()

Determine if the cookie should be added to the response.

Response
addCookieToResponse(Request $request, Response $response)

Add the CSRF token to the response cookies.

Cookie
newCookie(Request $request, array $config)

Create a new "XSRF-TOKEN" cookie that contains the CSRF token.

static void
except(array|string $uris)

Indicate that the given URIs should be excluded from CSRF verification.

static bool
serialized()

Determine if the cookie contents should be serialized.

static void
flushState()

Flush the state of the middleware.

Details

in InteractsWithTime at line 17
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 32
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

in InteractsWithTime at line 47
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

in InteractsWithTime at line 61
protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

in InteractsWithTime at line 73
protected string runTimeForHumans(float $startTime, float $endTime = null)

Given a start time, format the total run time for human readability.

Parameters

float $startTime
float $endTime

Return Value

string

in ExcludesPaths at line 13
protected bool inExceptArray(Request $request)

Determine if the request has a URI that should be excluded.

Parameters

Request $request

Return Value

bool

at line 123
array getExcludedPaths()

Get the URIs that should be excluded.

Return Value

array

at line 64
__construct(Application $app, Encrypter $encrypter)

Create a new middleware instance.

Parameters

Application $app
Encrypter $encrypter

at line 79
mixed handle(Request $request, Closure $next)

Handle an incoming request.

Parameters

Request $request
Closure $next

Return Value

mixed

Exceptions

TokenMismatchException

at line 103
protected bool isReading(Request $request)

Determine if the HTTP request uses a ‘read’ verb.

Parameters

Request $request

Return Value

bool

at line 113
protected bool runningUnitTests()

Determine if the application is running unit tests.

Return Value

bool

at line 134
protected bool tokensMatch(Request $request)

Determine if the session and input CSRF tokens match.

Parameters

Request $request

Return Value

bool

at line 149
protected string|null getTokenFromRequest(Request $request)

Get the CSRF token from the request.

Parameters

Request $request

Return Value

string|null

at line 169
bool shouldAddXsrfTokenCookie()

Determine if the cookie should be added to the response.

Return Value

bool

at line 181
protected Response addCookieToResponse(Request $request, Response $response)

Add the CSRF token to the response cookies.

Parameters

Request $request
Response $response

Return Value

Response

at line 201
protected Cookie newCookie(Request $request, array $config)

Create a new "XSRF-TOKEN" cookie that contains the CSRF token.

Parameters

Request $request
array $config

Return Value

Cookie

at line 223
static void except(array|string $uris)

Indicate that the given URIs should be excluded from CSRF verification.

Parameters

array|string $uris

Return Value

void

at line 235
static bool serialized()

Determine if the cookie contents should be serialized.

Return Value

bool

at line 245
static void flushState()

Flush the state of the middleware.

Return Value

void