NotifyActionLog
Extends AbstractImmutableEventConcrete event class for the custom events used to notify the User Action Log plugin about Two Factor Authentication actions.
| since |
4.2.0 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Public constructor
__construct( name, mixed||string|int arguments = []) :
| since |
4.2.0 |
|---|
Arguments
- name
stringEvent name. Must belong in self::ACCEPTABLE_EVENTS- arguments
array<string|int, mixed>Event arguments (different for each event).
Response
mixed
create
Creates a new CMS event object for a given event name and subject. The following arguments must be given: subject object The subject of the event. This is the core object you are going to manipulate.
create( eventName, mixed||string|int arguments = []) :
eventClass string The Event class name. If you do not provide it Joomla\CMS\Events<eventNameWithoutOnPrefix> will be used.
| since |
4.0.0 |
|---|---|
| throws |
|
Arguments
- eventName
stringThe name of the event, e.g. onTableBeforeLoad- arguments
array<string|int, mixed>Additional arguments to pass to the event
Response
static
getArgument
Get an event argument value.
getArgument( name, default = null) :
It will use a pre-processing method if one exists. The method has the signature:
onGet<ArgumentName>($value): mixed
where:
$value is the value currently stored in the $arguments array of the event It returns the value to return to the caller.
| since |
4.0.0 |
|---|
Arguments
- name
stringThe argument name.- default
mixedThe default value if not found.
Response
mixedThe argument value or the default value.
getEventClassByEventName
Get the concrete event class name for the given event name.
getEventClassByEventName( eventName) :
This method falls back to the generic Joomla\Event\Event class if the event name is unknown to this trait.
| since |
4.2.0 |
|---|
Arguments
- eventName
stringThe event name
Response
stringThe event class name
offsetSet
Set the value of an event argument.
offsetSet( name, value) :
| since |
4.0.0 |
|---|---|
| throws |
|
Arguments
- name
stringThe argument name.- value
mixedThe argument value.
Response
void
offsetUnset
Remove an event argument.
offsetUnset( name) :
| since |
4.0.0 |
|---|---|
| throws |
|
Arguments
- name
stringThe argument name.
Response
void
setArgument
Add argument to event.
setArgument( name, value) :
It will use a pre-processing method if one exists. The method has the signature:
onSet<ArgumentName>($value): mixed
where:
$value is the value being set by the user It returns the value to return to set in the $arguments array of the event.
| since |
4.0.0 |
|---|
Arguments
- name
stringArgument name.- value
mixedValue.
Response
$this
Constants
ACCEPTABLE_EVENTS
| Value | ['onComUsersCaptiveValidateSuccess', 'onComUsersViewMethodsAfterDisplay', 'onComUsersCaptiveShowCaptive', 'onComUsersCaptiveShowSelect', 'onComUsersCaptiveValidateFailed', 'onComUsersCaptiveValidateInvalidMethod', 'onComUsersCaptiveValidateTryLimitReached', 'onComUsersCaptiveValidateSuccess', 'onComUsersControllerMethodAfterRegenerateBackupCodes', 'onComUsersControllerMethodBeforeAdd', 'onComUsersControllerMethodBeforeDelete', 'onComUsersControllerMethodBeforeEdit', 'onComUsersControllerMethodBeforeSave', 'onComUsersControllerMethodsBeforeDisable', 'onComUsersControllerMethodsBeforeDoNotShowThisAgain'] |
|---|
Properties
eventNameToConcreteClass
Maps event names to concrete Event classes.
This is only for events with invariable names. Events with variable names are handled with PHP logic in the getEventClassByEventName class.
| since |
4.2.0 |
|---|
Type(s)
array<string|int, mixed>