Allow object to be passed in for query parameters about retrofit-php

[tonynelson19]

What were you thinking for this feature?

It would be awesome if you could support property paths, similar to the following:

/**
 * @GET("/search")
 * @Query("q", var="parameters.term")
 * @Query("sort", var="parameters.sort")
 * @Query("order", var="parameters.order")
 */
public function search(SearchParameters $parameters);

<?php

class SearchParameters
{
    /**
     * @return string
     */
    public function getTerm()
    {
        return $this->term;
    }

    /**
     * @return string
     */
    public function getSort()
    {
        return $this->sort;
    }

    /**
     * @return string
     */
    public function getOrder()
    {
        return $this->order;
    }

    // ...
}

The same could be applied to path parameters too.

/**
 * @GET("/users/{user.username}/list")
 */
public function listRepos(UserInterface $user);

[natebrunette]

I was thinking that it would be "serialized" and added to the query parameters.

[natebrunette]

In version 3, this can be handled using @QueryMap and passing in an iterable object.

/**
 * @GET("/search")
 * @QueryMap("parameters")
 */
public function search(SearchParameters $parameters): Call;

class SearchParameters implements IteratorAggregate
{
    private $query;
    private $sort;
    private $order;
    
    public function getIterator()
    {
        new ArrayIterator([
            'q' => $this->query,
            'sort' => $this->sort,
            'order' => $this->order,
        ]);
    }
}