ZenphotoCMS 1.6.3

zpTrivialSpam

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

Note that this filter will always pass comments from users with "manage" rights on the commented object.

Table of Contents

Properties

$name  : mixed

Methods

__construct()  : SpamFilter
The SpamFilter class instantiation function.
displayName()  : mixed
filterMessage()  : int
The function for processing a message to see if it might be SPAM returns: 0 if the message is SPAM 1 if the message might be SPAM (it will be marked for moderation) 2 if the message is not SPAM
getOptionsSupported()  : array<string|int, mixed>
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' => OPTION_TYPE_CUSTOM will cause admin to call handleOption to generate the HTML for the option 'desc' => text to be displayed for the option description.
handleOption()  : mixed
Handles custom formatting of options for Admin

Properties

Methods

__construct()

The SpamFilter class instantiation function.

public __construct() : SpamFilter
Return values
SpamFilter

filterMessage()

The function for processing a message to see if it might be SPAM returns: 0 if the message is SPAM 1 if the message might be SPAM (it will be marked for moderation) 2 if the message is not SPAM

public filterMessage(string $author, string $email, string $website, string $body, string $receiver, string $ip) : int
Parameters
$author : string

Author field from the posting

$email : string

Email field from the posting

$website : string

Website field from the posting

$body : string

The text of the comment

$receiver : string

The object on which the post was made

$ip : string

the IP address of the comment poster

Return values
int

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' => OPTION_TYPE_CUSTOM will cause admin to call handleOption to generate the HTML for the option 'desc' => text to be displayed for the option description.

public getOptionsSupported() : array<string|int, mixed>
Return values
array<string|int, mixed>

handleOption()

Handles custom formatting of options for Admin

public handleOption(string $option, mixed $currentValue) : mixed
Parameters
$option : string

the option name of the option to be processed

$currentValue : mixed

the current value of the option (the "before" value)


        
On this page

Search results