JDocumentHTML/1.5
From Joomla! Documentation
< JDocumentHTML(Difference between revisions)
(Bulk upload by Doxiki2) |
(Layout updates) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|1.5}} 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/1.5|__construct]] | |[[JDocumentHTML::__construct/1.5|__construct]] | ||
|Class constructor. | |Class constructor. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::_loadTemplate/1.5|_loadTemplate]] | |[[JDocumentHTML::_loadTemplate/1.5|_loadTemplate]] | ||
|Load a template file. | |Load a template file. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::_parseTemplate/1.5|_parseTemplate]] | |[[JDocumentHTML::_parseTemplate/1.5|_parseTemplate]] | ||
|Parse a document template. | |Parse a document template. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::addCustomTag/1.5|addCustomTag]] | |[[JDocumentHTML::addCustomTag/1.5|addCustomTag]] | ||
|Adds a custom html string to the head block. | |Adds a custom html string to the head block. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::addFavicon/1.5|addFavicon]] | |[[JDocumentHTML::addFavicon/1.5|addFavicon]] | ||
|Adds a shortcut icon (favicon). | |Adds a shortcut icon (favicon). | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::addHeadLink/1.5|addHeadLink]] | |[[JDocumentHTML::addHeadLink/1.5|addHeadLink]] | ||
|Adds <link> tags to the head of the document. | |Adds <link> tags to the head of the document. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::countMenuChildren/1.5|countMenuChildren]] | |[[JDocumentHTML::countMenuChildren/1.5|countMenuChildren]] | ||
|Count the number of child menu items. | |Count the number of child menu items. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::countModules/1.5|countModules]] | |[[JDocumentHTML::countModules/1.5|countModules]] | ||
|Count the modules based on the given condition. | |Count the modules based on the given condition. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::getBuffer/1.5|getBuffer]] | |[[JDocumentHTML::getBuffer/1.5|getBuffer]] | ||
|Get the contents of a document include. | |Get the contents of a document include. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::getHeadData/1.5|getHeadData]] | |[[JDocumentHTML::getHeadData/1.5|getHeadData]] | ||
|Get the html document head data. | |Get the html document head data. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::render/1.5|render]] | |[[JDocumentHTML::render/1.5|render]] | ||
|Outputs the template to the browser. | |Outputs the template to the browser. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::setBuffer/1.5|setBuffer]] | |[[JDocumentHTML::setBuffer/1.5|setBuffer]] | ||
|Set the contents a document include. | |Set the contents a document include. | ||
|- | |- | ||
| + | |public | ||
|[[JDocumentHTML::setHeadData/1.5|setHeadData]] | |[[JDocumentHTML::setHeadData/1.5|setHeadData]] | ||
|Set the html document head data. | |Set the html document head data. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/document/html/html.php | ||
| + | * '''Extends''' [[JDocument/1.5|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=== | ||
| + | * {{JVer|1.5}} '''JDocumentHTML''' on [http://api.joomla.org/Joomla-Framework/Document/JDocumentHTML.html api.joomla.org] | ||
| + | * {{JVer|1.5}} '''JDocumentHTML source code''' on [[jframework15:document/html/html.php|JoomlaCode]] | ||
| + | * {{JVer|1.5}} Subpackage [[Subpackage Document/1.5|Document]] | ||
| + | * [[JDocumentHTML|Other versions of 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 74: | Line 87: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:Framework]][[Category:Framework 1.5]][[Category:JDocumentHTML]]</noinclude> | <noinclude>[[Category:Framework]][[Category:Framework 1.5]][[Category:JDocumentHTML]]</noinclude> | ||
Revision as of 18:07, 25 April 2011
JDocumentHTML
Description
This class defines a web page document. Note that templates are executed within the scope of this object, so $this in a template is an object of type JDocumentHTML.
[Edit Descripton]
Methods
| Visibility | Method name | Description |
|---|---|---|
| public | __construct | Class constructor. |
| public | _loadTemplate | Load a template file. |
| public | _parseTemplate | Parse a document template. |
| 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 | render | Outputs the template to the browser. |
| public | setBuffer | Set the contents a document include. |
| public | setHeadData | Set the html document head data. |
- Defined in libraries/joomla/document/html/html.php
- Extends JDocument
Importing
jimport( 'joomla.document.html.html' );
See also
- JDocumentHTML on api.joomla.org
- JDocumentHTML source code on JoomlaCode
- Subpackage Document
- Other versions of JDocumentHTML
SeeAlso:JDocumentHTML [Edit See Also]
User contributed notes
<CodeExamplesForm />
