mirror of https://github.com/joomla/joomla-cms.git
115 lines
2.2 KiB
PHP
115 lines
2.2 KiB
PHP
<?php
|
|
/**
|
|
* Joomla! Content Management System
|
|
*
|
|
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
|
|
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
|
*/
|
|
|
|
namespace Joomla\CMS\Document;
|
|
|
|
\defined('JPATH_PLATFORM') or die;
|
|
|
|
use Joomla\CMS\Factory as CmsFactory;
|
|
|
|
/**
|
|
* JsonDocument class, provides an easy interface to parse and display JSON output
|
|
*
|
|
* @link http://www.json.org/
|
|
* @since 1.7.0
|
|
*/
|
|
class JsonDocument extends Document
|
|
{
|
|
/**
|
|
* Document name
|
|
*
|
|
* @var string
|
|
* @since 1.7.0
|
|
*/
|
|
protected $_name = 'joomla';
|
|
|
|
/**
|
|
* Class constructor
|
|
*
|
|
* @param array $options Associative array of options
|
|
*
|
|
* @since 1.7.0
|
|
*/
|
|
public function __construct($options = array())
|
|
{
|
|
parent::__construct($options);
|
|
|
|
// Set mime type
|
|
if (isset($_SERVER['HTTP_ACCEPT'])
|
|
&& strpos($_SERVER['HTTP_ACCEPT'], 'application/json') === false
|
|
&& strpos($_SERVER['HTTP_ACCEPT'], 'text/html') !== false)
|
|
{
|
|
// Internet Explorer < 10
|
|
$this->_mime = 'text/plain';
|
|
}
|
|
else
|
|
{
|
|
$this->_mime = 'application/json';
|
|
}
|
|
|
|
// Set document type
|
|
$this->_type = 'json';
|
|
}
|
|
|
|
/**
|
|
* Render the document.
|
|
*
|
|
* @param boolean $cache If true, cache the output
|
|
* @param array $params Associative array of attributes
|
|
*
|
|
* @return string The rendered data
|
|
*
|
|
* @since 1.7.0
|
|
*/
|
|
public function render($cache = false, $params = array())
|
|
{
|
|
/** @var \Joomla\CMS\Application\CMSApplication $app **/
|
|
$app = CmsFactory::getApplication();
|
|
|
|
$app->allowCache($cache);
|
|
|
|
if ($this->_mime === 'application/json')
|
|
{
|
|
// Browser other than Internet Explorer < 10
|
|
$app->setHeader('Content-Disposition', 'attachment; filename="' . $this->getName() . '.json"', true);
|
|
}
|
|
|
|
parent::render($cache, $params);
|
|
|
|
return $this->getBuffer();
|
|
}
|
|
|
|
/**
|
|
* Returns the document name
|
|
*
|
|
* @return string
|
|
*
|
|
* @since 1.7.0
|
|
*/
|
|
public function getName()
|
|
{
|
|
return $this->_name;
|
|
}
|
|
|
|
/**
|
|
* Sets the document name
|
|
*
|
|
* @param string $name Document name
|
|
*
|
|
* @return JsonDocument instance of $this to allow chaining
|
|
*
|
|
* @since 1.7.0
|
|
*/
|
|
public function setName($name = 'joomla')
|
|
{
|
|
$this->_name = $name;
|
|
|
|
return $this;
|
|
}
|
|
}
|