Actions

JDocumentHTML/getBuffer

From Joomla! Documentation

Revision as of 17:42, 7 September 2008 by Chris Davenport (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Gets the contents of a document buffer. This will generally be the output captured from a <jdoc:include ... /> statement in the template.

Syntax

string getBuffer( $type, $name, $attribs )

where:

Argument Data type Description Default
$type string Renderer type. If null then the entire buffer array is returned. null
$name string Name of the element rendered. null
$attribs array Associative array of remaining attributes.

Example

On encountering a <jdoc:include type="mytype" name="myname" class="myclass" /> statement in the document template, this is effectively the call that would be made (the actual call is made in the private method JDocumentHTML->_parseTemplate):

$doc =& JFactory::getDocument();
$buffer = $doc->getBuffer( 'mytype', 'myname', array( 'class' => 'myclass' ) );

See also