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

Class: MantisCoreFormattingPlugin

Source Location: /plugins/MantisCoreFormatting/MantisCoreFormatting.php

Class MantisCoreFormattingPlugin

Class Overview

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

Located in /plugins/MantisCoreFormatting/MantisCoreFormatting.php [line 19]

MantisPlugin
   |
   --MantisFormattingPlugin
      |
      --MantisCoreFormattingPlugin

Methods

[ Top ]
Method Summary
void   config()   Default plugin configuration.
string   email()   Email text processing.
multi   formatted()   Formatted text processing.
void   register()   A method that populates the plugin information and minimum requirements.
string   rss()   RSS text processing.
multi   text()   Plain text processing.

[ Top ]
Methods
config  [line 42]

  void config( )

Default plugin configuration.



Redefinition of:
MantisPlugin::config()

[ Top ]
email  [line 152]

  string email( string $p_event, string $p_string  )

Email text processing.

Parameters:
string   $p_event:  Event name
string   $p_string:  Unformatted text

API Tags:
Return:  Formatted text


Redefinition of:
MantisFormattingPlugin::email()
Email text processing.

[ Top ]
formatted  [line 83]

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

Formatted text processing.

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

API Tags:
Return:  Array with formatted text and multiline paramater


Redefinition of:
MantisFormattingPlugin::formatted()
Formatted text processing.

[ Top ]
register  [line 24]

  void register( )

A method that populates the plugin information and minimum requirements.



Redefinition of:
MantisPlugin::register()

[ Top ]
rss  [line 120]

  string rss( string $p_event, string $p_string  )

RSS text processing.

Parameters:
string   $p_event:  Event name
string   $p_string:  Unformatted text

API Tags:
Return:  Formatted text


Redefinition of:
MantisFormattingPlugin::rss()
RSS text processing.

[ Top ]
text  [line 58]

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

Plain text processing.

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

API Tags:
Return:  Array with formatted text and multiline paramater


Redefinition of:
MantisFormattingPlugin::text()
Plain text processing.

[ Top ]

Documentation generated on Sun, 05 Apr 2009 23:01:23 +0100 by phpDocumentor 1.4.1