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

Class: MantisFormattingPlugin

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

Class Overview

MantisPlugin
   |
   --MantisFormattingPlugin

Abstract class for any plugin that's modifying textual output.


Author(s):

Methods


Inherited Variables

Inherited Methods

Class: MantisPlugin

MantisPlugin::__construct()
MantisPlugin::config()
return an array of default configuration name/value pairs
MantisPlugin::errors()
MantisPlugin::events()
MantisPlugin::hooks()
MantisPlugin::init()
this function allows your plugin to set itself up, include any necessary API's, declare or hook events, etc.
MantisPlugin::install()
MantisPlugin::register()
this function registers your plugin - must set at least name and version
MantisPlugin::schema()
MantisPlugin::uninstall()
This callback is executed after the normal uninstallation process, and should
MantisPlugin::upgrade()
This callback is executed after the normal schema upgrade process has executed.
MantisPlugin::__init()

Class Details

[line 31]
Abstract class for any plugin that's modifying textual output.



Tags:

abstract:  


[ Top ]


Class Methods


method email [line 83]

string email( string $p_event, string $p_string)

Email text processing.



Tags:

return:  Formatted text


Parameters:

string   $p_event   Event name
string   $p_string   Unformatted text

[ Top ]

method formatted [line 63]

multi formatted( string $p_event, string $p_string, [boolean $p_multiline = true])

Formatted text processing.



Tags:

return:  Array with formatted text and multiline paramater


Parameters:

string   $p_event   Event name
string   $p_string   Unformatted text
boolean   $p_multiline   Multiline text

[ Top ]

method hooks [line 36]

void hooks( )

Event hook declaration.



Overrides MantisPlugin::hooks() (parent method not documented)

[ Top ]

method rss [line 73]

string rss( string $p_event, string $p_string)

RSS text processing.



Tags:

return:  Formatted text


Parameters:

string   $p_event   Event name
string   $p_string   Unformatted text

[ Top ]

method text [line 52]

multi text( string $p_event, string $p_string, [boolean $p_multiline = true])

Plain text processing.



Tags:

return:  Array with formatted text and multiline paramater


Parameters:

string   $p_event   Event name
string   $p_string   Unformatted text
boolean   $p_multiline   Multiline text

[ Top ]


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