Copied!

Visitor

Visitor.php : 20

Visits a value object into an HTTP Response.

Properties

protected $response

Visitor.php : 25

HTTP Response Object.

 
protected Response $response

Methods

public__construct()

Visitor.php : 39 
public __construct(Generator $generator, NormalizerInterface $normalizer, EncoderInterface $encoder, ValueObjectVisitorResolverInterface $valueObjectVisitorResolver, string $format)

Parameters

Name Type Default value Description
$generator Generator - -
$normalizer NormalizerInterface - -
$encoder EncoderInterface - -
$valueObjectVisitorResolver ValueObjectVisitorResolverInterface - -
$format string - -

publicgetGenerator()

Visitor.php : 211 
public getGenerator() : Generator

Return values

Generator

publicgetMediaType()

Visitor.php : 201

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

Tags
See
Generator::getMediaType()

publicgetResponse()

Visitor.php : 206 
public getResponse() : Response

Return values

Response

publicsetHeader()

Visitor.php : 55

Set HTTP response header.

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

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 mixed - -

publicsetStatus()

Visitor.php : 105

Sets the given status code in the corresponding header.

 
public setStatus(int $statusCode) : void

Note that headers are generally not overwritten!

Parameters

Name Type Default value Description
$statusCode int - -

publicsuppressHeader()

Visitor.php : 90

Leaves the header out of the response, also when inner visitors set it.

 
public suppressHeader(string $name) : void

For example, a list of resources suppresses the Accept-Patch header, which is valid for a single resource only. A header which is already set stays in the response.

Parameters

Name Type Default value Description
$name string - -

publicvisit()

Visitor.php : 116

Visit struct returned by controllers.

 
public visit(mixed $data) : Response

Parameters

Name Type Default value Description
$data mixed - -

Return values

Response

publicvisitValueObject()

Visitor.php : 177

Visit struct returned by controllers.

 
public visitValueObject(mixed $data) : void

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

Parameters

Name Type Default value Description
$data mixed - -