Source for file jsonresponse.php

Documentation is available at jsonresponse.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_languages
  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.txt
  8.  */
  9.  
  10. defined('_JEXEC') or die;
  11.  
  12. /**
  13.  * JSON Response class
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_languages
  17.  * @since       2.5
  18.  * @deprecated    4.0
  19.  */
  20. class JJsonResponse
  21. {
  22.     /**
  23.      * Determines whether the request was successful
  24.      *
  25.      * @var    boolean 
  26.      * @since  2.5
  27.      */
  28.     public $success = true;
  29.  
  30.     /**
  31.      * Determines whether the request wasn't successful.
  32.      * This is always the negation of $this->success,
  33.      * so you can use both flags equivalently.
  34.      *
  35.      * @var    boolean 
  36.      * @since  2.5
  37.      */
  38.     public $error = false;
  39.  
  40.     /**
  41.      * The main response message
  42.      *
  43.      * @var    string 
  44.      * @since  2.5
  45.      */
  46.     public $message = null;
  47.  
  48.     /**
  49.      * Array of messages gathered in the JApplication object
  50.      *
  51.      * @var    array 
  52.      * @since  2.5
  53.      */
  54.     public $messages = null;
  55.  
  56.     /**
  57.      * The response data
  58.      *
  59.      * @var    mixed 
  60.      * @since  2.5
  61.      */
  62.     public $data = null;
  63.  
  64.     /**
  65.      * Constructor
  66.      *
  67.      * @param   mixed    $response  The Response data
  68.      * @param   string   $message   The main response message
  69.      * @param   boolean  $error     True, if the success flag shall be set to false, defaults to false
  70.      *
  71.      * @since        2.5
  72.      * @deprecated    4.0     Use JResponseJson instead
  73.      */
  74.     public function __construct($response = null, $message = null, $error = false)
  75.     {
  76.         JLog::add('Class JJsonResponse is deprecated. Use class JResponseJson instead.', JLog::WARNING, 'deprecated');
  77.  
  78.         $this->message = $message;
  79.  
  80.         // Get the message queue
  81.         $messages = JFactory::getApplication()->getMessageQueue();
  82.  
  83.         // Build the sorted messages list
  84.         if (is_array($messages) && count($messages))
  85.         {
  86.             foreach ($messages as $message)
  87.             {
  88.                 if (isset($message['type']) && isset($message['message']))
  89.                 {
  90.                     $lists[$message['type']][] = $message['message'];
  91.                 }
  92.             }
  93.         }
  94.  
  95.         // If messages exist add them to the output
  96.         if (isset($lists) && is_array($lists))
  97.         {
  98.             $this->messages = $lists;
  99.         }
  100.  
  101.         // Check if we are dealing with an error
  102.         if ($response instanceof Exception)
  103.         {
  104.             // Prepare the error response
  105.             $this->success = false;
  106.             $this->error = true;
  107.             $this->message    = $response->getMessage();
  108.         }
  109.         else
  110.         {
  111.             // Prepare the response data
  112.             $this->success = !$error;
  113.             $this->error = $error;
  114.             $this->data = $response;
  115.         }
  116.     }
  117.  
  118.     /**
  119.      * Magic toString method for sending the response in JSON format
  120.      *
  121.      * @return  string  The response in JSON format
  122.      *
  123.      * @since   2.5
  124.      */
  125.     public function __toString()
  126.     {
  127.         return json_encode($this);
  128.     }
  129. }

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