Class: ComDefaultTemplateFilterModule

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

Class Overview

KObject
   |
   --KTemplateFilterAbstract
      |
      --ComDefaultTemplateFilterModule

Module Template Filter

Author(s):

Johan Janssens <johan@nooku.org>

Implements interfaces:

KTemplateFilterWrite

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 23]
Module Template Filter

This filter allow to dynamically inject data into module position.

Filter will parse elements of the form <modules position="[position]">[content]</modules> and prepend or append the content to the module position.

Tags:

author:

Johan Janssens <johan@nooku.org>

[ Top ]

Class Methods

method write [line 48]

ComDefaultTemplateFilterModule write(
string
&$text)

Find any <module></module> elements and inject them into the JDocument object

Tags:

access:

public

Parameters:

string

&$text

Block of text to parse

[ Top ]

method _initialize [line 33]

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 Mon, 20 May 2013 03:03:04 +0200 by phpDocumentor 1.4.3