http.md

Utilisation d'un CRUD avec une API HTTP

Exemple avec l'API Opendatasoft Correspondance Code INSEE - Code Postal :

<?php
//src/Controller/MyHttpController
namespace App\Controller;

use App\Form\Searcher\CitySearcher;
use Ecommit\CrudBundle\Controller\AbstractCrudController;
use Ecommit\CrudBundle\Crud\Crud;
use Ecommit\CrudBundle\Crud\Http\QueryBuilder;
use Ecommit\CrudBundle\Crud\Http\QueryBuilderQueryParameter;
use Ecommit\Paginator\ArrayPaginator;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Contracts\HttpClient\HttpClientInterface;

class MyHttpController extends AbstractCrudController
{
    protected getCrudOptions(): array
    {
        /*
         * Demo de l'API : http://public.opendatasoft.com/api/records/1.0/search?dataset=correspondance-code-insee-code-postal&q=annecy
         *
         * Voir https://public.opendatasoft.com/explore/dataset/correspondance-code-insee-code-postal/api/
         *
         * L'API REST nous retourne un JSON
         * Propriétés qui nous intéressent :
         *      nhits (nombre de résultats trouvés)
         *      records (résultats trouvés)
         *          Pour chaque résultat trouvé :
         *              fields.nom_comm (nom de la ville)
         *              fields.postal_code (code postal)
         *              population (population)
         *              record_timestamp (timestamp de l'enregistrement)
         */

        //Création du QueryBuilder
        //Définition de l'URL REST, appelée en GET
        $queryBuilder = new QueryBuilder('http://public.opendatasoft.com/api/records/1.0/search', 'GET', $this->get(HttpClientInterface::class));

        /*
         * Définition du paramètre "dataset" ajouté en GET à la requête.
         *
         * A différents moments (dans cette méthode et dans la classe du formulaire de recherche), on peut modifier l'objet $queryBuilder :
         *
         * Pour ajouter des éléments à la requête HTTP, on peut appeler la méthode "addParameter" en lui passant en paramètre
         * une instance de l'une des classes suivantes :
         *      Ecommit\CrudBundle\Crud\Http\QueryBuilderQueryParameter : Paramètre passé en GET (query)
         *      Ecommit\CrudBundle\Crud\Http\QueryBuilderBodyParameter : Paramètre passé dans le body
         *      Ecommit\CrudBundle\Crud\Http\QueryBuilderBody : Paramètre unique (sans nom) passé dans le body
         *      Ecommit\CrudBundle\Crud\Http\QueryBuilderHeaderParameter : Paramètre passé dans l'entête
         *
         * La méthode "setBodyIsJson" peut être appelée pour définir une requête au format JSON.
         */
        $queryBuilder->addParameter(new QueryBuilderQueryParameter('dataset', 'correspondance-code-insee-code-postal'));

        //FACULTATIF - Ajout dans la requête HTTP la gestion de la pagination
        $queryBuilder->setPaginationBuilder(function (QueryBuilder $queryBuilder, $page, $resultsPerPage): void {
            $start = ($page - 1) * $resultsPerPage;

            $queryBuilder->addParameter(new QueryBuilderQueryParameter('rows', $resultsPerPage));
            $queryBuilder->addParameter(new QueryBuilderQueryParameter('start', $start));
        });

        //FACULTATIF - Ajout dans la requête HTTP la gestion du tri
        $queryBuilder->setOrderBuilder(function (QueryBuilder $queryBuilder, $orders): void {
            foreach ($orders as $sort => $sortDirection) {
                $sortDirectionParameter = ($sortDirection === Crud::ASC)? '-' : '';
                $queryBuilder->addParameter(new QueryBuilderQueryParameter('sort', $sortDirection.$sort));
            }
        });

        $crudConfig = $this->createCrudConfig('my_http_crud');
        $crudConfig->addColumn(['id' => 'name', 'alias' => 'fields.nom_comm', 'label' => 'Nom', 'sortable' => false])
            ->addColumn(['id' => 'postal_code', 'alias' =>  'fields.postal_code', 'label' =>  'Postal code', 'sortable' => false])
            ->addColumn(['id' => 'population', 'alias' =>  'fields.population', 'label' =>  'Population', 'alias_sort' => 'population'])
            ->addColumn(['id' => 'timestamp', 'alias' =>  'record_timestamp', 'label' =>  'Timestamp', 'sortable' => false])
            ->setQueryBuilder($queryBuilder)
            ->setMaxPerPage([2, 5, 10], 5)
            ->setDefaultSort('population', Crud::DESC)
            ->setRoute('my_http_crud_ajax')
            ->setBuildPaginator(function (QueryBuilder $queryBuilder, $page, $resultsPerPage) {
                //Appel HTTP + décode du JSON de la réponse
                $response = json_decode($queryBuilder->getResponse($page, $resultsPerPage)->getContent());

                //Création du paginator
                $paginator = new ArrayPaginator([
                    'page' => $page,
                    'max_per_page' => $resultsPerPage,
                    'data' => $response->records,
                    'count' => $response->nhits,
                ]);

                return $paginator;
            })
            ->createSearchForm(new CitySearcher())
            ->setPersistentSettings(true);

        return $crudConfig->getOptions();
    }

    protected function getTemplateName(string $action): string
    {
        return sprintf('my_http_crud/%s.html.twig', $action);
    }

    /**
     * @Route("/my-http-crud", name="my_http_crud")
     */
    public function crudAction()
    {
        return $this->getCrudResponse();
    }

    /**
     * @Route("/my-http-crud/ajax", name="my_http_crud_ajax")
     */
    public function ajaxCrudAction()
    {
        return $this->getAjaxCrudResponse();
    }

    public static function getSubscribedServices()
    {
        return array_merge(parent::getSubscribedServices(), [
            HttpClientInterface::class,
        ]);
    }
}

<?php
//src/Form/Searcher/CitySearcher
namespace App\Form\Searcher;

use Ecommit\CrudBundle\Crud\Http\QueryBuilderQueryParameter;
use Ecommit\CrudBundle\Crud\SearchFormBuilder;
use Ecommit\CrudBundle\Form\Searcher\AbstractSearcher;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Validator\Constraints as Assert;

class CitySearcher extends AbstractSearcher
{
    /**
     * @Assert\Length(max=50)
     */
    public $text;

    public function buildForm(SearchFormBuilder $builder, array $options): void
    {
        //Ajout d'un champ de recherche

        $builder->addField('text', TextType::class, [
            'label' => 'Query',
            'required' => false,
        ]);
    }

    public function updateQueryBuilder(mixed $queryBuilder, array $options): void
    {
        //Traitement de la recherche

        if (null !== $this->text && is_scalar($this->text)) {
            $queryBuilder->addParameter(new QueryBuilderQueryParameter('q', $this->text));
        }
    }
}