Docs For Class Dwoo

Description

base plugin class

you have to implement the <em>process()</em> method, it will receive the parameters that are in the template code

This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

This file is released under the LGPL "GNU Lesser General Public License" More information can be found here: http://www.gnu.org/copyleft/lesser.html

author: Jordi Boggiano <[email protected]>
version: 0.9.1
copyright: Copyright (c) 2008, Jordi Boggiano
link: http://dwoo.org/
abstract:
date: 2008-05-30
license: GNU Lesser General Public License

Located in /Dwoo/Plugin.php (line 25)

Direct descendents

Class	Description
Dwoo_Block_Plugin	base class for block plugins
Dwoo_Plugin_counter	Initiates a counter that is incremented every time you call it
Dwoo_Plugin_cycle	Cycles between several values and returns one of them on each call
Dwoo_Plugin_dump	Dumps values of the given variable, or the entire data if nothing provided
Dwoo_Plugin_extends	Extends another template, read more about template inheritance at http://wiki.dwoo.org/index.php/TemplateInheritance

Variable Summary

Dwoo $dwoo

Method Summary

static string paramsToAttributes ( $params, [string $delim = '\''])

Dwoo_Plugin __construct (Dwoo $dwoo)

Variables

Dwoo $dwoo (line 32)

the dwoo instance that runs this plugin

access: protected

Methods

static paramsToAttributes (line 69)

utility function that converts an array of compiled parameters (or rest array) to a string of xml/html tag attributes

this is to be used in preProcessing or postProcessing functions, example : $p = $compiler->getCompiledParams($params); // get only the rest array as attributes $attributes = Dwoo_Plugin::paramsToAttributes($p['*']); // get all the parameters as attributes (if there is a rest array, it will be included) $attributes = Dwoo_Plugin::paramsToAttributes($p);

access: public

static string paramsToAttributes ( $params, [string $delim = '\''])

array $params: an array of attributeName=>value items that will be compiled to be ready for inclusion in a php string
string $delim: the string delimiter you want to use (defaults to ')

Constructor __construct (line 40)

constructor, if you override it, call parent::__construct($dwoo); or assign the dwoo instance yourself if you need it

access: public

Dwoo_Plugin __construct (Dwoo $dwoo)

Dwoo $dwoo: the dwoo instance that runs this plugin

Class Dwoo_Plugin