rin-project/fast-crud

Make CRUD Very Simple! (NOT FINISHED, COMING SOON!)

v0.1.0 2020-08-09 16:55 UTC

Requires

• php: ^7.1.3
• ext-ctype: *
• ext-iconv: *
• knplabs/knp-paginator-bundle: ^5.2
• nelmio/api-doc-bundle: ^3.6
• sensio/framework-extra-bundle: ^5.5
• symfony/dotenv: 5.1.*
• symfony/flex: ^1.3.1
• symfony/framework-bundle: 5.1.*
• symfony/yaml: 5.1.*

Conflicts

• symfony/symfony: *

MIT

• Rin Peng

• symfony
• Fast CRUD

README

Lets Make CRUD Very Simple! If you have any funny ideas, write issues.

Prerequisites

• PHP 7.1.3 or higher
• Symfony 5.0 or higher

Testing Environment

• Mac OSX 10.15 Catalina
• PHP 7.2.7
• Symfony 5.1

Installation

Open a command console, enter your project directory and install fast-crud from composer:

$ composer require rin-project/fast-crud

Add bundle config to App\Kernel.php for registring bundle if you're not using Flex:

return [
    // ...

    // add this line
    RinProject\FastCrudBundle\FastCrudBundle::class => ['all' => true],
];

Import default config in config/packages/framework.yaml:

# config/packages/framework.yaml
imports:
    - { resource: "@FastCrudBundle/Resources/config/config.yaml" }

Import default routes in config/routes.yaml (optional):

# config/routes.yaml
fast-crud-route:
    resource: "@FastCrudBundle/Resources/config/routes.yaml"

If you want to catch all exceptions automatics, enable exception interceptor in config file config/packages/framework.yaml:

# config/packages/framework.yaml
fast_crud:
    exception_interceptor:
        enabled: true
        effective_pattern: /^\/(api|manage)\/.*$/

Usage

Generate by command

C: create
R: retrieve
U: update
D: delete
L: list

Sample:

$ php bin/console make:fast-crud RUDL App:Content
$ php bin/console make:fast-crud RL App:Region

Or generate manually

If you have the same PRiMARY NAME of Entity, Controller and Service, like User, UserController, UserService.

Create a Fast-CRUD service:

namespace App\Service;

use RinProject\FastCrudBundle\Service\CrudService;

final class UserService extends CrudService {}

Create a controller inherit CrudController:

namespace App\Api\Controller;

use RinProject\FastCrudBundle\Controller\CrudController;
use RinProject\FastCrudBundle\View\ApiView;
use RinProject\FastCrudBundle\View\Mixin\SingleCreateAndUpdateApiViewMixin;
use RinProject\FastCrudBundle\View\Mixin\SingleRetrieveApiViewMixin;

/**
 * @Route("/api/user", name="api-user-")
 */
class UserController extends CrudController
{
    use ApiView, SingleRetrieveApiViewMixin, SingleCreateAndUpdateApiViewMixin;

    public function commonFilter()
    {
        return ['id' => $this->getUser()];
    }
}

Or you have the different PRIMARY NAME, like Staff, UserController and PersonService.

Service:

namespace App\Service;

use App\Entity\Staff;
use RinProject\FastCrudBundle\Service\CrudService;

final class PersonService extends CrudService
{
    function __construct(ContainerInterface $container)
    {
        parent::__construct($container, Staff::class);
    }
}

Controller:

namespace App\Api\Controller;

use App\Service\PersonService;
use RinProject\FastCrudBundle\Controller\CrudController;
use RinProject\FastCrudBundle\View\ApiView;
use RinProject\FastCrudBundle\View\Mixin\SingleCreateAndUpdateApiViewMixin;
use RinProject\FastCrudBundle\View\Mixin\SingleRetrieveApiViewMixin;

/**
 * @Route("/api/user", name="api-user-")
 */
class UserController extends CrudController
{
    use ApiView, SingleRetrieveApiViewMixin, SingleCreateAndUpdateApiViewMixin;

    public function __construct()
    {
        $this->serviceClass = PersonService::class;
    }

    public function commonFilter()
    {
        return ['id' => $this->getUser()];
    }
}

TO BE CONTINUE ...