Fixes #14869: Provide a simple API for outputting JSON

rombert · rombert · commit 1792dbb45caf · 2012-10-28T12:19:08.000+02:00
Conflicts:
	core/json_api.php
diff --git a/core/json_api.php b/core/json_api.php
@@ -26,7 +26,12 @@
  * @uses url_api.php
  */
 
-require_api( 'url_api.php' );
+/**
+ * requires url_api
+ */
+require_once( 'url_api.php' );
+require_once( 'database_api.php' );
+require_once( 'lang_api.php' );
 
 /**
  * Get a chunk of JSON from a given URL.
@@ -44,3 +49,72 @@ function json_url( $p_url, $p_member = null ) {
 		return $t_json->$p_member;
 	}
 }
+
+/**
+ * JSON error handler
+ * 
+ * <p>Ensures that all necessary headers are set and terminates processing after being invoked.</p>
+ */
+function json_error_handler( $p_type, $p_error, $p_file, $p_line, $p_context ) {
+	# flush any language overrides to return to user's natural default
+	if( function_exists( 'db_is_connected' ) ) {
+		if( db_is_connected() ) {
+			lang_push( lang_get_default() );
+		}
+	}
+
+	# build an appropriate error string
+	switch( $p_type ) {
+		case E_WARNING:
+			$t_error_type = 'SYSTEM WARNING';
+			$t_error_description = $p_error;
+			break;
+		case E_NOTICE:
+			$t_error_type = 'SYSTEM NOTICE';
+			$t_error_description = $p_error;
+			break;
+		case E_USER_ERROR:
+			$t_error_type = "APPLICATION ERROR #$p_error";
+			$t_error_description = error_string( $p_error );
+			break;
+		case E_USER_WARNING:
+			$t_error_type = "APPLICATION WARNING #$p_error";
+			$t_error_description = error_string( $p_error );
+			break;
+		case E_USER_NOTICE:
+			# used for debugging
+			$t_error_type = 'DEBUG';
+			$t_error_description = $p_error;
+			break;
+		default:
+			#shouldn't happen, just display the error just in case
+			$t_error_type = '';
+			$t_error_description = $p_error;
+	}
+
+	json_output_raw(array(
+		'status' => 'ERROR',
+		'type' => $t_error_type,
+		'contents' => $t_error_description 
+	));
+}
+/**
+ * Outputs the specified contents inside a json response with OK status
+ * 
+ * <p>Ensures that all necessary headers are set and terminates processing.</p>
+ * @param string $contents The contents to encode
+ */
+ function json_output_response ( $contents = '') {
+	
+ 	json_output_raw( array(
+		'status' => 'OK',
+		'contents' => $contents	
+	) );
+}
+
+function json_output_raw( $contents ) {
+	
+	header('Content-Type: application/json');
+	echo json_encode( $contents );
+	exit();
+}
