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

Class: Welcompose_AntiSpam_Comment

Source Location: /plugins/antispam/antispam.interface.php

Interface Overview


Project: Welcompose File: antispam.interface.php


Author(s):

  • Andreas Ahlenstorf

Copyright:

  • 2008 creatics, Olaf Gleba

Methods



Class Details

[line 25]
Project: Welcompose File: antispam.interface.php

Copyright (c) 2008 creatics

Project owner: creatics, Olaf Gleba 50939 Köln, Germany http://www.creatics.de

This file is licensed under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE v3 http://www.opensource.org/licenses/agpl-v3.html

$Id$




Tags:

author:  Andreas Ahlenstorf
copyright:  2008 creatics, Olaf Gleba
license:  GNU AFFERO GENERAL PUBLIC LICENSE v3


[ Top ]


Class Methods


constructor __construct [line 41]

Welcompose_AntiSpam_Comment __construct( string $name, string $email, string $homepage, string $message)

Creates new instance of anti spam plugin. Takes the user supplied name as first argument, the user supplied email address (if any) as second argument, the user supplied homepage url as third argument and the user supplied message as fourth and last argument.

If any of the arguments is empty, simply pass an empty string.




Tags:

throws:  Welcompose_AntiSpam_CommentException
access:  public


Parameters:

string   $name   Name
string   $email   Email address
string   $homepage   Homepage URL
string   $message   Message

[ Top ]

method check [line 48]

void check( )

Executes spam check. Returns boolean true if the spam check was successfully executed. Note that this says nothing about the comment being spam or not.



Tags:

access:  public


[ Top ]

method getApiVersion [line 55]

int getApiVersion( )

Returns the api version used by the anti spam plugin.



Tags:

access:  public


[ Top ]

method getPluginName [line 62]

string getPluginName( )

Returns the plugin name.



Tags:

access:  public


[ Top ]

method getRegisteredUser [line 78]

bool getRegisteredUser( )

Returns current state of registered user flag.



Tags:

throws:  Welcompose_AntiSpam_CommentException
access:  public


[ Top ]

method getReport [line 93]

string getReport( )

Returns string with detailed spam report.



Tags:

access:  public


[ Top ]

method getResult [line 86]

bool getResult( )

Returns result of previously executed spam check.

True indicates ham, false indicates spam.




Tags:

access:  public


[ Top ]

method setRegisteredUser [line 70]

void setRegisteredUser( bool $flag)

Sets wheter the posting user is registered or not.



Tags:

throws:  Welcompose_AntiSpam_CommentException
access:  public


Parameters:

bool   $flag  

[ Top ]


Documentation generated on Sun, 08 Jan 2012 17:51:40 +0100 by phpDocumentor 1.4.3