Allow iterating over a collection to generate links

[baldurrensch]

We should be able to generate links off of collections, so you would specify a parameter to create a link for each element in that array.

For example, you have an array of authors, and you want to generate a link for each author

/**
 * @Rest\Relation("self",      
 *   href = @Rest\Route("author", collection_parameters = { "id" = ".author[].id" }))
 */

[adrienbrault]

What about something like

@RelationCollection(
    @Relation("author", href = @Route("user_get", "parameters" = { "id" = "id" })),
    "property" = "author"
)

or

@Relations(
    @Relation("author", href = @Route("user_get", "parameters" = { "id" = "id" })),
    "property" = "author"
)

[baldurrensch]

Yeah. I like that. Now, the problem is: The id is with respect to author. What if you want to have a variable with respect to your parent object?

[stof]

If you don't have a way to access the parent object from this object, there is no way to build a property path for it (or to retrieve the value when the tool has your object)

[baldurrensch]

No, I think I wasn't clear in my previous comment. Let me give you an example:

/**
 * @Relations(
 *     @Relation("author", href = @Route("author", 
 *       "parameters" = { "bookId" = "id", "authorId" = "id" })),
 *       "property" = "author"
 * )
 */
class Book
{
    private $id;
    private $authors; // That's the collection
}

How do you now distinguish between taking the id of Book, versus the id of Author?

[adrienbrault]

You traverse the graph back:

/**
 * @Relations(
 *     @Relation("author", href = @Route("author", 
 *       "parameters" = { "bookId" = "book.id", "authorId" = "id" })),
 *       "property" = "author"
 * )
 */
class Book
{
    private $id;
    private $authors; // That's the collection
}

[baldurrensch]

If that actually exists, or, something like this:

/**
 * @Relations(
 *     @Relation("author", href = @Route("author", 
 *       "parameters" = { "bookId" = "id" })),
 *       "property" = { "author" = { "authorId" = "id" } }
 * )
 */
class Book
{
    private $id;
    private $authors; // That's the collection
}

[cblegare]

One year later, ping ?

[adrienbrault]

I would advise to use the new hateoas library : https://github.com/willdurand/Hateoas/blob/master/tests/Hateoas/Tests/Fixtures/AdrienBrault.php#L56-L61