\Guzzle\Service\BuilderServiceBuilderInterface

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 {@see \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}").

Summary

Methods
Constants
get()
set()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

get()

get(string  $name, boolean|array  $throwAway = false) : \Guzzle\Service\ClientInterface|mixed

Get a ClientInterface object or arbitrary data from the service builder

Parameters

string $name

Name of the registered service or data to retrieve

boolean|array $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 {@see \Guzzle\Common\FromConfigInterface} and will not store the client for later retrieval.

Throws

\Guzzle\Service\Exception\ServiceNotFoundException

when a client or data cannot be found by the given name

Returns

\Guzzle\Service\ClientInterface|mixed

set()

set(string  $key, mixed  $service) : \Guzzle\Service\Builder\ServiceBuilderInterface

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

Parameters

string $key

Name of the client or data to register

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