Getting Started

Minimal Steps

Installation:

composer require canaltp/tyr-bundle:1.1.x

Add the bundle to AppKernel.php:

new CanalTP\TyrBundle\CanalTPTyrBundle(),

Configure: Update app/config.yml with your Tyr API endpoint:

canal_tp_tyr:
    url: %tyr_url%
    end_point_id: 2  # Optional

Define the tyr_url parameter in parameters.yml:

parameters:
    tyr_url: http://tyr.dev.canaltp.fr/v0/

First Use Case: Inject the service via dependency injection or fetch it from the container:

$tyrApi = $this->get('canal_tp_tyr.api');
$user = $tyrApi->getUserByEmail('[email protected]');

Implementation Patterns

Dependency Injection

Leverage Symfony’s DI container for cleaner code:

// In a controller/service
public function __construct(CanalTP\TyrBundle\Service\TyrApi $tyrApi) {
    $this->tyrApi = $tyrApi;
}

Dynamic Endpoint Handling

Set the endpoint ID dynamically (e.g., per request or user):

$tyrApi->setEndPointId($request->get('endpoint_id'));

Error Handling

Wrap API calls in try-catch blocks to handle exceptions gracefully:

try {
    $user = $tyrApi->getUserByEmail('[email protected]');
} catch (\Exception $e) {
    $this->addFlash('error', 'Failed to fetch user: ' . $e->getMessage());
}

Integration with Symfony Events

Use events to pre-process or post-process API responses:

// In a listener
public function onKernelRequest(GetResponseEvent $event) {
    $tyrApi = $this->container->get('canal_tp_tyr.api');
    $tyrApi->setEndPointId($this->getEndpointIdFromContext());
}

Gotchas and Tips

Configuration Quirks

Missing end_point_id: If not set in config.yml, ensure it’s dynamically set via setEndPointId() or the API will fail.
URL Trailing Slash: The url parameter in config.yml must end with / (e.g., http://tyr.dev/v0/). Omitting it may cause 404 errors.

Debugging

Check HTTP Client: The bundle uses Symfony’s HttpClient under the hood. Enable debug mode to inspect requests:
```
# config.yml
framework:
    http_client:
        debug: true
```

Log Responses: Extend AbstractTyrService to log raw responses for debugging:

$tyrApi->getClient()->getEventDispatcher()->addListener(
    'response',
    function ($event) {
        $this->logger->debug('Tyr API Response:', ['response' => $event->getResponse()->getContent()]);
    }
);

Extension Points

Custom Endpoints: Override the service to add custom methods:

// src/Service/CustomTyrApi.php
class CustomTyrApi extends \CanalTP\TyrBundle\Service\TyrApi {
    public function getCustomData($id) {
        return $this->get('http_client')->request('GET', $this->url . 'custom/' . $id);
    }
}

services:
    canal_tp_tyr.api:
        class: App\Service\CustomTyrApi
        arguments: ['@http_client', '%tyr_url%', '%kernel.debug%']

Performance

Caching: Cache frequent API calls using Symfony’s cache system:

$cache = $this->container->get('cache.app');
$key = 'tyr_user_' . md5('[email protected]');
if (!$cache->has($key)) {
    $user = $tyrApi->getUserByEmail('[email protected]');
    $cache->set($key, $user, 3600); // Cache for 1 hour
} else {
    $user = $cache->get($key);
}

Deprecation Note

Last Release (2018): The package is outdated. Test thoroughly in a staging environment before production use. Consider forking or replacing with a maintained alternative (e.g., Guzzle HTTP for custom API clients).

Tyr Bundle Laravel Package