Overview

Namespaces

  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
    • Tests
      • Batch
      • Cache
      • Common
        • Cache
        • Exception
      • Http
        • Curl
        • Exception
        • Message
          • Header
      • Inflection
      • Iterator
      • Log
      • Message
      • Mock
      • Parser
        • Cookie
        • Message
      • Parsers
        • UriTemplate
      • Plugin
        • Async
        • Backoff
        • Cache
        • Cookie
          • CookieJar
        • CurlAuth
        • ErrorResponse
        • History
        • Log
        • Md5
        • Mock
        • Oauth
        • Redirect
      • Service
        • Builder
        • Command
          • LocationVisitor
            • Request
            • Response
        • Description
        • Exception
        • Mock
          • Command
            • Sub
          • Model
        • Resource
      • Stream
  • None
  • Omnipay
    • Common
      • Exception
      • Message
    • Dummy
      • Message
    • VivaPayments
      • Message
  • PHP

Classes

  • AbstractResponseVisitor
  • BodyVisitor
  • HeaderVisitor
  • JsonVisitor
  • ReasonPhraseVisitor
  • StatusCodeVisitor
  • XmlVisitor

Interfaces

  • ResponseVisitorInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class JsonVisitor

Location visitor used to marshal JSON response data into a formatted array.

Allows top level JSON parameters to be inserted into the result of a command. The top level attributes are grabbed from the response's JSON data using the name value by default. Filters can be applied to parameters as they are traversed. This allows data to be normalized before returning it to users (for example converting timestamps to DateTime objects).

Guzzle\Service\Command\LocationVisitor\Response\AbstractResponseVisitor implements Guzzle\Service\Command\LocationVisitor\Response\ResponseVisitorInterface
Extended by Guzzle\Service\Command\LocationVisitor\Response\JsonVisitor
Namespace: Guzzle\Service\Command\LocationVisitor\Response
Located at src/Guzzle/Service/Command/LocationVisitor/Response/JsonVisitor.php
Methods summary
public
# before( Guzzle\Service\Command\CommandInterface $command, array & $result )

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).

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).

Parameters

$command
Command being visited
$result
Result value to update if needed (e.g. parsing XML or JSON)

Overrides

Guzzle\Service\Command\LocationVisitor\Response\AbstractResponseVisitor::before()
public
# visit( Guzzle\Service\Command\CommandInterface $command, Guzzle\Http\Message\Response $response, Guzzle\Service\Description\Parameter $param, mixed & $value, mixed $context = null )

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

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

Parameters

$command
Command being visited
$response
Response being visited
$param
Parameter being visited
$value
Result associative array value being updated by reference
$context
Parsing context

Overrides

Guzzle\Service\Command\LocationVisitor\Response\AbstractResponseVisitor::visit()
protected
# recursiveProcess( Guzzle\Service\Description\Parameter $param, mixed & $value )

Recursively process a parameter while applying filters

Recursively process a parameter while applying filters

Parameters

$param
API parameter being validated
$value
Value to validate and process. The value may change during this process.
Methods inherited from Guzzle\Service\Command\LocationVisitor\Response\AbstractResponseVisitor
after()
Omnipay Viva Payments Gateway Module API Documentation API documentation generated by ApiGen