1. class
  2. SilverStripe
  3. \
  4. SpamProtection
  5. \
  6. Extension
  7. \
  8. FormSpamProtectionExtension

FormSpamProtectionExtension

class FormSpamProtectionExtension extends Extension (View source)

An extension to the Form class which provides the method enableSpamProtection() helper.

Traits

Configurable

Provides extensions to this object to integrate it with standard config API methods.

Config options

allowed_actions

This is used by extensions designed to be applied to controllers.

 from  Extension
default_spam_protector string
mappable_fields array
field_name string

Properties

protected object $owner

The object this extension is applied to.

 from  Extension

Methods

public
__construct()

No description

from  Extension
public static 
add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

from  Extension
public
setOwner(object $owner)

Set the owner of this extension.

from  Extension
public
mixed
withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

from  Extension
public
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

from  Extension
public
object
getOwner()

Returns the owner of this extension.

from  Extension
public static 
string
get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

from  Extension
public static 
Config_ForClass
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

from  Configurable
public
mixed
stat(string $name) deprecated

Get inherited config value

from  Configurable
public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

from  Configurable
public
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

from  Configurable
public static 
SpamProtector|null
get_protector(array $options = null)

Instantiate a SpamProtector instance

public
object
enableSpamProtection(array $options = array())

Activates the spam protection module.

Details

in Extension at line 39
__construct()

No description

in Extension at line 50
static add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

Parameters

string $class
string $extensionClass
mixed $args

in Extension at line 60
setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

in Extension at line 74
mixed withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

Parameters

mixed $owner

Owner to set
callable $callback

Callback to invoke
array $args

Args to pass to callback

Return Value

mixed

in Extension at line 87
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

in Extension at line 100
object getOwner()

Returns the owner of this extension.

Return Value

object

in Extension at line 113
static string get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().

Parameters

string $extensionStr

E.g. "Versioned('Stage','Live')"

Return Value

string

Extension classname, e.g. "Versioned"

in Configurable at line 20
static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

in Configurable at line 32
mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

in Configurable at line 44
mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

in Configurable at line 57
$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

at line 68
static SpamProtector|null get_protector(array $options = null)

Instantiate a SpamProtector instance

Parameters

array $options

Configuration options

Return Value

SpamProtector|null

at line 91
object enableSpamProtection(array $options = array())

Activates the spam protection module.

Parameters

array $options

Return Value

object

Exceptions

LogicException