Explicitly listed types supported by Response Tagger

[mnocon]

As mentioned on the community Slack, the doc should list the available types to make this less confusing.

If an experienced Symfony developer who reads the doc still make mistakes when using the API, then it must be confusing.

In addition, I think we should consider improving the DX by making changes directly in the ibexa/http-cache package, for example by:

• in dev mode, throwing an exception on unsupported types
• in prod, logging that the type does not have any supported taggers
• adding a Content (or ContentAwareInterface) tagger to support Content out of the box

Report:

Answer:

Feedback:

[github-actions]

Preview of modified files

Preview of modified Markdown:

• docs/infrastructure_and_maintenance/cache/http_cache/content_aware_cache.md

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[github-actions]

code_samples/ change report

Before (on target branch)	After (in current PR)
code_samples/cache/http_cache/src/response_tagging.php	code_samples/cache/http_cache/src/response_tagging.php
	docs/infrastructure_and_maintenance/cache/http_cache/content_aware_cache.md@166:``` php hl_lines="3 6 9" docs/infrastructure_and_maintenance/cache/http_cache/content_aware_cache.md@167:[[= include_file('code_samples/cache/http_cache/src/response_tagging.php', 2, 11) =]] docs/infrastructure_and_maintenance/cache/http_cache/content_aware_cache.md@168:``` 001⫶/** @var \Ibexa\Contracts\HttpCache\ResponseTagger\ResponseTagger $responseTagger */ 002⫶/** @var \Ibexa\Core\MVC\Symfony\View\ContentValueView|\Ibexa\Core\MVC\Symfony\View\LocationValueView $view */ 003❇️$responseTagger->tag($view); // When working with a view 004⫶ 005⫶/** @var \Ibexa\Contracts\Core\Repository\Values\Content\Content $content */ 006❇️$responseTagger->tag($content->getContentInfo()); // When working with a content item 007⫶ 008⫶/** @var \Ibexa\Contracts\Core\Repository\Values\Content\Location $location */ 009❇️$responseTagger->tag($location); // When working with a location

Download colorized diff