class EnablerExtension extends Extension (View source)

Applies to the {Security} controller in order to detect requests for actions related to the log in process or other such credential management (such as the forgot password flow).

This is in order to replace the set {\SilverStripe\View\SSViewer} theme list with a controlled set in order to always show a consistent interface that relates more to the CMS than the website it is loading on. Particular actions can be set to be ignored by including them in the excluded_actions list defined in yml _config for this class. By default all allowed actions on the Security controller excepting index and ping will have the new theme set applied.

Properties

protected object $owner

The object this extension is applied to.

from  Extension

Methods

public
__construct()

No description

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

Called when this extension is added to a particular class

public
setOwner(object $owner)

Set the owner of this extension.

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

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

public
clearOwner()

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

public
object
getOwner()

Returns the owner of this 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().

public
beforeCallActionHandler()

No description

public
afterCallActionHandler()

No description

public
string
ContentLocale()

Returns an RFC1766 compliant locale string, e.g. 'fr-CA'.

public
darkModeIsEnabled()

No description

Details

__construct()

No description

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

setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

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

clearOwner()

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

object getOwner()

Returns the owner of this extension.

Return Value

object

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"

beforeCallActionHandler()

No description

afterCallActionHandler()

No description

string ContentLocale()

Returns an RFC1766 compliant locale string, e.g. 'fr-CA'.

Note: Added to support front-end translations trough detection of the lang attribute on the html tag. Because the Security controller extends directly on Controller instead of ContentController we need to add this fallback method.

Return Value

string

darkModeIsEnabled()

No description