An open API service indexing awesome lists of open source software.

https://github.com/robertlemke/robertlemke.akismet

Flow package which provides convenient access to the Akismet REST service
https://github.com/robertlemke/robertlemke.akismet

Last synced: about 1 year ago
JSON representation

Flow package which provides convenient access to the Akismet REST service

Awesome Lists containing this project

README

          

Akismet
=======

Flow package which provides convenient access to the Akismet REST service.

Setup
-----

In order to use the service you'll first need to sign up for a (usually) free
account at http://akismet.com/

Next, just include this package into your application by adding it to the required
package of your composer.json file.

Finally add your Akismet credentials to your Settings.yaml:

RobertLemke:
Akismet:

# Defines the host of the Akismet service. Does not have to be changed unless
# Akismet changes its service entry point.
serviceHost: 'rest.akismet.com'

# The API key you have been provided by Akismet
apiKey: ''

# The frontpage URI pointing to your blog or the site using Akismet. Must be
# a full URI, for example "http://robertlemke.com/blog".
blogUri: ''

Usage
-----

The Service class provides a simple API for checking if a comment is spam or
submitting new spam or ham to the service:

$isSpam = $service->isCommentSpam($permaLink, $content, $type, $author, $authorEmailAddress, $authorUri);