Interface Dwoo_IPluginProxy

Description

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.

Located in /Dwoo/IPluginProxy.php (line 18)


	
			
Method Summary
callback getCallback (string $name)
string getCode (string $name, array $params)
string getLoader (string $name)
bool handles (string $name)
Methods
getCallback (line 54)

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. :

  1.  return array($this"callbackHelper");
  2.  // and callbackHelper would be as such:
  3.  public function callbackHelper(array $rest=array()){}

  • access: public
callback getCallback (string $name)
  • string $name: the plugin name
getCode (line 36)

returns the code (as a string) to call the plugin (this will be executed at runtime inside the Dwoo class)

  • access: public
string getCode (string $name, array $params)
  • string $name: the plugin name
  • array $params: a parameter array, array key "*" is the rest array
getLoader (line 64)

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 empty string

  • access: public
string getLoader (string $name)
  • string $name: the plugin name
handles (line 26)

returns true or false to say whether the given plugin is handled by this proxy or not

  • return: true if the plugin is known and usable, otherwise false
  • access: public
bool handles (string $name)
  • string $name: the plugin name

Documentation generated on Sun, 07 Feb 2010 17:53:50 +0000 by phpDocumentor 1.4.0