Source for file IPluginProxy.php
Documentation is available at IPluginProxy.php
* interface that represents a dwoo plugin proxy
* 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.
* @author Denis Arh <denis@arh.cc>
* @author Jordi Boggiano <j.boggiano@seld.be>
* @copyright Copyright (c) 2008, Denis Arh, Jordi Boggiano
* @license http://dwoo.org/LICENSE Modified BSD License
* returns true or false to say whether the given plugin is handled by this proxy or not
* @param string $name the plugin name
* @return bool true if the plugin is known and usable, otherwise false
* returns the code (as a string) to call the plugin
* (this will be executed at runtime inside the Dwoo class)
* @param string $name the plugin name
* @param array $params a parameter array, array key "*" is the rest array
public function getCode($name, $params);
* returns a callback to the plugin, this is used with the reflection API to
* find out about the plugin's parameter names etc.
* should you need a rest array without the possibility to edit the
* plugin's code, you can provide a callback to some
* other function with the correct parameter signature, i.e. :
* return array($this, "callbackHelper");
* // and callbackHelper would be as such:
* public function callbackHelper(array $rest=array()){}
* @param string $name the plugin name
* returns some code that will check if the plugin is loaded and if not load it
* this is optional, if your plugins are autoloaded or whatever, just return an
* @param string $name the plugin name
Documentation generated on Sat, 18 Jul 2009 21:05:10 +0200 by phpDocumentor 1.4.0