[ Index ]

PHP Cross Reference of MantisBT

title

Body

[close]

/core/classes/ -> MantisPlugin.class.php (summary)

(no description)

Copyright: Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
Copyright: Copyright (C) 2002 - 2011 MantisBT Team - mantisbt-dev@lists.sourceforge.net
File Size: 162 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 11 functions

  init()
  errors()
  config()
  events()
  hooks()
  schema()
  install()
  upgrade()
  uninstall()
  __construct()
  __init()

Functions
Functions that are not part of a class:

init()   X-Ref
this function allows your plugin to set itself up, include any
necessary API's, declare or hook events, etc.
Alternatively, your plugin can hook the EVENT_PLUGIN_INIT event
that will be called after all plugins have been initialized.


errors()   X-Ref
This function allows plugins to add new error messages for Mantis usage

returns: array The error_name=>error_message list to add

config()   X-Ref
return an array of default configuration name/value pairs


events()   X-Ref
No description

hooks()   X-Ref
No description

schema()   X-Ref
No description

install()   X-Ref
Perform pre-installation operations

This method is called before installing the given plugin.
It can be used to add pre-install checks on external requirements

returns: bool true if install can proceed

upgrade( $p_schema )   X-Ref
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


uninstall()   X-Ref
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.


__construct( $p_basename )   X-Ref
No description

__init()   X-Ref
No description



Generated: Thu Jul 28 15:48:31 2011 Cross-referenced by PHPXref 0.7