Inheritance diagram for Guzzle\Service\ClientInterface:

Public Member Functions
	execute ($command)

	getCommand ($name, array $args=array())

	getDescription ()

	getIterator ($command, array $commandOptions=null, array $iteratorOptions=array())

	setDescription (ServiceDescriptionInterface $service)

Public Member Functions inherited from Guzzle\Http\ClientInterface
	createRequest ( $method=RequestInterface::GET, $uri=null, $headers=null, $body=null, array $options=array())

	delete ($uri=null, $headers=null, $body=null, array $options=array())

	get ($uri=null, $headers=null, $options=array())

	getBaseUrl ($expand=true)

	getConfig ($key=false)

	head ($uri=null, $headers=null, array $options=array())

	options ($uri=null, array $options=array())

	patch ($uri=null, $headers=null, $body=null, array $options=array())

	post ($uri=null, $headers=null, $postBody=null, array $options=array())

	put ($uri=null, $headers=null, $body=null, array $options=array())

	send ($requests)

	setBaseUrl ($url)

	setConfig ($config)

	setSslVerification ($certificateAuthority=true, $verifyPeer=true, $verifyHost=2)

	setUserAgent ($userAgent, $includeDefault=false)

Public Member Functions inherited from Guzzle\Common\HasDispatcherInterface
	addSubscriber (EventSubscriberInterface $subscriber)

	dispatch ($eventName, array $context=array())

	getEventDispatcher ()

	setEventDispatcher (EventDispatcherInterface $eventDispatcher)

Additional Inherited Members
Static Public Member Functions inherited from Guzzle\Common\HasDispatcherInterface
static	getAllEvents ()

Static Public Member Functions inherited from Guzzle\Common\FromConfigInterface
static	factory ($config=array())

Data Fields inherited from Guzzle\Http\ClientInterface
const	CREATE_REQUEST = 'client.create_request'

const	HTTP_DATE = 'D, d M Y H:i:s \G\M\T'

Detailed Description

Client interface for executing commands on a web service.

Definition at line 16 of file lib/vendor/guzzle/guzzle/src/Guzzle/Service/ClientInterface.php.

Member Function Documentation

◆ execute()

Guzzle\Service\ClientInterface::execute ( $command )

Execute one or more commands

Parameters

CommandInterface | array | Traversable $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

Exceptions

InvalidArgumentException	if an invalid command is passed
CommandTransferException	if an exception is encountered when transferring multiple commands

Implemented in Guzzle\Service\Client.

◆ getCommand()

Guzzle\Service\ClientInterface::getCommand	(		$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.

Parameters

string	$name	Name of the command to retrieve
array	$args	Arguments to pass to the command

Returns: CommandInterface

Exceptions

InvalidArgumentException if no command can be found by name

Implemented in Guzzle\Service\Client.

◆ getDescription()

Guzzle\Service\ClientInterface::getDescription ( )

Get the service description of the client

Returns: ServiceDescriptionInterface|null

Implemented in Guzzle\Service\Client.

◆ getIterator()

Guzzle\Service\ClientInterface::getIterator	(		$command,
		array	$commandOptions = `null`,
		array	$iteratorOptions = `array()`
	)

Get a resource iterator from the client.

Parameters

string \| CommandInterface	$command	Command class or command name.
array	$commandOptions	Command options used when creating commands.
array	$iteratorOptions	Iterator options passed to the iterator when it is instantiated.