IBX-6045: Introduced attributes argument to Generator::startValueElement signature

[alongosz]

Question	Answer
JIRA issue	IBX-6045
Required by	ibexa/shipping#25
Type	bug
Target Ibexa version	v4.6.0
BC breaks	yes

This PR adds missing 3rd argument $attributes to \Ibexa\Contracts\Rest\Output\Generator::startValueElement contract signature. The existing implementations

• \Ibexa\Rest\Output\Generator\Json::startValueElement
• \Ibexa\Rest\Output\Generator\Xml::startValueElement

have been relying on this argument for the past 11 years, so it's safe to declare this as a bug.

Documentation

Technically it's a BC break which requires documenting in 4.6.0 upgrade instructions and release notes.

The method signature of \Ibexa\Contracts\Rest\Output\Generator::startValueElement got improved and now looks as follows:

    /**
     * @phpstan-param scalar $value
     * @phpstan-param array<string, scalar> $attributes
     */
    abstract public function startValueElement(string $name, $value, array $attributes = []): void;

any 3rd party code extending \Ibexa\Contracts\Rest\Output\Generator needs to update the signature.

Checklist:

• Provided PR description.
• Tested the solution manually.
• Provided automated test coverage.
• Checked that target branch is set correctly.
• Ran PHP CS Fixer for new PHP code (use $ composer fix-cs).
• Asked for a review.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[alongosz]

QA: there's nothing to test here really besides what CI REST functional/integration tests did. It's a change on abstract which has been already present in the implementations for the last 11 years and affects static analysis only (and 3rd party extending it - unlikely scenario).