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

Class: SpamFilter

Source Location: /plugins/spamfilters/akismet.php

Class SpamFilter

Class Overview

This implements the standard SpamFilter class for the Akismet spam filter.

Located in /plugins/spamfilters/akismet.php [line 14]



		
		
		
		

Methods

[ Top ]
Method Summary
SpamFilter   SpamFilter()   The SpamFilter class instantiation function.
int   filterMessage()   The function for processing a message to see if it might be SPAM
array   getOptionsSupported()   The admin options interface
void   handleOption()   Handles custom formatting of options for Admin (of which, there are none for Akismet)

[ Top ]
Methods
Constructor SpamFilter  [line 21]

  SpamFilter SpamFilter( )

The SpamFilter class instantiation function.



[ Top ]
filterMessage  [line 69]

  int filterMessage( string $author, string $email, string $website, string $body, string $imageLink, string $ip  )

The function for processing a message to see if it might be SPAM

returns:

  1. if the message is SPAM
  2. if the message might be SPAM (it will be marked for moderation)
  3. if the message is not SPAM

Parameters:
string   $author:  Author field from the posting
string   $email:  Email field from the posting
string   $website:  Website field from the posting
string   $body:  The text of the comment
string   $imageLink:  A link to the album/image on which the post was made
string   $ip:  the IP address of the comment poster


[ Top ]
getOptionsSupported  [line 38]

  array getOptionsSupported( )

The admin options interface

called from admin Options tab returns an array of the option names the theme supports the array is indexed by the option name. The value for each option is an array: 'type' => 0 says for admin to use a standard textbox for the option 'type' => 1 says for admin to use a standard checkbox for the option 'type' => 2 will cause admin to call handleOption to generate the HTML for the option 'desc' => text to be displayed for the option description.



[ Top ]
handleOption  [line 50]

  void handleOption( string $option, mixed $currentValue  )

Handles custom formatting of options for Admin (of which, there are none for Akismet)

Parameters:
string   $option:  the option name of the option to be processed
mixed   $currentValue:  the current value of the option (the "before" value)


[ Top ]

Documentation generated on Tue, 02 Dec 2008 21:23:36 +0100 by phpDocumentor 1.4.1