Class constructor. Builds a new JDocument object. Derived subclasses call parent::__construct($options). The $options associative array can contain the keys lineend, charset, language, direction, tab, link, and base.

Redefines JObject::__construct(); overridden in descendant classes.

JDocument __construct($options)

This method adds a linked script to the document.

void addScript($url, [$type = 'text/javascript'])

This method embeds a script in the document.

void addScriptDeclaration($content, [$type = 'text/javascript'])

This method embeds a style declaration in the document.

void addStyleDeclaration($content, [$type = 'text/css'])

This method adds a linked stylesheet to the document.

void addStyleSheet($url, [$type = 'text/css'] , [$media = null], [$attribs = array()])

This method returns the base URI of the document.

string getBase()

This method returns the content of the document buffer. Redefined in descendants:

string getBuffer()

This method returns the document character set encoding.

string getCharset()

This method returns the document description.

string getDescription()

This method returns the text direction of the document, ltr (left-to-right) or rtl (right‑to‑left).

string getDirection()

This method returns the document generator string; the default is 'Joomla! 1.5 - Open Source Content Management'.

string getGenerator()

This method returns an associative array containing the document header data. The header data array includes the title, description, link, metatags, links, stylesheets, style, scripts, script, and custom keys and values.Redefined in descendants:

array getHeadData()

This method returns a reference to a global instance of a JDocument subclass object, based on $type(error, feed, HTML, PDF, or RAW) and $attributes. Use JFactory::getDocument() to get the application document.

JDocument &getInstance([$type = 'html'], [$attributes = array()])

This method returns the document language.

string getLanguage()

This method returns the document base URI.

string getLink()

This method returns the document metadata. If the metadata is http-equiv (equivalent to an HTTP header) then specify $http_equiv as true.

string getMetaData($name, [$http_equiv = false])

This method returns the document modified date.

string getModifiedDate()

This method returns the document title.

string getTitle()

This method returns the document type.

string getType()

This method returns a reference to an instance of a JDocumentRenderer subclass object. The $type can be Atom, RSS, Component, Head, Message, Module, or Modules. If you define your own JDocumentRenderer class you must include the class before using this method.

JDocumentRenderer &loadRenderer($type)

This method outputs the rendered document. This method varies depending upon the subclass. Redefined in descendants:

string render([$cache = false], [$params = array()])

This method sets the base URI of the document.

void setBase($base)

This method sets the buffered contents of the document. Redefined in descendants:

void setBase($content)

This method sets the character set encoding for the document. This does not convert content to the new character set.

void setCharset([$type = 'utf-8'])

This method sets the document description.

void setDescription($description)

This method sets the text direction of the document, ltr (left‑to‑right) or rtl (right‑to‑left).

void setDirection([$dir = 'ltr'])

This method sets the document generator; the default is 'Joomla! 1.5 – Open Source Content Management'.

void setGenerator($generator)

This method sets the head data of the document. The head $data array is an associative array that must include the title, description, link, metatags, links, stylesheets, style, scripts, script, and custom keys and values. Redefined in descendants:

void setBase(array $data)

This method sets the global document language declaration; the default is Great Britain English (en-GB).

void setLanguage([$lang = 'en-gb'])

This method sets the document EOL character string. The $style can be win, unix, mac, or a custom EOL character string.

void setLineEnd($style)

This method sets the document's full URL.

void setLink($url)

This method sets or alters a document meta tag. If the metadata is http-equiv (equivalent to an HTTP header) then specify $http_equiv as true. If $name is 'generator' or 'description' this method will call setGenerator() or setDescription() respectively; for all others the $_metatags array is updated.

void setMetaData($name, $content, [$http_equiv = false])

This method sets the MIME encoding that is sent to the browser. This usually will be text/html because most browsers cannot yet accept the proper mime settings for XHTML: application/xthml+xml and to a lesser extent application/xml. See the W3C note (http://www.w3.org/TR/xhtml-media-types/) for more details.

void setMimeEncoding([$type = 'text/html'])

This method sets the document's modified date.

void setModifiedDate($date)

This method sets the string used to indent HTML.

void setTab($string)

This method sets the title of the document.

void setTitle($title)

This method sets the document type.

void setType($type)

This private method returns the document EOL character/string.

string getLineEnd()

This private method returns the document indentation character string.

string getTab()