1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
|
<?php
/**
* This file implements the Plugin class (EXPERIMENTAL)
*
* This is the base class from which all plugins classes are derived.
*
* b2evolution - {@link http://b2evolution.net/}
* Released under GNU GPL License - {@link http://b2evolution.net/about/license.html}
* @copyright (c)2003-2005 by Francois PLANQUE - {@link http://fplanque.net/}
*
* @package plugins
*/
if( !defined('DB_USER') ) die( 'Please, do not access this page directly.' );
/**
* Plugin Class
*
* @package plugins
* @abstract
*/
class Plugin
{
/**#@+
* Should be overriden by derived class:
*/
var $code = '';
var $priority = 50;
var $name = 'Unnamed plug-in';
var $version;
var $author;
var $help_url;
var $short_desc;
var $long_desc;
/**#@-*/
/**
* Constructor, should set name and description
*
* {@internal Plugin::Plugin(-) }}
*/
function Plugin()
{
$this->short_desc = T_('No desc available');
$this->long_desc = T_('No description available');
}
/**
* Template function: display plugin code
*
* {@internal Plugin::code(-) }}
*/
function code()
{
echo $this->code;
}
/**
* Template function: display plugin name
*
* {@internal Plugin::name(-) }}
*
* @param string Output format, see {@link format_to_output()}
*/
function name( $format = 'htmlbody' )
{
echo format_to_output( $this->name, $format );
}
/**
* Template function: display short description for plug in
*
* {@internal Plugin::short_desc(-) }}
*
* @param string Output format, see {@link format_to_output()}
*/
function short_desc( $format = 'htmlbody' )
{
echo format_to_output( $this->short_desc, $format );
}
/**
* Template function: display long description for plug in
*
* {@internal Plugin::long_desc(-) }}
*
* @param string Output format, see {@link format_to_output()}
*/
function long_desc( $format = 'htmlbody' )
{
echo format_to_output( $this->long_desc, $format );
}
/**
* Set param value
*
* {@internal Plugin::set_param(-) }}
*
* @param string Name of parameter
* @param mixed Value of parameter
*/
function set_param( $parname, $parvalue )
{
// Set value:
$this->$parname = $parvalue;
}
}
?>
|