awwar/symfony-http-entity-manager

Doctrine-like http client

2.0.0-rc 2023-10-28 17:20 UTC

Requires

• php: ^8.0
• awwar/php-http-entity-manager: 1.0.0-rc
• symfony/config: ~5.4|^6.0
• symfony/dependency-injection: ~5.4|^6.0
• symfony/finder: ~5.4|^6.0
• symfony/http-client-contracts: ^2.0|^3.0
• symfony/http-kernel: ~5.4|^6.0

MIT

README

A library that allows you to work with external APIs in the same way that a Symfony Doctrine ORM works with databases.

for example:

$users = $this->httpEntityManager->getRepository(User::class);
$admins = $this->httpEntityManager->getRepository(Admin::class);

$sasha = $users->find(124);
$alex = $admins->filterOne(['filter' => ['specialization' => 'cinema']]);

$deal = Deal::create($sasha, $alex, "buying a movie ticket", 30);

$sasha->getDeals()->add($deal);

$alex->setSpecialization('cinema');

$this->httpEntityManager->persist($deal);
$this->httpEntityManager->flush();

real requests:

# get customer
curl --request GET \
  --url 'https://api.mysite.com/users/124'
  
# get responsible
curl --request GET \
  --url 'https://api.mysite.com/admins?filter[specialization]=cinema'
  
# create deal
curl --request POST \
  --url https://api.mysite.com/deals/ \
  --data '{
    "amount": 30,
    "title": "buying a movie ticket",
    "relations": [
       {"name": "customer", "id": 124}
       {"name": "responsible", "id": 555}
    ]
'

# add created deal to customer
curl --request PATCH \
  --url https://api.mysite.com/users/124 \
  --data '{
    "relations": [
       {"name": "deal", "id": 322}
    ]
'

As we can see, all the changes were applied in the right order, and the changes by Alex did not apply at all, because we didn't change the value of his specialization. All thanks to UnitOfWork, which tracks changes and executes them in the right sequence and does not allow unnecessary changes that could affect system performance.

Looks simple? See more!

• Setup
• Annotations
• Examples of use

ToDo:

1. Implement work with formats other than "json"
2. When deleting a connection with an entity, a request to delete this relation is not sent
3. Late proxying. If there is a custom entity, and it has a collection of deals, to get a collection of proxy deals, you need to pass at least an array of their IDs. However, it is known about such api where the user can be obtained via GET /users/123 and his deals via GET /users/123/deals. To do this, you need to implement late proxying.