|
| __construct (array $config) |
|
| setDebug ($isDebug) |
|
| isDebug () |
|
| get ($resourcePath, $queryParameters=array(), $mimeType= 'application/vnd.maileon.api+xml', $deserializationType=null) |
|
| put ($resourcePath, $payload="", $queryParameters=array(), $mimeType= 'application/vnd.maileon.api+xml', $deserializationType=null) |
|
| post ($resourcePath, $payload="", $queryParameters=array(), $mimeType= 'application/vnd.maileon.api+xml', $deserializationType=null, $contentType=null, $contentLength=null) |
|
| delete ($resourcePath, $queryParameters=array(), $mimeType= 'application/vnd.maileon.api+xml', $deserializationType=null) |
|
|
| appendArrayFields ($params, $name, $fieldValues) |
|
Abstract base class for all the service accessing individual resources. This class handles the basic authentication and provides convenience methods to access the four HTTP methods used in RESTful web services.
- Author
- Felix Heinrichs | Trusted Mails GmbH | felix.heinrichs@trusted-mails.com
-
Marcus Ständer | Trusted Mails GmbH | marcus.staender@trusted-mails.com
Definition at line 11 of file AbstractMaileonService.php.
com_maileon_api_AbstractMaileonService::__construct |
( |
array |
$config | ) |
|
Creates a new instance of the service.
- Parameters
-
string[] | $config the API call configuration array |
Definition at line 78 of file AbstractMaileonService.php.
com_maileon_api_AbstractMaileonService::setDebug |
( |
|
$isDebug | ) |
|
(De)activates printing debug output. CAUTION: enabling this in production may compromise sensitive information.
- Parameters
-
bool | $isDebug | true to enable debugging, false to disable it |
Definition at line 114 of file AbstractMaileonService.php.
com_maileon_api_AbstractMaileonService::isDebug |
( |
| ) |
|
com_maileon_api_AbstractMaileonService::get |
( |
|
$resourcePath, |
|
|
|
$queryParameters = array() , |
|
|
|
$mimeType = 'application/vnd.maileon.api+xml' , |
|
|
|
$deserializationType = null |
|
) |
| |
Performs a GET operation on a resource
- Parameters
-
string | $resourcePath | the path of the resource to GET |
| string[] | $queryParameters any additional query parameters |
string | $mimeType | the acceptable response MIME type |
mixed | $deserializationType | The name of the class this result should be deserialized as. Use array( 'array', 'typename' ) to deserialize arrays of a type. |
- Returns
- com_maileon_api_MaileonAPIResult the result object of the API call
- Exceptions
-
Definition at line 146 of file AbstractMaileonService.php.
com_maileon_api_AbstractMaileonService::put |
( |
|
$resourcePath, |
|
|
|
$payload = "" , |
|
|
|
$queryParameters = array() , |
|
|
|
$mimeType = 'application/vnd.maileon.api+xml' , |
|
|
|
$deserializationType = null |
|
) |
| |
Performs a PUT operation (i.e. an update) on a resource.
- Parameters
-
string | $resourcePath | the path of the resource to PUT |
string | $payload | the payload data to PUT, i.e. the data to update the current state of the resource with |
array | $queryParameters | any additional query parameters |
string | $mimeType | the acceptable response MIME type |
mixed | $deserializationType | The name of the class this result should be deserialized as. Use array( 'array', 'typename' ) to deserialize arrays of a type. |
- Returns
- com_maileon_api_MaileonAPIResult the result object of the API call
- Exceptions
-
Definition at line 173 of file AbstractMaileonService.php.
com_maileon_api_AbstractMaileonService::post |
( |
|
$resourcePath, |
|
|
|
$payload = "" , |
|
|
|
$queryParameters = array() , |
|
|
|
$mimeType = 'application/vnd.maileon.api+xml' , |
|
|
|
$deserializationType = null , |
|
|
|
$contentType = null , |
|
|
|
$contentLength = null |
|
) |
| |
Performs a POST operation (i.e. creates a new instance) on a resource.
- Parameters
-
string | $resourcePath | the path of the resource to POST. This is typically the parent (or owner) resource of the resource instance to create. |
string | $payload | the data to POST, i.e. the contents of the new resource instance |
array | $queryParameters | any additional query parameters |
string | $mimeType | the acceptable response MIME type |
mixed | $deserializationType | The name of the class this result should be deserialized as. Use array( 'array', 'typename' ) to deserialize arrays of a type. |
- Returns
- com_maileon_api_MaileonAPIResult the result object of the API call
- Exceptions
-
Definition at line 208 of file AbstractMaileonService.php.
com_maileon_api_AbstractMaileonService::delete |
( |
|
$resourcePath, |
|
|
|
$queryParameters = array() , |
|
|
|
$mimeType = 'application/vnd.maileon.api+xml' , |
|
|
|
$deserializationType = null |
|
) |
| |
Performs a DELETE operation on a resource.
- Parameters
-
string | $resourcePath | the resource to DELETE |
array | $queryParameters | any additional query parameters |
string | $mimeType | the acceptable response MIME type |
mixed | $deserializationType | The name of the class this result should be deserialized as. Use array( 'array', 'typename' ) to deserialize arrays of a type. |
- Returns
- com_maileon_api_MaileonAPIResult the result object of the API call
- Exceptions
-
Definition at line 237 of file AbstractMaileonService.php.
string com_maileon_api_AbstractMaileonService::$MAILEON_XML_MIME_TYPE = 'application/vnd.maileon.api+xml' |
|
static |
array com_maileon_api_AbstractMaileonService::$configuration |
|
protected |
string com_maileon_api_AbstractMaileonService::$encodedApiKey |
|
protected |
boolean com_maileon_api_AbstractMaileonService::$debug = false |
|
protected |
boolean com_maileon_api_AbstractMaileonService::$throwException = true |
|
protected |
string com_maileon_api_AbstractMaileonService::$proxy_host |
|
protected |
int com_maileon_api_AbstractMaileonService::$proxy_port = 80 |
|
protected |
int com_maileon_api_AbstractMaileonService::$timeout |
|
protected |
The documentation for this class was generated from the following file: