Open Journal Systems  3.3.0
Public Member Functions | Static Public Member Functions | Protected Attributes
Guzzle\Service\Exception\CommandTransferException Class Reference
Inheritance diagram for Guzzle\Service\Exception\CommandTransferException:
Guzzle\Http\Exception\MultiTransferException Guzzle\Common\Exception\ExceptionCollection Guzzle\Common\Exception\GuzzleException

Public Member Functions

 addFailedCommand (CommandInterface $command)
 
 addSuccessfulCommand (CommandInterface $command)
 
 getAllCommands ()
 
 getExceptionForFailedCommand (CommandInterface $command)
 
 getFailedCommands ()
 
 getSuccessfulCommands ()
 
- Public Member Functions inherited from Guzzle\Http\Exception\MultiTransferException
 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)
 

Static Public Member Functions

static fromMultiTransferException (MultiTransferException $e)
 

Protected Attributes

 $failedCommands = array()
 
 $successfulCommands = array()
 
- Protected Attributes inherited from Guzzle\Http\Exception\MultiTransferException
 $exceptionForRequest = array()
 
 $failedRequests = array()
 
 $successfulRequests = array()
 
- Protected Attributes inherited from Guzzle\Common\Exception\ExceptionCollection
 $exceptions = array()
 

Detailed Description

Exception thrown when transferring commands in parallel

Definition at line 11 of file CommandTransferException.php.

Member Function Documentation

◆ addFailedCommand()

Guzzle\Service\Exception\CommandTransferException::addFailedCommand ( CommandInterface  $command)

Add to the array of failed commands

Parameters
CommandInterface$commandFailed command
Returns
self

Definition at line 81 of file CommandTransferException.php.

◆ addSuccessfulCommand()

Guzzle\Service\Exception\CommandTransferException::addSuccessfulCommand ( CommandInterface  $command)

Add to the array of successful commands

Parameters
CommandInterface$commandSuccessful command
Returns
self

Definition at line 67 of file CommandTransferException.php.

◆ fromMultiTransferException()

static Guzzle\Service\Exception\CommandTransferException::fromMultiTransferException ( MultiTransferException  $e)
static

Creates a new CommandTransferException from a MultiTransferException

Parameters
MultiTransferException$eException to base a new exception on
Returns
self

Definition at line 23 of file CommandTransferException.php.

References Guzzle\Common\Exception\ExceptionCollection\count(), Guzzle\Http\Exception\MultiTransferException\getExceptionForFailedRequest(), Guzzle\Http\Exception\MultiTransferException\getFailedRequests(), and Guzzle\Http\Exception\MultiTransferException\getSuccessfulRequests().

Referenced by Guzzle\Service\Client\executeMultiple(), Guzzle\Tests\Service\Exception\CommandTransferExceptionTest\testAddsNonRequestExceptions(), Guzzle\Tests\Service\Exception\CommandTransferExceptionTest\testCanRetrieveExceptionForCommand(), and Guzzle\Tests\Service\Exception\CommandTransferExceptionTest\testConvertsMultiExceptionIntoCommandTransfer().

◆ getAllCommands()

Guzzle\Service\Exception\CommandTransferException::getAllCommands ( )

Get all of the commands in the transfer

Returns
array

Definition at line 55 of file CommandTransferException.php.

◆ getExceptionForFailedCommand()

Guzzle\Service\Exception\CommandTransferException::getExceptionForFailedCommand ( CommandInterface  $command)

Get the Exception that caused the given $command to fail

Parameters
CommandInterface$commandFailed command
Returns
\Exception|null

Definition at line 115 of file CommandTransferException.php.

References Guzzle\Http\Exception\MultiTransferException\getExceptionForFailedRequest(), and Guzzle\Service\Command\CommandInterface\getRequest().

◆ getFailedCommands()

Guzzle\Service\Exception\CommandTransferException::getFailedCommands ( )

Get an array of failed commands

Returns
array

Definition at line 103 of file CommandTransferException.php.

References Guzzle\Service\Exception\CommandTransferException\$failedCommands.

Referenced by Guzzle\Tests\Service\ClientTest\testWrapsMultipleCommandExceptions().

◆ getSuccessfulCommands()

Guzzle\Service\Exception\CommandTransferException::getSuccessfulCommands ( )

Get an array of successful commands

Returns
array

Definition at line 93 of file CommandTransferException.php.

References Guzzle\Service\Exception\CommandTransferException\$successfulCommands.

Referenced by Guzzle\Tests\Service\ClientTest\testWrapsMultipleCommandExceptions().

Field Documentation

◆ $failedCommands

Guzzle\Service\Exception\CommandTransferException::$failedCommands = array()
protected

Definition at line 14 of file CommandTransferException.php.

Referenced by Guzzle\Service\Exception\CommandTransferException\getFailedCommands().

◆ $successfulCommands

Guzzle\Service\Exception\CommandTransferException::$successfulCommands = array()
protected

Definition at line 13 of file CommandTransferException.php.

Referenced by Guzzle\Service\Exception\CommandTransferException\getSuccessfulCommands().

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