MemberExtension
class MemberExtension extends DataExtension implements PermissionProvider (View source)
Extend Member to add relationship to registered methods and track some specific preferences
Constants
MFA_ADMINISTER_REGISTERED_METHODS |
|
Properties
protected | SS_Object | $owner | The object this extension is applied to. |
from Extension |
protected | DataObject | $ownerBaseClass | The base class that this extension was applied to; $this->owner must be one of these |
from Extension |
public | $class | from Extension |
Methods
Called when this extension is added to a particular class
Helper method to strip eval'ed arguments from a string thats passed to DataObject::$extensions or Object::add_extension().
Update the database schema as required by this extension.
Define extra database fields
This function is used to provide modifications to the form in the CMS by the extension. By default, no changes are made. DataObject->getCMSFields().
This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()
This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().
this function is used to provide modifications to the summary fields in CMS by the extension By default, the summaryField() of its owner will merge more fields defined in the extension's $extra_fields['summary_fields']
this function is used to provide modifications to the fields labels in CMS by the extension By default, the fieldLabels() of its owner will merge more fields defined in the extension's $extra_fields['field_labels']
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(SS_Object $owner, string $ownerBaseClass = null)
Set the owner of this extension.
clearOwner()
No description
SS_Object
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 thats passed to DataObject::$extensions or Object::add_extension().
static
get_extra_config($class, $extension, $args)
No description
static
unload_extra_statics($class, $extension)
No description
validate(ValidationResult $validationResult)
Hook for extension-specific validation.
augmentSQL(SQLQuery $query)
Edit the given query object to support queries for this extension
augmentDatabase()
Update the database schema as required by this extension.
When duplicating a table's structure, remember to duplicate the create options as well. See Versioned->augmentDatabase for an example.
augmentWrite(array $manipulation)
Augment a write-record request.
onBeforeWrite()
No description
onAfterWrite()
No description
onBeforeDelete()
No description
onAfterDelete()
No description
requireDefaultRecords()
No description
populateDefaults()
No description
can($member)
No description
canEdit($member)
No description
canDelete($member)
No description
canCreate($member)
No description
array
extraStatics($class = null, $extension = null)
Define extra database fields
Return a map where the keys are db, has_one, etc, and the values are additional fields/relations to be defined.
updateCMSFields(FieldList $fields)
This function is used to provide modifications to the form in the CMS by the extension. By default, no changes are made. DataObject->getCMSFields().
Please consider using updateFormFields() to globally add formfields to the record. The method updateCMSFields() should just be used to add or modify tabs, or fields which are specific to the CMS-context.
Caution: Use FieldList->addFieldToTab() to add fields.
updateFrontEndFields(FieldList $fields)
This function is used to provide modifications to the form used for front end forms. DataObject->getFrontEndFields()
Caution: Use FieldList->push() to add fields.
updateCMSActions(FieldList $actions)
This is used to provide modifications to the form actions used in the CMS. DataObject->getCMSActions().
updateSummaryFields(array $fields)
this function is used to provide modifications to the summary fields in CMS by the extension By default, the summaryField() of its owner will merge more fields defined in the extension's $extra_fields['summary_fields']
updateFieldLabels(array $labels)
this function is used to provide modifications to the fields labels in CMS by the extension By default, the fieldLabels() of its owner will merge more fields defined in the extension's $extra_fields['field_labels']
MFARegisteredMethod|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(MFARegisteredMethod $registeredMethod)
Set the default registered method for the current member. Does not write the owner record.
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.
void
afterMemberLoggedIn()
Clear any temporary multi-factor authentication related session keys when a member is successfully logged in.
HasManyList
RegisteredMFAMethods()
No description