Adding Create, Edit, and Delete Actions¶

By default, only the List action is enabled when you create a CRUD controller. This step-by-step guide shows you how to add Create, Edit, Detail, and Delete actions by implementing a CRUD handler.

1. Create a CRUD handler¶

The handler acts as a bridge between your CRUD controller and your business logic (typically facades). Create a new class that implements any of extended interfaces of Shopsys\AdministrationBundle\Component\Crud\Handler\HandlerInterface

Note: For guidance on choosing the right handler interface for your needs, see Choosing the Right Interface.

<?php

declare(strict_types=1);

namespace App\Model\Order;

use Shopsys\AdministrationBundle\Component\Crud\Handler\DeleteHandlerInterface;

class OrderDeleteHandler implements DeleteHandlerInterface
{
    public function __construct(
        private readonly OrderFacade $orderFacade,
    ) {
    }

    public function getById(int $id): object
    {
        return $this->orderFacade->getById($id);
    }

    public function delete(object $entity): void
    {
        $this->orderFacade->deleteById($entity->getId());
    }
}

2. Register the Handler in Your Controller¶

<?php

declare(strict_types=1);

namespace App\Controller\Admin;

use App\Model\Order\Order;
use App\Model\Order\OrderDeleteHandler;
use Shopsys\AdministrationBundle\Component\Attributes\CrudController;
use Shopsys\AdministrationBundle\Controller\AbstractCrudController;

#[CrudController(entityClass: Order::class)]
class OrderController extends AbstractCrudController
{
    public function configure(CrudConfig $config): void
    {
        $config
            ->registerHandler(OrderDeleteHandler::class)
        ;
    }
}

This will enable Delete action in your CRUD controller.

Edit Handler Example¶

To enable edit functionality, implement EditHandlerInterface:

<?php

declare(strict_types=1);

namespace App\Model\Order;

use Shopsys\AdministrationBundle\Component\Crud\Handler\EditHandlerInterface;

class OrderEditHandler implements EditHandlerInterface
{
    public function __construct(
        private readonly OrderFacade $orderFacade,
        private readonly OrderDataFactory $orderDataFactory,
    ) {
    }

    public function getById(int $id): object
    {
        return $this->orderFacade->getById($id);
    }

    public function createDataFromEntity(object $entity): object
    {
        return $this->orderDataFactory->createFromOrder($entity);
    }

    public function edit(object $entity, object $data): void
    {
        $this->orderFacade->edit($entity->getId(), $data);
    }
}

Create Handler Example¶

To enable create functionality, implement CreateHandlerInterface:

<?php

declare(strict_types=1);

namespace App\Model\Order;

use Shopsys\AdministrationBundle\Component\Crud\Handler\CreateHandlerInterface;

class OrderCreateHandler implements CreateHandlerInterface
{
    public function __construct(
        private readonly OrderFacade $orderFacade,
        private readonly OrderDataFactory $orderDataFactory,
    ) {
    }

    public function getById(int $id): object
    {
        return $this->orderFacade->getById($id);
    }

    public function createData(): object
    {
        return $this->orderDataFactory->create();
    }

    public function create(object $data): object
    {
        return $this->orderFacade->create($data);
    }
}

Full CRUD Handler¶

To enable all operations at once, implement CrudHandlerInterface which combines Delete, Edit, and Create:

<?php

declare(strict_types=1);

namespace App\Model\Order;

use Shopsys\AdministrationBundle\Component\Crud\Handler\CrudHandlerInterface;

class OrderCrudHandler implements CrudHandlerInterface
{
    public function __construct(
        private readonly OrderFacade $orderFacade,
        private readonly OrderDataFactory $orderDataFactory,
    ) {
    }

    public function getById(int $id): object
    {
        return $this->orderFacade->getById($id);
    }

    public function delete(object $entity): void
    {
        $this->orderFacade->deleteById($entity->getId());
    }

    public function createDataFromEntity(object $entity): object
    {
        return $this->orderDataFactory->createFromOrder($entity);
    }

    public function edit(object $entity, object $data): void
    {
        $this->orderFacade->edit($entity->getId(), $data);
    }

    public function createData(): object
    {
        return $this->orderDataFactory->create();
    }

    public function create(object $data): object
    {
        return $this->orderFacade->create($data);
    }
}

3. Implement Entity String Representation¶

For user-friendly messages in the admin interface, implement the Shopsys\FrameworkBundle\Component\Utils\Presentable interface in your entity class:

<?php

declare(strict_types=1);

namespace App\Model\Order;

use Shopsys\FrameworkBundle\Component\Utils\Presentable;

class Order implements Presentable
{
    // ... other properties and methods ...

    public function toHumanReadable(): string
    {
        return t('Order #%number%', ['%number%' => $this->getNumber()]);
    }
}

Read more about implementing Presentable interface in the Entity Naming section.

4. Configure Form¶

To display forms on create and edit pages, override the configureForm() method in your CRUD controller. The method receives a CrudFormConfigurator and the entity being edited (null for create).

You can use an existing FormType class:

use Shopsys\AdministrationBundle\Component\Crud\Form\CrudFormConfigurator;

protected function configureForm(CrudFormConfigurator $formConfigurator, ?object $entity = null): void
{
    $formConfigurator->useFormType(OrderFormType::class, [
        'order' => $entity,
    ]);
}

Or build the form inline using the builder:

use Shopsys\AdministrationBundle\Component\Crud\Form\CrudFormConfigurator;
use Symfony\Component\Form\Extension\Core\Type\TextType;

protected function configureForm(CrudFormConfigurator $formConfigurator, ?object $entity = null): void
{
    $formConfigurator->useBuilder()
        ->add('name', TextType::class, [
            'label' => t('Name'),
            'required' => true,
        ]);
}

See configureForm reference for more details.