AkismetSpamProtector
class AkismetSpamProtector implements SpamProtector (View source)
Spam protector for Akismet
Traits
A class that can be instantiated or replaced via DI
Properties
| protected | string | $apiKey | The API key that will be used for the service. Can be set on the singleton to take priority over configuration. |
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get the API key. Priority is given first to explicitly set values on a singleton, then to configuration values and finally to environment values.
Return the FormField associated with this protector.
Details
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
$this
setApiKey(string $key)
Set the API key
string
getApiKey()
Get the API key. Priority is given first to explicitly set values on a singleton, then to configuration values and finally to environment values.
AkismetService|null
getService()
Retrieves Akismet API object, or null if not configured
FormField
getFormField(string $name = null, string $title = null, mixed $value = null, $form = null, $rightTitle = null)
Return the FormField associated with this protector.
Most spam methods will simply return a piece of HTML to be injected at the end of the form. If a spam method needs to inject more than one form field (i.e a hidden field and a text field) then return a FieldGroup from this method to include both.
setFieldMapping(array $fieldMapping)
Set the fields to map spam protection too