Class Client

Client object for executing commands on a web service.

Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface

Extended by

Guzzle\Http\Client implements Guzzle\Http\ClientInterface

Extended by

Guzzle\Service\Client implements Guzzle\Service\ClientInterface

Direct known subclasses

Guzzle\Tests\Service\Mock\MockClient

Namespace: Guzzle\Service
Located at src/Guzzle/Service/Client.php

Methods summary
`public static Guzzle\Service\Client`	# `factory( array\|Guzzle\Common\Collection $config = array() )` Basic factory method to create a new client. Extend this method in subclasses to build more complex clients. Basic factory method to create a new client. Extend this method in subclasses to build more complex clients. Parameters `$config` Configuration data Returns `Guzzle\Service\Client` Implementation of `Guzzle\Common\FromConfigInterface::factory()`
`public static array`	# `getAllEvents( )` Get a list of all of the events emitted from the class Get a list of all of the events emitted from the class Returns array Overrides `Guzzle\Http\Client::getAllEvents()` Implementation of `Guzzle\Common\HasDispatcherInterface::getAllEvents()`
`public mixed`	# `__call( string $method, array $args )` Magic method used to retrieve a command Magic method used to retrieve a command Parameters `$method` Name of the command object to instantiate `$args` Arguments to pass to the command Returns mixed Returns the result of the command Throws `BadMethodCallException` when a command is not found
`public Guzzle\Service\Command\CommandInterface`	# `getCommand( string $name, array $args = array() )` Get a command by name. First, the client will see if it has a service description and if the service description defines a command by the supplied name. If no dynamic command is found, the client will look for a concrete command class exists matching the name supplied. If neither are found, an InvalidArgumentException is thrown. Get a command by name. First, the client will see if it has a service description and if the service description defines a command by the supplied name. If no dynamic command is found, the client will look for a concrete command class exists matching the name supplied. If neither are found, an InvalidArgumentException is thrown. Parameters `$name` Name of the command to retrieve `$args` Arguments to pass to the command Returns `Guzzle\Service\Command\CommandInterface` Throws `InvalidArgumentException` if no command can be found by name Implementation of `Guzzle\Service\ClientInterface::getCommand()`
`public Guzzle\Service\Client`	# `setCommandFactory( Guzzle\Service\Command\Factory\FactoryInterface $factory )` Set the command factory used to create commands by name Set the command factory used to create commands by name Parameters `$factory` Command factory Returns `Guzzle\Service\Client`
`public Guzzle\Service\Client`	# `setResourceIteratorFactory( Guzzle\Service\Resource\ResourceIteratorFactoryInterface $factory )` Set the resource iterator factory associated with the client Set the resource iterator factory associated with the client Parameters `$factory` Resource iterator factory Returns `Guzzle\Service\Client`
`public ResourceIteratorInterface`	# `getIterator( string\|Guzzle\Service\Command\CommandInterface $command, array $commandOptions = null, array $iteratorOptions = array() )` Get a resource iterator from the client. Get a resource iterator from the client. Parameters `$command` Command class or command name. `$commandOptions` Command options used when creating commands. `$iteratorOptions` Iterator options passed to the iterator when it is instantiated. Returns ResourceIteratorInterface Implementation of `Guzzle\Service\ClientInterface::getIterator()`
`public mixed`	# `execute( Guzzle\Service\Command\CommandInterface\|array\|Traversable $command )` Execute one or more commands Execute one or more commands Parameters `$command` Command, array of commands or Traversable object containing commands to execute Returns mixed Returns the result of the executed command or an array of commands if executing multiple commands Throws `InvalidArgumentException` if an invalid command is passed `Guzzle\Service\Exception\CommandTransferException` if an exception is encountered when transferring multiple commands Implementation of `Guzzle\Service\ClientInterface::execute()`
`public Guzzle\Service\ClientInterface`	# `setDescription( Guzzle\Service\Description\ServiceDescriptionInterface $service )` Set the service description of the client Set the service description of the client Parameters `$service` Service description Returns `Guzzle\Service\ClientInterface` Implementation of `Guzzle\Service\ClientInterface::setDescription()`
`public Guzzle\Service\Description\ServiceDescriptionInterface\|null`	# `getDescription( )` Get the service description of the client Get the service description of the client Returns `Guzzle\Service\Description\ServiceDescriptionInterface`\|null Implementation of `Guzzle\Service\ClientInterface::getDescription()`
`public Guzzle\Service\Client`	# `setInflector( Guzzle\Inflection\InflectorInterface $inflector )` Set the inflector used with the client Set the inflector used with the client Parameters `$inflector` Inflection object Returns `Guzzle\Service\Client`
`public Guzzle\Service\Client`	# `getInflector( )` Get the inflector used with the client Get the inflector used with the client Returns `Guzzle\Service\Client`
`protected Guzzle\Http\Message\RequestInterface`	# `prepareCommand( Guzzle\Service\Command\CommandInterface $command )` Prepare a command for sending and get the RequestInterface object created by the command Prepare a command for sending and get the RequestInterface object created by the command Parameters `$command` Command to prepare Returns `Guzzle\Http\Message\RequestInterface`
`protected array`	# `executeMultiple( array\|Traversable $commands )` Execute multiple commands in parallel Execute multiple commands in parallel Parameters `$commands` Array of CommandInterface objects to execute Returns array Returns an array of the executed commands Throws `Guzzle\Service\Exception\CommandTransferException`
`protected`	# `getResourceIteratorFactory( )`
`protected Guzzle\Service\Command\Factory\FactoryInterface`	# `getCommandFactory( )` Get the command factory associated with the client Get the command factory associated with the client Returns `Guzzle\Service\Command\Factory\FactoryInterface`
`public`	# `enableMagicMethods( $isEnabled )` Deprecated Codecoverageignore

Methods inherited from Guzzle\Http\Client
`__construct(), createRequest(), delete(), expandTemplate(), extractPharCacert(), get(), getBaseUrl(), getConfig(), getCurlMulti(), getDefaultHeaders(), getDefaultOption(), getDefaultUserAgent(), getUriTemplate(), head(), initSsl(), options(), patch(), post(), preparePharCacert(), prepareRequest(), put(), send(), sendMultiple(), setBaseUrl(), setConfig(), setCurlMulti(), setDefaultHeaders(), setDefaultOption(), setRequestFactory(), setSslVerification(), setUriTemplate(), setUserAgent()`

Methods inherited from Guzzle\Common\AbstractHasDispatcher
`addSubscriber(), dispatch(), getEventDispatcher(), setEventDispatcher()`

Constants summary
`string`	`COMMAND_PARAMS`	# `'command.params'`

Constants inherited from Guzzle\Http\Client
`CURL_OPTIONS, DEFAULT_SELECT_TIMEOUT, DISABLE_REDIRECTS, MAX_HANDLES, REQUEST_OPTIONS, REQUEST_PARAMS, SSL_CERT_AUTHORITY`

Constants inherited from Guzzle\Http\ClientInterface
`CREATE_REQUEST, HTTP_DATE`

Properties summary
`protected Guzzle\Service\Description\ServiceDescriptionInterface`	`$serviceDescription` Description of the service and possible commands Description of the service and possible commands	#
`protected Guzzle\Service\Command\Factory\FactoryInterface`	`$commandFactory`	#
`protected Guzzle\Service\Resource\ResourceIteratorFactoryInterface`	`$resourceIteratorFactory`	#
`protected Guzzle\Inflection\InflectorInterface`	`$inflector` Inflector associated with the service/client Inflector associated with the service/client	#

Properties inherited from Guzzle\Http\Client
`$defaultHeaders, $requestFactory, $userAgent`

Properties inherited from Guzzle\Common\AbstractHasDispatcher
`$eventDispatcher`