Visitor

Visitor.php : 14 Copy path

Visits a value object into an HTTP Response.

Properties¶

$generator ¶

Visitor.php : 26 Copy path

Generator.

protected Generator $generator

$response ¶

Visitor.php : 33 Copy path

HTTP Response Object.

protected Response $response

$valueObjectVisitorDispatcher ¶

Visitor.php : 19 Copy path

protected ValueObjectVisitorDispatcher $valueObjectVisitorDispatcher = []

Methods¶

__construct() ¶

Visitor.php : 48 Copy path

Construct from Generator and an array of concrete view model visitors.

public __construct(Generator $generator, ValueObjectVisitorDispatcher $valueObjectVisitorDispatcher)

Parameters

Name	Type	Default value	Description
$generator	Generator	-	-
$valueObjectVisitorDispatcher	ValueObjectVisitorDispatcher	-	-

getMediaType() ¶

Visitor.php : 148 Copy path

Generates a media type for $type based on the used generator.

public getMediaType(string $type) : string

Parameters

Name	Type	Default value	Description
$type	string	-	-

Return values

string

getResponse() ¶

Visitor.php : 156 Copy path

public getResponse() : Response

Return values

Response

setHeader() ¶

Visitor.php : 64 Copy path

Set HTTP response header.

public setHeader(string $name, string $value) : mixed

Does not allow overwriting of response headers. The first definition of a header will be used.

Parameters

Name	Type	Default value	Description
$name	string	-	-
$value	string	-	-

setStatus() ¶

Visitor.php : 78 Copy path

Sets the given status code in the corresponding header.

public setStatus(int $statusCode) : mixed

Note that headers are generally not overwritten!

Parameters

Name	Type	Default value	Description
$statusCode	int	-	-

visit() ¶

Visitor.php : 93 Copy path

Visit struct returned by controllers.

public visit(mixed $data) : Response

Parameters

Name	Type	Default value	Description
$data	mixed	-	-

Return values

Response

visitValueObject() ¶

Visitor.php : 131 Copy path

Visit struct returned by controllers.

public visitValueObject(object $data) : mixed

Can be called by sub-visitors to visit nested objects.

Parameters

Name	Type	Default value	Description
$data	object	-	-