Raptor integration - feature branch: Rework PHP

[adriendupuis]

Question	Answer
JIRA Ticket
Versions
Edition

Rework #3121 PHP API usage

• Add an introduction about the tracking event dispatcher service (guessing it's the one refered as "the service")
• Detail the event mapper usage

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 files

Preview of modified Markdown:

• docs/recommendations/raptor_integration/tracking_php_api.md

Preview of addition to PHP API Reference:

• Ibexa\Contracts\ConnectorRaptor\Tracking\Event\EventDataInterface
• Ibexa\Contracts\ConnectorRaptor\Tracking\EventContext
• Ibexa\Contracts\ConnectorRaptor\Tracking\EventType
• Ibexa\Contracts\ConnectorRaptor\Tracking\ServerSideTrackingDispatcherInterface

[dabrt]

There are some minor issues that need fixing

[github-actions]

code_samples/ change report

Before (on target branch)	After (in current PR)
code_samples/recommendations/EventMapper.php	code_samples/recommendations/EventMapper.php
docs/recommendations/raptor_integration/tracking_php_api.md@19:``` php docs/recommendations/raptor_integration/tracking_php_api.md@20:[[= include_file('code_samples/recommendations/EventMapper.php') =]] docs/recommendations/raptor_integration/tracking_php_api.md@21:```	docs/recommendations/raptor_integration/tracking_php_api.md@39:``` php docs/recommendations/raptor_integration/tracking_php_api.md@40:[[= include_file('code_samples/recommendations/EventMapper.php', 4, 8) =]]//… docs/recommendations/raptor_integration/tracking_php_api.md@41: docs/recommendations/raptor_integration/tracking_php_api.md@42:[[= include_file('code_samples/recommendations/EventMapper.php', 20, 27, remove_indent=True) =]] docs/recommendations/raptor_integration/tracking_php_api.md@43:```
001⫶<?php declare(strict_types=1); 002⫶ 003⫶namespace App\Tracking; 004⫶ 005⫶use Ibexa\Contracts\ConnectorRaptor\Tracking\EventMapperInterface; 006⫶use Ibexa\Contracts\ConnectorRaptor\Tracking\EventType; 007⫶use Ibexa\Contracts\ConnectorRaptor\Tracking\ServerSideTrackingDispatcherInterface; 008⫶use Ibexa\Contracts\ProductCatalog\Values\ProductInterface; 009⫶ 010⫶class EventMapper 011⫶{ 012⫶ public function __construct( 013⫶ private readonly EventMapperInterface $eventMapper, 014⫶ private readonly ServerSideTrackingDispatcherInterface $trackingDispatcher, 015⫶ ) { 016⫶ } 017⫶ 018⫶ public function trackProductView(ProductInterface $product, string $url): void 019⫶ { 020⫶ // Map product to VisitEventData automatically 021⫶ $eventData = $this->eventMapper->map(EventType::VISIT, $product); 022⫶ 023⫶ // Send tracking event 024⫶ $this->trackingDispatcher->dispatch($eventData); 025⫶ } 026⫶}	The following line doesn't include file correctly: [[= include_file('code_samples/recommendations/EventMapper.php', 20, 27, remove_indent=True) =]]

Download colorized diff

[sonarqubecloud]

Quality Gate failed

Failed conditions
8 Security Hotspots
42.7% Duplication on New Code (required ≤ 3%)
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE