silverstripe-spamprotection/code/interfaces/SpamProtector.php

44 lines
1.3 KiB
PHP
Raw Normal View History

<?php
2016-10-10 07:44:28 +02:00
namespace SilverStripe\Spamprotection;
use SilverStripe\Forms\FormField;
/**
* SpamProtector base interface.
*
* All Protectors are required implement this interface if they want to appear
* on the form.
*
* Classes with this interface are used to generate helper lists to allow the
* user to select the protector.
*
* @package spamprotection
*/
2015-11-21 07:15:15 +01:00
interface SpamProtector
{
/**
* Return the {@link FormField} associated with this protector.
*
* Most spam methods will simply return a piece of HTML to be injected at
2015-11-21 07:15:15 +01:00
* 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
2015-11-21 07:15:15 +01:00
* {@link FieldGroup} from this method to include both.
*
* @param string $name
* @param string $title
* @param mixed $value
* @return FormField The resulting field
*/
public function getFormField($name = null, $title = null, $value = null);
2015-11-21 07:15:15 +01:00
/**
* Set the fields to map spam protection too
*
* @param array $fieldMapping array of Field Names, where the indexes of the array are
* the field names of the form and the values are the standard spamprotection
* fields used by the protector
*/
public function setFieldMapping($fieldMapping);
}