SetaFramework API Reference

Index

\com\setasign\SetaFramework
1. Helper

com\setasign\SetaFramework\Helper

CsrfProtectionException Class Exception

File: /SetaFramework/src/Helper/CsrfProtectionException.php

Class hierarchy

\Exception
- \com\setasign\SetaFramework\Exception
  - CsrfProtectionException

Implements

Summary

Methods

__construct()
__clone()
__toString()
__wakeup()
getCode()
getFile()
getLine()
getMessage()
getPrevious()
getTrace()
getTraceAsString()
jsonSerialize()

Properties

$actualToken
$code
$expectedToken
$file
$line
$message

Constants

INVALID_TOKEN
MISSING_EXPECTED_TOKEN
MISSING_TOKEN

Constants

INVALID_TOKEN

public const CsrfProtectionException::INVALID_TOKEN = 3

This means that the given token from the request and an expected token from the session doesn't match.

MISSING_EXPECTED_TOKEN

public const CsrfProtectionException::MISSING_EXPECTED_TOKEN = 1

This means no session was initialized before.

MISSING_TOKEN

public const CsrfProtectionException::MISSING_TOKEN = 2

This means there wasn't a csrf token in the request.

Properties

$actualToken

private ?string CsrfProtectionException::$actualToken

$code

protected \Exception::$code = 0

$expectedToken

private ?string CsrfProtectionException::$expectedToken

$file

protected \Exception::$file = ''

$line

protected \Exception::$line = 0

$message

protected \Exception::$message = ''

Methods

__construct()

public CsrfProtectionException::__construct (

?string $expectedToken,
?string $actualToken

)

Parameters

$expectedToken : ?string
$actualToken : ?string

__clone()

Internal PHP method: Exception::__clone

__toString()

Internal PHP method: Exception::__toString

__wakeup()

Internal PHP method: Exception::__wakeup

getCode()

Internal PHP method: Exception::getCode

getFile()

Internal PHP method: Exception::getFile

getLine()

Internal PHP method: Exception::getLine

getMessage()

Internal PHP method: Exception::getMessage

getPrevious()

Internal PHP method: Exception::getPrevious

getTrace()

Internal PHP method: Exception::getTrace

getTraceAsString()

Internal PHP method: Exception::getTraceAsString

jsonSerialize()

public CsrfProtectionException::jsonSerialize (

void

): array