Datagrid¶

The Datagrid is a component that allows you to display a list of records as a table.

This component is built on top of the Grid component and provides easier configuration. It can also be used as a standalone component outside of the Crud Controller.

• Configuration
• Fields
• Row actions

Architecture¶

Datagrid uses some internal interfaces and classes to work properly and to provide decoupled architecture with the possibility to customize its behavior.

Adapter¶

Adapters are used to fetch data from different sources. The adapter is responsible for fetching data and transforming it into a format that can be displayed in the Datagrid.

There are currently two adapters available:

• Shopsys\AdministrationBundle\Component\Datagrid\Adapter\Array\ArrayAdapter - Adapter that works with arrays
• Shopsys\AdministrationBundle\Component\Datagrid\Adapter\Orm\OrmAdapter - Adapter that works with Doctrine entities and it's used by Crud Controller

You can also create your own adapter by implementing the Shopsys\AdministrationBundle\Component\Datagrid\Adapter\AdapterInterface.

Datagrid class¶

The Shopsys\AdministrationBundle\Component\Datagrid\Datagrid class is the main class that is used to configure the Datagrid. It provides methods to configure columns, filters, actions, and other features.

Permission Integration¶

Datagrid acts as a decorator for the internal Grid component and automatically integrates with the RBAC permission system through the required roleConstant parameter. The role constant is passed to the underlying Grid component, which handles all permission-based features.

For detailed information about automatic permission controls, see Grid Permission Integration.

Define Datagrid¶

To define a datagrid that is prepared for configuration you need to do two steps:

1. Create your adapter via Factory:

class MyController extends AbstractController
{
    /**
    * @param Shopsys\AdministrationBundle\Component\Datagrid\Adapter\Array\ArrayAdapterFactory $arrayAdapterFactory
    * @param Shopsys\AdministrationBundle\Component\Datagrid\Adapter\Orm\OrmAdapterFactory $ormAdapterFactory
    */
    public function __construct(
        private readonly ArrayAdapterFactory $arrayAdapterFactory,
        private readonly OrmAdapterFactory $ormAdapterFactory
    ) {
    }

    public function myAction(): Response
    {
        // ...

        /** @var Shopsys\AdministrationBundle\Component\Datagrid\Adapter\Array\ArrayAdapter $adapter */
        $adapter = $this->arrayAdapterFactory->create($arrayData);

        // or

        /** @var Shopsys\AdministrationBundle\Component\Datagrid\Adapter\Orm\OrmAdapter $adapter */
        $adapter = $this->ormAdapterFactory->create($entityClass);
        // ...
    }
}

1. Create Datagrid instance via Factory:

class MyController extends AbstractController
{
    /**
    * ...
    * @param Shopsys\AdministrationBundle\Component\Datagrid\DatagridFactory $datagridFactory
    */
    public function __construct(
        // ...
        private readonly DatagridFactory $datagridFactory,
    ) {
    }

    public function myAction(): Response
    {
        // ...

        $datagrid = $this->datagridFactory->create($adapter, [
            'roleConstant' => 'ROLE_MY', // required - enables permission-based features
        ]);


        // In template use {{ grid.render }} method to render the datagrid
        return $this->render('my_template.html.twig', [
            'datagrid' => $datagrid->createView(),
        ]);
    }
}

1. Configure Datagrid:

The next step is to configure Datagrid by using the Datagrid class. The Datagrid class provides methods to configure columns, filters, actions, and other features.

More information about configuration can be found in the Configuration section.