Source for file json.php

Documentation is available at json.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Libraries
  4.  * @subpackage  Response
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE
  8.  */
  9.  
  10. defined('JPATH_PLATFORM') or die;
  11.  
  12. /**
  13.  * JSON Response class.
  14.  *
  15.  * This class serves to provide the Joomla Platform with a common interface to access
  16.  * response variables for e.g. Ajax requests.
  17.  *
  18.  * @package     Joomla.Libraries
  19.  * @subpackage  Response
  20.  * @since       3.1
  21.  */
  22. class JResponseJson
  23. {
  24.     /**
  25.      * Determines whether the request was successful
  26.      *
  27.      * @var    boolean 
  28.      * @since  3.1
  29.      */
  30.     public $success = true;
  31.  
  32.     /**
  33.      * The main response message
  34.      *
  35.      * @var    string 
  36.      * @since  3.1
  37.      */
  38.     public $message = null;
  39.  
  40.     /**
  41.      * Array of messages gathered in the JApplication object
  42.      *
  43.      * @var    array 
  44.      * @since  3.1
  45.      */
  46.     public $messages = null;
  47.  
  48.     /**
  49.      * The response data
  50.      *
  51.      * @var    mixed 
  52.      * @since  3.1
  53.      */
  54.     public $data = null;
  55.  
  56.     /**
  57.      * Constructor
  58.      *
  59.      * @param   mixed    $response        The Response data
  60.      * @param   string   $message         The main response message
  61.      * @param   boolean  $error           True, if the success flag shall be set to false, defaults to false
  62.      * @param   boolean  $ignoreMessages  True, if the message queue shouldn't be included, defaults to false
  63.      *
  64.      * @since   3.1
  65.      */
  66.     public function __construct($response = null, $message = null, $error = false, $ignoreMessages = false)
  67.     {
  68.         $this->message = $message;
  69.  
  70.         // Get the message queue if requested and available
  71.         $app = JFactory::$application;
  72.  
  73.         if (!$ignoreMessages && !is_null($app) && is_callable(array($app, 'getMessageQueue')))
  74.         {
  75.             $messages = $app->getMessageQueue();
  76.  
  77.             // Build the sorted messages list
  78.             if (is_array($messages) && count($messages))
  79.             {
  80.                 foreach ($messages as $message)
  81.                 {
  82.                     if (isset($message['type']) && isset($message['message']))
  83.                     {
  84.                         $lists[$message['type']][] = $message['message'];
  85.                     }
  86.                 }
  87.             }
  88.  
  89.             // If messages exist add them to the output
  90.             if (isset($lists) && is_array($lists))
  91.             {
  92.                 $this->messages = $lists;
  93.             }
  94.         }
  95.  
  96.         // Check if we are dealing with an error
  97.         if ($response instanceof Exception)
  98.         {
  99.             // Prepare the error response
  100.             $this->success    = false;
  101.             $this->message    = $response->getMessage();
  102.         }
  103.         else
  104.         {
  105.             // Prepare the response data
  106.             $this->success    = !$error;
  107.             $this->data            = $response;
  108.         }
  109.     }
  110.  
  111.     /**
  112.      * Magic toString method for sending the response in JSON format
  113.      *
  114.      * @return  string  The response in JSON format
  115.      *
  116.      * @since   3.1
  117.      */
  118.     public function __toString()
  119.     {
  120.         return json_encode($this);
  121.     }
  122. }

Documentation generated on Tue, 19 Nov 2013 15:06:18 +0100 by phpDocumentor 1.4.3