Download the PHP package check24/apitk-manipulation-bundle without Composer

apitk-manipulation-bundle

API Toolkit Bundle to handle POST, PUT, PATCH and DELETE methods.

Installation

Install the package via composer:

Usage

Example Classes

See the example-Folder in this repository: https://github.com/alexdo/apitk-manipulation-bundle/tree/master/example

User entity

User FormType

Controller

Updating Entities (POST, PUT, PATCH)

Updating entites works by mapping request data to a form, validating it and then persisting the form's data to the Database via Doctrine.

You'll need:

• Doctrine Entity
• Form Type with data_class
• Controller Action

This will also auto-generate appropriate Swagger parameters. Usage of FOSRest bundle is optional. Controller methods look the same for POST and PUT.

The $user parameter is an already updated version of the requested User. You can do anything you want with it: Serialization, JSON encode, etc.

Internally, the Update annotation fetches the default EntityManager, gets the Repository and executes find($id) on it. You can customize this in three ways:

1. If you'd like to use a different ORM connection than default, supply it via entityManager:

   This will cause the annotation to fetch the repository and entity from the "custom" EntityManager.

2. If you'd like to use a different Repository method than find, use the methodName option:

3. If your path component is something different than id, eg. email, you can supply the parameter to use via the requestParam option:

Removing Entities (DELETE)

To remove an entity, add an action to your controller that uses the Delete-Annotation.

@Manipulation\Delete("id", entity=User::class)

• "id" is the name of the path-component to get the ID from
• entity=User::class is the type of the entity to be removed

The $response parameter is a HTTP 204-Response (No Content). You can just return it, or ignore it and build one of your own.

Delete will, by default, perform a hard delete by executing find($id) on UserRepository and then removing the Entity via ObjectManager::remove.

As with Update, you can customize this behaviour:

1. If you'd like to perform a soft delete or other things instead, use the methodName option:

   This will cause the Annotation to call DeleteRepository::deleteById(DeletionService $deletionService). The DeletionService allows you to access all request parameters. Perform anything you want to mark your Entity as deleted, eg. setting a deleted-Property from 0 to 1 and then flushing the EntityManager.

2. If you'd like to use a different ORM connection than default, supply it via entityManager:

   This will cause the annotation to operate against the "custom" EntityManager.