\Guzzle\Service\ExceptionCommandTransferException

Exception thrown when transferring commands in parallel

Summary

Methods

Properties

Constants

getAllRequests()
addSuccessfulRequest()
addFailedRequest()
addFailedRequestWithException()
getExceptionForFailedRequest()
setSuccessfulRequests()
setFailedRequests()
getSuccessfulRequests()
getFailedRequests()
containsRequest()
__construct()
setExceptions()
add()
count()
getIterator()
getFirst()
fromMultiTransferException()
getAllCommands()
addSuccessfulCommand()
addFailedCommand()
getSuccessfulCommands()
getFailedCommands()
getExceptionForFailedCommand()

No public properties found

No constants found

No protected methods found

$successfulRequests
$failedRequests
$exceptionForRequest
$exceptions
$successfulCommands
$failedCommands

N/A

getExceptionMessage()

$shortMessage

N/A

Properties

$successfulRequests

$successfulRequests :

Type

$failedRequests

$failedRequests :

Type

$exceptionForRequest

$exceptionForRequest :

Type

$exceptions

$exceptions : array

Type

array — Array of Exceptions

$successfulCommands

$successfulCommands :

Type

$failedCommands

$failedCommands :

Type

$shortMessage

$shortMessage : string

Type

string — Succinct exception message not including sub-exceptions

Methods

getAllRequests()

getAllRequests() : array

Get all of the requests in the transfer

Returns

array

addSuccessfulRequest()

addSuccessfulRequest(\Guzzle\Http\Message\RequestInterface  $request) : self

Add to the array of successful requests

Parameters

\Guzzle\Http\Message\RequestInterface

$request

Successful request

Returns

self

addFailedRequest()

addFailedRequest(\Guzzle\Http\Message\RequestInterface  $request) : self

Add to the array of failed requests

Parameters

\Guzzle\Http\Message\RequestInterface

$request

Failed request

Returns

self

addFailedRequestWithException()

addFailedRequestWithException(\Guzzle\Http\Message\RequestInterface  $request, \Exception  $exception) : self

Add to the array of failed requests and associate with exceptions

Parameters

\Guzzle\Http\Message\RequestInterface	$request	Failed request
\Exception	$exception	Exception to add and associate with

Returns

self

getExceptionForFailedRequest()

getExceptionForFailedRequest(\Guzzle\Http\Message\RequestInterface  $request) : \Exception|null

Get the Exception that caused the given $request to fail

Parameters

\Guzzle\Http\Message\RequestInterface

$request

Failed command

Returns

\Exception|null

setSuccessfulRequests()

setSuccessfulRequests(array  $requests) : self

Set all of the successful requests

Parameters

array

$requests

Returns

self

setFailedRequests()

setFailedRequests(array  $requests) : self

Set all of the failed requests

Parameters

array

$requests

Returns

self

getSuccessfulRequests()

getSuccessfulRequests() : array

Get an array of successful requests sent in the multi transfer

Returns

array

getFailedRequests()

getFailedRequests() : array

Get an array of failed requests sent in the multi transfer

Returns

array

containsRequest()

containsRequest(\Guzzle\Http\Message\RequestInterface  $request) : boolean

Check if the exception object contains a request

Parameters

\Guzzle\Http\Message\RequestInterface

$request

Request to check

Returns

boolean

__construct()

__construct(  $message = '',   $code, \Exception  $previous = null)

Parameters

	$message
	$code
\Exception	$previous

setExceptions()

setExceptions(array  $exceptions) : self

Set all of the exceptions

Parameters

array

$exceptions

Array of exceptions

Returns

self

add()

add(\Guzzle\Common\Exception\ExceptionCollection|\Exception  $e) : \Guzzle\Common\Exception\ExceptionCollection;

Add exceptions to the collection

Parameters

\Guzzle\Common\Exception\ExceptionCollection|\Exception

Exception to add

Returns

\Guzzle\Common\Exception\ExceptionCollection;

count()

count() : integer

Get the total number of request exceptions

Returns

integer

getIterator()

getIterator() : \ArrayIterator

Allows array-like iteration over the request exceptions

Returns

\ArrayIterator

getFirst()

getFirst() : \Exception

Get the first exception in the collection

Returns

\Exception

fromMultiTransferException()

fromMultiTransferException(\Guzzle\Http\Exception\MultiTransferException  $e) : self

Creates a new CommandTransferException from a MultiTransferException

Parameters

\Guzzle\Http\Exception\MultiTransferException

Exception to base a new exception on

Returns

self

getAllCommands()

getAllCommands() : array

Get all of the commands in the transfer

Returns

array

addSuccessfulCommand()

addSuccessfulCommand(\Guzzle\Service\Command\CommandInterface  $command) : self

Add to the array of successful commands

Parameters

\Guzzle\Service\Command\CommandInterface

$command

Successful command

Returns

self

addFailedCommand()

addFailedCommand(\Guzzle\Service\Command\CommandInterface  $command) : self

Add to the array of failed commands

Parameters

\Guzzle\Service\Command\CommandInterface

$command

Failed command

Returns

self

getSuccessfulCommands()

getSuccessfulCommands() : array

Get an array of successful commands

Returns

array

getFailedCommands()

getFailedCommands() : array

Get an array of failed commands

Returns

array

getExceptionForFailedCommand()

getExceptionForFailedCommand(\Guzzle\Service\Command\CommandInterface  $command) : \Exception|null

Get the Exception that caused the given $command to fail

Parameters

\Guzzle\Service\Command\CommandInterface

$command

Failed command

Returns

\Exception|null

getExceptionMessage()

getExceptionMessage(\Exception  $e,   $depth)

Parameters

\Exception	$e
	$depth