ServiceBuilderInterface
in
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}").
Table of Contents
Methods
- get() : ClientInterface|mixed
- Get a ClientInterface object or arbitrary data from the service builder
- set() : ServiceBuilderInterface
- Register a service or arbitrary data by name with the service builder
Methods
get()
Get a ClientInterface object or arbitrary data from the service builder
public
get(string $name[, bool|array<string|int, mixed> $throwAway = false ]) : ClientInterface|mixed
Parameters
- $name : string
-
Name of the registered service or data to retrieve
- $throwAway : bool|array<string|int, mixed> = false
-
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 FromConfigInterface and will not store the client for later retrieval.
Tags
Return values
ClientInterface|mixedset()
Register a service or arbitrary data by name with the service builder
public
set(string $key, mixed $service) : ServiceBuilderInterface
Parameters
- $key : string
-
Name of the client or data to register
- $service : mixed
-
Client configuration array or arbitrary data to register. The client configuration array must include a 'class' (string) and 'params' (array) key.