Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JDocument
+ Graphe d'héritage de JDocument:
+ Graphe de collaboration de JDocument:

Liste de tous les membres

Fonctions membres publiques

 __construct ($options=array())
 setType ($type)
 getType ()
 getBuffer ()
 setBuffer ($content, $options=array())
 getMetaData ($name, $httpEquiv=false)
 setMetaData ($name, $content, $http_equiv=false, $sync=true)
 addScript ($url, $type="text/javascript", $defer=false, $async=false)
 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', $sync=true)
 getMimeEncoding ()
 setLineEnd ($style)
 _getLineEnd ()
 setTab ($string)
 _getTab ()
 loadRenderer ($type)
 parse ($params=array())
 render ($cache=false, $params=array())
- Fonctions membres publiques inherited from JObject
 __toString ()
 def ($property, $default=null)
 get ($property, $default=null)
 getProperties ($public=true)
 getError ($i=null, $toString=true)
 getErrors ()
 set ($property, $value=null)
 setProperties ($properties)
 setError ($error)
 toString ()

Fonctions membres publiques statiques

static getInstance ($type= 'html', $attributes=array())

Attributs publics

 $title = ''
 $description = ''
 $link = ''
 $base = ''
 $language = 'en-gb'
 $direction = 'ltr'
 $_generator = 'Joomla! - 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

Attributs publics statiques

static $_buffer = null

Attributs protégés statiques

static $instances = array()

Additional Inherited Members

- Attributs protégés inherited from JObject
 $_errors = array()

Documentation des constructeurs et destructeur

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

Class constructor.

Paramètres:
array$optionsAssociative array of options
Depuis:
11.1

Réimplémentée à partir de JObject.

Réimplémentée dans JDocumentFeed, JDocumentHTML, JDocumentOpensearch, JDocumentJSON, JDocumentError, JDocumentXml, et JDocumentRaw.

Références $options.


Documentation des fonctions membres

JDocument::_getLineEnd ( )

Returns the lineEnd

Renvoie:
string
Depuis:
11.1
JDocument::_getTab ( )

Returns a string containing the unit for indenting HTML

Renvoie:
string
Depuis:
11.1
JDocument::addScript (   $url,
  $type = "text/javascript",
  $defer = false,
  $async = false 
)

Adds a linked script to the page

Paramètres:
string$urlURL to the linked script
string$typeType of script. Defaults to 'text/javascript'
boolean$deferAdds the defer attribute.
boolean$asyncAdds the async attribute.
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

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

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

Adds a script to the page

Paramètres:
string$contentScript
string$typeScripting mime (defaults to 'text/javascript')
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

Références $type.

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

Adds a stylesheet declaration to the page

Paramètres:
string$contentStyle declarations
string$typeType of stylesheet (defaults to 'text/css')
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

Références $type.

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

Adds a linked stylesheet to the page

Paramètres:
string$urlURL to the linked style sheet
string$typeMime encoding type
string$mediaMedia type that this stylesheet applies to
array$attribsArray of attributes
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

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

JDocument::getBase ( )

Return the base URI of the document.

Renvoie:
string
Depuis:
11.1

Références $base.

JDocument::getBuffer ( )

Get the contents of the document buffer

Renvoie:
The contents of the document buffer
Depuis:
11.1
JDocument::getCharset ( )

Returns the document charset encoding.

Renvoie:
string
Depuis:
11.1
JDocument::getDescription ( )

Return the title of the page.

Renvoie:
string
Depuis:
11.1
JDocument::getDirection ( )

Returns the document direction declaration.

Renvoie:
string
Depuis:
11.1

Références $direction.

JDocument::getGenerator ( )

Returns the document generator

Renvoie:
string
Depuis:
11.1
static JDocument::getInstance (   $type = 'html',
  $attributes = array() 
)
static

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

Paramètres:
string$typeThe document type to instantiate
array$attributesArray of attributes
Renvoie:
object The document object.
Depuis:
11.1

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

Référencé par FinderControllerIndexer\batch(), JFactory\createDocument(), et JError\customErrorPage().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

JDocument::getLanguage ( )

Returns the document language.

Renvoie:
string
Depuis:
11.1

Références $language.

JDocument::getLink ( )

Returns the document base url

Renvoie:
string
Depuis:
11.1

Références $link.

JDocument::getMetaData (   $name,
  $httpEquiv = false 
)

Gets a meta tag.

Paramètres:
string$nameValue of name or http-equiv tag
boolean$httpEquivMETA type "http-equiv" defaults to null
Renvoie:
string
Depuis:
11.1

Références $name, et elseif.

JDocument::getMimeEncoding ( )

Return the document MIME encoding that is sent to the browser.

Renvoie:
string
Depuis:
11.1
JDocument::getModifiedDate ( )

Returns the document modified date

Renvoie:
string
Depuis:
11.1
JDocument::getTitle ( )

Return the title of the document.

Renvoie:
string
Depuis:
11.1

Références $title.

JDocument::getType ( )

Returns the document type

Renvoie:
string
Depuis:
11.1
JDocument::loadRenderer (   $type)

Load a renderer

Paramètres:
string$typeThe renderer type
Renvoie:
JDocumentRenderer Object or null if class does not exist
Depuis:
11.1

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

+ Voici le graphe d'appel pour cette fonction :

JDocument::parse (   $params = array())

Parses the document and prepares the buffers

Paramètres:
array$paramsThe array of parameters
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

Réimplémentée dans JDocumentHTML.

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

Outputs the document

Paramètres:
boolean$cacheIf true, cache the output
array$paramsAssociative array of attributes
Renvoie:
The rendered data
Depuis:
11.1

Réimplémentée dans JDocumentHTML, JDocumentFeed, JDocumentOpensearch, JDocumentError, JDocumentJSON, JDocumentXml, 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$baseThe base URI to be set
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

Références $base.

JDocument::setBuffer (   $content,
  $options = array() 
)

Set the contents of the document buffer

Paramètres:
string$contentThe content to be set in the buffer.
array$optionsArray of optional elements.
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

Réimplémentée dans JDocumentHTML.

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

Sets the document charset

Paramètres:
string$typeCharset encoding string
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

Références $type.

JDocument::setDescription (   $description)

Sets the description of the document

Paramètres:
string$descriptionThe description to set
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

Références description.

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

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

Paramètres:
string$dirThe language direction to be set
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

Références direction.

JDocument::setGenerator (   $generator)

Sets the document generator

Paramètres:
string$generatorThe generator to be set
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1
JDocument::setLanguage (   $lang = "en-gb")

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

Paramètres:
string$langThe language to be set
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

Références $lang, et language.

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.
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

Références $style.

JDocument::setLink (   $url)

Sets the document link

Paramètres:
string$urlA url
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

Références $url.

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

Sets or alters a meta tag.

Paramètres:
string$nameValue of name or http-equiv tag
string$contentValue of the content tag
boolean$http_equivMETA type "http-equiv" defaults to null
boolean$syncShould http-equiv="content-type" by synced with HTTP-header?
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

Références $name, et elseif.

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

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$typeThe document type to be sent
boolean$syncShould the type be synced with HTML?
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

http://www.w3.org/TR/xhtml-media-types

Références $type.

JDocument::setModifiedDate (   $date)

Sets the document modified date

Paramètres:
string$dateThe date to be set
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

Références $date.

JDocument::setTab (   $string)

Sets the string used to indent HTML

Paramètres:
string$stringString used to indent ("\11", "\t", ' ', etc.).
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1
JDocument::setTitle (   $title)

Sets the title of the document

Paramètres:
string$titleThe title to be set
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

Références $title, et title.

JDocument::setType (   $type)

Set the document type

Paramètres:
string$typeType document is to set to
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
11.1

Références $type.


Documentation des données membres

JDocument::$_buffer = null
static
JDocument::$_charset = 'utf-8'
JDocument::$_engine = null
JDocument::$_generator = 'Joomla! - 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::$instances = array()
staticprotected
JDocument::$language = 'en-gb'
JDocument::$link = ''
JDocument::$title = ''

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