Guzzle\Http\Exception\MultiTransferException Class Reference

Inheritance diagram for Guzzle\Http\Exception\MultiTransferException:

Public Member Functions
	addFailedRequest (RequestInterface $request)
	addFailedRequestWithException (RequestInterface $request, \Exception $exception)
	addSuccessfulRequest (RequestInterface $request)
	containsRequest (RequestInterface $request)
	getAllRequests ()
	getExceptionForFailedRequest (RequestInterface $request)
	getFailedRequests ()
	getSuccessfulRequests ()
	setFailedRequests (array $requests)
	setSuccessfulRequests (array $requests)
Public Member Functions inherited from Guzzle\Common\Exception\ExceptionCollection
	__construct ($message='', $code=0, \Exception $previous=null)
	add ($e)
	count ()
	getFirst ()
	getIterator ()
	setExceptions (array $exceptions)

Protected Attributes
	$exceptionForRequest = array()
	$failedRequests = array()
	$successfulRequests = array()
Protected Attributes inherited from Guzzle\Common\Exception\ExceptionCollection
	$exceptions = array()

Detailed Description

Exception encountered during a multi transfer

Definition at line 11 of file MultiTransferException.php.

Member Function Documentation

addFailedRequest()

Guzzle\Http\Exception\MultiTransferException::addFailedRequest

(

RequestInterface

$request

)

Add to the array of failed requests

Parameters

RequestInterface

$request

Failed request

Returns

self

Definition at line 48 of file MultiTransferException.php.

addFailedRequestWithException()

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

Add to the array of failed requests and associate with exceptions

Parameters

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

Returns

self

Definition at line 63 of file MultiTransferException.php.

References Guzzle\Common\Exception\ExceptionCollection\add().

addSuccessfulRequest()

Guzzle\Http\Exception\MultiTransferException::addSuccessfulRequest

(

RequestInterface

$request

)

Add to the array of successful requests

Parameters

RequestInterface

$request

Successful request

Returns

self

Definition at line 34 of file MultiTransferException.php.

containsRequest()

Guzzle\Http\Exception\MultiTransferException::containsRequest

(

RequestInterface

$request

)

Check if the exception object contains a request

Parameters

RequestInterface

$request

Request to check

Returns

bool

Definition at line 141 of file MultiTransferException.php.

Referenced by Guzzle\Tests\Http\Curl\CurlMultiTest\testSendsThroughCurlAndAggregatesRequestExceptions().

getAllRequests()

Guzzle\Http\Exception\MultiTransferException::getAllRequests

(

)

Get all of the requests in the transfer

Returns

array

Definition at line 22 of file MultiTransferException.php.

Referenced by Guzzle\Tests\Http\Curl\CurlMultiTest\testSendsThroughCurlAndAggregatesRequestExceptions().

getExceptionForFailedRequest()

Guzzle\Http\Exception\MultiTransferException::getExceptionForFailedRequest

(

RequestInterface

$request

)

Get the Exception that caused the given $request to fail

Parameters

RequestInterface

$request

Failed command

Returns

\Exception|null

Definition at line 79 of file MultiTransferException.php.

Referenced by Guzzle\Service\Exception\CommandTransferException\fromMultiTransferException(), and Guzzle\Service\Exception\CommandTransferException\getExceptionForFailedCommand().

getFailedRequests()

Guzzle\Http\Exception\MultiTransferException::getFailedRequests

(

)

Get an array of failed requests sent in the multi transfer

Returns

array

Definition at line 129 of file MultiTransferException.php.

References Guzzle\Http\Exception\MultiTransferException\$failedRequests.

Referenced by Guzzle\Service\Client\executeMultiple(), Guzzle\Service\Exception\CommandTransferException\fromMultiTransferException(), Guzzle\Tests\Http\Curl\CurlMultiTest\testSendsThroughCurlAndAggregatesRequestExceptions(), and Guzzle\Tests\Service\ClientTest\testWrapsMultipleCommandExceptions().

getSuccessfulRequests()

Guzzle\Http\Exception\MultiTransferException::getSuccessfulRequests

(

)

Get an array of successful requests sent in the multi transfer

Returns

array

Definition at line 119 of file MultiTransferException.php.

References Guzzle\Http\Exception\MultiTransferException\$successfulRequests.

Referenced by Guzzle\Service\Exception\CommandTransferException\fromMultiTransferException(), Guzzle\Tests\Http\Curl\CurlMultiTest\testSendsThroughCurlAndAggregatesRequestExceptions(), and Guzzle\Tests\Service\ClientTest\testWrapsMultipleCommandExceptions().

setFailedRequests()

Guzzle\Http\Exception\MultiTransferException::setFailedRequests

(

array

$requests

)

Set all of the failed requests

Parameters

array

Array of requests

Returns

self

Definition at line 107 of file MultiTransferException.php.

setSuccessfulRequests()

Guzzle\Http\Exception\MultiTransferException::setSuccessfulRequests

(

array

$requests

)

Set all of the successful requests

Parameters

array

Array of requests

Returns

self

Definition at line 93 of file MultiTransferException.php.

Field Documentation

$exceptionForRequest

Guzzle\Http\Exception\MultiTransferException::$exceptionForRequest = array()

protected

Definition at line 15 of file MultiTransferException.php.

$failedRequests

Guzzle\Http\Exception\MultiTransferException::$failedRequests = array()

protected

Definition at line 14 of file MultiTransferException.php.

Referenced by Guzzle\Http\Exception\MultiTransferException\getFailedRequests().

$successfulRequests

Guzzle\Http\Exception\MultiTransferException::$successfulRequests = array()

protected

Definition at line 13 of file MultiTransferException.php.

Referenced by Guzzle\Http\Exception\MultiTransferException\getSuccessfulRequests().

---

The documentation for this class was generated from the following file:

• MultiTransferException.php