MantisBT
[ class tree: MantisBT ] [ index: MantisBT ] [ all elements ]

Class: MantisPlugin

Source Location: /core/classes/MantisPlugin.class.php

Class Overview


Base class that implements basic plugin functionality and integration with MantisBT. See the Mantis wiki for more information.


Author(s):

Variables

Methods


Child classes:

MantisCorePlugin
MantisBT Core Plugin Used to give other plugins a permanent core plugin to 'require' for compatibility.
MantisFormattingPlugin
Abstract class for any plugin that's modifying textual output.
MantisWikiPlugin
Base class that implements the skeleton for a wiki plugin.

Class Details

[line 33]
Base class that implements basic plugin functionality and integration with MantisBT. See the Mantis wiki for more information.



Tags:

abstract:  


[ Top ]


Class Variables

$author =  null

[line 63]

author - Your name, or an array of names.



Tags:

access:  public

Type:   mixed


[ Top ]

$basename =  null

[line 131]



Tags:

access:  public

Type:   mixed


[ Top ]

$contact =  null

[line 67]

contact - An email address where you can be contacted.



Tags:

access:  public

Type:   mixed


[ Top ]

$description =  null

[line 42]

description - A full description of your plugin.



Tags:

access:  public

Type:   mixed


[ Top ]

$name =  null

[line 38]

name - Your plugin's full name. Required value.



Tags:

access:  public

Type:   mixed


[ Top ]

$page =  null

[line 46]

page - The name of a plugin page for further information and administration.



Tags:

access:  public

Type:   mixed


[ Top ]

$requires =  null

[line 55]

requires - An array of key/value pairs of basename/version plugin dependencies.

Prefixing a version with '<' will allow your plugin to specify a maximum version (non-inclusive) for a dependency.




Tags:

access:  public

Type:   mixed


[ Top ]

$url =  null

[line 71]

url - A web address for your plugin.



Tags:

access:  public

Type:   mixed


[ Top ]

$uses =  null

[line 59]

An array of key/value pairs of basename/version plugin dependencies (soft dependency)



Tags:

access:  public

Type:   mixed


[ Top ]

$version =  null

[line 50]

version - Your plugin's version string. Required value.



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 132]

MantisPlugin __construct( $p_basename)



Tags:

access:  public


Parameters:

   $p_basename  

[ Top ]

method config [line 91]

void config( )

return an array of default configuration name/value pairs



Tags:

access:  public


Overridden in child classes as:

MantisCoreWikiPlugin::config()

[ Top ]

method errors [line 84]

void errors( )



Tags:

access:  public


[ Top ]

method events [line 95]

void events( )



Tags:

access:  public


[ Top ]

method hooks [line 99]

void hooks( )



Tags:

access:  public


Overridden in child classes as:

MantisFormattingPlugin::hooks()
Event hook declaration.
MantisWikiPlugin::hooks()

[ Top ]

method init [line 82]

void init( )

this function allows your plugin to set itself up, include any necessary API's, declare or hook events, etc.

Alternatively, your can plugin can hook the EVENT_PLUGIN_INIT event that will be called after all plugins have be initialized.




Tags:

access:  public


[ Top ]

method install [line 107]

void install( )



Tags:

access:  public


[ Top ]

method register [line 76]

void register( )

this function registers your plugin - must set at least name and version



Tags:

abstract:  
access:  public


Overridden in child classes as:

MantisCorePlugin::register()
MantisCoreDokuwikiPlugin::register()
MantisCoreMediaWikiPlugin::register()
MantisCoreTwikiPlugin::register()
MantisCoreWikkaWikiPlugin::register()
MantisCoreXwikiPlugin::register()

[ Top ]

method schema [line 103]

void schema( )



Tags:

access:  public


[ Top ]

method uninstall [line 126]

void uninstall( )

This callback is executed after the normal uninstallation process, and should

handle such operations as reverting database schemas, removing unnecessary data, etc. This callback should be used only if Mantis would break when this plugin is uninstalled without any other actions taken, as users may not want to lose data, or be able to re-install the plugin later.




Tags:

access:  public


[ Top ]

method upgrade [line 115]

void upgrade( $p_schema)

This callback is executed after the normal schema upgrade process has executed.

This gives your plugin the chance to convert or normalize data after an upgrade




Tags:

access:  public


Parameters:

   $p_schema  

[ Top ]

method __init [line 137]

void __init( )



Tags:

access:  public


[ Top ]


Documentation generated on Sun, 12 Dec 2010 23:50:42 +0900 by phpDocumentor 1.4.3
inserted by FC2 system