Class MultiTransferException
Exception encountered during a multi transfer
- Exception
-
Guzzle\Common\Exception\ExceptionCollection
implements
Guzzle\Common\Exception\GuzzleException,
IteratorAggregate,
Countable
-
Guzzle\Http\Exception\MultiTransferException
Direct known subclasses
Methods summary
-
publicgetAllRequests ( )Get all of the requests in the transfer
-
publicaddSuccessfulRequest ( Guzzle\Http\Message\RequestInterface $request )Add to the array of successful requests
-
publicaddFailedRequest ( Guzzle\Http\Message\RequestInterface $request )Add to the array of failed requests
-
publicaddFailedRequestWithException ( Guzzle\Http\Message\RequestInterface $request, Exception $exception )Add to the array of failed requests and associate with exceptions
-
publicgetExceptionForFailedRequest ( Guzzle\Http\Message\RequestInterface $request )Get the Exception that caused the given $request to fail
-
publicsetSuccessfulRequests ( array $requests )Set all of the successful requests
-
publicsetFailedRequests ( array $requests )Set all of the failed requests
-
publicgetSuccessfulRequests ( )Get an array of successful requests sent in the multi transfer
-
publicgetFailedRequests ( )Get an array of failed requests sent in the multi transfer
-
publiccontainsRequest ( Guzzle\Http\Message\RequestInterface $request )Check if the exception object contains a request
Methods detail
Get all of the requests in the transfer
Returns
array
public
Guzzle\Http\Exception\MultiTransferException
addSuccessfulRequest( Guzzle\Http\Message\RequestInterface $request )
Add to the array of successful requests
Parameters
- $request
Guzzle\Http\Message\RequestInterface
$request Successful request
Returns
public
Guzzle\Http\Exception\MultiTransferException
addFailedRequest( Guzzle\Http\Message\RequestInterface $request )
Add to the array of failed requests
Parameters
- $request
Guzzle\Http\Message\RequestInterface
$request Failed request
Returns
public
Guzzle\Http\Exception\MultiTransferException
addFailedRequestWithException( Guzzle\Http\Message\RequestInterface $request, Exception $exception )
Add to the array of failed requests and associate with exceptions
Parameters
- $request
Guzzle\Http\Message\RequestInterface
$request Failed request- $exception
Exception
$exception Exception to add and associate with
Returns
public
Exception|null
getExceptionForFailedRequest( Guzzle\Http\Message\RequestInterface $request )
Get the Exception that caused the given $request to fail
Parameters
- $request
Guzzle\Http\Message\RequestInterface
$request Failed command
Returns
Exception|nullSet all of the successful requests
Parameters
- $requests
array
Array of requests
Returns
Set all of the failed requests
Parameters
- $requests
array
Array of requests
Returns
Get an array of successful requests sent in the multi transfer
Returns
arrayGet an array of failed requests sent in the multi transfer
Returns
arrayCheck if the exception object contains a request
Parameters
- $request
Guzzle\Http\Message\RequestInterface
$request Request to check
Returns
booleanMethods inherited from Guzzle\Common\Exception\ExceptionCollection
__construct(),
add(),
count(),
getFirst(),
getIterator(),
setExceptions()
Methods inherited from Exception
__toString(),
__wakeup(),
getCode(),
getFile(),
getLine(),
getMessage(),
getPrevious(),
getTrace(),
getTraceAsString()
Magic methods summary
Properties summary
protected
array
|
$successfulRequests | |
protected
array
|
$failedRequests | |
protected
array
|
$exceptionForRequest |