Important

You are browsing the documentation for version 4.1 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Security Support ends in January 2023. Read version 5.0 (the latest LTS version) of the Oro documentation to get the updated information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Array Datasource

This datasource provides the ability to set data for the datagrid from thearray.

Example

1
2
3
4
 datagrids:
     DATAGRID_NAME_HERE:
         source:
             type: array

Configuration

To configure datasource, create a datagrid event listener and subscribe to the oro_datagrid.datagrid.build.after.DATAGRID_NAME_HERE event.

1
2
3
4
 acme_bundle.event_listener.datagrid.my_custom_listener:
     class: Acme\Bundle\AcmeBundle\EventListener\Datagrid\MyCustomListener
     tags:
         - { name: kernel.event_listener, event: oro_datagrid.datagrid.build.after.DATAGRID_NAME_HERE, method: onBuildAfter }

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 <?php

 namespace Acme\Bundle\AcmeBundle\EventListener\Datagrid;

 use Oro\Bundle\DataGridBundle\Datasource\ArrayDatasource\ArrayDatasource;
 use Oro\Bundle\DataGridBundle\Event\BuildAfter;
 use Oro\Bundle\DataGridBundle\Exception\UnexpectedTypeException;

 class MyCustomListener
 {
     /**
     * @param BuildAfter $event
     */
     public function onBuildAfter(BuildAfter $event)
     {
         $datagrid = $event->getDatagrid();
         $datasource = $datagrid->getDatasource();

         if (!$datasource instanceof ArrayDatasource) {
             throw new UnexpectedTypeException($datasource, ArrayDatasource::class);
         }

         // Create datagrid source array
         $source = [
             // row 1
             [
                 'first_column' => 'Value in first row and first column',
                 'second_column' => 'Value in first row and second column'
             ],
             // row 2
             [
                 'first_column' => 'Value in second row and first column',
                 'second_column' => 'Value in second row and second column'
             ],
             // ...
         ];

         $datasource->setArraySource($source);
     }
 }

Predefined columns can be defined using the following configuration:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
 datagrids:
     DATAGRID_NAME_HERE:
         source:
             type: array
         columns:
             first_column:
                 label: Column 1 Label
         sorters:
             columns:
                 first_column:
                     data_name: first_column