class vB_Akismet

Class to handle interacting with the Akismet service

Traits

Properties

protected $options
protected $hostUrl
protected $verified
protected string $akismetVersion Akismet version, used in URI
protected string $akismetKey Akismet key
protected string $akismetBoard Akismet board URL
protected string $_akismetApiUrl Akismet built URL
static protected $instance

Methods

__sleep()

No description

__wakeup()

No description

static 
instance()

Enforces singleton use

setParams($params)

No description

string
verifyText(array $params)

Makes a verification call to Aksimet to check content

string
markAsSpam(array $params)

Identify a missed item as spam

string
markAsHam(array $params)

Identify a missed identified item as ham (false positive)

boolean
_build()

Verify that the supplied Akismet key is valid and build the API URL

string
_submit(string $submitUrl, array $params)

Submits a request to the Akismet service (POST)

Details

in vB_Trait_NoSerialize at line 15
__sleep()

in vB_Trait_NoSerialize at line 20
__wakeup()

at line 94
static instance()

Enforces singleton use

*

at line 110
protected setParams($params)

Parameters

$params

at line 157
string verifyText(array $params)

Makes a verification call to Aksimet to check content

Parameters

array $params Array of keys and values, http://akismet.com/development/api/

Return Value

string spam or ham

at line 178
string markAsSpam(array $params)

Identify a missed item as spam

Parameters

array $params Array of keys and values, http://akismet.com/development/api/

Return Value

string direct result from API call

at line 202
string markAsHam(array $params)

Identify a missed identified item as ham (false positive)

Parameters

array $params Array of keys and values, http://akismet.com/development/api/

Return Value

string direct result from API call

at line 224
protected boolean _build()

Verify that the supplied Akismet key is valid and build the API URL

Return Value

boolean True if the building succeeded else false

at line 256
protected string _submit(string $submitUrl, array $params)

Submits a request to the Akismet service (POST)

Parameters

string $submitUrl URL to submit to
array $params Array of data to submit

Return Value

string Data returned by Akismet