|
|
| (5 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| − | 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'''. | + | This class is available in the following Joomla versions:- |
| − | | + | <splist showpath=notparent /> |
| − | ===Availability===
| + | <noinclude>[[Category:Platform JClasses]][[Category:JDocumentHTML]]</noinclude> |
| − | {{JVer|1.5|From Joomla 1.5}} {{JVer|1.6|Joomla 1.6}}
| + | |
| − | | + | |
| − | ===Defined in===
| + | |
| − | /libraries/joomla/document/html/html.php
| + | |
| − | | + | |
| − | ===Extends===
| + | |
| − | * [[JDocument]]
| + | |
| − | | + | |
| − | ===Get and Set Methods===
| + | |
| − | Properties which do not have specific get or set methods listed here can be retrieved or set using the inherited from [[JDocument]] or [[JObject/get|JObject->get]] method.
| + | |
| − | {| class="wikitable"
| + | |
| − | |-
| + | |
| − | !Get method
| + | |
| − | !Set method
| + | |
| − | !Description
| + | |
| − | |-
| + | |
| − | |[[JDocumentHTML/getBuffer|getBuffer]]
| + | |
| − | |[[JDocumentHTML/setBuffer|setBuffer]]
| + | |
| − | |Contents of the document buffer. Overrides the [[JDocument]] methods [[JDocument/getBuffer|JDocument->getBuffer]] and [[JDocument/setBuffer|JDocument->setBuffer]] respectively.
| + | |
| − | |-
| + | |
| − | |[[JDocumentHTML/getHeadData|getHeadData]]
| + | |
| − | |[[JDocumentHTML/setHeadData|setHeadData]]
| + | |
| − | |Data destined for the HTML <head> section in array form. Separate methods to get and set all the fields in this array are provided and should normally be used in preference to these methods.
| + | |
| − | |}
| + | |
| − | ===Importing=== | + | |
| − | Do not import this class directly; it is imported and instantiated by [[JDocument/getInstance|JDocument->getInstance]].
| + | |
| − | ===Other Methods===
| + | |
| − | {| class="wikitable"
| + | |
| − | |-
| + | |
| − | |[[JDocumentHTML/addCustomTag|addCustomTag]]
| + | |
| − | |Adds a custom HTML string to the document head.
| + | |
| − | |-
| + | |
| − | |[[JDocumentHTML/addFavicon|addFavicon]]
| + | |
| − | |Adds a favicon.ico for the document.
| + | |
| − | |-
| + | |
| − | |[[JDocumentHTML/addHeadLink|addHeadLink]]
| + | |
| − | |Adds <link> tags to the document head. See separate reference page for further information.
| + | |
| − | |-
| + | |
| − | |[[JDocumentHTML/countMenuChildren|countMenuChildren]]
| + | |
| − | |Counts the number of child menu items.
| + | |
| − | |-
| + | |
| − | |[[JDocumentHTML/countModules|countModules]]
| + | |
| − | |Counts the number of modules enabled in one or more module positions.
| + | |
| − | |-
| + | |
| − | |[[JDocumentHTML/render|render]]
| + | |
| − | |Renders the HTML document.
| + | |
| − | |}
| + | |
| − | | + | |
| − | ===See also===
| + | |
| − | * [http://api.joomla.org/Joomla-Framework/Document/JDocumentHTML.html JDocumentHTML on api.joomla.org]
| + | |
| − | <noinclude>[[Category:Development]][[Category:Framework]][[Category:JDocumentHTML]]</noinclude> | + | |
