murph-doc/docs/crud/generator.md

Generator

Prepare your entity

• implements App\Core\Entity\EntityInterface (see Entity Manager)
• creates a repository query (see Repository Query)
• creates a factory (see Factory)
• generates a form (see php bin/console make:form --help)

Generation

The generation is performed in CLI. These information are required:

• The name of the futur controller (eg: MyEntityAdminController)
• The namespace of the entity (eg: App\Entity\MyEntity)
• The namespace of the entity repository query (eg: App\Repository\MyEntityRepositoryQuery)
• The namespace of the the entity factory (eg: App\Factory\MyEntityFactory)
• The namespace of the form used to create and update the entity (eg: App\Form\MyEntityType)

Simply run php bin/console make:crud-controller.

The next controller will be generated:

// src/Controller/MyEntityAdminController
namespace App\Controller;

use App\Core\Controller\Admin\Crud\CrudController;
use App\Core\Crud\CrudConfiguration;
use App\Core\Crud\Field;
use App\Core\Entity\EntityInterface;
use App\Core\Manager\EntityManager;
use App\Entity\MyEntity as Entity;
use App\Factory\MyEntityFactory as Factory;
use App\Form\MyEntityType as Type;
use App\Repository\MyEntityRepositoryQuery as RepositoryQuery;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpFoundation\Session\Session;
use Symfony\Component\Routing\Annotation\Route;

class MyEntityAdminController extends CrudController
{
    /**
     * @Route("/admin/my_entity/{page}", name="admin_my_entity_index", methods={"GET"}, requirements={"page":"\d+"})
     */
    public function index(int $page = 1, RepositoryQuery $query, Request $request, Session $session): Response
    {
        return $this->doIndex($page, $query, $request, $session);
    }

    /**
     * @Route("/admin/my_entity/new", name="admin_my_entity_new", methods={"GET", "POST"})
     */
    public function new(Factory $factory, EntityManager $entityManager, Request $request): Response
    {
        return $this->doNew($factory->create(), $entityManager, $request);
    }

    /**
     * @Route("/admin/my_entity/show/{entity}", name="admin_my_entity_show", methods={"GET"})
     */
    public function show(Entity $entity): Response
    {
        return $this->doShow($entity);
    }

    /**
     * @Route("/admin/my_entity/filter", name="admin_my_entity_filter", methods={"GET"})
     */
    public function filter(Session $session): Response
    {
        return $this->doFilter($session);
    }

    /**
     * @Route("/admin/my_entity/edit/{entity}", name="admin_my_entity_edit", methods={"GET", "POST"})
     */
    public function edit(Entity $entity, EntityManager $entityManager, Request $request): Response
    {
        return $this->doEdit($entity, $entityManager, $request);
    }

    /**
     * @Route("/admin/my_entity/sort/{page}", name="admin_my_entity_sort", methods={"POST"}, requirements={"page":"\d+"})
     */
    public function sort(int $page = 1, RepositoryQuery $query, EntityManager $entityManager, Request $request, Session $session): Response
    {
        return $this->doSort($page, $query, $entityManager, $request, $session);
    }

    /**
     * @Route("/admin/my_entity/delete/{entity}", name="admin_my_entity_delete", methods={"DELETE"})
     */
    public function delete(Entity $entity, EntityManager $entityManager, Request $request): Response
    {
        return $this->doDelete($entity, $entityManager, $request);
    }

    protected function getConfiguration(): CrudConfiguration
    {
        return CrudConfiguration::create()
            ->setPageTitle('index', 'List of App\Entity\MyEntity')
            ->setPageTitle('edit', 'Edition of {id}')
            ->setPageTitle('new', 'New App\Entity\MyEntity')
            ->setPageTitle('show', 'View of {id}')

            ->setPageRoute('index', 'admin_my_entity_index')
            ->setPageRoute('new', 'admin_my_entity_new')
            ->setPageRoute('edit', 'admin_my_entity_edit')
            ->setPageRoute('show', 'admin_my_entity_show')
            ->setPageRoute('sort', 'admin_my_entity_sort')
            ->setPageRoute('delete', 'admin_my_entity_delete')
            ->setPageRoute('filter', 'admin_my_entity_filter')

            ->setForm('edit', Type::class, [])
            ->setForm('new', Type::class)
            // ->setForm('filter', Type::class)

            // ->setMaxPerPage('index', 20)

            // ->setIsSortableCollection('index', false)
            // ->setSortableCollectionProperty('sortOrder')

            // ->setAction('index', 'new', true)
            // ->setAction('index', 'show', true)
            // ->setAction('index', 'edit', true)
            // ->setAction('index', 'delete', true)

            // ->setAction('edit', 'back', true)
            // ->setAction('edit', 'show', true)
            // ->setAction('edit', 'delete', true)

            // ->setField('index', 'Label', Field\TextField::class, [
            //     'property' => 'label',
            // ])
        ;
    }

    protected function getSection(): string
    {
        return 'my_entity';
    }
}