1 <?php
  2 /**
  3  * @package     FrameworkOnFramework
  4  * @subpackage  view
  5  * @copyright   Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
  6  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  7  */
  8 // Protect from unauthorized access
  9 defined('FOF_INCLUDED') or die;
 10 
 11 /**
 12  * FrameworkOnFramework JSON View class. Renders the data as a JSON object or
 13  * array. It can optionally output HAL links as well.
 14  *
 15  * @package  FrameworkOnFramework
 16  * @since    2.0
 17  */
 18 class FOFViewJson extends FOFViewHtml
 19 {
 20     /**
 21      * When set to true we'll add hypermedia to the output, implementing the
 22      * HAL specification (http://stateless.co/hal_specification.html)
 23      *
 24      * @var   boolean
 25      */
 26     public $useHypermedia = false;
 27 
 28     /**
 29      * Public constructor
 30      *
 31      * @param   array  $config  The component's configuration array
 32      */
 33     public function __construct($config = array())
 34     {
 35         parent::__construct($config);
 36 
 37         if (isset($config['use_hypermedia']))
 38         {
 39             $this->useHypermedia = (bool) $config['use_hypermedia'];
 40         }
 41     }
 42 
 43     /**
 44      * The event which runs when we are displaying the record list JSON view
 45      *
 46      * @param   string  $tpl  The view sub-template to use
 47      *
 48      * @return  boolean  True to allow display of the view
 49      */
 50     protected function onDisplay($tpl = null)
 51     {
 52         // Load the model
 53         $model = $this->getModel();
 54 
 55         $items = $model->getItemList();
 56         $this->items = $items;
 57 
 58         $document = FOFPlatform::getInstance()->getDocument();
 59 
 60         if ($document instanceof JDocument)
 61         {
 62             if ($this->useHypermedia)
 63             {
 64                 $document->setMimeEncoding('application/hal+json');
 65             }
 66             else
 67             {
 68                 $document->setMimeEncoding('application/json');
 69             }
 70         }
 71 
 72         if (is_null($tpl))
 73         {
 74             $tpl = 'json';
 75         }
 76 
 77         FOFPlatform::getInstance()->setErrorHandling(E_ALL, 'ignore');
 78 
 79         $hasFailed = false;
 80 
 81         try
 82         {
 83             $result = $this->loadTemplate($tpl, true);
 84 
 85             if ($result instanceof Exception)
 86             {
 87                 $hasFailed = true;
 88             }
 89         }
 90         catch (Exception $e)
 91         {
 92             $hasFailed = true;
 93         }
 94 
 95         if ($hasFailed)
 96         {
 97             // Default JSON behaviour in case the template isn't there!
 98             if ($this->useHypermedia)
 99             {
100                 $haldocument = $this->_createDocumentWithHypermedia($items, $model);
101                 $json = $haldocument->render('json');
102             }
103             else
104             {
105                 $json = json_encode($items);
106             }
107 
108             // JSONP support
109             $callback = $this->input->get('callback', null, 'raw');
110 
111             if (!empty($callback))
112             {
113                 echo $callback . '(' . $json . ')';
114             }
115             else
116             {
117                 $defaultName = $this->input->getCmd('view', 'joomla');
118                 $filename = $this->input->getCmd('basename', $defaultName);
119 
120                 $document->setName($filename);
121                 echo $json;
122             }
123 
124             return false;
125         }
126         else
127         {
128             echo $result;
129 
130             return false;
131         }
132     }
133 
134     /**
135      * The event which runs when we are displaying a single item JSON view
136      *
137      * @param   string  $tpl  The view sub-template to use
138      *
139      * @return  boolean  True to allow display of the view
140      */
141     protected function onRead($tpl = null)
142     {
143         $model = $this->getModel();
144 
145         $item = $model->getItem();
146         $this->item = $item;
147 
148         $document = FOFPlatform::getInstance()->getDocument();
149 
150         if ($document instanceof JDocument)
151         {
152             if ($this->useHypermedia)
153             {
154                 $document->setMimeEncoding('application/hal+json');
155             }
156             else
157             {
158                 $document->setMimeEncoding('application/json');
159             }
160         }
161 
162         if (is_null($tpl))
163         {
164             $tpl = 'json';
165         }
166 
167         FOFPlatform::getInstance()->setErrorHandling(E_ALL, 'ignore');
168 
169         $hasFailed = false;
170 
171         try
172         {
173             $result = $this->loadTemplate($tpl, true);
174 
175             if ($result instanceof Exception)
176             {
177                 $hasFailed = true;
178             }
179         }
180         catch (Exception $e)
181         {
182             $hasFailed = true;
183         }
184 
185         if ($hasFailed)
186         {
187             // Default JSON behaviour in case the template isn't there!
188 
189             if ($this->useHypermedia)
190             {
191                 $haldocument = $this->_createDocumentWithHypermedia($item, $model);
192                 $json = $haldocument->render('json');
193             }
194             else
195             {
196                 $json = json_encode($item);
197             }
198 
199             // JSONP support
200             $callback = $this->input->get('callback', null);
201 
202             if (!empty($callback))
203             {
204                 echo $callback . '(' . $json . ')';
205             }
206             else
207             {
208                 $defaultName = $this->input->getCmd('view', 'joomla');
209                 $filename = $this->input->getCmd('basename', $defaultName);
210                 $document->setName($filename);
211                 echo $json;
212             }
213 
214             return false;
215         }
216         else
217         {
218             echo $result;
219 
220             return false;
221         }
222     }
223 
224     /**
225      * Creates a FOFHalDocument using the provided data
226      *
227      * @param   array     $data   The data to put in the document
228      * @param   FOFModel  $model  The model of this view
229      *
230      * @return  FOFHalDocument  A HAL-enabled document
231      */
232     protected function _createDocumentWithHypermedia($data, $model = null)
233     {
234         // Create a new HAL document
235 
236         if (is_array($data))
237         {
238             $count = count($data);
239         }
240         else
241         {
242             $count = null;
243         }
244 
245         if ($count == 1)
246         {
247             reset($data);
248             $document = new FOFHalDocument(end($data));
249         }
250         else
251         {
252             $document = new FOFHalDocument($data);
253         }
254 
255         // Create a self link
256         $uri = (string) (JUri::getInstance());
257         $uri = $this->_removeURIBase($uri);
258         $uri = JRoute::_($uri);
259         $document->addLink('self', new FOFHalLink($uri));
260 
261         // Create relative links in a record list context
262 
263         if (is_array($data) && ($model instanceof FOFModel))
264         {
265             $pagination = $model->getPagination();
266 
267             if ($pagination->get('pages.total') > 1)
268             {
269                 // Try to guess URL parameters and create a prototype URL
270                 // NOTE: You are better off specialising this method
271                 $protoUri = $this->_getPrototypeURIForPagination();
272 
273                 // The "first" link
274                 $uri = clone $protoUri;
275                 $uri->setVar('limitstart', 0);
276                 $uri = JRoute::_((string) $uri);
277 
278                 $document->addLink('first', new FOFHalLink($uri));
279 
280                 // Do we need a "prev" link?
281 
282                 if ($pagination->get('pages.current') > 1)
283                 {
284                     $prevPage = $pagination->get('pages.current') - 1;
285                     $limitstart = ($prevPage - 1) * $pagination->limit;
286                     $uri = clone $protoUri;
287                     $uri->setVar('limitstart', $limitstart);
288                     $uri = JRoute::_((string) $uri);
289 
290                     $document->addLink('prev', new FOFHalLink($uri));
291                 }
292 
293                 // Do we need a "next" link?
294 
295                 if ($pagination->get('pages.current') < $pagination->get('pages.total'))
296                 {
297                     $nextPage = $pagination->get('pages.current') + 1;
298                     $limitstart = ($nextPage - 1) * $pagination->limit;
299                     $uri = clone $protoUri;
300                     $uri->setVar('limitstart', $limitstart);
301                     $uri = JRoute::_((string) $uri);
302 
303                     $document->addLink('next', new FOFHalLink($uri));
304                 }
305 
306                 // The "last" link?
307                 $lastPage = $pagination->get('pages.total');
308                 $limitstart = ($lastPage - 1) * $pagination->limit;
309                 $uri = clone $protoUri;
310                 $uri->setVar('limitstart', $limitstart);
311                 $uri = JRoute::_((string) $uri);
312 
313                 $document->addLink('last', new FOFHalLink($uri));
314             }
315         }
316 
317         return $document;
318     }
319 
320     /**
321      * Convert an absolute URI to a relative one
322      *
323      * @param   string  $uri  The URI to convert
324      *
325      * @return  string  The relative URL
326      */
327     protected function _removeURIBase($uri)
328     {
329         static $root = null, $rootlen = 0;
330 
331         if (is_null($root))
332         {
333             $root = rtrim(FOFPlatform::getInstance()->URIbase(), '/');
334             $rootlen = strlen($root);
335         }
336 
337         if (substr($uri, 0, $rootlen) == $root)
338         {
339             $uri = substr($uri, $rootlen);
340         }
341 
342         return ltrim($uri, '/');
343     }
344 
345     /**
346      * Returns a JUri instance with a prototype URI used as the base for the
347      * other URIs created by the JSON renderer
348      *
349      * @return  JUri  The prototype JUri instance
350      */
351     protected function _getPrototypeURIForPagination()
352     {
353         $protoUri = new JUri('index.php');
354         $protoUri->setQuery($this->input->getData());
355         $protoUri->delVar('savestate');
356         $protoUri->delVar('base_path');
357 
358         return $protoUri;
359     }
360 }
361 

Joomla! Framework TM API documentation generated by ApiGen 2.8.0
Joomla!® and Joomla! Framework™ are trademarks of Open Source Matters, Inc. in the United States and other countries.