Exception encountered during a multi transfer
Expanded class hierarchy of MultiTransferException
class MultiTransferException extends ExceptionCollection {
protected $successfulRequests = array();
protected $failedRequests = array();
/**
* Get all of the requests in the transfer
*
* @return array
*/
public function getAllRequests() {
return array_merge($this->successfulRequests, $this->failedRequests);
}
/**
* Add to the array of successful requests
*
* @param RequestInterface $request Successful request
*
* @return self
*/
public function addSuccessfulRequest(RequestInterface $request) {
$this->successfulRequests[] = $request;
return $this;
}
/**
* Add to the array of failed requests
*
* @param RequestInterface $request Failed request
*
* @return self
*/
public function addFailedRequest(RequestInterface $request) {
$this->failedRequests[] = $request;
return $this;
}
/**
* Set all of the successful requests
*
* @param array Array of requests
*
* @return self
*/
public function setSuccessfulRequests(array $requests) {
$this->successfulRequests = $requests;
return $this;
}
/**
* Set all of the failed requests
*
* @param array Array of requests
*
* @return self
*/
public function setFailedRequests(array $requests) {
$this->failedRequests = $requests;
return $this;
}
/**
* Get an array of successful requests sent in the multi transfer
*
* @return array
*/
public function getSuccessfulRequests() {
return $this->successfulRequests;
}
/**
* Get an array of failed requests sent in the multi transfer
*
* @return array
*/
public function getFailedRequests() {
return $this->failedRequests;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ExceptionCollection:: |
protected | property | ||
ExceptionCollection:: |
public | function | Add exceptions to the collection | |
ExceptionCollection:: |
public | function | Get the total number of request exceptions | |
ExceptionCollection:: |
public | function | Get the first exception in the collection | |
ExceptionCollection:: |
public | function | Allows array-like iteration over the request exceptions | |
ExceptionCollection:: |
public | function | Set all of the exceptions | |
MultiTransferException:: |
protected | property | ||
MultiTransferException:: |
protected | property | ||
MultiTransferException:: |
public | function | Add to the array of failed requests | |
MultiTransferException:: |
public | function | Add to the array of successful requests | |
MultiTransferException:: |
public | function | Get all of the requests in the transfer | |
MultiTransferException:: |
public | function | Get an array of failed requests sent in the multi transfer | |
MultiTransferException:: |
public | function | Get an array of successful requests sent in the multi transfer | |
MultiTransferException:: |
public | function | Set all of the failed requests | |
MultiTransferException:: |
public | function | Set all of the successful requests |