lambelcebur-doctrine-orm-fast-api
Quickly create an automatic API CRUD with your Doctrine ORM connection
See
Installation
Installation of this module uses composer. For composer documentation, please refer to getcomposer.org.
composer require lambelcebur/doctrine-orm-fast-apiThen add LamBelcebur\DoctrineORMFastApi to your config/application.config.php
How to use?
LamBelcebur\DoctrineORMFastApi\Controller\IndexController extends AbstractRestfulController and provide the automatic code to all methods.
- All views return a JsonModel
Config your custom route, by default /bapi
[
return [
...other configs
'LamBelcebur\DoctrineORMFastApi' => [
'route' => [
'bapi' => [
'type' => \Laminas\Router\Http\Literal::class,
'options' => [
'route' => '/my-custom-url',
],
],
],
],
];
]Get available api's
- go to url
/bapi
get list
- go to url
/bapi/entity-name
get list
- get EntityManager or Paginator Object from route params
<?php
/** @var JsonModel $exchangeMessagesJsonView */
use Laminas\View\Model\JsonModel;use LamBelcebur\DoctrineORMFastApi\Controller\IndexController;$exchangeMessagesJsonView = $this->forward()->dispatch(IndexController::class, [
'entity' => YourEntity::class,
'options' => [
'paginator' => true, //set paginator object in return
'entityManager' => true, //set entityManager in return
'hydrate' => false, //set items like objects in return
],
]);get list with filter
- go to url
/bapi/entity-name?propertyOrRelationName=propertyOrRelationValue- To filter with a boolean you need to convert to an integer
- /bapi/product?enable=1
- /bapi/product?enable=1&family=7
Get
- Do a GET requesto to url
/bapi/entity-name/identifierValue- /bapi/product/25687
Update
- Do a PUT request to url
/bapi/entity-name/identifierValue- PUT -> /bapi/product/25687
Create
- Do a POST request to url
/bapi/entity-name/identifierValue- POST -> /bapi/product/25687
DELETE
- Do a DELETE request to url
/bapi/entity-name/identifierValue- DELETE -> /bapi/product/25687
Form validation
- If you need to validate data with a ZendForm just add the formName to the url to get it from the FormElementManager
- /bapi/product/25687/my-form-name
Naming strategy
[
return [
...other configs
'LamBelcebur\DoctrineORMFastApi' => [
'naming_strategy' => DashNamingStrategy::class,
],
];
]Add new strategies
- You can add other strategies by fieldName, fieldType, or relation.
Examples
- First Add your strategies by type or by name in your config file
[
'LamBelcebur\DoctrineORMFastApi' => [
'hydrator-value-strategy-by-type' => [
'datetime' => \Laminas\Hydrator\Strategy\DateTimeFormatterStrategy::class,
],
'hydrator-value-strategy-by-name' => [
'languages' => \Laminas\Hydrator\Strategy\ExplodeStrategy::class,
],
...other configs
]
]- Remove the
reflection-file-pathfile to regenerate configuration. By Defaultgetcwd() . '/config/autoload/lambelcebur-doctrine-orm-fast-api.global.php'
Custom extract function
- use
\LamBelcebur\DoctrineORMFastApi\Resource\DoctrineORMFastApiInterfacein your entity to implements your custom method
namespace LamBelcebur\DoctrineORMFastApi\Resource;
use Doctrine\ORM\EntityManager;
use Laminas\Hydrator\HydratorInterface;
interface DoctrineORMFastApiInterface
{
public function toDoctrineORMFastApi(EntityManager $em,HydratorInterface $hydrator): array;
}
Default Config
return [
__NAMESPACE__ => [
'reflection-file-path' => getcwd() . '/config/autoload/lambelcebur-doctrine-orm-fast-api.global.php',
'naming_strategy' => DashNamingStrategy::class,
'strategies' => [
EntityStrategy::class => EntityStrategy::class,
CollectionStrategy::class => CollectionStrategy::class,
],
'reflection-table' => [],
'hydrator-relation-strategy' => [
ClassMetadata::MANY_TO_ONE => EntityStrategy::class,
ClassMetadata::ONE_TO_ONE => EntityStrategy::class,
ClassMetadata::ONE_TO_MANY => CollectionStrategy::class,
ClassMetadata::MANY_TO_MANY => CollectionStrategy::class,
],
'hydrator-value-strategy-by-type' => [
//'datetime' => DateTimeFormatterStrategy::class,
],
'hydrator-value-strategy-by-name' => [
//'languages' => ExplodeStrategy::class,
//'defaultLocale' => ExplodeStrategy::class,
],
'hydrator-value-strategy-by-class' => [],
'route' => [
__NAMESPACE__ => [
'type' => Literal::class,
'options' => [
'route' => '/bapi',
'defaults' => [
'controller' => IndexController::class,
],
],
'may_terminate' => true,
'child_routes' => [
'entity' => [
'type' => Segment::class,
'options' => [
'route' => '/:entity[/:id][/:form]',
'constraints' => [
'entity' => '[a-zA-Z0-9-]+',
'form' => '[a-zA-Z0-9-]+',
'id' => '[a-zA-Z0-9-]+',
],
'defaults' => [
'form' => null,
],
],
],
],
],
],
],
'controllers' => [
'factories' => [
IndexController::class => IndexControllerFactory::class,
],
],
];