Class Guzzle\Http\Exception\MultiTransferException

InheritanceGuzzle\Http\Exception\MultiTransferException » Guzzle\Common\Exception\ExceptionCollection » Exception
ImplementsCountable, Guzzle\Common\Exception\GuzzleException, IteratorAggregate
SubclassesGuzzle\Service\Exception\CommandTransferException

Exception encountered during a multi transfer

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Guzzle\Common\Exception\ExceptionCollection
add() Add exceptions to the collection Guzzle\Common\Exception\ExceptionCollection
addFailedRequest() Add to the array of failed requests Guzzle\Http\Exception\MultiTransferException
addFailedRequestWithException() Add to the array of failed requests and associate with exceptions Guzzle\Http\Exception\MultiTransferException
addSuccessfulRequest() Add to the array of successful requests Guzzle\Http\Exception\MultiTransferException
containsRequest() Check if the exception object contains a request Guzzle\Http\Exception\MultiTransferException
count() Get the total number of request exceptions Guzzle\Common\Exception\ExceptionCollection
getAllRequests() Get all of the requests in the transfer Guzzle\Http\Exception\MultiTransferException
getExceptionForFailedRequest() Get the Exception that caused the given $request to fail Guzzle\Http\Exception\MultiTransferException
getFailedRequests() Get an array of failed requests sent in the multi transfer Guzzle\Http\Exception\MultiTransferException
getFirst() Get the first exception in the collection Guzzle\Common\Exception\ExceptionCollection
getIterator() Allows array-like iteration over the request exceptions Guzzle\Common\Exception\ExceptionCollection
getSuccessfulRequests() Get an array of successful requests sent in the multi transfer Guzzle\Http\Exception\MultiTransferException
setExceptions() Set all of the exceptions Guzzle\Common\Exception\ExceptionCollection
setFailedRequests() Set all of the failed requests Guzzle\Http\Exception\MultiTransferException
setSuccessfulRequests() Set all of the successful requests Guzzle\Http\Exception\MultiTransferException

Property Details

$exceptionForRequest protected property
protected $exceptionForRequest = []
$failedRequests protected property
protected $failedRequests = []
$successfulRequests protected property
protected $successfulRequests = []

Method Details

addFailedRequest() public method

Add to the array of failed requests

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

Failed request

addFailedRequestWithException() public method

Add to the array of failed requests and associate with exceptions

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

Failed request

$exception Exception

Exception to add and associate with

addSuccessfulRequest() public method

Add to the array of successful requests

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

Successful request

containsRequest() public method

Check if the exception object contains a request

public bool containsRequest ( Guzzle\Http\Message\RequestInterface $request )
$request Guzzle\Http\Message\RequestInterface

Request to check

getAllRequests() public method

Get all of the requests in the transfer

public array getAllRequests ( )
getExceptionForFailedRequest() public method

Get the Exception that caused the given $request to fail

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

Failed command

getFailedRequests() public method

Get an array of failed requests sent in the multi transfer

public array getFailedRequests ( )
getSuccessfulRequests() public method

Get an array of successful requests sent in the multi transfer

public array getSuccessfulRequests ( )
setFailedRequests() public method

Set all of the failed requests

public self setFailedRequests ( array $requests )
$requests
setSuccessfulRequests() public method

Set all of the successful requests

public self setSuccessfulRequests ( array $requests )
$requests