Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class JsonDocument - list of methods

JsonDocument class, provides an easy interface to parse and display JSON output

Extends

Document

Direct known subclasses

JsonapiDocument
Package: Joomla\CMS\Document
Copyright: (C) 2009 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Document/JsonDocument.php
Project: Joomla

Method Summary

public
__construct
(mixed $options = array())

Class constructor
Parameters
  • array $options Associative array of options
Since
  • 1.7.0
Show source code of this method: __construct Source Code

public string
(mixed $cache = false, mixed $params = array())

Render the document.
Parameters
  • bool $cache If true, cache the output
  • array $params Associative array of attributes
Returns
  • string The rendered data
Since
  • 1.7.0
Show source code of this method: render Source Code

public string
()

Returns the document name
Returns
  • string
Since
  • 1.7.0
Show source code of this method: getName Source Code

public \Joomla\CMS\Document\JsonDocument
(mixed $name = 'joomla')

Sets the document name
Parameters
  • string $name Document name
Returns
  • \Joomla\CMS\Document\JsonDocument instance of $this to allow chaining
Since
  • 1.7.0
Show source code of this method: setName Source Code

Properties Summary

protected string
$_name
Document name
Since
  • 1.7.0

Tags Summary

Since
1.7.0