Class: Services_Akismet2

Example usage:

 /*

  * Handling user-posted comments
  */
 
 $comment = new Services_Akismet2_Comment(array(
     'author'      => 'Test Author',
     'authorEmail' => 'test@example.com',
     'authorUri'   => 'http://example.com/',
     'content'     => 'Hello, World!'
 ));
 
 try {
     $apiKey = 'AABBCCDDEEFF';
     $akismet = new Services_Akismet2('http://blog.example.com/', $apiKey);
     if ($akismet->isSpam($comment)) {
         // rather than simply ignoring the spam comment, it is recommended
         // to save the comment and mark it as spam in case the comment is a
         // false positive.
     } else {
         // save comment as normal comment
     }
 } catch (Services_Akismet2_InvalidApiKeyException $keyException) {
     echo 'Invalid API key!';
 } catch (Services_Akismet2_HttpException $httpException) {
     echo 'Error communicating with Akismet API server: ' .
         $httpException->getMessage();
 } catch (Services_Akismet2_InvalidCommentException $commentException) {
     echo 'Specified comment is missing one or more required fields.' .
         $commentException->getMessage();
 }
 
 /*
  * Submitting a comment as known spam
  */
 
 $comment = new Services_Akismet2_Comment(array(
     'author'      => 'Test Author',
     'authorEmail' => 'test@example.com',
     'authorUri'   => 'http://example.com/',
     'content'     => 'Hello, World!'
 ));
 
 try {
     $apiKey = 'AABBCCDDEEFF';
     $akismet = new Services_Akismet2('http://blog.example.com/', $apiKey);
     $akismet->submitSpam($comment);
 } catch (Services_Akismet2_InvalidApiKeyException $keyException) {
     echo 'Invalid API key!';
 } catch (Services_Akismet2_HttpException $httpException) {
     echo 'Error communicating with Akismet API server: ' .
         $httpException->getMessage();
 } catch (Services_Akismet2_InvalidCommentException $commentException) {
     echo 'Specified comment is missing one or more required fields.' .
         $commentException->getMessage();
 }
 
 /*
  * Submitting a comment as a false positive
  */
 
 $comment = new Services_Akismet2_Comment(array(
     'author'      => 'Test Author',
     'authorEmail' => 'test@example.com',
     'authorUri'   => 'http://example.com/',
     'content'     => 'Hello, World!'
 ));
 
 try {
     $apiKey = 'AABBCCDDEEFF';
     $akismet = new Services_Akismet2('http://blog.example.com/', $apiKey);
     $akismet->submitFalsePositive($comment);
 } catch (Services_Akismet2_InvalidApiKeyException $keyException) {
     echo 'Invalid API key!';
 } catch (Services_Akismet2_HttpException $httpException) {
     echo 'Error communicating with Akismet API server: ' .
         $httpException->getMessage();
 } catch (Services_Akismet2_InvalidCommentException $commentException) {
     echo 'Specified comment is missing one or more required fields.' .
         $commentException->getMessage();
 }

$apiKey =  ''

[line 232]

$apiKeyIsValid =  null

[line 248]

$apiPort =  80

[line 192]

Defaults to 80.

$apiServer =  'rest.akismet.com'

[line 203]

Defaults to 'rest.akismet.com'.

$apiVersion =  '1.1'

[line 214]

Defaults to '1.1'.

$blogUri =  ''

[line 223]

$request =  null

[line 239]

__construct (Constructor)   [line 267]

getUserAgent   [line 572]

isApiKeyValid   [line 553]

isSpam   [line 362]

sendRequest   [line 475]

setConfig   [line 320]

 // sets config using an associative array
 $akismet->setConfig(array(
     'apiServer' => 'rest.akismet.com',
     'apiPort'   => 80
 ));
 
 // sets config using fluent interface
 $akismet->setConfig('apiServer', 'rest.akismet.com')
         ->setConfig('apiPort', 80);

setRequest   [line 453]

submitFalsePositive   [line 431]

submitSpam   [line 396]

validateApiKey   [line 524]