Symfony2 REST bundle : Filter Parameter

Question

How i do to get resource based on filter parameter :

As Example : .../api/book?author=X

If an complete example i will be happy !

Ahmed Siouani · Accepted Answer · 2014-04-24 09:48:23Z

6

Based on FOSRestBundle, you can use QueryParam annotation and ParamFetcher as follow,

use FOS\RestBundle\Controller\FOSRestController;
// ...
use FOS\RestBundle\Request\ParamFetcher;
use FOS\RestBundle\Controller\Annotations\QueryParam;

class BookController extends FOSRestController
{
    /**
     *
     * @QueryParam(name="author", description="the author of the book")
     */
    public function getBookAction(ParamFetcher $paramFetcher)
    {
         $author = $paramFetcher->get('author'); // Can then be used to filter books on author

         // do something ...
    }

requirements,

You've to enable the param fetcher listener by adding param_fetcher_listener: true in the bundle's configuration in your app/config/config.yml file.

edited Apr 24, 2014 at 9:48

answered Apr 24, 2014 at 9:15

Ahmed Siouani

13.9k12 gold badges63 silver badges73 bronze badges

Sign up to request clarification or add additional context in comments.

6 Comments

Human Over a year ago

i m looking to use it with handler.. it's right ?

public function getActualitesAction(Request $request, ParamFetcherInterface $paramFetcher)     {         $offset = $paramFetcher->get('offset');         $offset = null == $offset ? 0 : $offset;         $limit = $paramFetcher->get('limit');         $ville = $paramFetcher->get('ville');          return $this->container->get('genius_profile.actualite.handler')->all($limit, $offset,$ville);     }

Human Over a year ago

handler part :

public function all($limit = 5, $offset = 0,$ville)     {         return $this->repository->findBy(array(), null, $limit, $offset,$ville);     }

Ahmed Siouani Over a year ago

Yep, the idea looks good as it helps you keep your controllers short and readable. You may also consider using the requirements and the default options of the QueryParam annotation.

Human Over a year ago

i haved tryed my method with

public function all($limit = 5, $offset = 0,$ext)     {         return $this->repository->findBy(array(), null, $limit, $offset,$ext);     }

but did not work :/

user986408 Over a year ago

Is there no out-of-the-box solution to automatically create filters for all entity fields?

|

Collectives™ on Stack Overflow

Symfony2 REST bundle : Filter Parameter

1 Answer 1

6 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

6 Comments

Your Answer

Sign up or log in

Post as a guest

Related