Basic ValueObjectVisitor.
Properties¶
                 $httpStatusCodes
            ¶
        $httpStatusCodes
            ¶
    
        
        AbstractExceptionVisitor.php
                :
        24
                 
    
        Mapping of HTTP status codes to their respective error messages.
|  |  | 
                 $requestParser
            ¶
        $requestParser
            ¶
    
        
        ValueObjectVisitor.php
                :
        24
                 
    
        URL handler for URL generation.
|  |  | 
                 $router
            ¶
        $router
            ¶
    
        
        ValueObjectVisitor.php
                :
        29
                 
    
        |  |  | 
                 $templateRouter
            ¶
        $templateRouter
            ¶
    
        
        ValueObjectVisitor.php
                :
        34
                 
    
        |  |  | 
Methods¶
                 setRequestParser()
            ¶
setRequestParser()
            ¶
    
        
        ValueObjectVisitor.php
                :
        58
                 
    
        |  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $requestParser | RequestParser | - | - | 
                 setRouter()
            ¶
setRouter()
            ¶
    
        
        ValueObjectVisitor.php
                :
        48
                 
    
        |  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $router | RouterInterface | - | - | 
                 setTemplateRouter()
            ¶
setTemplateRouter()
            ¶
    
        
        ValueObjectVisitor.php
                :
        53
                 
    
        |  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $templateRouter | RouterInterface | - | - | 
                 visit()
            ¶
visit()
            ¶
    
        
        AbstractExceptionVisitor.php
                :
        77
                 
    
        Visit struct returned by controllers.
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $visitor | Visitor | - | - | 
| $generator | Generator | - | - | 
| $data | Exception | - | - | 
                 canDisplayExceptionMessage()
            ¶
canDisplayExceptionMessage()
            ¶
    
        
        AbstractExceptionVisitor.php
                :
        156
                 
    
        |  |  | 
Return values
bool
                 canDisplayExceptionTrace()
            ¶
canDisplayExceptionTrace()
            ¶
    
        
        AbstractExceptionVisitor.php
                :
        146
                 
    
        |  |  | 
Return values
bool
                 canDisplayPreviousException()
            ¶
canDisplayPreviousException()
            ¶
    
        
        AbstractExceptionVisitor.php
                :
        151
                 
    
        |  |  | 
Return values
bool
                 generateErrorCode()
            ¶
generateErrorCode()
            ¶
    
        
        AbstractExceptionVisitor.php
                :
        107
                 
    
        Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $generator | Generator | - | - | 
| $visitor | Visitor | - | - | 
| $e | Exception | - | - | 
Return values
int
                 getErrorDescription()
            ¶
getErrorDescription()
            ¶
    
        
        AbstractExceptionVisitor.php
                :
        122
                 
    
        |  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $data | Exception | - | - | 
| $statusCode | int | - | - | 
Return values
string
                 getErrorMessage()
            ¶
getErrorMessage()
            ¶
    
        
        AbstractExceptionVisitor.php
                :
        117
                 
    
        |  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $data | Exception | - | - | 
| $statusCode | int | - | - | 
Return values
string
                 getStatus()
            ¶
getStatus()
            ¶
    
        
        AbstractExceptionVisitor.php
                :
        67
                 
    
        Returns HTTP status code.
|  |  | 
Return values
int
                 getTranslator()
            ¶
getTranslator()
            ¶
    
        
        AbstractExceptionVisitor.php
                :
        141
                 
    
        |  |  | 
Return values
TranslatorInterface|null
                 serializeBool()
            ¶
serializeBool()
            ¶
    
        
        ValueObjectVisitor.php
                :
        71
                 
    
        Returns a string representation for the given $boolValue.
|  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $generator | Generator | - | - | 
| $boolValue | bool | - | - | 
                 serializeSortField()
            ¶
serializeSortField()
            ¶
    
        
        ValueObjectVisitor.php
                :
        153
                 
    
        Serializes the given $sortField to a string representation.
|  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $sortField | int | - | - | 
Return values
string
                 serializeSortOrder()
            ¶
serializeSortOrder()
            ¶
    
        
        ValueObjectVisitor.php
                :
        192
                 
    
        Serializes the given $sortOrder to a string representation.
|  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $sortOrder | int | - | - | 
Return values
string
                 visitDescriptionsList()
            ¶
visitDescriptionsList()
            ¶
    
        
        ValueObjectVisitor.php
                :
        93
                 
    
        Visits the given list of $descriptions.
|  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $generator | Generator | - | - | 
| $descriptions | array<string|int, mixed> | - | - | 
                 visitLimitation()
            ¶
visitLimitation()
            ¶
    
        
        ValueObjectVisitor.php
                :
        123
                 
    
        Visits a limitation.
|  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $generator | Generator | - | - | 
| $limitation | Limitation | - | - | 
                 visitNamesList()
            ¶
visitNamesList()
            ¶
    
        
        ValueObjectVisitor.php
                :
        82
                 
    
        Visits the given list of $names.
|  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $generator | Generator | - | - | 
| $names | array<string|int, mixed> | - | - | 
                 visitTranslatedList()
            ¶
visitTranslatedList()
            ¶
    
        
        ValueObjectVisitor.php
                :
        105
                 
    
        Visits a list of translated elements.
|  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $generator | Generator | - | - | 
| $translatedElements | array<string|int, mixed> | - | - | 
| $listName | mixed | - | - |