Multiple ways of using the given request parameters for detecting the entity in the request attributes.

DoctrineParamConverter.php

<?php

namespace Sensio\Bundle\FrameworkExtraBundle\Request\ParamConverter;

use Sensio\Bundle\FrameworkExtraBundle\Configuration\ConfigurationInterface;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\HttpFoundation\Request;
use Doctrine\Common\Persistence\ManagerRegistry;

/*
 * This file is part of the Symfony framework.
 *
 * (c) Fabien Potencier <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

/**
 * DoctrineParamConverter.
 *
 * @author     Fabien Potencier <[email protected]>
 */
class DoctrineParamConverter implements ParamConverterInterface
{
    /**
     * @var ManagerRegistry
     */
    protected $registry;

    public function __construct(ManagerRegistry $registry = null)
    {
        $this->registry = $registry;
    }

    public function apply(Request $request, ConfigurationInterface $configuration)
    {
        $options = $this->getOptions($configuration);

        if (null !== $options['method']) {
            $object = $this->useMethod($configuration, $request, $options);
        } elseif ((false === $object = $this->find($configuration, $request, $options)) &&
            (false === $object = $this->findOneBy($configuration, $request, $options))) {
            throw new \LogicException('Unable to guess how to get a Doctrine instance from the request information.');
        }

        if (null === $object && false === $configuration->isOptional()) {
            throw new NotFoundHttpException(sprintf('%s object not found.', $configuration->getClass()));
        }

        $request->attributes->set($configuration->getName(), $object);

        return true;
    }

    protected function useMethod(ConfigurationInterface $configuration, Request $request, $options)
    {
        $class = $configuration->getClass();
        $repository = $this->registry->getRepository($class, $options['entity_manager']);

        try {
            $method = new \ReflectionMethod($repository, $options['method']);
        } catch(\ReflectionException $e) {
            throw new \LogicException(sprintf('The method "%s::%s" does not exist.', get_class($repository), $options['method']), 0, $e);
        }

        if (!$method->isPublic()) {
            throw new \LogicException(sprintf('The method "%s::%s" cannot be accessed.', get_class($repository), $options['method']));
        }

        $invokeParameters = array();

        foreach ($method->getParameters() as $parameter) {
            /** @var $parameter \ReflectionParameter  */
            $name = $parameter->getName();

            if (null === $value = $request->attributes->get($name)) {
                if (!$parameter->isOptional() || !$parameter->isDefaultValueAvailable()) {
                    throw new \LogicException(sprintf('Cannot find a value for parameter "%s" in "%s::%s".', $name, get_class($repository), $options['method']));
                }

                $value = $parameter->getDefaultValue();
            }

            $invokeParameters[] = $value;
        }

        return $method->invokeArgs($repository, $invokeParameters);
    }

    protected function find(ConfigurationInterface $configuration, Request $request, $options)
    {
        $name = $configuration->getName();

        if ((null === $id = $request->attributes->get('id')) &&
            (null === $id = $request->attributes->get($name))) {
            return false;
        }

        $class = $configuration->getClass();

        return $this->registry->getRepository($class, $options['entity_manager'])->find($id);
    }

    protected function findOneBy(ConfigurationInterface $configuration, Request $request, $options)
    {
        $class = $configuration->getClass();
        $metadata = $this->registry->getManager($options['entity_manager'])->getClassMetadata($class);
        $criteria = array();
        $attribute_prefix = $configuration->getName() . '_';

        foreach ($request->attributes->all() as $key => $value) {
            if (!$metadata->hasField($key) && !$metadata->hasAssociation($key)) {
                if (false === strpos($key, $attribute_prefix)) {
                    continue;
                }

                $key = substr($key, strlen($attribute_prefix));

                if (!$metadata->hasField($key) && !$metadata->hasAssociation($key)) {
                    continue;
                }
            }

            $criteria[$key] = $value;
        }

        if (empty($criteria)) {
            return false;
        }

        return $this->registry->getRepository($class, $options['entity_manager'])->findOneBy($criteria);
    }

    public function supports(ConfigurationInterface $configuration)
    {
        if (null === $this->registry) {
            return false;
        }

        if (null === $configuration->getClass()) {
            return false;
        }

        $options = $this->getOptions($configuration);

        // Doctrine Entity?
        return ! $this->registry->getManager($options['entity_manager'])
                                ->getMetadataFactory()
                                ->isTransient($configuration->getClass());
    }

    protected function getOptions(ConfigurationInterface $configuration)
    {
        return array_replace(array(
            'entity_manager' => null,
            'method' => null,
        ), $configuration->getOptions());
    }
}

I thought about four ways of using the DoctrineParamConverter:

1. A simple id request attribute.
2. Fields and associations of the entity, checked by the associated metadata.
3. Id with a prefix based on the given name of the action parameter, eg.: user_id
4. Fields and associations with a prefix like in version 3, eg.: user_group

I added an improvement on working with a defined reflection method.

The DoctrineParamConverter is now using reflections for guessing the values it has to pass to the defined method.

Eg.:

class UserRepository {

    public function findUserWithGroup($user, $group) {
         // Go, go - find it!
    }

}

When I now define findUserWithGroup as my custom method, the converter searches for the request attributes user and group - based on the parameter names - and calls the method with the given values.