fxp/resource

Resource management layer for doctrine

v1.2.0 2019-03-26 19:25 UTC

README

Latest Version Build Status Coverage Status Scrutinizer Code Quality SensioLabsInsight

The Fxp Resource is a resource management layer for doctrine. This library has been designed to facilitate the creation of a Batch API for processing a list of resources1 (ex. external data loader).

However, it is entirely possible to build an API Bulk above this library.

It allows to easily perform actions on Doctrine using the best practices automatically according to selected options (flush for each resource or for all resources, but also skip errors of the invalid resources), whether for a resource or set of resources.

Features include:

  • Resource Domain Manager for get a resource domain for an doctrine resource
  • Resource Domain for each doctrine resource for easy management:
    • generate new instance of resource with default value configured by Fxp Default Value
    • create one resource with validation (for object or Form instance)
    • create a list of resources with validation for each resource (for object or Form instance)
    • update one resource with validation (for object or Form instance)
    • update a list of resources with validation for each resource (for object or Form instance)
    • upsert one resource with validation (create or update for object or Form instance)
    • upsert a list of resources with validation for each resource (create or update for object or Form instance)
    • delete one resource with soft delete or hard delete for compatible resources
    • delete a list of resources with soft delete or hard delete for compatible resources
    • undelete one resource for compatible resources with soft delete
    • undelete a list of resources for compatible resources with soft delete
  • Each resource domain allow:
    • to have the possibility to do an transaction with rollback for each resource of the list or for all resources in only one time
    • to have the possibility to skip the errors of an resource, and continue to run the rest of the list (compatible only with the transaction for each resource)
    • to return the list of resources with the status of the action (created, updated, error ...) on each resource of the list
  • Request content converter:
    • JSON converter
  • Form handler to work with Symfony Form

Note: 1 A resource is an doctrine entity or doctrine document

Documentation

The bulk of the documentation is stored in the Resources/doc/index.md file in this library:

Read the Documentation

Installation

All the installation instructions are located in documentation.

License

This library is under the MIT license. See the complete license in the library:

LICENSE

About

Fxp Resource is a François Pluchino initiative. See also the list of contributors.

Reporting an issue or a feature request

Issues and feature requests are tracked in the Github issue tracker.