102 lines
2.2 KiB
PHP
102 lines
2.2 KiB
PHP
<?php
|
|
|
|
/**
|
|
* An extension to the {@link Form} class which provides the method
|
|
* {@link enableSpamProtection()} helper.
|
|
*
|
|
* @package spamprotection
|
|
*/
|
|
|
|
class FormSpamProtectionExtension extends Extension {
|
|
|
|
/**
|
|
* @config
|
|
*
|
|
* The default spam protector class name to use. Class should implement the
|
|
* {@link SpamProtector} interface.
|
|
*
|
|
* @var string $spam_protector
|
|
*/
|
|
private static $default_spam_protector;
|
|
|
|
/**
|
|
* @config
|
|
*
|
|
* The {@link enableSpamProtection} method will define which of the form
|
|
* values correlates to this form mapped fields list. Totally custom forms
|
|
* and subclassed SpamProtector instances are define their own mapping
|
|
*
|
|
* @var array $mappable_fields
|
|
*/
|
|
private static $mappable_fields = array(
|
|
'id',
|
|
'title',
|
|
'body',
|
|
'contextUrl',
|
|
'contextTitle',
|
|
'authorName',
|
|
'authorMail',
|
|
'authorUrl',
|
|
'authorIp',
|
|
'authorId'
|
|
);
|
|
|
|
/**
|
|
* Instantiate a SpamProtector instance
|
|
*
|
|
* @param array $options Configuration options
|
|
* @return SpamProtector
|
|
*/
|
|
public static function get_protector($options = null) {
|
|
// generate the spam protector
|
|
if(isset($options['protector'])) {
|
|
$protector = $options['protector'];
|
|
|
|
if(is_string($protector)) {
|
|
$protector = Injector::inst()->create($protector);
|
|
}
|
|
} else {
|
|
$protector = Config::inst()->get('FormSpamProtectionExtension', 'default_spam_protector');
|
|
$protector = Injector::inst()->create($protector);
|
|
}
|
|
return $protector;
|
|
}
|
|
|
|
/**
|
|
* Activates the spam protection module.
|
|
*
|
|
* @param array $options
|
|
*/
|
|
public function enableSpamProtection($options = array()) {
|
|
|
|
// captcha form field name (must be unique)
|
|
if(isset($options['name'])) {
|
|
$name = $options['name'];
|
|
} else {
|
|
$name = 'Captcha';
|
|
}
|
|
|
|
// captcha field title
|
|
if(isset($options['title'])) {
|
|
$title = $options['title'];
|
|
} else {
|
|
$title = '';
|
|
}
|
|
|
|
// set custom mapping on this form
|
|
$protector = self::get_protector($options);
|
|
if(isset($options['mapping'])) {
|
|
$protector->setFieldMapping($options['mapping']);
|
|
}
|
|
|
|
// add the form field
|
|
if($field = $protector->getFormField($name, $title)) {
|
|
$field->setForm($this->owner);
|
|
|
|
$this->owner->Fields()->push($field);
|
|
}
|
|
|
|
return $this->owner;
|
|
}
|
|
}
|