1. class
  2. mako
  3. \
  4. validator
  5. \
  6. input
  7. \
  8. http
  9. \
  10. routing
  11. \
  12. middleware
  13. \
  14. InputValidation

InputValidation

class InputValidation implements MiddlewareInterface

Input validation middleware.

Traits

ContentNegotiationTrait
Basic content negotiation.

Properties

protected Request $request Request.
protected Response $response Response.
protected int $httpStatusCode Default HTTP status code for invalid requests.
protected string $errorsFlashKey Session flash key for errors.
protected string $oldInputFlashKey Session flash key for old input.
protected string $errorsVariableName Errors view variable name.
protected string $oldInputVariableName Old input view variable name.
protected string $defaultErrorMessage Default error message.
protected array $dontInclude Keys that will be removed from the old input.
protected URLBuilder $urlBuilder URL builder.
protected Session|null $session Session.
protected ViewFactory|null $viewFactory View factory.
protected HttpInputInterface|null $input Input.

Methods

bool
expectsType(array $mimeTypes, string|null $suffix = null)

Does the client expect the provided mime type?

from ContentNegotiationTrait
bool
expectsJson()

Does the client expect JSON?

from ContentNegotiationTrait
bool
expectsXml()

Does the client expect XML?

from ContentNegotiationTrait
bool
respondWithType(array $mimeTypes, string|null $suffix = null)

Should we respond with the provided mime type?

from ContentNegotiationTrait
bool
respondWithJson()

Should we respond with JSON?

from ContentNegotiationTrait
bool
respondWithXml()

Should we respond with XML?

from ContentNegotiationTrait
__construct(URLBuilder $urlBuilder, Session|null $session = null, ViewFactory|null $viewFactory = null)

Constructor.

setInput(HttpInputInterface|null $input)

Set the input.

bool
shouldRedirect()

Should we redirect the client if possible?

bool
shouldIncludeOldInput()

Should the old input be included?

array
getOldInput()

Returns the old input.

string
getRedirectUrl()

Returns the redirect URL.

Response
handleRedirect(ValidationException $exception)

Add errors to flash data and redirect.

string
getErrorMessage()

Returns the error message.

string
buildXmlFromException(ValidationException $exception, string $charset)

Builds XML based on the exception.

Response
handleOutput(ValidationException $exception)

Output errors.

Response
execute(Request $request, Response $response, Closure $next)

Executes the middleware.

Details

in ContentNegotiationTrait at line 30
protected bool expectsType(array $mimeTypes, string|null $suffix = null)

Does the client expect the provided mime type?

Parameters

array $mimeTypes Mime types
string|null $suffix Mime type suffix

Return Value

bool

in ContentNegotiationTrait at line 47
protected bool expectsJson()

Does the client expect JSON?

Return Value

bool

in ContentNegotiationTrait at line 57
protected bool expectsXml()

Does the client expect XML?

Return Value

bool

in ContentNegotiationTrait at line 69
protected bool respondWithType(array $mimeTypes, string|null $suffix = null)

Should we respond with the provided mime type?

Parameters

array $mimeTypes Mime types
string|null $suffix Mime type suffix

Return Value

bool

in ContentNegotiationTrait at line 86
protected bool respondWithJson()

Should we respond with JSON?

Return Value

bool

in ContentNegotiationTrait at line 96
protected bool respondWithXml()

Should we respond with XML?

Return Value

bool

at line 137
__construct(URLBuilder $urlBuilder, Session|null $session = null, ViewFactory|null $viewFactory = null)

Constructor.

Parameters

URLBuilder $urlBuilder URL builder
Session|null $session Session
ViewFactory|null $viewFactory View factory

at line 151
protected setInput(HttpInputInterface|null $input)

Set the input.

Parameters

HttpInputInterface|null $input Input

at line 161
protected bool shouldRedirect()

Should we redirect the client if possible?

Return Value

bool

at line 176
protected bool shouldIncludeOldInput()

Should the old input be included?

Return Value

bool

at line 191
protected array getOldInput()

Returns the old input.

Return Value

array

at line 210
protected string getRedirectUrl()

Returns the redirect URL.

Return Value

string

at line 226
protected Response handleRedirect(ValidationException $exception)

Add errors to flash data and redirect.

Parameters

ValidationException $exception Validation exception

Return Value

Response

at line 245
protected string getErrorMessage()

Returns the error message.

Return Value

string

at line 262
protected string buildXmlFromException(ValidationException $exception, string $charset)

Builds XML based on the exception.

Parameters

ValidationException $exception Validation exception
string $charset Character set

Return Value

string

at line 284
protected Response handleOutput(ValidationException $exception)

Output errors.

Parameters

ValidationException $exception Validation exception

Return Value

Response

at line 314
Response execute(Request $request, Response $response, Closure $next)

Executes the middleware.

Parameters

Request $request Request
Response $response Response
Closure $next Next layer

Return Value

Response