PHP API Ref 5.0.0: HTML

[adriendupuis]

Question	Answer
JIRA Ticket
Versions	5.0
Edition	All

PHP API Ref 5.0 HTML generated with #2710 + #2709

Examples:

• enum Ibexa\Contracts\Core\Repository\Values\Content\RelationType: int
• enum Ibexa\Contracts\Rector\Sets\IbexaSetList
• Ibexa\Contracts\Core\Validation\ValidationStructWrapperInterface:: getStruct() attribute
• final readonly class Ibexa\Contracts\Rector\Factory\IbexaRectorConfigFactory

Checklist

• Text renders correctly
• Text has been checked with vale
• Description metadata is up to date
• Redirects cover removed/moved pages
• Code samples are working
• PHP code samples have been fixed with PHP CS fixer
• Added link to this PR in relevant JIRA ticket or code PR

[github-actions]

Preview of modified Markdown: no Markdown change to preview.

[github-actions]

code_samples/ change report

Before (on target branch)	After (in current PR)
code_samples/api/rest_api/src/Rest/InputParser/GreetingInput.php docs/api/rest_api/extending_rest_api/creating_new_rest_resource.md@113:``` php docs/api/rest_api/extending_rest_api/creating_new_rest_resource.md@114:[[= include_file('code_samples/api/rest_api/src/Rest/InputParser/GreetingInput.php') =]] docs/api/rest_api/extending_rest_api/creating_new_rest_resource.md@115:``` 001⫶<?php declare(strict_types=1); 002⫶ 003⫶namespace App\Rest\InputParser; 004⫶ 005⫶use App\Rest\Values\Greeting; 006⫶use Ibexa\Contracts\Rest\Exceptions; 007⫶use Ibexa\Contracts\Rest\Input\ParsingDispatcher; 008⫶use Ibexa\Rest\Input\BaseParser; 009⫶ 010⫶class GreetingInput extends BaseParser 011⫶{	code_samples/api/rest_api/src/Rest/InputParser/GreetingInput.php docs/api/rest_api/extending_rest_api/creating_new_rest_resource.md@113:``` php docs/api/rest_api/extending_rest_api/creating_new_rest_resource.md@114:[[= include_file('code_samples/api/rest_api/src/Rest/InputParser/GreetingInput.php') =]] docs/api/rest_api/extending_rest_api/creating_new_rest_resource.md@115:``` 001⫶<?php declare(strict_types=1); 002⫶ 003⫶namespace App\Rest\InputParser; 004⫶ 005⫶use App\Rest\Values\Greeting; 006⫶use Ibexa\Contracts\Rest\Exceptions; 007⫶use Ibexa\Contracts\Rest\Input\ParsingDispatcher; 008⫶use Ibexa\Rest\Input\BaseParser; 009⫶ 010⫶class GreetingInput extends BaseParser 011⫶{
012⫶ public function parse(array $data, ParsingDispatcher $parsingDispatcher)	012⫶ public function parse(array $data, ParsingDispatcher $parsingDispatcher): Greeting
013⫶ { 014⫶ if (!isset($data['Salutation'])) { 015⫶ throw new Exceptions\Parser("Missing or invalid 'Salutation' element for Greeting."); 016⫶ } 017⫶ 018⫶ return new Greeting($data['Salutation'], $data['Recipient'] ?? 'World'); 019⫶ } 020⫶} code_samples/api/rest_api/src/Rest/ValueObjectVisitor/RestLocation.php docs/api/rest_api/extending_rest_api/adding_custom_media_type.md@34:``` php docs/api/rest_api/extending_rest_api/adding_custom_media_type.md@35:[[= include_file('code_samples/api/rest_api/src/Rest/ValueObjectVisitor/RestLocation.php') =]] docs/api/rest_api/extending_rest_api/adding_custom_media_type.md@36:``` 001⫶<?php declare(strict_types=1); 002⫶ 003⫶namespace App\Rest\ValueObjectVisitor; 004⫶ 005⫶use Ibexa\Contracts\Core\Repository\URLAliasService; 006⫶use Ibexa\Contracts\Rest\Output\Generator; 007⫶use Ibexa\Contracts\Rest\Output\Visitor; 008⫶use Ibexa\Rest\Server\Output\ValueObjectVisitor\RestLocation as BaseRestLocation; 009⫶use Ibexa\Rest\Server\Values\URLAliasRefList; 010⫶ 011⫶class RestLocation extends BaseRestLocation 012⫶{ 013⫶ private URLAliasService $urlAliasService; 014⫶ 015⫶ public function __construct(URLAliasService $urlAliasService) 016⫶ { 017⫶ $this->urlAliasService = $urlAliasService; 018⫶ } 019⫶	013⫶ { 014⫶ if (!isset($data['Salutation'])) { 015⫶ throw new Exceptions\Parser("Missing or invalid 'Salutation' element for Greeting."); 016⫶ } 017⫶ 018⫶ return new Greeting($data['Salutation'], $data['Recipient'] ?? 'World'); 019⫶ } 020⫶} code_samples/api/rest_api/src/Rest/ValueObjectVisitor/RestLocation.php docs/api/rest_api/extending_rest_api/adding_custom_media_type.md@34:``` php docs/api/rest_api/extending_rest_api/adding_custom_media_type.md@35:[[= include_file('code_samples/api/rest_api/src/Rest/ValueObjectVisitor/RestLocation.php') =]] docs/api/rest_api/extending_rest_api/adding_custom_media_type.md@36:``` 001⫶<?php declare(strict_types=1); 002⫶ 003⫶namespace App\Rest\ValueObjectVisitor; 004⫶ 005⫶use Ibexa\Contracts\Core\Repository\URLAliasService; 006⫶use Ibexa\Contracts\Rest\Output\Generator; 007⫶use Ibexa\Contracts\Rest\Output\Visitor; 008⫶use Ibexa\Rest\Server\Output\ValueObjectVisitor\RestLocation as BaseRestLocation; 009⫶use Ibexa\Rest\Server\Values\URLAliasRefList; 010⫶ 011⫶class RestLocation extends BaseRestLocation 012⫶{ 013⫶ private URLAliasService $urlAliasService; 014⫶ 015⫶ public function __construct(URLAliasService $urlAliasService) 016⫶ { 017⫶ $this->urlAliasService = $urlAliasService; 018⫶ } 019⫶
020⫶ public function visit(Visitor $visitor, Generator $generator, $data)	020⫶ public function visit(Visitor $visitor, Generator $generator, $data): void
021⫶ { 022⫶ // Not using $generator->startObjectElement to not have the XML Generator adding its own media-type attribute with the default vendor 023⫶ $generator->startHashElement('Location'); 024⫶ $generator->attribute( 025⫶ 'media-type', 026⫶ 'application/app.api.Location+' . strtolower((new \ReflectionClass($generator))->getShortName()) 027⫶ ); 028⫶ $generator->attribute( 029⫶ 'href', 030⫶ $this->router->generate( 031⫶ 'ibexa.rest.load_location', 032⫶ ['locationPath' => trim($data->location->pathString, '/')] 033⫶ ) 034⫶ ); 035⫶ parent::visit($visitor, $generator, $data); 036⫶ $visitor->visitValueObject(new URLAliasRefList(array_merge( 037⫶ $this->urlAliasService->listLocationAliases($data->location, false), 038⫶ $this->urlAliasService->listLocationAliases($data->location, true) 039⫶ ), $this->router->generate( 040⫶ 'ibexa.rest.list_location_url_aliases', 041⫶ ['locationPath' => trim($data->location->pathString, '/')] 042⫶ ))); 043⫶ $generator->endHashElement('Location'); 044⫶ } 045⫶}	021⫶ { 022⫶ // Not using $generator->startObjectElement to not have the XML Generator adding its own media-type attribute with the default vendor 023⫶ $generator->startHashElement('Location'); 024⫶ $generator->attribute( 025⫶ 'media-type', 026⫶ 'application/app.api.Location+' . strtolower((new \ReflectionClass($generator))->getShortName()) 027⫶ ); 028⫶ $generator->attribute( 029⫶ 'href', 030⫶ $this->router->generate( 031⫶ 'ibexa.rest.load_location', 032⫶ ['locationPath' => trim($data->location->pathString, '/')] 033⫶ ) 034⫶ ); 035⫶ parent::visit($visitor, $generator, $data); 036⫶ $visitor->visitValueObject(new URLAliasRefList(array_merge( 037⫶ $this->urlAliasService->listLocationAliases($data->location, false), 038⫶ $this->urlAliasService->listLocationAliases($data->location, true) 039⫶ ), $this->router->generate( 040⫶ 'ibexa.rest.list_location_url_aliases', 041⫶ ['locationPath' => trim($data->location->pathString, '/')] 042⫶ ))); 043⫶ $generator->endHashElement('Location'); 044⫶ } 045⫶}

Download colorized diff