Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques | Fonctions membres publiques statiques | Attributs publics | Attributs publics statiques | Attributs protégés | Attributs protégés statiques
Référence de la classe JDocument
+ Graphe d'héritage 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)
 addScript ($url, $type="text/javascript", $defer=false, $async=false)
 addScriptVersion ($url, $version=null, $type="text/javascript", $defer=false, $async=false)
 addScriptDeclaration ($content, $type= 'text/javascript')
 addStyleSheet ($url, $type= 'text/css', $media=null, $attribs=array())
 addStyleSheetVersion ($url, $version=null, $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 ()
 setMediaVersion ($mediaVersion)
 getMediaVersion ()
 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 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

 $mediaVersion = null

Attributs protégés statiques

static $instances = array()

Description détaillée

Définition à la ligne 19 du fichier document.php.

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 dans JDocumentFeed, JDocumentHTML, JDocumentOpensearch, JDocumentJSON, JDocumentError, JDocumentXml, JDocumentImage, et JDocumentRaw.

Définition à la ligne 219 du fichier document.php.

{
if (array_key_exists('lineend', $options))
{
$this->setLineEnd($options['lineend']);
}
if (array_key_exists('charset', $options))
{
$this->setCharset($options['charset']);
}
if (array_key_exists('language', $options))
{
$this->setLanguage($options['language']);
}
if (array_key_exists('direction', $options))
{
$this->setDirection($options['direction']);
}
if (array_key_exists('tab', $options))
{
$this->setTab($options['tab']);
}
if (array_key_exists('link', $options))
{
$this->setLink($options['link']);
}
if (array_key_exists('base', $options))
{
$this->setBase($options['base']);
}
if (array_key_exists('mediaversion', $options))
{
$this->setMediaVersion($options['mediaversion']);
}
}

Documentation des fonctions membres

JDocument::_getLineEnd ( )

Returns the lineEnd

Renvoie:
string
Depuis:
11.1

Définition à la ligne 963 du fichier document.php.

{
return $this->_lineEnd;
}
JDocument::_getTab ( )

Returns a string containing the unit for indenting HTML

Renvoie:
string
Depuis:
11.1

Définition à la ligne 991 du fichier document.php.

{
return $this->_tab;
}
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

Définition à la ligne 466 du fichier document.php.

{
$this->_scripts[$url]['mime'] = $type;
$this->_scripts[$url]['defer'] = $defer;
$this->_scripts[$url]['async'] = $async;
return $this;
}
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

Définition à la ligne 515 du fichier document.php.

{
if (!isset($this->_script[strtolower($type)]))
{
$this->_script[strtolower($type)] = $content;
}
else
{
$this->_script[strtolower($type)] .= chr(13) . $content;
}
return $this;
}
JDocument::addScriptVersion (   $url,
  $version = null,
  $type = "text/javascript",
  $defer = false,
  $async = false 
)

Adds a linked script to the page with a version to allow to flush it. Ex: myscript.js54771616b5bceae9df03c6173babf11d If not specified Joomla! automatically handles versioning

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

Définition à la ligne 489 du fichier document.php.

{
// Automatic version
if ($version === null)
{
$version = $this->getMediaVersion();
}
if (!empty($version) && strpos($url, '?') === false)
{
$url .= '?' . $version;
}
return $this->addScript($url, $type, $defer, $async);
}
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

Définition à la ligne 590 du fichier document.php.

{
if (!isset($this->_style[strtolower($type)]))
{
$this->_style[strtolower($type)] = $content;
}
else
{
$this->_style[strtolower($type)] .= chr(13) . $content;
}
return $this;
}
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

Définition à la ligne 541 du fichier document.php.

{
$this->_styleSheets[$url]['mime'] = $type;
$this->_styleSheets[$url]['media'] = $media;
$this->_styleSheets[$url]['attribs'] = $attribs;
return $this;
}
JDocument::addStyleSheetVersion (   $url,
  $version = null,
  $type = "text/css",
  $media = null,
  $attribs = array() 
)

Adds a linked stylesheet version to the page. Ex: template.css?54771616b5bceae9df03c6173babf11d If not specified Joomla! automatically handles versioning

Paramètres:
string$urlURL to the linked style sheet
string$versionVersion of the stylesheet
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:
3.2

Définition à la ligne 564 du fichier document.php.

{
// Automatic version
if ($version === null)
{
$version = $this->getMediaVersion();
}
if (!empty($version) && strpos($url, '?') === false)
{
$url .= '?' . $version;
}
return $this->addStyleSheet($url, $type, $media, $attribs);
}
JDocument::getBase ( )

Return the base URI of the document.

Renvoie:
string
Depuis:
11.1

Définition à la ligne 767 du fichier document.php.

{
return $this->base;
}
JDocument::getBuffer ( )

Get the contents of the document buffer

Renvoie:
The contents of the document buffer
Depuis:
11.1

Définition à la ligne 357 du fichier document.php.

{
return self::$_buffer;
}
JDocument::getCharset ( )

Returns the document charset encoding.

Renvoie:
string
Depuis:
11.1

Définition à la ligne 627 du fichier document.php.

{
return $this->_charset;
}
JDocument::getDescription ( )

Return the title of the page.

Renvoie:
string
Depuis:
11.1

Définition à la ligne 795 du fichier document.php.

{
return $this->description;
}
JDocument::getDirection ( )

Returns the document direction declaration.

Renvoie:
string
Depuis:
11.1

Définition à la ligne 683 du fichier document.php.

{
return $this->direction;
}
JDocument::getGenerator ( )

Returns the document generator

Renvoie:
string
Depuis:
11.1

Définition à la ligne 851 du fichier document.php.

{
return $this->_generator;
}
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
Exceptions:
RuntimeException

Définition à la ligne 274 du fichier document.php.

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

{
$signature = serialize(array($type, $attributes));
if (empty(self::$instances[$signature]))
{
$type = preg_replace('/[^A-Z0-9_\.-]/i', '', $type);
$path = __DIR__ . '/' . $type . '/' . $type . '.php';
$ntype = null;
// Check if the document type exists
if (!file_exists($path))
{
// Default to the raw format
$ntype = $type;
$type = 'raw';
}
// Determine the path and class
$class = 'JDocument' . $type;
if (!class_exists($class))
{
$path = __DIR__ . '/' . $type . '/' . $type . '.php';
if (file_exists($path))
{
require_once $path;
}
else
{
throw new RuntimeException('Invalid JDocument Class', 500);
}
}
$instance = new $class($attributes);
self::$instances[$signature] = $instance;
if (!is_null($ntype))
{
// Set the type to the Document type originally requested
$instance->setType($ntype);
}
}
return self::$instances[$signature];
}

+ Voici le graphe des appelants de cette fonction :

JDocument::getLanguage ( )

Returns the document language.

Renvoie:
string
Depuis:
11.1

Définition à la ligne 655 du fichier document.php.

{
return $this->language;
}
JDocument::getLink ( )

Returns the document base url

Renvoie:
string
Depuis:
11.1

Définition à la ligne 823 du fichier document.php.

{
return $this->link;
}
JDocument::getMediaVersion ( )

Return the media version

Renvoie:
string
Depuis:
3.2

Définition à la ligne 739 du fichier document.php.

{
return $this->mediaVersion;
}
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

Définition à la ligne 389 du fichier document.php.

{
$name = strtolower($name);
if ($name == 'generator')
{
$result = $this->getGenerator();
}
elseif ($name == 'description')
{
$result = $this->getDescription();
}
else
{
if ($httpEquiv == true)
{
$result = @$this->_metaTags['http-equiv'][$name];
}
else
{
$result = @$this->_metaTags['standard'][$name];
}
}
return $result;
}
JDocument::getMimeEncoding ( )

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

Renvoie:
string
Depuis:
11.1

Définition à la ligne 922 du fichier document.php.

{
return $this->_mime;
}
JDocument::getModifiedDate ( )

Returns the document modified date

Renvoie:
string
Depuis:
11.1

Définition à la ligne 879 du fichier document.php.

{
return $this->_mdate;
}
JDocument::getTitle ( )

Return the title of the document.

Renvoie:
string
Depuis:
11.1

Définition à la ligne 711 du fichier document.php.

{
return $this->title;
}
JDocument::getType ( )

Returns the document type

Renvoie:
string
Depuis:
11.1

Définition à la ligne 345 du fichier document.php.

{
return $this->_type;
}
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
Exceptions:
RuntimeException

Définition à la ligne 1006 du fichier document.php.

{
$class = 'JDocumentRenderer' . $type;
if (!class_exists($class))
{
$path = __DIR__ . '/' . $this->_type . '/renderer/' . $type . '.php';
if (file_exists($path))
{
require_once $path;
}
else
{
throw new RuntimeException('Unable to load renderer class', 500);
}
}
if (!class_exists($class))
{
return null;
}
$instance = new $class($this);
return $instance;
}
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.

Définition à la ligne 1043 du fichier document.php.

{
return $this;
}
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, JDocumentImage, et JDocumentRaw.

Définition à la ligne 1058 du fichier document.php.

Références JFactory\getApplication().

{
$app = JFactory::getApplication();
if ($mdate = $this->getModifiedDate())
{
$app->modifiedDate = $mdate;
}
$app->mimeType = $this->_mime;
$app->charSet = $this->_charset;
}

+ 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

Définition à la ligne 753 du fichier document.php.

{
$this->base = $base;
return $this;
}
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.

Définition à la ligne 372 du fichier document.php.

{
self::$_buffer = $content;
return $this;
}
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

Définition à la ligne 613 du fichier document.php.

{
$this->_charset = $type;
return $this;
}
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

Définition à la ligne 781 du fichier document.php.

{
$this->description = $description;
return $this;
}
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

Définition à la ligne 669 du fichier document.php.

{
$this->direction = strtolower($dir);
return $this;
}
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

Définition à la ligne 837 du fichier document.php.

{
$this->_generator = $generator;
return $this;
}
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

Définition à la ligne 641 du fichier document.php.

{
$this->language = strtolower($lang);
return $this;
}
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

Définition à la ligne 936 du fichier document.php.

{
switch ($style)
{
case 'win':
$this->_lineEnd = "\15\12";
break;
case 'unix':
$this->_lineEnd = "\12";
break;
case 'mac':
$this->_lineEnd = "\15";
break;
default:
$this->_lineEnd = $style;
}
return $this;
}
JDocument::setLink (   $url)

Sets the document link

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

Définition à la ligne 809 du fichier document.php.

{
$this->link = $url;
return $this;
}
JDocument::setMediaVersion (   $mediaVersion)

Set the assets version

Paramètres:
string$mediaVersionMedia version to use
Renvoie:
JDocument instance of $this to allow chaining
Depuis:
3.2

Définition à la ligne 725 du fichier document.php.

{
$this->mediaVersion = strtolower($mediaVersion);
return $this;
}
JDocument::setMetaData (   $name,
  $content,
  $http_equiv = false 
)

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

Définition à la ligne 427 du fichier document.php.

{
$name = strtolower($name);
if ($name == 'generator')
{
$this->setGenerator($content);
}
elseif ($name == 'description')
{
$this->setDescription($content);
}
else
{
if ($http_equiv == true)
{
$this->_metaTags['http-equiv'][$name] = $content;
}
else
{
$this->_metaTags['standard'][$name] = $content;
}
}
return $this;
}
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

Définition à la ligne 902 du fichier document.php.

{
$this->_mime = strtolower($type);
// Syncing with meta-data
if ($sync)
{
$this->setMetaData('content-type', $type . '; charset=' . $this->_charset, true);
}
return $this;
}
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

Définition à la ligne 865 du fichier document.php.

{
$this->_mdate = $date;
return $this;
}
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

Définition à la ligne 977 du fichier document.php.

{
$this->_tab = $string;
return $this;
}
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

Définition à la ligne 697 du fichier document.php.

{
$this->title = $title;
return $this;
}
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

Définition à la ligne 331 du fichier document.php.

{
$this->_type = $type;
return $this;
}

Documentation des données membres

JDocument::$_buffer = null
static

Définition à la ligne 194 du fichier document.php.

JDocument::$_charset = 'utf-8'

Définition à la ligne 106 du fichier document.php.

JDocument::$_engine = null

Définition à la ligne 178 du fichier document.php.

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

Définition à la ligne 74 du fichier document.php.

JDocument::$_lineEnd = "\12"

Définition à la ligne 98 du fichier document.php.

JDocument::$_mdate = ''

Définition à la ligne 82 du fichier document.php.

JDocument::$_metaTags = array()

Définition à la ligne 170 du fichier document.php.

JDocument::$_mime = ''

Définition à la ligne 114 du fichier document.php.

JDocument::$_namespace = ''

Définition à la ligne 122 du fichier document.php.

JDocument::$_profile = ''

Définition à la ligne 130 du fichier document.php.

JDocument::$_script = array()

Définition à la ligne 146 du fichier document.php.

JDocument::$_scripts = array()

Définition à la ligne 138 du fichier document.php.

JDocument::$_style = array()

Définition à la ligne 162 du fichier document.php.

JDocument::$_styleSheets = array()

Définition à la ligne 154 du fichier document.php.

JDocument::$_tab = "\11"

Définition à la ligne 90 du fichier document.php.

JDocument::$_type = null

Définition à la ligne 186 du fichier document.php.

JDocument::$base = ''

Définition à la ligne 51 du fichier document.php.

JDocument::$description = ''

Définition à la ligne 35 du fichier document.php.

JDocument::$direction = 'ltr'

Définition à la ligne 67 du fichier document.php.

JDocument::$instances = array()
staticprotected

Définition à la ligne 202 du fichier document.php.

JDocument::$language = 'en-gb'

Définition à la ligne 59 du fichier document.php.

JDocument::$link = ''

Définition à la ligne 43 du fichier document.php.

JDocument::$mediaVersion = null
protected

Définition à la ligne 210 du fichier document.php.

JDocument::$title = ''

Définition à la ligne 27 du fichier document.php.

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