Custom Collection "GET" Method - API Platform

Hi everyone,

I have an entity that i can get with the standard get operation (collection / or id one) :

/**
 * Insee
 *
 * @ApiResource(
 *     collectionOperations={"get"},
 *     itemOperations={"get"},
 *     attributes={
 *     }
 * )
 * @ApiFilter(SearchFilter::class, properties={"insCode": "exact", "insLibelle": "partial"})
 * @ORM\Table(name="dif_zonages.insee", indexes={@ORM\Index(name="FK_INSEE_CANTON", columns={"CAN_CODE"})})
 * @ORM\Entity
 */
class Insee
{

    /**
     * @var string
     *
     * @ORM\Column(name="INS_CODE", type="string", length=5, nullable=false)
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="IDENTITY")
     */
    private $insCode = '';

    /**
     * @var string|null
     *
     * @ORM\Column(name="INS_LIBELLE", type="string", length=254, nullable=true)
     */
    private $insLibelle;

    /**
     * @var float|null
     *
     * @ORM\Column(name="INS_LATITUDE", type="float", precision=10, scale=0, nullable=true, options={"comment"="Latitude de la commune (coordonnées géographiques)"})
     */
    private $insLatitude;

    /**
     * @var float|null
     *
     * @ORM\Column(name="INS_LONGITUDE", type="float", precision=10, scale=0, nullable=true, options={"comment"="Longitude de la commune (coordonnées géographiques)"})
     */
    private $insLongitude;

    /**
     * Constructor
     */
    public function __construct()
    {
        $this->insdCodeSource = new \Doctrine\Common\Collections\ArrayCollection();
    }

Etc .....

    /**
     * @return float|null
     */
    public function getInsLatitude(): ?float
    {
        return $this->insLatitude;
    }

    /**
     * @param float|null $insLatitude
     */
    public function setInsLatitude(?float $insLatitude): void
    {
        $this->insLatitude = $insLatitude;
    }

    /**
     * @return float|null
     */
    public function getInsLongitude(): ?float
    {
        return $this->insLongitude;
    }

    /**
     * @param float|null $insLongitude
     */
    public function setInsLongitude(?float $insLongitude): void
    {
        $this->insLongitude = $insLongitude;
    }

}

However, i want to add a custom "GET"opération so i can get a list of Insee object from 2 parameters : latitude and longitude. Can you help me what should i use? I saw that we can create Extension but the doc is very limited so…

Thanks in advance !

[yivi]

Would be nice to add an example of this in the documentation. Something that shows how a minimal implementation would loook like.

What this action should return (we know that on item_operation GET we can return either an entity or a Response, what should we return for a collection GET? A Doctrine collection? An array|\Traversable?

[simocheccoli]

Using only your DataProvider and your Entity with correct annotations should be enough. I use this without creating any special controller for this entity.

@foxsdev Any usefull example? I’have already try by tagging DataProvider (custom-collection-data-provider) but it’s doesn’t work as expected