JsonDocument
Extends \Joomla\CMS\Document\DocumentJsonDocument class, provides an easy interface to parse and display JSON output
link | |
---|---|
since |
1.7.0 |
Methods
__construct
Class constructor.
__construct(array $options = array())
since |
1.7.0 |
---|
Arguments
- $options
array
Associative array of options
_getLineEnd
Returns the lineEnd
_getLineEnd() : string
since |
1.7.0 |
---|
Response
string
_getTab
Returns a string containing the unit for indenting HTML
_getTab() : string
since |
1.7.0 |
---|
Response
string
addScript
Adds a linked script to the page
addScript(string $url, array $options = array(), array $attribs = array()) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|---|
deprecated |
4.0 The (url, mime, defer, async) method signature is deprecated, use (url, options, attributes) instead. |
Arguments
- $url
string
URL to the linked script.- $options
array
Array of options. Example: array('version' => 'auto', 'conditional' => 'lt IE 9')- $attribs
array
Array of attributes. Example: array('id' => 'scriptid', 'async' => 'async', 'data-test' => 1)
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
addScriptDeclaration
Adds a script to the page
addScriptDeclaration(string $content, string $type = 'text/javascript') : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- $content
string
Script- $type
string
Scripting mime (defaults to 'text/javascript')
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
addScriptOptions
Add option for script
addScriptOptions(string $key, mixed $options, boolean $merge = true) : \Joomla\CMS\Document\Document
since |
3.5 |
---|
Arguments
- $key
string
Name in Storage- $options
mixed
Scrip options as array or string- $merge
boolean
Whether merge with existing (true) or replace (false)
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
addScriptVersion
Adds a linked script to the page with a version to allow to flush it. Ex: myscript.js?54771616b5bceae9df03c6173babf11d If not specified Joomla! automatically handles versioning
addScriptVersion(string $url, array $options = array(), array $attribs = array()) : \Joomla\CMS\Document\Document
since |
3.2 |
---|---|
deprecated |
4.0 This method is deprecated, use addScript(url, options, attributes) instead. |
Arguments
- $url
string
URL to the linked script.- $options
array
Array of options. Example: array('version' => 'auto', 'conditional' => 'lt IE 9')- $attribs
array
Array of attributes. Example: array('id' => 'scriptid', 'async' => 'async', 'data-test' => 1)
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
addStyleDeclaration
Adds a stylesheet declaration to the page
addStyleDeclaration(string $content, string $type = 'text/css') : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- $content
string
Style declarations- $type
string
Type of stylesheet (defaults to 'text/css')
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
addStyleSheet
Adds a linked stylesheet to the page
addStyleSheet(string $url, array $options = array(), array $attribs = array()) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|---|
deprecated |
4.0 The (url, mime, media, attribs) method signature is deprecated, use (url, options, attributes) instead. |
Arguments
- $url
string
URL to the linked style sheet- $options
array
Array of options. Example: array('version' => 'auto', 'conditional' => 'lt IE 9')- $attribs
array
Array of attributes. Example: array('id' => 'stylesheet', 'data-test' => 1)
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
addStyleSheetVersion
Adds a linked stylesheet version to the page. Ex: template.css?54771616b5bceae9df03c6173babf11d If not specified Joomla! automatically handles versioning
addStyleSheetVersion(string $url, array $options = array(), array $attribs = array()) : \Joomla\CMS\Document\Document
since |
3.2 |
---|---|
deprecated |
4.0 This method is deprecated, use addStyleSheet(url, options, attributes) instead. |
Arguments
- $url
string
URL to the linked style sheet- $options
array
Array of options. Example: array('version' => 'auto', 'conditional' => 'lt IE 9')- $attribs
array
Array of attributes. Example: array('id' => 'stylesheet', 'data-test' => 1)
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
getBase
Return the base URI of the document.
getBase() : string
since |
1.7.0 |
---|
Response
string
getBuffer
Get the contents of the document buffer
getBuffer() : mixed
since |
1.7.0 |
---|
Response
mixed
getCharset
Returns the document charset encoding.
getCharset() : string
since |
1.7.0 |
---|
Response
string
getDescription
Return the description of the document.
getDescription() : string
since |
1.7.0 |
---|
Response
string
getDirection
Returns the document direction declaration.
getDirection() : string
since |
1.7.0 |
---|
Response
string
getGenerator
Returns the document generator
getGenerator() : string
since |
1.7.0 |
---|
Response
string
getInstance
Returns the global Document object, only creating it if it doesn't already exist.
getInstance(string $type = 'html', array $attributes = array()) : object
since |
1.7.0 |
---|
Arguments
- $type
string
The document type to instantiate- $attributes
array
Array of attributes
Response
object
The document object.
getLanguage
Returns the document language.
getLanguage() : string
since |
1.7.0 |
---|
Response
string
getLink
Returns the document base url
getLink() : string
since |
1.7.0 |
---|
Response
string
getMediaVersion
Return the media version
getMediaVersion() : string
since |
3.2 |
---|
Response
string
getMetaData
Gets a meta tag.
getMetaData(string $name, string $attribute = 'name') : string
since |
1.7.0 |
---|
Arguments
- $name
string
Name of the meta HTML tag- $attribute
string
Attribute to use in the meta HTML tag
Response
string
getMimeEncoding
Return the document MIME encoding that is sent to the browser.
getMimeEncoding() : string
since |
1.7.0 |
---|
Response
string
getModifiedDate
Returns the document modified date
getModifiedDate() : string|\Joomla\CMS\Date\Date
getName
Returns the document name
getName() : string
since |
1.7.0 |
---|
Response
string
getScriptOptions
Get script(s) options
getScriptOptions(string $key = null) : array
since |
3.5 |
---|
Arguments
- $key
string
Name in Storage
Response
array
Options for given $key, or all script options
getTitle
Return the title of the document.
getTitle() : string
since |
1.7.0 |
---|
Response
string
getType
Returns the document type
getType() : string
since |
1.7.0 |
---|
Response
string
loadRenderer
Load a renderer
loadRenderer(string $type) : \Joomla\CMS\Document\DocumentRenderer
since |
1.7.0 |
---|---|
throws |
|
Arguments
- $type
string
The renderer type
Response
parse
Parses the document and prepares the buffers
parse(array $params = array()) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- $params
array
The array of parameters
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
render
Outputs the document
render(boolean $cache = false, array $params = array()) : void
since |
1.7.0 |
---|
Arguments
- $cache
boolean
If true, cache the output- $params
array
Associative array of attributes
setBase
Sets the base URI of the document
setBase(string $base) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- $base
string
The base URI to be set
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
setBuffer
Set the contents of the document buffer
setBuffer(string $content, array $options = array()) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- $content
string
The content to be set in the buffer.- $options
array
Array of optional elements.
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
setCharset
Sets the document charset
setCharset(string $type = 'utf-8') : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- $type
string
Charset encoding string
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
setDescription
Sets the description of the document
setDescription(string $description) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- $description
string
The description to set
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
setDirection
Sets the global document direction declaration. Default is left-to-right (ltr).
setDirection(string $dir = 'ltr') : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- $dir
string
The language direction to be set
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
setGenerator
Sets the document generator
setGenerator(string $generator) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- $generator
string
The generator to be set
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
setLanguage
Sets the global document language declaration. Default is English (en-gb).
setLanguage(string $lang = 'en-gb') : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- $lang
string
The language to be set
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
setLineEnd
Sets the line end style to Windows, Mac, Unix or a custom string.
setLineEnd(string $style) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- $style
string
"win", "mac", "unix" or custom string.
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
setLink
Sets the document link
setLink(string $url) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- $url
string
A url
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
setMediaVersion
Set the assets version
setMediaVersion(string $mediaVersion) : \Joomla\CMS\Document\Document
since |
3.2 |
---|
Arguments
- $mediaVersion
string
Media version to use
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
setMetaData
Sets or alters a meta tag.
setMetaData(string $name, mixed $content, string $attribute = 'name') : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- $name
string
Name of the meta HTML tag- $content
mixed
Value of the meta HTML tag as array or string- $attribute
string
Attribute to use in the meta HTML tag
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
setMimeEncoding
Sets the document MIME encoding that is sent to the browser.
setMimeEncoding(string $type = 'text/html', boolean $sync = true) : \Joomla\CMS\Document\Document
This usually will be text/html because most browsers cannot yet accept the proper mime settings for XHTML: application/xhtml+xml and to a lesser extent application/xml and text/xml. See the W3C note (http://www.w3.org/TR/xhtml-media-types/) for more details.
since |
1.7.0 |
---|---|
link |
Arguments
- $type
string
The document type to be sent- $sync
boolean
Should the type be synced with HTML?
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
setModifiedDate
Sets the document modified date
setModifiedDate(string|\Joomla\CMS\Date\Date $date) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|---|
throws |
|
Arguments
- $date
string|\Joomla\CMS\Date\Date
The date to be set
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
setName
Sets the document name
setName(string $name = 'joomla') : \Joomla\CMS\Document\JsonDocument
since |
1.7.0 |
---|
Arguments
- $name
string
Document name
Response
\Joomla\CMS\Document\JsonDocument
instance of $this to allow chaining
setTab
Sets the string used to indent HTML
setTab(string $string) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- $string
string
String used to indent ("\11", "\t", ' ', etc.).
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
setTitle
Sets the title of the document
setTitle(string $title) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- $title
string
The title to be set
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
setType
Set the document type
setType(string $type) : \Joomla\CMS\Document\Document
since |
1.7.0 |
---|
Arguments
- $type
string
Type document is to set to
Response
\Joomla\CMS\Document\Document
instance of $this to allow chaining
Properties
_name
Document name
since |
1.7.0 |
---|
Type(s)
string
title
Document title
since |
1.7.0 |
---|
Type(s)
string
description
Document description
since |
1.7.0 |
---|
Type(s)
string
link
Document full URL
since |
1.7.0 |
---|
Type(s)
string
base
Document base URL
since |
1.7.0 |
---|
Type(s)
string
language
Contains the document language setting
since |
1.7.0 |
---|
Type(s)
string
direction
Contains the document direction setting
since |
1.7.0 |
---|
Type(s)
string
_generator
Document generator
since |
1.7.0 |
---|
Type(s)
string
_tab
Tab string
since |
1.7.0 |
---|
Type(s)
string
_lineEnd
Contains the line end string
since |
1.7.0 |
---|
Type(s)
string
_charset
Contains the character encoding string
since |
1.7.0 |
---|
Type(s)
string
_mime
Document mime type
since |
1.7.0 |
---|
Type(s)
string
_namespace
Document namespace
since |
1.7.0 |
---|
Type(s)
string
_profile
Document profile
since |
1.7.0 |
---|
Type(s)
string
_scripts
Array of linked scripts
since |
1.7.0 |
---|
Type(s)
array
_script
Array of scripts placed in the header
since |
1.7.0 |
---|
Type(s)
array
scriptOptions
Array of scripts options
Type(s)
array
_styleSheets
Array of linked style sheets
since |
1.7.0 |
---|
Type(s)
array
_style
Array of included style declarations
since |
1.7.0 |
---|
Type(s)
array
_metaTags
Array of meta tags
since |
1.7.0 |
---|
Type(s)
array
_engine
The rendering engine
since |
1.7.0 |
---|
Type(s)
object
_type
The document type
since |
1.7.0 |
---|
Type(s)
string
_buffer
Array of buffered output
since |
1.7.0 |
---|
Type(s)
mixed
instances
Document instances container.
since |
1.7.3 |
---|
Type(s)
array
mediaVersion
Media version added to assets
since |
3.2 |
---|
Type(s)
string