PHP Class Equip\Responder\FormattedResponder

Inheritance: extends Equip\Structure\SortedDictionary, implements Equip\Adr\ResponderInterface, use trait Equip\Resolver\ResolverTrait

Datei anzeigen Open project: equip/framework

Public Methods

Method	Description
__construct ( Negotiator $negotiator, Relay\ResolverInterface $resolver, array $formatters = [JsonFormatter::class => 1] )
__invoke ( Psr\Http\Message\ServerRequestInterface $request, Psr\Http\Message\ResponseInterface $response, Equip\Adr\PayloadInterface $payload )

Method	Description
assertValid ( array $classes )
format ( Psr\Http\Message\ServerRequestInterface $request, Psr\Http\Message\ResponseInterface $response, Equip\Adr\PayloadInterface $payload ) : Psr\Http\Message\ResponseInterface	Update the response by formatting the payload.
formatter ( Psr\Http\Message\ServerRequestInterface $request ) : Equip\Formatter\FormatterInterface	Retrieve the formatter to use for the current request.
hasOutput ( Equip\Adr\PayloadInterface $payload ) : boolean	Determine if the payload has usable output
priorities ( ) : array	Retrieve a map of accepted priorities with the responsible formatter.
sortValues ( )

public __construct ( Negotiator $negotiator, Relay\ResolverInterface $resolver, array $formatters = [JsonFormatter::class => 1] )
$negotiator	Negotiation\Negotiator
$resolver	Relay\ResolverInterface
$formatters	array

public __invoke ( Psr\Http\Message\ServerRequestInterface $request, Psr\Http\Message\ResponseInterface $response, Equip\Adr\PayloadInterface $payload )
$request	Psr\Http\Message\ServerRequestInterface
$response	Psr\Http\Message\ResponseInterface
$payload	Equip\Adr\PayloadInterface

protected assertValid ( array $classes )
$classes	array

Update the response by formatting the payload.

protected format ( Psr\Http\Message\ServerRequestInterface $request, Psr\Http\Message\ResponseInterface $response, Equip\Adr\PayloadInterface $payload ) : Psr\Http\Message\ResponseInterface
$request	Psr\Http\Message\ServerRequestInterface
$response	Psr\Http\Message\ResponseInterface
$payload	Equip\Adr\PayloadInterface
return	Psr\Http\Message\ResponseInterface

Uses content negotiation to find the best available output format for the requested content type.

protected formatter ( Psr\Http\Message\ServerRequestInterface $request ) : Equip\Formatter\FormatterInterface
$request	Psr\Http\Message\ServerRequestInterface
return	Equip\Formatter\FormatterInterface

Determine if the payload has usable output

protected hasOutput ( Equip\Adr\PayloadInterface $payload ) : boolean
$payload	Equip\Adr\PayloadInterface
return	boolean

Retrieve a map of accepted priorities with the responsible formatter.

protected priorities ( ) : array
return	array

protected sortValues ( )