[6.1] Make abstract immutable event actually immutable

[wilsonge]

Pull Request for Issue #39372 .

Summary of Changes

As pointed out in the issue our immutable event is very mutable. This fixes all the cases so that once initialised there can be no properties set into the event (it’s possible we might need some plug-in events to actually be mutable).

As we've now split the Immutable class from the mutable class - I've taken this opportunity to move the create method to it's own factory class - because it will be somewhat confusing for users that the mutable AbstractEvent class can create AbstractImmutable class's which are somewhat unrelated.

Testing Instructions

Ensure core continues to work when performing a variety of actions. We also should test this with some 3rd party plugins to ensure they also still work.

Actual result BEFORE applying this Pull Request

Event is mutable

Expected result AFTER applying this Pull Request

Event is not mutable

Link to documentations

Please select:

• Documentation link for docs.joomla.org:

• No documentation changes for docs.joomla.org needed

• Pull Request link for manual.joomla.org:

• No documentation changes for manual.joomla.org needed

[richard67]

@SharkyKZ Why confused? Because of what the PR does? Or because it's for 5.0?

[SharkyKZ]

@SharkyKZ Why confused? Because of what the PR does? Or because it's for 5.0?

Because it doesn't make much sense for this immutable class to extend a class that is explicitly mutable. Any change here is going to be a B/C break anyways so might as well fix the inheritance tree.

[wilsonge]

Because it doesn't make much sense for this immutable class to extend a class that is explicitly mutable. Any change here is going to be a B/C break anyways so might as well fix the inheritance tree.

That's a fair shout. The framework class is final so couldn't extend from there but implemented as similar now

If this PR is accepted I'll do a PR to migrate the EventFactory creation back to the 4.x CMS tree

[wilsonge]

@SharkyKZ can you re-review please

[HLeithner]

I'm not sure how useful it is to introduce a new class for a functionality which we should not use.
Every event should have it's own class and should be created directly without a factory. ymmv

[wilsonge]

Whilst the class exists it should do what it says on the tin :) yvmv :P

[HLeithner]

Is this PR now absolute after the all new events?

[HLeithner]

This pull request has been automatically rebased to 5.1-dev.

[kernusr]

In order to make the AbstractEventImmutable class true immutable, you disabled the ability to call setArgument after initialization. It's the right way! But what about methods addArgument, removeArgument, clearArguments?

[wilsonge]

@kernusr we're extending the frameworks' abstractEvent here now - so these methods don't exist at all

[HLeithner]

This pull request has been automatically rebased to 5.2-dev.

[HLeithner]

This pull request has been automatically rebased to 5.3-dev.

[HLeithner]

This pull request has been automatically rebased to 6.0-dev.

[HLeithner]

This pull request has been automatically rebased to 6.1-dev.