mirror of
https://github.com/slawkens/myaac.git
synced 2025-04-26 17:29:21 +02:00
65 lines
2.0 KiB
PHP
65 lines
2.0 KiB
PHP
<?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
|
|
* @link http://dwoo.org/
|
|
* @version 1.0.0
|
|
* @date 2008-10-23
|
|
* @package Dwoo
|
|
*/
|
|
interface Dwoo_IPluginProxy
|
|
{
|
|
/**
|
|
* 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
|
|
*/
|
|
public function handles($name);
|
|
|
|
/**
|
|
* 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
|
|
* @return string
|
|
*/
|
|
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. :
|
|
* <code>
|
|
* return array($this, "callbackHelper");
|
|
* // and callbackHelper would be as such:
|
|
* public function callbackHelper(array $rest=array()){}
|
|
* </code>
|
|
*
|
|
* @param string $name the plugin name
|
|
* @return callback
|
|
*/
|
|
public function getCallback($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
|
|
* empty string
|
|
*
|
|
* @param string $name the plugin name
|
|
* @return string
|
|
*/
|
|
public function getLoader($name);
|
|
} |