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

Class: MantisFormattingPlugin

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

Class MantisFormattingPlugin

Class Overview

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

Located in /core/classes/MantisFormattingPlugin.class.php [line 24]

MantisPlugin
   |
   --MantisFormattingPlugin
Author(s):
API Tags:
Abstract:  

Methods

[ Top ]
Descendants
Child Class Description
MantisCoreFormattingPlugin Abstract class for any plugin that's modifying textual output.

[ Top ]
Method Summary
string   email()   Email text processing.
multi   formatted()   Formatted text processing.
void   hooks()   Event hook declaration.
string   rss()   RSS text processing.
multi   text()   Plain text processing.

[ Top ]
Methods
email  [line 76]

  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


Redefined in descendants as:

[ Top ]
formatted  [line 56]

  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


Redefined in descendants as:

[ Top ]
hooks  [line 29]

  void hooks( )

Event hook declaration.



Redefinition of:
MantisPlugin::hooks()

[ Top ]
rss  [line 66]

  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


Redefined in descendants as:

[ Top ]
text  [line 45]

  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


Redefined in descendants as:

[ Top ]

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