Deeply nested subresources management #7068

ytilotti · 2025-04-07T16:58:07Z

ytilotti
Apr 7, 2025

I’m trying to manage level 3 sub-resources. I’m having trouble finding a solution.

The context with this 3 files:

// Company.php
namespace App\Entity;

use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use App\Repository\CompanyRepository;
use Doctrine\ORM\Mapping as ORM;

#[ORM\Entity(repositoryClass: CompanyRepository::class)]
#[ApiResource(
    operations: [
        new GetCollection(),
        new Get(),
    ],
)]
class Company
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    private ?int $id = null;

    #[ORM\Column]
    private ?string $name;
    
    #[ORM\OneToMany(mappedBy: 'company', targetEntity: CompanyEmployee::class)]
    private $employees

    #...
}

// CompanyEmployee.php
namespace App\Entity;

use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\Link;
use App\Repository\CompanyEmployeeRepository;
use Doctrine\ORM\Mapping as ORM;

#[ORM\Entity(repositoryClass: CompanyEmployeeRepository::class)]
#[ApiResource(
    operations: [
        new GetCollection(
            uriTemplate: '/company/{id}/employee',
            uriVariables: [
                'id' => new Link(fromClass: Company::class, toProperty: 'company'),
            ],
        ),
        new Get(
            uriTemplate: '/company/{id}/employee/{employeeId}',
            uriVariables: [
                'id' => new Link(fromClass: Company::class, toProperty: 'company'),
                'employeeId' => new Link(fromClass: CompanyEmployee::class),
            ],
        ),
    ],
)]
class CompanyEmployee
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    private ?int $id = null;

    #[ORM\ManyToOne(inversedBy: 'employees')]
    private ?Company $company;
    
    #[ORM\OneToMany(mappedBy: 'employee', targetEntity: CompanyEmployeeTask::class)]
    private $tasks

    #...
}

// CompanyEmployeeTasks.php
namespace App\Entity;

use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\Get;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\Link;
use App\Repository\CompanyEmployeeTaskRepository;
use Doctrine\ORM\Mapping as ORM;

#[ORM\Entity(repositoryClass: CompanyEmployeeTaskRepository::class)]
#[ApiResource(
    operations: [
        new GetCollection(
            uriTemplate: '/company/{id}/employee/{employeeId}/task',
            uriVariables: [
                'id' => new Link(fromClass: Company::class, /* What I can add ?*/),
                'employeeId' => new Link(fromClass: CompanyEmployee::class, toProperty: 'employee'),
            ],
        ),
        new Get(
            uriTemplate: '/company/{id}/employee/{employeeId}/task/{taskId}',
            uriVariables: [
                'id' => new Link(fromClass: Company::class, /* What I can add ?*/),
                'employeeId' => new Link(fromClass: CompanyEmployees::class, toProperty: 'employee'),
                'taskId' => new Link(fromClass: CompanyEmployeeTask::class),
            ],
        ),
    ],
)]
class CompanyEmployeeTask
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    private ?int $id = null;

    #[ORM\ManyToOne(inversedBy: 'tasks')]
    private ?Employee $employee;

    #...
}

What params I need to add in the third file (CompanyEmployeeTasks.php) to manage the Company?
It's not possible to do this nesting?

I can manage the collection of CompanyEmployeeTask with a:

stateOptions: new Options(handleLinks: CompanyLinkHandler::class),

But the IRI of the Get can't be generated with this e 10000 rror:
Unable to generate an IRI for the item of type "App\\Entity\\CompanyEmployeeTask"

In first I write on CompanyEmployeeTask:

uriVariables: [
    'id' => new Link(fromClass: Company::class, toProperty: 'company'),
    'employeeId' => new Link(fromClass: CompanyEmployees::class, toProperty: 'employee'),
    'taskId' => new Link(fromClass: CompanyEmployeeTask::class),
    ],

But I have the logic error:
Can't get a way to read the property "company" in class "App\\Entity\\CompanyEmployeeTask"

If anyone have more informations, it can be a pleasure!

soyuka · 2025-04-08T09:29:46Z

soyuka
Apr 8, 2025
Maintainer

When its too complicated to use links (we can't cover all use cases) use:

https://api-platform.com/docs/guides/handle-links/

0 replies

ytilotti · 2025-04-08T10:04:15Z

ytilotti
Apr 8, 2025
Author

Yes @soyuka I used it. I found a solution on the third file, but not understand why works!

    uriTemplate: '/company/{id}/employee/{employeeId}/tasks',
    uriVariables: [
        'id' => new Link(fromClass: Company::class, toProperty: 'employee', security: "is_granted('manage', employee)"),
        'employeeId' => new Link(fromClass: CompanyEmployee::class, toProperty: 'employee'),
    ],
    stateOptions: new Options(handleLinks: [CompanyEmployeeTask::class, 'handleLinks']),

public static function handleLinks(QueryBuilder $queryBuilder, array $uriVariables, QueryNameGeneratorInterface $queryNameGenerator, array $context): void
    {
        $queryBuilder
            ->join($queryBuilder->getRootAliases()[0].'.employees', 'e')
            ->andWhere('e.company = :companyId')
            ->andWhere('e.id = :employeeId')
            ->setParameter('companyId', $uriVariables['id'])
            ->setParameter('employeeId', $uriVariables['employeeId'])
        ;
    }

This is very strange to use employee on this level
'id' => new Link(fromClass: Company::class, toProperty: 'employee', security: "is_granted('manage', employee)"),

2 replies

soyuka Apr 8, 2025
Maintainer

When you use handle links at least you can do exactly what you want, you can then use uriVariables: ['id', 'employeeId']

ytilotti Apr 8, 2025
Author

If you have only uriVariables: ['id', 'employeeId'] you can't generate IRI and manage security.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deeply nested subresources management #7068

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 2 comments 2 replies

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

Select a reply

Deeply nested subresources management #7068

ytilotti Apr 7, 2025

Replies: 2 comments · 2 replies

soyuka Apr 8, 2025 Maintainer

ytilotti Apr 8, 2025 Author

soyuka Apr 8, 2025 Maintainer

ytilotti Apr 8, 2025 Author

ytilotti
Apr 7, 2025

Replies: 2 comments 2 replies

soyuka
Apr 8, 2025
Maintainer

ytilotti
Apr 8, 2025
Author

soyuka Apr 8, 2025
Maintainer

ytilotti Apr 8, 2025
Author