Joomla CMS
3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
|
Fonctions membres publiques | |
__construct ($options=array()) | |
getHeadData () | |
resetHeadData ($types=null) | |
setHeadData ($data) | |
mergeHeadData ($data) | |
addHeadLink ($href, $relation, $relType='rel', $attribs=array()) | |
addFavicon ($href, $type='image/vnd.microsoft.icon', $relation='shortcut icon') | |
addCustomTag ($html) | |
isHtml5 () | |
setHtml5 ($state) | |
getBuffer ($type=null, $name=null, $attribs=array()) | |
setBuffer ($content, $options=array()) | |
parse ($params=array()) | |
render ($caching=false, $params=array()) | |
countModules ($condition) | |
countMenuChildren () | |
Fonctions membres publiques hérités de Document | |
__construct ($options=array()) | |
setType ($type) | |
getType () | |
getBuffer () | |
setBuffer ($content, $options=array()) | |
getMetaData ($name, $attribute='name') | |
setMetaData ($name, $content, $attribute='name') | |
addScript ($url, $options=array(), $attribs=array()) | |
addScriptVersion ($url, $options=array(), $attribs=array()) | |
addScriptDeclaration ($content, $type='text/javascript') | |
addScriptOptions ($key, $options, $merge=true) | |
getScriptOptions ($key=null) | |
addStyleSheet ($url, $options=array(), $attribs=array()) | |
addStyleSheetVersion ($url, $options=array(), $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()) | |
Champs de données | |
$_links = array() | |
$_custom = array() | |
$template = null | |
$baseurl = null | |
$params = null | |
$_file = null | |
Champs de données hérités de Document | |
$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 | |
Fonctions membres protégées | |
_loadTemplate ($directory, $filename) | |
_fetchTemplate ($params=array()) | |
_parseTemplate () | |
_renderTemplate () | |
Attributs protégés | |
$_template = '' | |
$_template_tags = array() | |
$_caching = null | |
Attributs protégés hérités de Document | |
$scriptOptions = array() | |
$mediaVersion = null | |
Fonctions membres privées | |
resetHeadDatum ($type) | |
Attributs privés | |
$_html5 = null | |
Membres hérités additionnels | |
Fonctions membres publiques statiques hérités de Document | |
static | getInstance ($type='html', $attributes=array()) |
Attributs publics statiques hérités de Document | |
static | $_buffer = null |
Attributs protégés statiques hérités de Document | |
static | $instances = array() |
HtmlDocument class, provides an easy interface to parse and display a HTML document
__construct | ( | $options = array() | ) |
Class constructor
array | $options | Associative array of options |
Références $options.
|
protected |
Fetch the template, and initialise the params
array | $params | Parameters to determine the template |
Références $file, $filter, $lang, $params, $template, Uri\base(), JPATH_BASE, et null.
|
protected |
Load a template file
string | $directory | The name of the template |
string | $filename | The actual filename |
Références $icon, $path, Uri\base(), et JPATH_BASE.
|
protected |
|
protected |
Render pre-parsed template
addCustomTag | ( | $html | ) |
Adds a custom HTML string to the head block
string | $html | The HTML to add to the head |
Références $html.
addFavicon | ( | $href, | |
$type = 'image/vnd.microsoft.icon' , |
|||
$relation = 'shortcut icon' |
|||
) |
Adds a shortcut icon (favicon)
This adds a link to the icon shown in the favorites list or on the left of the url in the address bar. Some browsers display it on the tab, as well.
string | $href | The link that is being related. |
string | $type | File type |
string | $relation | Relation of link |
addHeadLink | ( | $href, | |
$relation, | |||
$relType = 'rel' , |
|||
$attribs = array() |
|||
) |
Adds <link>
tags to the head of the document
$relType defaults to 'rel' as it is the most common relation type used. ('rev' refers to reverse relation, 'rel' indicates normal, forward relation.) Typical tag: <link href="index.php" rel="Start">
string | $href | The link that is being related. |
string | $relation | Relation of link. |
string | $relType | Relation type attribute. Either rel or rev (default: 'rel'). |
array | $attribs | Associative array of remaining attributes. |
countMenuChildren | ( | ) |
countModules | ( | $condition | ) |
Count the modules based on the given condition
string | $condition | The condition to use |
Références $condition, $i, $n, $name, Log\add(), ModuleHelper\getModules(), et Log\WARNING.
Get the contents of a document include
string | $type | The type of renderer |
string | $name | The name of the element to render |
array | $attribs | Associative array of remaining attributes. |
Références $attribs, $data, $hash, $itemId, $name, $options, $renderer, $title, $type, Factory\getApplication(), Factory\getCache(), Cache\getWorkarounds(), null, et Cache\setWorkarounds().
getHeadData | ( | ) |
Get the HTML document head data
Références $data, $description, $link, et $title.
isHtml5 | ( | ) |
Returns whether the document is set up to be output as HTML5
mergeHeadData | ( | $data | ) |
parse | ( | $params = array() | ) |
Parses the template and populates the buffer
array | $params | Parameters for fetching the template |
Références $params.
render | ( | $caching = false , |
|
$params = array() |
|||
) |
resetHeadData | ( | $types = null | ) |
Reset the HTML document head data
mixed | $types | type or types of the heads elements to reset |
Références $type, description, et title.
|
private |
setBuffer | ( | $content, | |
$options = array() |
|||
) |
Set the contents a document includes
string | $content | The content to be set in the buffer. |
array | $options | Array of optional elements. |
setHeadData | ( | $data | ) |
Set the HTML document head data
array | $data | The document head data in array form |
Références $data, description, null, et title.
setHtml5 | ( | $state | ) |
Sets whether the document should be output as HTML5
bool | $state | True when HTML5 should be output |
Références $state.
|
protected |
$_custom = array() |
$_file = null |
|
private |
$_links = array() |
|
protected |
|
protected |
$baseurl = null |
$params = null |
$template = null |