Class: ComDefaultTemplateFilterChrome

Source Location: /administrator/components/com_default/templates/filters/chrome.php

Class Overview

KObject
   |
   --KTemplateFilterAbstract
      |
      --ComDefaultTemplateFilterChrome

Chrome Template Filter

Author(s):

Johan Janssens <johan@nooku.org>

Implements interfaces:

KTemplateFilterWrite

Variables

Methods

Inherited Variables

Class: KTemplateFilterAbstract

KTemplateFilterAbstract::$_priority
KTemplateFilterAbstract::$_template

Class: KObject

KObject::$_mixed_methods
KObject::$__methods
KObject::$__service_container
KObject::$__service_identifier

Inherited Methods

Class: KTemplateFilterAbstract

KTemplateFilterAbstract::__construct(): Constructor.
KTemplateFilterAbstract::execute(): Command handler
KTemplateFilterAbstract::getPriority(): Get the priority of a behavior
KTemplateFilterAbstract::getTemplate(): Get the template object
KTemplateFilterAbstract::_initialize(): Initializes the options for the object
KTemplateFilterAbstract::_parseAttributes(): Method to extract key/value pairs out of a string with xml style attributes

Class: KObject

KObject::__construct(): Constructor
KObject::get(): Get the object properties
KObject::getHandle(): Get a handle for this object
KObject::getIdentifier(): Gets the service identifier.
KObject::getMethods(): Get a list of all the available methods
KObject::getService(): Get an instance of a class based on a class identifier only creating it if it does not exist yet.
KObject::inherits(): Checks if the object or one of it's mixin's inherits from a class.
KObject::mixin(): Mixin an object
KObject::set(): Set the object properties
KObject::_initialize(): Initializes the options for the object
KObject::__call(): Search the mixin method map and call the method or trigger an error
KObject::__clone(): Preform a deep clone of the object.

Class Details

[line 20]
Chrome Template Filter

This filter allows to apply module chrome to a template

Tags:

author:

Johan Janssens <johan@nooku.org>

[ Top ]

Class Variables

$_attribs =

[line 51]

The module attribs

Tags:

access:

protected

Type:

array

[ Top ]

$_class =

[line 37]

The module class

Tags:

access:

protected

Type:

string

[ Top ]

$_styles =

[line 44]

The module styles

Tags:

access:

protected

Type:

array

[ Top ]

$_title =

[line 30]

The module title

If set this will be passed to the module chrome rendered. If the renderer support rendering of a title it will be displayed.

Tags:

access:

protected

Type:

string

[ Top ]

Class Methods

constructor __construct [line 58]

ComDefaultTemplateFilterChrome __construct(
[
$config = null])

Constructor.

Tags:

access:

public

Overrides KTemplateFilterAbstract::__construct() (Constructor.)

Parameters:

object An

$config

optional KConfig object with configuration options

[ Top ]

method write [line 99]

ComDefaultTemplateFilterChrome write(
string
&$text)

Apply module chrome to the template output

Tags:

access:

public

Parameters:

string

&$text

Block of text to parse

[ Top ]

method _initialize [line 76]

void _initialize(

$config)

Initializes the options for the object

Called from __construct() as a first step of object instantiation.

Tags:

access:

protected

Overrides KTemplateFilterAbstract::_initialize() (Initializes the options for the object)

Parameters:

object An

$config

optional KConfig object with configuration options

[ Top ]

Documentation generated on Wed, 22 May 2013 03:00:59 +0200 by phpDocumentor 1.4.3