Graphe d'héritage de JDocument:

Graphe de collaboration de JDocument:

Liste de tous les membres

Fonctions membres publiques

__construct ($options=array())
& getInstance ($type= 'html', $attributes=array())
setType ($type)
getType ()
getHeadData ()
setHeadData ($data)
getBuffer ()
setBuffer ($content)
getMetaData ($name, $http_equiv=false)
setMetaData ($name, $content, $http_equiv=false)
addScript ($url, $type="text/javascript")
addScriptDeclaration ($content, $type= 'text/javascript')
addStyleSheet ($url, $type= 'text/css', $media=null, $attribs=array())
addStyleDeclaration ($content, $type= 'text/css')
setCharset ($type= 'utf-8')
getCharset ()
setLanguage ($lang="en-gb")
getLanguage ()
setDirection ($dir="ltr")
getDirection ()
setTitle ($title)
getTitle ()
setBase ($base)
getBase ()
setDescription ($description)
getDescription ()
setLink ($url)
getLink ()
setGenerator ($generator)
getGenerator ()
setModifiedDate ($date)
getModifiedDate ()
setMimeEncoding ($type= 'text/html')
setLineEnd ($style)
_getLineEnd ()
setTab ($string)
_getTab ()
& loadRenderer ($type)
render ($cache=false, $params=array())

Attributs publics

$title = ''
$description = ''
$link = ''
$base = ''
$language = 'en-gb'
$direction = 'ltr'
$_generator = 'Joomla! 1.5 - Open Source Content Management'
$_mdate = ''
$_tab = "\11"
$_lineEnd = "\12"
$_charset = 'utf-8'
$_mime = ''
$_namespace = ''
$_profile = ''
$_scripts = array()
$_script = array()
$_styleSheets = array()
$_style = array()
$_metaTags = array()
$_engine = null
$_type = null
$_buffer = null

Documentation des constructeurs et destructeur

JDocument::__construct ( $ options = array() )

Class constructor

protected

Paramètres:

array $options Associative array of options

Réimplémentée dans JDocumentError, JDocumentFeed, JDocumentHTML, JDocumentPDF, et JDocumentRAW.

Documentation des fonctions membres

JDocument::_getLineEnd ( )

Returns the lineEnd

private

Renvoie:: string

JDocument::_getTab ( )

Returns a string containing the unit for indenting HTML

private

Renvoie:: string

JDocument::addScript	(	$	url,
		$	type = `"text/javascript"`
	)

Adds a linked script to the page

Paramètres:

string	$url	URL to the linked script
string	$type	Type of script. Defaults to 'text/javascript' public

Références $type, et $url.

JDocument::addScriptDeclaration	(	$	content,
		$	type = `'text/javascript'`
	)

Adds a script to the page

public

Paramètres:

string	$content	Script
string	$type	Scripting mime (defaults to 'text/javascript')

Renvoie:: void

Références $content, et $type.

JDocument::addStyleDeclaration	(	$	content,
		$	type = `'text/css'`
	)

Adds a stylesheet declaration to the page

Paramètres:

string	$content	Style declarations
string	$type	Type of stylesheet (defaults to 'text/css') public

Renvoie:: void

Références $content, et $type.

JDocument::addStyleSheet	(	$	url,
		$	type = `'text/css'`,
		$	media = `null`,
		$	attribs = `array()`
	)

Adds a linked stylesheet to the page

Paramètres:

string	$url	URL to the linked style sheet
string	$type	Mime encoding type
string	$media	Media type that this stylesheet applies to public

Références $type, et $url.

JDocument::getBase ( )

Return the base URI of the document.

Renvoie:: string public

JDocument::getBuffer ( )

Get the contents of the document buffer

public

Renvoie:: The contents of the document buffer

JDocument::getCharset ( )

Returns the document charset encoding.

public

Renvoie:: string

JDocument::getDescription ( )

Return the title of the page.

Renvoie:: string public

JDocument::getDirection ( )

Returns the document language.

Renvoie:: string public

JDocument::getGenerator ( )

Returns the document generator

public

Renvoie:: string

JDocument::getHeadData ( )

Get the document head data

public

Renvoie:: array The document head data in array form

Réimplémentée dans JDocumentHTML.

& JDocument::getInstance	(	$	type = `'html'`,
		$	attributes = `array()`
	)

Returns a reference to the global JDocument object, only creating it if it doesn't already exist.

This method must be invoked as:

  $document = &JDocument::getInstance();

public

Paramètres:

type $type The document type to instantiate

Renvoie:: object The document object.

Références $class, $path, $type, JText::_(), et JError::raiseError().

Référencé par JFactory::_createDocument(), et JError::customErrorPage().

Voici le graphe d'appel pour cette fonction :

JDocument::getLanguage ( )

Returns the document language.

Renvoie:: string public

JDocument::getLink ( )

Returns the document base url

public

Renvoie:: string

JDocument::getMetaData	(	$	name,
		$	http_equiv = `false`
	)

Gets a meta tag.

Paramètres:

string	$name	Value of name or http-equiv tag
bool	$http_equiv	META type "http-equiv" defaults to null

Renvoie:: string public

Références $name, et elseif.

JDocument::getModifiedDate ( )

Returns the document modified date

public

Renvoie:: string

JDocument::getTitle ( )

Return the title of the document.

Renvoie:: string public

JDocument::getType ( )

Returns the document type

public

Renvoie:: string

& JDocument::loadRenderer ( $ type )

Load a renderer

public

Paramètres:

string The renderer type

Renvoie:: object

Depuis:: 1.5

Références $class, $path, JText::_(), et JError::raiseError().

Voici le graphe d'appel pour cette fonction :

JDocument::render	(	$	cache = `false`,
		$	params = `array()`
	)

Outputs the document

public

Paramètres:

boolean	$cache	If true, cache the output
boolean	$compress	If true, compress the output
array	$params	Associative array of attributes

Renvoie:: The rendered data

Réimplémentée dans JDocumentError, JDocumentFeed, JDocumentHTML, JDocumentPDF, et JDocumentRAW.

Références JResponse::setHeader().

Voici le graphe d'appel pour cette fonction :

JDocument::setBase ( $ base )

Sets the base URI of the document

Paramètres:

string $base public

JDocument::setBuffer ( $ content )

Set the contents of the document buffer

public

Paramètres:

string $content The content to be set in the buffer

Références $content.

JDocument::setCharset ( $ type = 'utf-8' )

Sets the document charset

Paramètres:

string $type Charset encoding string public

Renvoie:: void

Références $type.

JDocument::setDescription ( $ description )

Sets the description of the document

Paramètres:

string $title public

JDocument::setDirection ( $ dir = "ltr" )

Sets the global document direction declaration. Default is left-to-right (ltr).

public

Paramètres:

string $lang

JDocument::setGenerator ( $ generator )

Sets the document generator

Paramètres:

string public

Renvoie:: void

JDocument::setHeadData ( $ data )

Set the document head data

public

Paramètres:

array $data The document head data in array form

Réimplémentée dans JDocumentHTML.

JDocument::setLanguage ( $ lang = "en-gb" )

Sets the global document language declaration. Default is English (en-gb).

public

Paramètres:

string $lang

Références $lang.

JDocument::setLineEnd ( $ style )

Sets the line end style to Windows, Mac, Unix or a custom string.

Paramètres:

string $style "win", "mac", "unix" or custom string. public

Renvoie:: void

JDocument::setLink ( $ url )

Sets the document link

Paramètres:

string $url A url public

Renvoie:: void

Références $url.

JDocument::setMetaData	(	$	name,
		$	content,
		$	http_equiv = `false`
	)

Sets or alters a meta tag.

Paramètres:

string	$name	Value of name or http-equiv tag
string	$content	Value of the content tag
bool	$http_equiv	META type "http-equiv" defaults to null

Renvoie:: void public

Références $content, $name, et elseif.

JDocument::setMimeEncoding ( $ type = 'text/html' )

Sets the document 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/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.

Paramètres:

string $type public

Renvoie:: void

Références $type.

JDocument::setModifiedDate ( $ date )

Sets the document modified date

Paramètres:

string public

Renvoie:: void

Références $date.

JDocument::setTab ( $ string )

Sets the string used to indent HTML

Paramètres:

string $string String used to indent ("\11", "\t", ' ', etc.). public

Renvoie:: void

JDocument::setTitle ( $ title )

Sets the title of the document

Paramètres:

string $title public

Références $title.

JDocument::setType ( $ type )

Set the document type

public

Paramètres:

string $type

Références $type.

Documentation des données membres

JDocument::$_buffer = null

JDocument::$_charset = 'utf-8'

JDocument::$_engine = null

Réimplémentée dans JDocumentPDF.

JDocument::$_generator = 'Joomla! 1.5 - Open Source Content Management'

JDocument::$_lineEnd = "\12"

JDocument::$_mdate = ''

JDocument::$_metaTags = array()

JDocument::$_mime = ''

JDocument::$_namespace = ''

JDocument::$_profile = ''

JDocument::$_script = array()

JDocument::$_scripts = array()

JDocument::$_style = array()

JDocument::$_styleSheets = array()

JDocument::$_tab = "\11"

JDocument::$_type = null

JDocument::$base = ''

JDocument::$description = ''

JDocument::$direction = 'ltr'

JDocument::$language = 'en-gb'

JDocument::$link = ''

JDocument::$title = ''

La documentation de cette classe a été générée à partir du fichier suivant :

document.php

Référence de la classe JDocument

Fonctions membres publiques

Attributs publics

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres