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

  • ServiceBuilder
  • ServiceBuilderLoader

Interfaces

  • ServiceBuilderInterface
  • Overview
  • Namespace
  • Class
  • Tree

Interface ServiceBuilderInterface

Service builder used to store and build clients or arbitrary data. Client configuration data can be supplied to tell the service builder how to create and cache Guzzle\Service\ClientInterface objects. Arbitrary data can be supplied and accessed from a service builder. Arbitrary data and other clients can be referenced by name in client configuration arrays to make them input for building other clients (e.g. "{key}").

Direct known implementers

Guzzle\Service\Builder\ServiceBuilder
Namespace: Guzzle\Service\Builder
Located at src/Guzzle/Service/Builder/ServiceBuilderInterface.php
Methods summary
public Guzzle\Service\ClientInterface|mixed
# get( string $name, boolean|array $throwAway = false )

Get a ClientInterface object or arbitrary data from the service builder

Get a ClientInterface object or arbitrary data from the service builder

Parameters

$name
Name of the registered service or data to retrieve
$throwAway

Only pertains to retrieving client objects built using a configuration array. Set to TRUE to not store the client for later retrieval from the ServiceBuilder. If an array is specified, that data will overwrite the configured params of the client if the client implements Guzzle\Common\FromConfigInterface and will not store the client for later retrieval.

Returns

Guzzle\Service\ClientInterface|mixed

Throws

Guzzle\Service\Exception\ServiceNotFoundException
when a client or data cannot be found by the given name
public Guzzle\Service\Builder\ServiceBuilderInterface
# set( string $key, mixed $service )

Register a service or arbitrary data by name with the service builder

Register a service or arbitrary data by name with the service builder

Parameters

$key
Name of the client or data to register
$service

Client configuration array or arbitrary data to register. The client configuration array must include a 'class' (string) and 'params' (array) key.

Returns

Guzzle\Service\Builder\ServiceBuilderInterface
Omnipay Viva Payments Gateway Module API Documentation API documentation generated by ApiGen