* var callDataObj = {"serviceName":"PizzaService", "methodName":"getPizza","parameters":[]};
* var callData = JSON.stringify(callDataObj);
* $.post("http://yourserver.com/Amfphp/?contentType=application/json", callData, onSuccess);
*
*
* Requires at least PHP 5.2.
*
* @package Amfphp_Plugins_Json
* @author Yannick DOMINGUEZ
*/
class AmfphpJson implements Amfphp_Core_Common_IDeserializer, Amfphp_Core_Common_IDeserializedRequestHandler, Amfphp_Core_Common_IExceptionHandler, Amfphp_Core_Common_ISerializer {
/**
* the content-type string indicating a JSON content
*/
const JSON_CONTENT_TYPE = 'application/json';
/**
* return error details.
* @see Amfphp_Core_Config::CONFIG_RETURN_ERROR_DETAILS
* @var boolean
*/
protected $returnErrorDetails = false;
/**
* constructor. Add filters on the HookManager.
* @param array $config optional key/value pairs in an associative array. Used to override default configuration values.
*/
public function __construct(array $config = null) {
$filterManager = Amfphp_Core_FilterManager::getInstance();
$filterManager->addFilter(Amfphp_Core_Gateway::FILTER_DESERIALIZER, $this, 'filterHandler');
$filterManager->addFilter(Amfphp_Core_Gateway::FILTER_DESERIALIZED_REQUEST_HANDLER, $this, 'filterHandler');
$filterManager->addFilter(Amfphp_Core_Gateway::FILTER_EXCEPTION_HANDLER, $this, 'filterHandler');
$filterManager->addFilter(Amfphp_Core_Gateway::FILTER_SERIALIZER, $this, 'filterHandler');
$this->returnErrorDetails = (isset($config[Amfphp_Core_Config::CONFIG_RETURN_ERROR_DETAILS]) && $config[Amfphp_Core_Config::CONFIG_RETURN_ERROR_DETAILS]);
}
/**
* If the content type contains the 'json' string, returns this plugin
* @param mixed null at call in gateway.
* @param String $contentType
* @return this or null
*/
public function filterHandler($handler, $contentType) {
if (strpos($contentType, self::JSON_CONTENT_TYPE) !== false) {
return $this;
}
}
/**
* deserialize
* @see Amfphp_Core_Common_IDeserializer
* @param array $getData
* @param array $postData
* @param string $rawPostData
* @return string
*/
public function deserialize(array $getData, array $postData, $rawPostData) {
$jsonString = '';
if ($rawPostData != '') {
$jsonString = $rawPostData;
} else if (isset($postData['json'])) {
$jsonString = $postData['json'];
} else {
throw new Exception('json call data not found. It must be sent in the post data');
}
$deserializedRequest = json_decode($rawPostData);
if ($deserializedRequest === null) {
$error = '';
switch (json_last_error()) {
case JSON_ERROR_NONE:
$error = 'No errors';
break;
case JSON_ERROR_DEPTH:
$error = 'Maximum stack depth exceeded';
break;
case JSON_ERROR_STATE_MISMATCH:
$error = 'Underflow or the modes mismatch';
break;
case JSON_ERROR_CTRL_CHAR:
$error = 'Unexpected control character found';
break;
case JSON_ERROR_SYNTAX:
$error = 'Syntax error, malformed JSON';
break;
case JSON_ERROR_UTF8:
$error = 'Malformed UTF-8 characters, possibly incorrectly encoded';
break;
default:
$error = 'Unknown error';
break;
}
throw new Exception("Error decoding JSON. $error \njsonString:\n $jsonString
");
}
if (!isset($deserializedRequest->serviceName)) {
throw new Exception("Service name field missing in JSON. \njsonString:\n $jsonString \ndecoded: \n" . print_r($deserializedRequest, true) . '
');
}
if (!isset($deserializedRequest->methodName)) {
throw new Exception("MethodName field missing in JSON. \njsonString:\n $jsonString \ndecoded: \n" . print_r($deserializedRequest, true) . '
');
}
return $deserializedRequest;
}
/**
* Retrieve the serviceName, methodName and parameters from the PHP object
* representing the JSON string
* call service
* @see Amfphp_Core_Common_IDeserializedRequestHandler
* @param array $deserializedRequest
* @param Amfphp_Core_Common_ServiceRouter $serviceRouter
* @return the service call response
*/
public function handleDeserializedRequest($deserializedRequest, Amfphp_Core_Common_ServiceRouter $serviceRouter) {
$serviceName = $deserializedRequest->serviceName;
$methodName = $deserializedRequest->methodName;
$parameters = array();
if (isset($deserializedRequest->parameters)) {
$parameters = $deserializedRequest->parameters;
}
return $serviceRouter->executeServiceCall($serviceName, $methodName, $parameters);
}
/**
* don't format; just throw! In this way ajax libs will have their error functions triggered
* @param Exception $exception
* @see Amfphp_Core_Common_IExceptionHandler
*/
public function handleException(Exception $exception) {
throw $exception;
}
/**
* Encode the PHP object returned from the service call into a JSON string
* @see Amfphp_Core_Common_ISerializer
* @param mixed $data
* @return the encoded JSON string sent to JavaScript
*/
public function serialize($data) {
return json_encode($data);
}
}
?>