Difference between revisions of "JDocumentHTML"
From Joomla! Documentation
(Layout updates) |
m (→User contributed notes: bad link repair) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|11.1}} JDocumentHTML== | ||
| + | ===Description=== | ||
| + | {{Description:JDocumentHTML}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JDocumentHTML|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JDocumentHTML|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::__construct/11.1|__construct]] | |[[JDocumentHTML::__construct/11.1|__construct]] | ||
|Class constructor. | |Class constructor. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::addCustomTag/11.1|addCustomTag]] | |[[JDocumentHTML::addCustomTag/11.1|addCustomTag]] | ||
|Adds a custom html string to the head block. | |Adds a custom html string to the head block. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::addFavicon/11.1|addFavicon]] | |[[JDocumentHTML::addFavicon/11.1|addFavicon]] | ||
|Adds a shortcut icon (favicon). | |Adds a shortcut icon (favicon). | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::addHeadLink/11.1|addHeadLink]] | |[[JDocumentHTML::addHeadLink/11.1|addHeadLink]] | ||
|Adds <link> tags to the head of the document. | |Adds <link> tags to the head of the document. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::countMenuChildren/11.1|countMenuChildren]] | |[[JDocumentHTML::countMenuChildren/11.1|countMenuChildren]] | ||
|Count the number of child menu items. | |Count the number of child menu items. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::countModules/11.1|countModules]] | |[[JDocumentHTML::countModules/11.1|countModules]] | ||
|Count the modules based on the given condition. | |Count the modules based on the given condition. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::getBuffer/11.1|getBuffer]] | |[[JDocumentHTML::getBuffer/11.1|getBuffer]] | ||
|Get the contents of a document include. | |Get the contents of a document include. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::getHeadData/11.1|getHeadData]] | |[[JDocumentHTML::getHeadData/11.1|getHeadData]] | ||
|Get the html document head data. | |Get the html document head data. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::mergeHeadData/11.1|mergeHeadData]] | |[[JDocumentHTML::mergeHeadData/11.1|mergeHeadData]] | ||
|Merge the html document head data. | |Merge the html document head data. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::parse/11.1|parse]] | |[[JDocumentHTML::parse/11.1|parse]] | ||
|Parses the template and populates the buffer. | |Parses the template and populates the buffer. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::render/11.1|render]] | |[[JDocumentHTML::render/11.1|render]] | ||
|Outputs the template to the browser. | |Outputs the template to the browser. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::setBuffer/11.1|setBuffer]] | |[[JDocumentHTML::setBuffer/11.1|setBuffer]] | ||
|Set the contents a document includes. | |Set the contents a document includes. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::setHeadData/11.1|setHeadData]] | |[[JDocumentHTML::setHeadData/11.1|setHeadData]] | ||
|Set the html document head data. | |Set the html document head data. | ||
|- | |- | ||
| + | |protected | ||
|[[JDocumentHTML::_fetchTemplate/11.1|_fetchTemplate]] | |[[JDocumentHTML::_fetchTemplate/11.1|_fetchTemplate]] | ||
|Fetch the template, and initialise the params. | |Fetch the template, and initialise the params. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/document/html/html.php | ||
| + | * '''Extends''' [[JDocument/11.1|JDocument]] | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.document.html.html' );</source> | <source lang="php">jimport( 'joomla.document.html.html' );</source> | ||
===See also=== | ===See also=== | ||
| − | * JDocumentHTML source code | + | * {{JVer|11.1}} '''JDocumentHTML source code''' on [[jplatform:document/html/html.php|BitBucket]] |
| − | * [[JDocumentHTML|Other versions of | + | * {{JVer|11.1}} Subpackage [[Subpackage Document/11.1|Document]] |
| + | * [[JDocumentHTML|Other versions of JDocumentHTML]] | ||
{{SeeAlso:JDocumentHTML}} | {{SeeAlso:JDocumentHTML}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JDocumentHTML|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JDocumentHTML|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 78: | Line 90: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| − | <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JDocumentHTML]]</noinclude> | + | <noinclude>[[Category:Platform JClasses]][[Category:Platform 11.1]][[Category:JDocumentHTML]]</noinclude> |
Revision as of 13:37, 29 August 2012
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JDocumentHTML[edit]
Description[edit]
Template:Description:JDocumentHTML [Edit Descripton]
Methods[edit]
| Visibility | Method name | Description |
|---|---|---|
| public | __construct | Class constructor. |
| public | addCustomTag | Adds a custom html string to the head block. |
| public | addFavicon | Adds a shortcut icon (favicon). |
| public | addHeadLink | Adds <link> tags to the head of the document. |
| public | countMenuChildren | Count the number of child menu items. |
| public | countModules | Count the modules based on the given condition. |
| public | getBuffer | Get the contents of a document include. |
| public | getHeadData | Get the html document head data. |
| public | mergeHeadData | Merge the html document head data. |
| public | parse | Parses the template and populates the buffer. |
| public | render | Outputs the template to the browser. |
| public | setBuffer | Set the contents a document includes. |
| public | setHeadData | Set the html document head data. |
| protected | _fetchTemplate | Fetch the template, and initialise the params. |
- Defined in libraries/joomla/document/html/html.php
- Extends JDocument
Importing[edit]
jimport( 'joomla.document.html.html' );See also[edit]
- JDocumentHTML source code on BitBucket
- Subpackage Document
- Other versions of JDocumentHTML
Template:SeeAlso:JDocumentHTML [Edit See Also]
User contributed notes[edit]
<CodeExamplesForm />