Guides
Provide the Resource State
September 19-20, 2024 | Lille & online
The international conference on the API Platform Framework
Get ready for game-changing announcements for the PHP community!
The API Platform Conference 2024 is happening soon, and it's close to selling out.
API Platform 4, Caddy web server, Xdebug, AI... Enjoy two days of inspiring talks with our friendly community and our amazing speakers.
Guide
Provide the Resource State
design
state
Our model is the same then in the previous guide (Declare a Resource. API Platform will declare
CRUD operations if we don’t declare them.
// src/App/ApiResource.php
namespace App\ApiResource;
use ApiPlatform\Metadata\ApiResource;
use App\State\BookProvider;
#[ApiResource(provider: BookProvider::class)]
class Book
{
public string $id;
}
// src/App/State.php
namespace App\State;
use ApiPlatform\Metadata\CollectionOperationInterface;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\State\ProviderInterface;
use App\ApiResource\Book;
final class BookProvider implements ProviderInterface
{
public function provide(Operation $operation, array $uriVariables = [], array $context = []): iterable|object|null
{
if ($operation instanceof CollectionOperationInterface) {
$book = new Book();
$book->id = '1';
/* $book2 = new Book();
* $book2->id = '2'; */
return [$book/* $book2 */];
}
$book = new Book();
$book->id = $uriVariables['id'];
return $book;
}
}
// src/App/Playground.php
namespace App\Playground;
use Symfony\Component\HttpFoundation\Request;
function request(): Request
{
return Request::create('/books.jsonld', 'GET');
}
