Interface Guzzle\Service\Command\LocationVisitor\Response\ResponseVisitorInterface

Implemented byGuzzle\Service\Command\LocationVisitor\Response\AbstractResponseVisitor, Guzzle\Service\Command\LocationVisitor\Response\BodyVisitor, Guzzle\Service\Command\LocationVisitor\Response\HeaderVisitor, Guzzle\Service\Command\LocationVisitor\Response\JsonVisitor, Guzzle\Service\Command\LocationVisitor\Response\ReasonPhraseVisitor, Guzzle\Service\Command\LocationVisitor\Response\StatusCodeVisitor, Guzzle\Service\Command\LocationVisitor\Response\XmlVisitor

Location visitor used to parse values out of a response into an associative array

Public Methods

Hide inherited methods

MethodDescriptionDefined By
after() Called after visiting all parameters Guzzle\Service\Command\LocationVisitor\Response\ResponseVisitorInterface
before() Called before visiting all parameters. This can be used for seeding the result of a command with default data (e.g. populating with JSON data in the response then adding to the parsed data). Guzzle\Service\Command\LocationVisitor\Response\ResponseVisitorInterface
visit() Called once for each parameter being visited that matches the location type Guzzle\Service\Command\LocationVisitor\Response\ResponseVisitorInterface

Method Details

after() public abstract method

Called after visiting all parameters

public abstract void after ( Guzzle\Service\Command\CommandInterface $command )
$command Guzzle\Service\Command\CommandInterface

Command being visited

before() public abstract method

Called before visiting all parameters. This can be used for seeding the result of a command with default data (e.g. populating with JSON data in the response then adding to the parsed data).

public abstract void before ( Guzzle\Service\Command\CommandInterface $command, array &$result )
$command Guzzle\Service\Command\CommandInterface

Command being visited

$result array

Result value to update if needed (e.g. parsing XML or JSON)

visit() public abstract method

Called once for each parameter being visited that matches the location type

public abstract void visit ( Guzzle\Service\Command\CommandInterface $command, Guzzle\Http\Message\Response $response, Guzzle\Service\Description\Parameter $param, &$value, $context null )
$command Guzzle\Service\Command\CommandInterface

Command being visited

$response Guzzle\Http\Message\Response

Response being visited

$param Guzzle\Service\Description\Parameter

Parameter being visited

$value mixed

Result associative array value being updated by reference

$context mixed

Parsing context