dcFilterWords Class Reference

Inheritance diagram for dcFilterWords:

Public Member Functions
	__construct ()
	getStatusMessage (string $status, ?int $comment_id)
	isSpam (string $type, ?string $author, ?string $email, ?string $site, ?string $ip, ?string $content, ?int $post_id, string &$status)
	gui (string $url)
	defaultWordsList ()
Public Member Functions inherited from dcSpamFilter
	__construct ()
	isSpam (string $type, ?string $author, ?string $email, ?string $site, ?string $ip, ?string $content, ?int $post_id, string &$status)
	trainFilter (string $status, string $filter, string $type, ?string $author, ?string $email, ?string $site, ?string $ip, ?string $content, dcRecord $rs)
	getStatusMessage (string $status, ?int $comment_id)
	gui (string $url)
	hasGUI ()
	guiURL ()
	guiLink ()

Data Fields
	$name = 'Bad Words'
	$has_gui = true
	$help = 'words-filter'
Data Fields inherited from dcSpamFilter
	$name
	$description
	$active = true
	$order = 100
	$auto_delete = false
	$help = null

Protected Member Functions
	setInfo ()
	setInfo ()

Additional Inherited Members
Protected Attributes inherited from dcSpamFilter
	$has_gui = false
	$gui_url = null

Constructor & Destructor Documentation

__construct()

__construct

(

)

Constructs a new instance.

Reimplemented from dcSpamFilter.

References dcCore\app(), and dcAntispam\SPAMRULE_TABLE_NAME.

Member Function Documentation

setInfo()

setInfo ( )

protected

Sets the filter description.

Reimplemented from dcSpamFilter.

getStatusMessage()

getStatusMessage	(	string	$status,
		?int	$comment_id
	)

Gets the status message.

Parameters

string	$status	The status
int	$comment_id	The comment identifier

Returns

string The status message.

Reimplemented from dcSpamFilter.

References dcSpamFilter\guiLink().

isSpam()

isSpam	(	string	$type,
		?string	$author,
		?string	$email,
		?string	$site,
		?string	$ip,
		?string	$content,
		?int	$post_id,
		string &	$status
	)

This method should return if a comment is a spam or not. If it returns true or false, execution of next filters will be stoped. If should return nothing to let next filters apply.

Parameters

string	$type	The comment type (comment / trackback)
string	$author	The comment author
string	$email	The comment author email
string	$site	The comment author site
string	$ip	The comment author IP
string	$content	The comment content
int	$post_id	The comment post_id
string	$status	The comment status

Returns

mixed

Reimplemented from dcSpamFilter.

gui()

gui

(

string

$url

)

Filter settings

Parameters

string

$url

The GUI URL

Returns

string

Reimplemented from dcSpamFilter.

References dcPage\addSuccessNotice(), dcCore\app(), form\checkbox(), defaultWordsList(), html\escapeHTML(), html\escapeURL(), form\field(), form\hidden(), and http\redirect().

defaultWordsList()

defaultWordsList

(

)

Set the default word list

Referenced by gui().

Field Documentation

$name

$name = 'Bad Words'

$has_gui

$has_gui = true

$help

$help = 'words-filter'

---

The documentation for this class was generated from the following file:

• plugins/antispam/filters/filter.words.php