ApiController Extender

[SychO9]

Part B of #1624
Part of #1891

Changes proposed in this pull request:

• Deprecate WillGetData Event.
• Deprecate WillSerializeData Event.
• Add extenders to replace both events above.

Reviewers should focus on:

• I had to move all the methods in WillGetData to the AbstractSerializeController, the signature for those methods are somewhat incomplete, some could use proper type hinting while other could explicitly support mixed parameter types of string|array do we want to do that ?
• Do we want to add to the extender convenience methods, similar to the ones present in the WillGetData event for adding/removing includes ...etc ?

Confirmed

• Backend changes: tests are green (run composer test).

[SychO9]

Btw, the methods removeInclude removeOptionalInclude and removeSortField which were ported from the WillGetData event, I'm pretty sure they never actually worked, so I changed the code behind them (only the ones imported, the old ones I didn't).

Arr::forget removes items using their keys, but in this context we do not use keys, only values.

[askvortsov1]

Looking great! A few minor comments

[SychO9]

Alright there's an issue I found while updating the bundled extensions to use this extender.

I passed an invokable class to prepareDataForSerialization (to replace the event listener) and the problem is that the class cannot receive the $data array by reference (which throws a php warning).

That's because when it comes to invokable classes, they're not directly called, it's the callback that returns the invokable which is called. (ContainerUtil::wrapCallback).

I think we can work around this if we receive the function arguments by reference when wrapping the invokable class object.

I'll make a separate pull request for that.

[askvortsov1]

Dumb question, but aren't all arrays received by reference on account of them being mutable objects? I thought PHPs pass by reference was only needed for primitives and strings

[SychO9]

Arrays are not considered objects, so just like primitives they are always passed by value and you have to explicitly specify that you would like to receive them by reference to modify them, otherwise you're just modifying a copy.

[askvortsov1]

Arrays are not considered objects, so just like primitives they are always passed by value and you have to explicitly specify that you would like to receive them by reference to modify them, otherwise you're just modifying a copy.

PHP why must you be like this 😬

I passed an invokable class to prepareDataForSerialization (to replace the event listener) and the problem is that the class cannot receive the $data array by reference (which throws a php warning).

Alright, good catch! Could we add some tests that will ensure that this will work once we fix this in ContainerUtil?

[SychO9]

Alright, good catch! Could we add some tests that will ensure that this will work once we fix this in ContainerUtil?

Good idea!

PHP why must you be like this 😬

¯\_(ツ)_/¯

[SychO9]

One of the tests naturally fails, until #2485 is merged.