![]() |
Maileon PHP client
1.5.5
Easily integrate your PHP application with Maileon.
|
Public Member Functions | |
__construct ($response, $curlSession, $throwException=true, $deserializationType=null) | |
getResult () | |
getStatusCode () | |
isSuccess () | |
isClientError () | |
getContentType () | |
getBodyData () | |
getResultXML () | |
getResponseHeaders () | |
toString () | |
The result of making a call to the Maileon REST API.
This class encapsulates the technical details of the REST API's HTTP response. In order to retrieve the payload result in deserialized form, just call com_maileon_api_MaileonAPIResult::getResult().
However, this class also allows the underlying HTTP response information to be queried, including the returned status code (com_maileon_api_MaileonAPIResult::getStatusCode()) and content type (com_maileon_api_MaileonAPIResult::getContentType()) as well as the raw HTTP response body data (com_maileon_api_MaileonAPIResult::getBodyData()).
Definition at line 15 of file MaileonAPIResult.php.
com_maileon_api_MaileonAPIResult::__construct | ( | $response, | |
$curlSession, | |||
$throwException = true , |
|||
$deserializationType = null |
|||
) |
Creates a new result object from the curl response and session data.
string | $response | the HTTP response data, null if there was none |
mixed | $curlSession | the cURL session that was used |
bool | $throwException | if true, an exception will be thrown in case of a connection or server error |
mixed | $deserializationType | The name of the class this result should be deserialized as. Use array( 'array', 'typename' ) to deserialize arrays of a type. |
com_maileon_api_MaileonAPIException | if $throwException == true and there was a connection problem or a server error occurred |
Definition at line 43 of file MaileonAPIResult.php.
com_maileon_api_MaileonAPIResult::getResult | ( | ) |
Definition at line 133 of file MaileonAPIResult.php.
com_maileon_api_MaileonAPIResult::getStatusCode | ( | ) |
Definition at line 141 of file MaileonAPIResult.php.
com_maileon_api_MaileonAPIResult::isSuccess | ( | ) |
Definition at line 149 of file MaileonAPIResult.php.
com_maileon_api_MaileonAPIResult::isClientError | ( | ) |
Definition at line 157 of file MaileonAPIResult.php.
com_maileon_api_MaileonAPIResult::getContentType | ( | ) |
Definition at line 165 of file MaileonAPIResult.php.
com_maileon_api_MaileonAPIResult::getBodyData | ( | ) |
Definition at line 173 of file MaileonAPIResult.php.
com_maileon_api_MaileonAPIResult::getResultXML | ( | ) |
Definition at line 181 of file MaileonAPIResult.php.
com_maileon_api_MaileonAPIResult::getResponseHeaders | ( | ) |
Definition at line 189 of file MaileonAPIResult.php.
com_maileon_api_MaileonAPIResult::toString | ( | ) |
Definition at line 197 of file MaileonAPIResult.php.