JobDataProvider

Author: Aymeric Ratinaud

README.md

@@ -12,6 +12,7 @@ Inspired by https://github.com/api-platform/demo
 - [Sixth example use FurnitureDataProvider (collectionDataProvider)] https://github.com/aratinau/api-platform-pagination#sixth-example-use-FurnitureDataProvider-(collectionDataProvider)
 - [Seventh example use QueryBuilder in subresource] 
 - [Eight example use QueryBuilder in subresource] https://github.com/aratinau/api-platform-pagination#eight-example-use-QueryBuilder-in-subresource
+- [Ninth use custom subresource with provider (without subresourceDataProvider)] https://github.com/aratinau/api-platform-pagination#ninth-example---custom-subresource-with-provider-(without-subresourceDataProvider)
 
 
 ## First Example use raw data from a csv file
@@ -98,7 +99,9 @@ Basic example showing how use and configure CollectionDataProvider
 
 ## Seventh example : simple DataProvider using subresourceDataProvider
 
-CommentSubresourceDataProvider show how use the standard behaviour 
+CommentSubresourceDataProvider show how use the standard behaviour
+
+### Usage
 
 `api/movies/{id}/comments`
 
@@ -110,6 +113,16 @@ DiscussionSubresourceDataProvider show how use QueryBuilder and order by DESC th
 
 `api/discussions/{id}/messages?page=1`
 
+## Ninth example - custom subresource with provider (without subresourceDataProvider)
+
+With JobDataProvider and path `jobs/{id}/employees` return employees from id's job
+
+[ ] TODO Pagination
+
+### Usage
+
+`api/jobs/{id}/employees`
+
 ## Install
 
     composer install

config/services.yaml

@@ -37,3 +37,7 @@ services:
     App\DataProvider\FurnitureDataProvider:
         bind:
             $collectionDataProvider: '@api_platform.doctrine.orm.default.collection_data_provider'
+
+    App\DataProvider\JobDataProvider:
+        bind:
+            $itemDataProvider: '@api_platform.doctrine.orm.default.item_data_provider'

fixtures/employee.yaml

@@ -0,0 +1,3 @@
+App\Entity\Employee:
+    employee_{1..1000}:
+        author: <name()>

fixtures/job.yaml

@@ -1,4 +1,5 @@
 App\Entity\Job:
-    job_{1..1000}:
+    job_{1..100}:
         name: <word(10, 700)>
         isPublished: '<numberBetween(0, 1)>'
+        employees: '<numberBetween(100, 200)>x @employee*'

src/DataProvider/JobDataProvider.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\DataProvider;
+
+use ApiPlatform\Core\DataProvider\DenormalizedIdentifiersAwareItemDataProviderInterface;
+use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
+use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
+use App\Entity\Job;
+
+final class JobDataProvider implements RestrictedDataProviderInterface, DenormalizedIdentifiersAwareItemDataProviderInterface
+{
+    private $itemDataProvider;
+
+    public function __construct(ItemDataProviderInterface $itemDataProvider)
+    {
+        $this->itemDataProvider = $itemDataProvider;
+    }
+
+    public function supports(string $resourceClass, string $operationName = null, array $context = []): bool
+    {
+        return
+            $resourceClass === Job::class &&
+            $operationName === "custom-subresource-job-employees"
+        ;
+    }
+
+    public function getItem(string $resourceClass, $id, string $operationName = null, array $context = [])
+    {
+        $itemDataProvider = $this->itemDataProvider->getItem($resourceClass, $id, $operationName, $context);
+
+        return $itemDataProvider->getEmployees()->getValues();
+    }
+}

src/Entity/Employee.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace App\Entity;
+
+use ApiPlatform\Core\Annotation\ApiResource;
+use App\Repository\EmployeeRepository;
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Serializer\Annotation\Groups;
+
+/**
+ * @ApiResource()
+ * @ORM\Entity(repositoryClass=EmployeeRepository::class)
+ */
+class Employee
+{
+    /**
+     * @ORM\Id
+     * @ORM\GeneratedValue
+     * @ORM\Column(type="integer")
+     * @Groups({"normalization-custom-subresource-job-employees"})
+     */
+    private $id;
+
+    /**
+     * @ORM\Column(type="string", length=255)
+     * @Groups({"normalization-custom-subresource-job-employees"})
+     */
+    private $author;
+
+    /**
+     * @ORM\ManyToOne(targetEntity=Job::class, inversedBy="employees")
+     * @ORM\JoinColumn(nullable=false)
+     */
+    private $job;
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function getAuthor(): ?string
+    {
+        return $this->author;
+    }
+
+    public function setAuthor(string $author): self
+    {
+        $this->author = $author;
+
+        return $this;
+    }
+
+    public function getJob(): ?Job
+    {
+        return $this->job;
+    }
+
+    public function setJob(?Job $job): self
+    {
+        $this->job = $job;
+
+        return $this;
+    }
+}

src/Entity/Job.php

@@ -4,11 +4,23 @@
 
 use ApiPlatform\Core\Annotation\ApiResource;
 use App\Repository\JobRepository;
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Serializer\Annotation\Groups;
 
 /**
  * @ApiResource(
- *     attributes={"pagination_enabled"=true}
+ *     attributes={"pagination_enabled"=true},
+ *     itemOperations={
+ *          "get",
+ *          "custom-subresource-job-employees"={
+ *              "method"="GET",
+ *              "deserialize"=false,
+ *              "path"="/jobs/{id}/employees",
+ *              "normalization_context"={"groups" = "normalization-custom-subresource-job-employees"}
+ *          }
+ *      }
  * )
  * @ORM\Entity(repositoryClass=JobRepository::class)
  */
@@ -18,19 +30,33 @@ class Job
      * @ORM\Id
      * @ORM\GeneratedValue
      * @ORM\Column(type="integer")
+     * @Groups({"normalization-custom-subresource-job-employees"})
      */
     private $id;
 
     /**
      * @ORM\Column(type="string", length=255)
+     * @Groups({"normalization-custom-subresource-job-employees"})
      */
     private $name;
 
     /**
      * @ORM\Column(type="boolean")
+     * @Groups({"normalization-custom-subresource-job-employees"})
      */
     private $isPublished;
 
+    /**
+     * @ORM\OneToMany(targetEntity=Employee::class, mappedBy="job")
+     * @Groups({"normalization-custom-subresource-job-employees"})
+     */
+    private $employees;
+
+    public function __construct()
+    {
+        $this->employees = new ArrayCollection();
+    }
+
     public function getId(): ?int
     {
         return $this->id;
@@ -58,4 +84,34 @@ public function setIsPublished(bool $isPublished): self
 
         return $this;
     }
+
+    /**
+     * @return Collection|Employee[]
+     */
+    public function getEmployees(): Collection
+    {
+        return $this->employees;
+    }
+
+    public function addEmployee(Employee $employee): self
+    {
+        if (!$this->employees->contains($employee)) {
+            $this->employees[] = $employee;
+            $employee->setJob($this);
+        }
+
+        return $this;
+    }
+
+    public function removeEmployee(Employee $employee): self
+    {
+        if ($this->employees->removeElement($employee)) {
+            // set the owning side to null (unless already changed)
+            if ($employee->getJob() === $this) {
+                $employee->setJob(null);
+            }
+        }
+
+        return $this;
+    }
 }

src/Repository/EmployeeRepository.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace App\Repository;
+
+use App\Entity\Employee;
+use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
+use Doctrine\Persistence\ManagerRegistry;
+
+/**
+ * @method Employee|null find($id, $lockMode = null, $lockVersion = null)
+ * @method Employee|null findOneBy(array $criteria, array $orderBy = null)
+ * @method Employee[]    findAll()
+ * @method Employee[]    findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null)
+ */
+class EmployeeRepository extends ServiceEntityRepository
+{
+    public function __construct(ManagerRegistry $registry)
+    {
+        parent::__construct($registry, Employee::class);
+    }
+
+    // /**
+    //  * @return Employee[] Returns an array of Employee objects
+    //  */
+    /*
+    public function findByExampleField($value)
+    {
+        return $this->createQueryBuilder('e')
+            ->andWhere('e.exampleField = :val')
+            ->setParameter('val', $value)
+            ->orderBy('e.id', 'ASC')
+            ->setMaxResults(10)
+            ->getQuery()
+            ->getResult()
+        ;
+    }
+    */
+
+    /*
+    public function findOneBySomeField($value): ?Employee
+    {
+        return $this->createQueryBuilder('e')
+            ->andWhere('e.exampleField = :val')
+            ->setParameter('val', $value)
+            ->getQuery()
+            ->getOneOrNullResult()
+        ;
+    }
+    */
+}