ApiCsrfMiddleware Class Reference

Public Member Functions
	__construct (APIHandler $handler)
	__invoke ($slimRequest, $response, $next)

Protected Member Functions
	_isCSRFRequired ($slimRequest)
	_isCSRFValid ($slimRequest)

Protected Attributes
	$_handler = null

Detailed Description

Slim middleware which requires a CSRF token for POST, PUT and DELETE operations whenever an API Token is not in use.

Definition at line 17 of file ApiCsrfMiddleware.inc.php.

Constructor & Destructor Documentation

__construct()

ApiCsrfMiddleware::__construct

(

APIHandler

$handler

)

Constructor

Parameters

APIHandler

$handler

Definition at line 30 of file ApiCsrfMiddleware.inc.php.

Member Function Documentation

__invoke()

ApiCsrfMiddleware::__invoke	(		$slimRequest,
			$response,
			$next
	)

Middleware invokable function

Parameters

SlimRequest	$slimRequest	request
SlimResponse	$response	response
callable	$next	Next middleware

Returns

SlimResponse

Definition at line 42 of file ApiCsrfMiddleware.inc.php.

References _isCSRFRequired(), and _isCSRFValid().

_isCSRFRequired()

ApiCsrfMiddleware::_isCSRFRequired (   $slimRequest )

protected

Check if a CSRF token is required

Parameters

SlimRequest

$slimRequest

Returns

boolean

Definition at line 59 of file ApiCsrfMiddleware.inc.php.

Referenced by __invoke().

_isCSRFValid()

ApiCsrfMiddleware::_isCSRFValid (   $slimRequest )

protected

Check if the CSRF token is present and valid

Parameters

SlimRequest

$slimRequest

Returns

boolean

Definition at line 73 of file ApiCsrfMiddleware.inc.php.

References PKPApplication\get().

Referenced by __invoke().

Field Documentation

$_handler

APIHandler ApiCsrfMiddleware::$_handler = null

protected

$handler Reference to api handler

Definition at line 23 of file ApiCsrfMiddleware.inc.php.

---

The documentation for this class was generated from the following file:

• ApiCsrfMiddleware.inc.php