MemberExtension
class MemberExtension extends Extension implements PermissionProvider (View source)
Extend Member to add relationship to registered methods and track some specific preferences
Constants
| MFA_ADMINISTER_REGISTERED_METHODS |
|
Properties
| protected | T | $owner | The object this extension is applied to. |
from Extension |
| MethodInterface | $DefaultRegisteredMethod | |||
| string | $DefaultRegisteredMethodID | |||
| bool | $HasSkippedMFARegistration |
Methods
Called when this extension is added to a particular class
Temporarily modify the owner. The original owner is ensured to be restored
Clear the current owner, and restore extension to the state prior to the last setOwner()
Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().
Invoke extension point. This will prefer explicit extend prefixed
methods.
Accessor for the DefaultRegisteredMethod property.
Set the default registered method for the current member. Does not write the owner record.
Determines whether the logged in user has sufficient permission to see the MFA config for this Member.
Determines whether the logged in user has sufficient permission to modify the MFA config for this Member.
Provides the MFA view/reset permission for selection in the permission list in the CMS.
Clear any temporary multi-factor authentication related session keys when a member is successfully logged in.
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
setOwner(object $owner)
Set the owner of this extension.
mixed
withOwner(mixed $owner, callable $callback, array $args = [])
Temporarily modify the owner. The original owner is ensured to be restored
clearOwner()
Clear the current owner, and restore extension to the state prior to the last setOwner()
T
getOwner()
Returns the owner of this extension.
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().
mixed
invokeExtension(object $owner, string $method, array ...$arguments)
Invoke extension point. This will prefer explicit extend prefixed
methods.
RegisteredMethod|null
getDefaultRegisteredMethod()
Accessor for the DefaultRegisteredMethod property.
This is replicating the usual functionality of a has_one relation but does it like this so we can ensure the same instance of the MethodInterface is provided regardless if you access it through the has_one or the has_many.
Member
setDefaultRegisteredMethod(RegisteredMethod $registeredMethod)
Set the default registered method for the current member. Does not write the owner record.
string
getDefaultRegisteredMethodName()
No description
string
getRegisteredMethodNames()
No description
bool
currentUserCanViewMFAConfig()
Determines whether the logged in user has sufficient permission to see the MFA config for this Member.
bool
currentUserCanEditMFAConfig()
Determines whether the logged in user has sufficient permission to modify the MFA config for this Member.
Note that this is different from being able to reset the config (which administrators can do).
providePermissions()
Provides the MFA view/reset permission for selection in the permission list in the CMS.
protected void
onAfterMemberLoggedIn()
Clear any temporary multi-factor authentication related session keys when a member is successfully logged in.
void
HasManyList() $RegisteredMethod> RegisteredMFAMethods()
No description