Interface ClientInterface

Client interface for executing commands on a web service.

Guzzle\Service\ClientInterface implements Guzzle\Http\ClientInterface, Guzzle\Common\FromConfigInterface

Direct known implementers

Guzzle\Service\Client

Indirect known implementers

Guzzle\Tests\Service\Mock\MockClient

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

Methods summary
`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
`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
`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`
`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
`public Guzzle\Service\Resource\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 `Guzzle\Service\Resource\ResourceIteratorInterface`

Methods inherited from Guzzle\Http\ClientInterface
`createRequest(), delete(), get(), getBaseUrl(), getConfig(), head(), options(), patch(), post(), put(), send(), setBaseUrl(), setConfig(), setSslVerification(), setUserAgent()`

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

Methods inherited from Guzzle\Common\FromConfigInterface
`factory()`

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