Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
objectmodel [2007/01/24 09:36] manniobjectmodel [2007/03/02 13:45] (current) – external edit 127.0.0.1
Line 5: Line 5:
   - A "POPFile Loadable Module" (PLM) is a standard Perl Module that starts with the line //# POPFILE LOADABLE MODULE// and which will be loaded dynamically by the POPFile module POPFile::Loader.  All PLMs are subclasses (or sub-subclasses etc.) of //POPFile::Module// where a great deal of documentation can be found.   - A "POPFile Loadable Module" (PLM) is a standard Perl Module that starts with the line //# POPFILE LOADABLE MODULE// and which will be loaded dynamically by the POPFile module POPFile::Loader.  All PLMs are subclasses (or sub-subclasses etc.) of //POPFile::Module// where a great deal of documentation can be found.
   - Non-PLM modules that are parent classes for PLMs.  Examples are //Proxy::Proxy//, //POPFile::Module//, //UI::HTTP//.   - Non-PLM modules that are parent classes for PLMs.  Examples are //Proxy::Proxy//, //POPFile::Module//, //UI::HTTP//.
-  - Modules that are neither of the two above and are loaded by some part of POPFile.  Examples are //POPFile::Loader//, //Classifier::MailParse//, //Classifier::WordMangle//.+  - Modules that are neither of the two above and are loaded by some part of POPFile.  Examples are //POPFile::Loader//, //Classifier::%%MailParse%%//, //Classifier::%%WordMangle%%//.
  
 ===== Private, Protected and Public ===== ===== Private, Protected and Public =====
Line 20: Line 20:
  
 <code> <code>
- +                                                   POPFile::Module
- +
-<code>                                                   POPFile::Module+
                                                           ^                                                           ^
                                                           |                                                                       |            
Line 35: Line 33:
                                +-------------+-----------+            |                                +-------------+-----------+            |
                                                                 |                                                                 |
-                          Proxy::POP3  Proxy::SMTP  Proxy:NNTP     UI::HTML</code>+                          Proxy::POP3  Proxy::SMTP  Proxy:NNTP     UI::HTML
 </code> </code>
  
-===== //POPFile::Module// =====+===== POPFile::Module =====
  
 This module implements the base class for all POPFile Loadable Modules and contains collection of methods that are common to all POPFile modules and only selected ones need be overriden by subclasses.  The public functions are all called by //POPFile::Loader// during the normal running of POPFile.   This module implements the base class for all POPFile Loadable Modules and contains collection of methods that are common to all POPFile modules and only selected ones need be overriden by subclasses.  The public functions are all called by //POPFile::Loader// during the normal running of POPFile.  
Line 83: Line 81:
 The current messages are: The current messages are:
  
-|| MessageID || Explanation || Send By || Monitored By ||+|| %%MessageID%% || Explanation || Send By || Monitored By ||
 || CLASS || A message was classified, message is the bucket and the parameter is null || Proxy::Proxy || UI::HTML || || CLASS || A message was classified, message is the bucket and the parameter is null || Proxy::Proxy || UI::HTML ||
 || UIREG || Register a UI component, message is the component type and the parameter is a the element and reference to the object registering || Proxy::POP3, Proxy::SMTP, Proxy::NNTP, UI::XMLRPC || UI::HTML || || UIREG || Register a UI component, message is the component type and the parameter is a the element and reference to the object registering || Proxy::POP3, Proxy::SMTP, Proxy::NNTP, UI::XMLRPC || UI::HTML ||
Line 95: Line 93:
  
 <code> <code>
-<code>              UI::HTML+              UI::HTML
                 ^  ^                 ^  ^
                 |  |                 |  |
Line 105: Line 103:
        | |      |          LOGIN              |        | |      |          LOGIN              |
       TICKD              CLASS            UIREG       TICKD              CLASS            UIREG
-        |                  |                |</code> +        |                  |                | 
-POPFile::Logger  |      Proxy::Proxy       Proxy::POP3 +POPFile::Logger |      Proxy::Proxy       Proxy::POP3 
-<code>       ^        |      (via pipe from     Proxy::NNTP+              |      (via pipe from     Proxy::NNTP
               |       POP3/SMTP/NNTP)   Proxy::SMTP               |       POP3/SMTP/NNTP)   Proxy::SMTP
-       +--------+                         UI::XMLRPC</code>+       +--------+                         UI::XMLRPC
 </code> </code>
  
 
objectmodel.1169631418.txt.gz · Last modified: 2008/02/08 19:49 (external edit)
Old revisions

Should you find anything in the documentation that is incomplete, unclear, outdated or just plain wrong, please let us know and leave a note in the Documentation Forum.

Recent changes RSS feed Donate Driven by DokuWiki
The content of this wiki is protected by the GNU Fee Documentation License