IBX-7055: Allowed to return null when content is not deleted

[mikadamczyk]

Question	Answer
JIRA issue	IBX-7055
Type	feature
Target Ibexa version	v4.6
BC breaks	no

When content is not deleted (e.g. on before event propagation is stopped) the null value must be set as a result.

Checklist:

• Provided PR description.
• Tested the solution manually.
• Provided automated test coverage.
• Checked that target branch is set correctly (main for features, the oldest supported for bugs).
• Ran PHP CS Fixer for new PHP code (use $ composer fix-cs).
• Asked for a review (ping @ibexa/engineering).

[Steveb-p]

Is this needed for some functionality?

In theory here, if there is a chance that result is not set, then BeforeTrashEvent::hasTrashItem() method should be called first. Because of how BeforeTrashEvent::getResult() works internally, null will never be returned - an exception will be thrown.

What you want to do instead is probably add phpstan-assert-if-true annotation to BeforeTrashEvent::isResultSet() method, instructing PHPStan that when this method returns true, $this->result will not be null.

See https://phpstan.org/writing-php-code/narrowing-types#custom-type-checking-functions-and-methods for more details.

[alongosz]

At least unit test layer for events should include coverage for this change.

[alongosz]

Running regressions via ibexa/commerce#508

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[alongosz]

Solr failure is unrelated, regressions all green. The change is too trivial for QA, merging :)