pear / services_akismet2
Provides an object-oriented interface to the Akismet REST API. The Akismet API is used to detect and to filter spam.
Requires
- php: >=5.2.1
- pear/http_request2: *
- pear/pear_exception: *
Requires (Dev)
This package is auto-updated.
Last update: 2024-10-29 05:04:39 UTC
README
This package provides an object-oriented interface to the Akismet REST API. The Akismet API is used to detect and to filter spam comments posted on weblogs.
There are several anti-spam service providers that use the Akismet API. To use the API, you will need an API key from such a provider. Example providers include Wordpress and TypePad.
Services_Akismet2 has been migrated from PEAR SVN.
Documentation
Quick Example
<?php require_once 'Services/Akismet2.php'; require_once 'Services/Akismet2/Comment.php'; $comment = new Services_Akismet2_Comment( array( 'comment_author' => 'Test Author', 'comment_author_email' => 'test@example.com', 'comment_author_url' => 'http://example.com/', 'comment_content' => 'Hello, World!' ) ); $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 } ?>
Further Documentation
Bugs and Issues
Please report all new issues via the PEAR bug tracker.
Please submit pull requests for your bug reports!
Testing
To test, run either $ phpunit tests/ or $ pear run-tests -r
Building
To build, simply $ pear package
Installing
To install from scratch $ pear install package.xml
To upgrade $ pear upgrade -f package.xml