class RequirementsExtension extends Extension (View source)

Traits

Properties

protected T $owner

The object this extension is applied to.

from  Extension
protected StoreInterface $store

A "session store" object that helps contain MFA specific session detail

from  BaseHandlerTrait

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
T
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
mixed
invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

protected
void
applyRequirements(bool $frontEndRequirements = true)

Perform the necessary "Requirements" calls to ensure client side scripts are available in the response

protected
StoreInterface|null
getStore()

No description

public
setStore(StoreInterface $store)

No description

protected
createStore(Member $member)

No description

protected
getSudoModeService()

Returns a sudo mode service instance

public
init()

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()

T getOwner()

Returns the owner of this extension.

Return Value

T

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"

mixed invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

Parameters

object $owner
string $method
array ...$arguments

Return Value

mixed

protected void applyRequirements(bool $frontEndRequirements = true)

Perform the necessary "Requirements" calls to ensure client side scripts are available in the response

Parameters

bool $frontEndRequirements

Indicates dependencies usually provided by admin should also be required

Return Value

void

protected StoreInterface|null getStore()

No description

Return Value

StoreInterface|null

BaseHandlerTrait setStore(StoreInterface $store)

No description

Parameters

StoreInterface $store

Return Value

BaseHandlerTrait

protected StoreInterface createStore(Member $member)

No description

Parameters

Member $member

Return Value

StoreInterface

protected SudoModeServiceInterface getSudoModeService()

Returns a sudo mode service instance

init()

No description