MessengerInterface::deleteAll has the wrong return type

Fixed the @return docblock for deleteAll() — changed from string[]|MarkupInterface[] to string[][]|MarkupInterface[][] to match ::all(),

Please review and let me know if anything more required

Since this is a novice tagged task may be good practice to make sure the summary is updated too.

@avinash.jha mind expanding on how you came up with that one please?

Thanks.

Hi @smustgrave

I followed these steps to determine the correct change:

1. The issue description notes: *"It should be the same as ::all() but it is the same as messagesByType($type);"*
2. I checked the implementation in `Messenger::deleteAll()`, which returns `$this->flashBag->clear()`.
3. Looking at Symfony's `FlashBag` class, the `clear()` method clears all flash messages and returns them. Internally, this returns the entire `$this->flashes` array (which is grouped by message type, e.g. `['status' => [...], 'warning' => [...], 'error' => [...]]`).
4. This is the exact same structure returned by `peekAll()` (which is called by `Messenger::all()`).
5. Since the original docblock for `deleteAll()` incorrectly documented a flat array (`string[]|MarkupInterface[]`), I corrected it to a nested array (`string[][]|MarkupInterface[][]`) to match the actual implementation and align it with `::all()`.

Updated the issue summary with the problem, proposed resolution, remaining tasks, and API changes.

The MR is still mergeable and the pipeline is passing. Moving back to Needs review.

Not sure the original purpose was to copy word for word the description from all(). Think that needs to be looked at.

Hi @smustgrave,

Updated the MR to avoid copying the ::all() return description word for word.

The deleteAll() docblock now keeps the corrected nested return type, but describes the returned values as deleted messages grouped by message type.

The branch was also rebased against the latest main, and the pipeline is passing now.

Moving back to Needs review.

Reads much better, thanks!

Left a comment on the MR about a further improvement - don't make that change yet until we get consensus here - thoughts folks?

If we do do we update all() too?

Would make sense if we agree with the approach

+1 for using the array shape. We're using shapes more and more lately. With those in place we can simplify the return type descriptions too, removing the explanations that specify what the message types are. They become part of the function definition.

That’s 3 let’s do it!

Updated the MR as suggested.

Both ::all() and ::deleteAll() now use the array shape return type, and the branch was rebased against latest main.

Thanks!

This looks correct to me, thanks for working on it!

Committed/pushed to main and 11.x, thanks!