Symfony2: Custom ParamConverter für HTTP-Requests erstellen

Eines der vielen kleinen Goodies die Symfony2 zu bieten hat ist der ParamConverter. Die ParamConverter übersetzen die Parameter beim HTTP-Request nach den gewünschten Vorgaben. So können zum Beispiel Datenmodelle direkt geladen oder Datum-Strings als DateTime-Objekte genutzt werden. Wenn man mit einem Standardsetup arbeitet, sind diese Converter direkt dabei.

Aber auch eigene Converter sind schnell geschrieben und einsatzfähig. Sämtliche Möglichkeiten des ParamConverters stehen in der Dokumentation.

Als Ausgangspunkt haben wir in dem Beispiel eine Action, die mit einer ID aufgerufen wird.

<?php
namespace E7\DemoBundle\Controller;

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
use E7\DemoBundle\Model\Post;

class DefaultController extends Controller {
    /**
     * @Route("/test/{postId}")
     * @ParamConverter()
     * @param   Post $post
     */
    public function testAction(Post $post) {
      // some usefull code
    }
}

Über die Annotation @ParamConverter weiß das System nun, dass der Parameter übersetzt werden soll. Die bereits zu Beginn erwähnten Converter sind bereits registriert. Um nun eine eigene Logik zu verwenden, brauchen wir einen eigenen Übersetzter. Die Klasse muss das Interface ParamConverterInterface implementieren.

Die Schnittstelle ist sehr einfach gehalten und bietet alls was man braucht. Die Methode supports() muss ein TRUE oder FALSE zurückgeben, ob die Klasse die Anfrage übersetzen kann und apply() mach dann den Rest.

<?php
namespace E7\DemoBundle\Request\ParamConverter;

use Sensio\Bundle\FrameworkExtraBundle\Request\ParamConverter\ParamConverterInterface;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\ConfigurationInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

class ModelParamConverter implements ParamConverterInterface {
    function apply(Request $request, ConfigurationInterface $configuration) {
        $name = $configuration->getName();
        $idParam = $name . 'Id';
        $class = $configuration->getClass();

        if (!$request->attributes->has($idParam)) {
            return false;
        }

        $id = $request->attributes->get($idParam);

        $model = loadModelById($id);
        $request->attributes->set($param, $model);

        if (null === $model->getId()) {
            throw new NotFoundHttpException(sprintf('%s object not found.', $class));
        }

        return true;
    }

    function supports(ConfigurationInterface $configuration) {
        return modelClassExists($class);
    }
}

Die Klasse soll schematisch zeigen, wie ein Converter funktionieren könnte. Die beiden Funktionen loadModelById() und modelClassExists() stehen nur als Pseudocode da. Alle verfügbaren Werte können über die Annotation $configuration abgerufen werden. Über $configuration kommen wir an den Namen des Parameter und den TypeHint.

Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter Object
(
    [name:protected] => post
    [class:protected] => E7\DemoBundle\Model\Post
    [options:protected] => Array
        (
        )

    [optional:protected] =>
    [converter:protected] => model
)

Bevor unser Converter überhaupt beachtet wird, müssen wir ihn in der services.yml als Service registrieren.

services:
    request.param_converter:
        class: E7\DemoBundle\Request\ParamConverter\ModelParamConverter
        tags:
            - { name: request.param_converter, converter: model }

Ab jetzt sollte alles zusammenarbeiten und wir können nach belieben Requestparameter umformen. Viel Spaß!