AlternC/lib/Alternc/Api/Response.php

68 lines
1.1 KiB
PHP
Raw Normal View History

2014-09-17 15:54:24 +00:00
<?php
/**
* Standard Response object for the AlternC API
*
*/
class Alternc_Api_Response {
2015-01-12 19:16:28 +00:00
/**
* Error codes
*/
const ERR_DISABLED_ACCOUNT = 221801;
const ERR_INVALID_AUTH = 221802;
2014-09-17 15:54:24 +00:00
/**
* Result code. 0 means success
*
* @var int
*/
2015-01-12 19:16:28 +00:00
public $code;
2014-09-17 15:54:24 +00:00
/**
* Result message. May be empty
*
* @var string
*/
public $message;
2015-01-12 19:16:28 +00:00
2014-09-17 15:54:24 +00:00
/**
* Result data
*
* @var array
*/
public $content;
2015-01-12 19:16:28 +00:00
2014-09-17 15:54:24 +00:00
/**
* Result metadata
*
* @var array
*/
2015-01-12 19:16:28 +00:00
public $metadata;
/**
* initialize a response object
* @param options any of the public above
*/
2015-01-12 19:16:28 +00:00
public function __construct($options = array()) {
$os = array("code", "message", "content", "metadata");
foreach ($os as $o) {
if (isset($options[$o]))
$this->$o = $options[$o];
}
}
2014-09-17 15:54:24 +00:00
/**
* Formats response to json
*
* @return string
*/
2015-01-12 19:16:28 +00:00
public function toJson() {
2014-09-17 15:54:24 +00:00
return json_encode(get_object_vars($this));
}
2015-01-12 19:16:28 +00:00
}
2015-01-12 19:16:28 +00:00
// class Alternc_Api_Response