AbstractExceptionVisitor

AbstractExceptionVisitor.php : 19 Copy path

Abstract

Extends ValueObjectVisitor

Basic ValueObjectVisitor.

Properties¶

$httpStatusCodes ¶

AbstractExceptionVisitor.php : 26 Copy path

Mapping of HTTP status codes to their respective error messages.

    
                        protected static array<int, string> $httpStatusCodes = [400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Time-out', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Long', 415 => 'Unsupported Media Type', 416 => 'Requested range not satisfiable', 417 => 'Expectation Failed', 418 => "I'm a teapot", 421 => 'There are too many connections from your internet address', 422 => 'Unprocessable Entity', 423 => 'Locked', 424 => 'Failed Dependency', 425 => 'Unordered Collection', 426 => 'Upgrade Required', 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Time-out', 505 => 'HTTP Version not supported', 506 => 'Variant Also Negotiates', 507 => 'Insufficient Storage', 509 => 'Bandwidth Limit Exceeded', 510 => 'Not Extended']

$router ¶

ValueObjectVisitor.php : 22 Copy path

protected RouterInterface $router

$templateRouter ¶

ValueObjectVisitor.php : 24 Copy path

protected RouterInterface $templateRouter

$uriParser ¶

ValueObjectVisitor.php : 20 Copy path

protected UriParserInterface $uriParser

Methods¶

setRouter() ¶

ValueObjectVisitor.php : 31 Copy path

public setRouter(RouterInterface $router) : void

Parameters

Name	Type	Default value	Description
$router	RouterInterface	-	-

setTemplateRouter() ¶

ValueObjectVisitor.php : 36 Copy path

public setTemplateRouter(RouterInterface $templateRouter) : void

Parameters

Name	Type	Default value	Description
$templateRouter	RouterInterface	-	-

setUriParser() ¶

ValueObjectVisitor.php : 41 Copy path

public setUriParser(UriParserInterface $uriParser) : void

Parameters

Name	Type	Default value	Description
$uriParser	UriParserInterface	-	-

visit() ¶

AbstractExceptionVisitor.php : 75 Copy path

Visit struct returned by controllers.

public visit(Visitor $visitor, Generator $generator, Exception $data) : void

Parameters

Name	Type	Default value	Description
$visitor	Visitor	-	-
$generator	Generator	-	-
$data	Exception	-	-

canDisplayExceptionMessage() ¶

AbstractExceptionVisitor.php : 154 Copy path

protected canDisplayExceptionMessage() : bool

Return values

bool

canDisplayExceptionTrace() ¶

AbstractExceptionVisitor.php : 144 Copy path

protected canDisplayExceptionTrace() : bool

Return values

bool

canDisplayPreviousException() ¶

AbstractExceptionVisitor.php : 149 Copy path

protected canDisplayPreviousException() : bool

Return values

bool

generateErrorCode() ¶

AbstractExceptionVisitor.php : 105 Copy path

protected generateErrorCode(Generator $generator, Visitor $visitor, Exception $e) : int

Parameters

Name	Type	Default value	Description
$generator	Generator	-	-
$visitor	Visitor	-	-
$e	Exception	-	-

Return values

int

getErrorDescription() ¶

AbstractExceptionVisitor.php : 120 Copy path

protected getErrorDescription(Exception $data, int $statusCode) : string

Parameters

Name	Type	Default value	Description
$data	Exception	-	-
$statusCode	int	-	-

Return values

string

getErrorMessage() ¶

AbstractExceptionVisitor.php : 115 Copy path

protected getErrorMessage(Exception $data, int $statusCode) : string

Parameters

Name	Type	Default value	Description
$data	Exception	-	-
$statusCode	int	-	-

Return values

string

getStatus() ¶

AbstractExceptionVisitor.php : 67 Copy path

Returns HTTP status code.

protected getStatus() : int

Return values

int

getTranslator() ¶

AbstractExceptionVisitor.php : 139 Copy path

protected getTranslator() : TranslatorInterface|null

Return values

TranslatorInterface|null

serializeBool() ¶

ValueObjectVisitor.php : 49 Copy path

Returns a string representation for the given $boolValue.

protected serializeBool(Generator $generator, bool|null $boolValue) : string|bool

Parameters

Name	Type	Default value	Description
$generator	Generator	-	-
$boolValue	bool\|null	-	-

Return values

string|bool

serializeSortField() ¶

ValueObjectVisitor.php : 114 Copy path

Serializes the given $sortField to a string representation.

protected serializeSortField(int $sortField) : string

Parameters

Name	Type	Default value	Description
$sortField	int	-	-

Return values

string

serializeSortOrder() ¶

ValueObjectVisitor.php : 147 Copy path

Serializes the given $sortOrder to a string representation.

protected serializeSortOrder(int $sortOrder) : string

Parameters

Name	Type	Default value	Description
$sortOrder	int	-	-

Return values

string

visitDescriptionsList() ¶

ValueObjectVisitor.php : 65 Copy path

Visits the given list of $descriptions.

protected visitDescriptionsList(Generator $generator, array<string|int, mixed> $descriptions) : void

Parameters

Name	Type	Default value	Description
$generator	Generator	-	-
$descriptions	array<string\|int, mixed>	-	-

visitLimitation() ¶

ValueObjectVisitor.php : 88 Copy path

Visits a limitation.

protected visitLimitation(Generator $generator, Limitation $limitation) : void

Parameters

Name	Type	Default value	Description
$generator	Generator	-	-
$limitation	Limitation	-	-

visitNamesList() ¶

ValueObjectVisitor.php : 57 Copy path

Visits the given list of $names.

protected visitNamesList(Generator $generator, array<string|int, mixed> $names) : void

Parameters

Name	Type	Default value	Description
$generator	Generator	-	-
$names	array<string\|int, mixed>	-	-

visitTranslatedList() ¶

ValueObjectVisitor.php : 73 Copy path

Visits a list of translated elements.

protected visitTranslatedList(Generator $generator, array<string|int, mixed> $translatedElements, string $listName) : void

Parameters

Name	Type	Default value	Description
$generator	Generator	-	-
$translatedElements	array<string\|int, mixed>	-	-
$listName	string	-	-