Joomla! API

Returns the most suitable event class for a Joomla core event name

A Trait to reshape arguments maintaining b/c with legacy plugin events.

Old plugin event handlers expect positional arguments, not named arguments, since they are simple PHP methods, e.g. public onExample($foo, $bar, $baz). Concrete Event classes, however, use named arguments which can be passed in any order. The following two examples are equivalent: $event1 = new ConcreteEventClass('onExample', ['foo' => 1, 'bar' => 2, 'baz' => 3]; $event2 = new ConcreteEventClass('onExample', ['bar' => 2, 'baz' => 3, 'foo' => 1,]; However, this means that the internal $arguments property of the event object holds the named arguments in a **different** order in each case. When the event handler is aware of the ConcreteEventClass it can retrieve named arguments and all is good in the world. However, when you have a legacy plugin listener registered through CMSPlugin::registerLegacyListener you have a major problem! The legacy listener is passing the arguments **positionally**, in the order they were added to the Event object. In the previous example, $event1 would work as expected because the foo, bar, and baz arguments were given in the same order legacy listeners expected them. On the other hand, $event2 would fail miserably because the call order would be $bar, $baz, $foo which is NOT what the legacy listener expected. The only way to fix that is to *reshape the argument* in the concrete event's constructor so that the order of arguments is guaranteed to be the same as expected by legacy listeners. Moreover, since Joomla is passing all arguments (except the 'result' argument) blindly to the legacy listener we must ensure that a. all necessary arguments are set and b. any other named arguments do NOT exist. Otherwise our legacy listeners would receive the wrong number of positional arguments and break. All this is achieved by the reshapeArguments() method in this trait which has to be called in the constructor of the concrete event class. This trait is marked as deprecated with a removal target of 5.0 because in Joomla 5 we will only be using concrete event classes with named arguments, removing legacy listeners and their positional arguments headaches.

« More »

This class implements the base Event object used system-wide to offer orthogonality. Core objects such as Models, Controllers, etc create such events on-the-fly and dispatch them through the application's Dispatcher (colloquially known as the "Joomla! plugin system"). This way a suitable plugin, typically a "system" plugin, can modify the behaviour of any internal class, providing system-wide services such as tags, content versioning, comments or even low-level services such as the implementation of created/modified/locked behaviours, record hit counter etc.

You can create a new Event with something like this: $event = AbstractEvent::create('onModelBeforeSomething', $myModel, $arguments); You can access the subject object from your event Listener using $event['subject']. It is up to your listener to determine whether it should apply its functionality against the subject. This AbstractEvent class implements a mutable event which is allowed to change its arguments at runtime. This is generally unadvisable. It's best to use AbstractImmutableEvent instead and constrict all your interaction to the subject class.

« More »

This class implements the immutable base Event object used system-wide to offer orthogonality.

« More »

Event class for representing the extensions's `onBeforeExtensionBoot` event

« More »

Event class for representing the extensions's `onBeforeExtensionBoot` event

« More »

Event class for representing the application's `onError` event

« More »

This class gives a concrete implementation of the AbstractEvent class.

« More »

Event class for modifying a table object before a batch event is applied

« More »

Concrete Event class for the onUserMultifactorBeforeDisplayMethods event

« More »

Concrete Event class for the onUserMultifactorCallback event

« More »

Concrete Event class for the onUserMultifactorCaptive event

« More »

Concrete Event class for the onUserMultifactorGetMethod event

« More »

Concrete Event class for the onUserMultifactorGetSetup event

« More »

Concrete event class for the custom events used to notify the User Action Log plugin about Two Factor Authentication actions.

« More »

Concrete Event class for the onUserMultifactorSaveSetup event

« More »

Concrete Event class for the onUserMultifactorValidate event

« More »

Concrete event class for the onAjaxWebauthn event

« More »

Concrete event class for the onAjaxWebauthnChallenge event

« More »

Concrete event class for the onAjaxWebauthnCreate event

« More »

Concrete event class for the onAjaxWebauthnDelete event

« More »

Concrete event class for the onAjaxWebauthnInitcreate event

« More »

Concrete event class for the onAjaxWebauthnLogin event

« More »

Concrete event class for the onAjaxWebauthnSavelabel event

« More »

Event class for the onGetIcon event.

« More »

This Trait partially implements the ResultAwareInterface for mutable and immutable events.

You must additionally implement the typeCheckResult method or use one of the ResultType*Aware traits in your Event handler.

« More »