Datagrid with custom Datasource

Hi,
I’m trying, to create a datagrid with custom source.
But I did not found the doc about that https://oroinc.com/orocrm/documentation/2.3/reference/format/datagrids#source

the type of data source. Currently, the only available types are orm and search, but you can also implement your own data source. Each data source may come with its own options to configure how the data is fetched.

So try something :
create my service with the tag

YAML

tags: - { name: oro_datagrid.datasource, type: reward-point }

1 2	tags:             - { name: oro_datagrid.datasource, type: reward-point }

Then call the type in datagrid.yml

PHP

datagrids: reward-points-grid: source: type: reward-point

1 2 3 4

datagrids:     reward-points-grid:         source:             type: reward-point

My serice :

PHP

class RewardPointDatasource implements DatasourceInterface { /** @var RewardPointUserActionRepository */ protected $rewardPointUserActionRepository; /** @var Registry $doctrine */ protected $doctrine; protected $userAction; public function __construct(Registry $doctrine, $userAction) { $this->doctrine = $doctrine; $this->userAction = $userAction; } public function getCustomerActionRewardPointAction() { $data = []; $this->getRPUARepository(); /** @var array $rewardPointUserActions */ $rewardPointUserActions = $this->rewardPointUserActionRepository->findAll(); /** @var RewardPointUserAction $rewardPointUserAction */ foreach ($rewardPointUserActions as $rewardPointUserAction) { $rewardPointUserAction = $rewardPointUserAction->getEntityType(); $rewardPointUserAction = $this->doctrine->getRepository($rewardPointUserAction); $action = $rewardPointUserAction->find((int)$rewardPointUserAction->getEntityId()); $rewardPointStrategyContext = new RewardPointStrategyContext($action); $currentData = $rewardPointStrategyContext->getData(); $currentData['user'] = $rewardPointUserAction->getCustomer() ->getFirstName().' '.$rewardPointUserAction->getCustomer()->getLastName(); $currentData['points'] = $rewardPointUserAction->getNbRewardPoint(); $data[] = new ResultRecord($currentData); } return $data; } /** * @return ObjectRepository */ protected function getRPUARepository() { if (!$this->rewardPointUserActionRepository) { $this->rewardPointUserActionRepository = $this->doctrine ->getRepository( $this->userAction ); } return $this->rewardPointUserActionRepository; } /** * Add source to datagrid * * @param DatagridInterface $grid * @param array $config */ public function process(DatagridInterface $grid, array $config) { $grid->setDatasource(clone $this); } /** * Returns data extracted via datasource * * @return ResultRecordInterface[] */ public function getResults() { return $this->getCustomerActionRewardPointAction(); } }

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 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73

class RewardPointDatasource implements DatasourceInterface {     /** @var  RewardPointUserActionRepository */     protected $rewardPointUserActionRepository;     /** @var Registry $doctrine */     protected $doctrine;     protected $userAction;       public function __construct(Registry $doctrine, $userAction)     {         $this->doctrine = $doctrine;         $this->userAction = $userAction;     }         public function getCustomerActionRewardPointAction()     {         $data = [];         $this->getRPUARepository();         /** @var array $rewardPointUserActions */         $rewardPointUserActions = $this->rewardPointUserActionRepository->findAll();         /** @var RewardPointUserAction $rewardPointUserAction */         foreach ($rewardPointUserActions as $rewardPointUserAction) {             $rewardPointUserAction = $rewardPointUserAction->getEntityType();             $rewardPointUserAction = $this->doctrine->getRepository($rewardPointUserAction);             $action = $rewardPointUserAction->find((int)$rewardPointUserAction->getEntityId());             $rewardPointStrategyContext = new RewardPointStrategyContext($action);             $currentData = $rewardPointStrategyContext->getData();             $currentData['user'] = $rewardPointUserAction->getCustomer()                     ->getFirstName().' '.$rewardPointUserAction->getCustomer()->getLastName();             $currentData['points'] = $rewardPointUserAction->getNbRewardPoint();             $data[] = new ResultRecord($currentData);         }           return $data;     }       /**      * @return ObjectRepository      */     protected function getRPUARepository()     {         if (!$this->rewardPointUserActionRepository) {             $this->rewardPointUserActionRepository = $this->doctrine                 ->getRepository(                     $this->userAction                 );         }           return $this->rewardPointUserActionRepository;     }       /**      * Add source to datagrid      *      * @param DatagridInterface $grid      * @param array             $config      */     public function process(DatagridInterface $grid, array $config)     {         $grid->setDatasource(clone $this);     }       /**      * Returns data extracted via datasource      *      * @return ResultRecordInterface[]      */     public function getResults()     {         return $this->getCustomerActionRewardPointAction();     } }

But it’s not seem enter into my RewardPointDatasource. May there are something to do to call this, like a listener or ?
Have you got an example ?

Thanks in advance.

Topic

[vseniukParticipant]

Hi Tyler,

I reproduced all your steps. As a example:

service:

YAML

# src/Demo/Bundle/demoBundle/Resources/config/services.yml services: ... demo.datagrid.datasource.reward_point: class: Demo\Bundle\DemoBundle\Datagrid\RewardPointDatasource arguments: - '@doctrine' tags: - { name: oro_datagrid.datasource, type: reward-point }

1 2 3 4 5 6 7 8 9 10 11

# src/Demo/Bundle/demoBundle/Resources/config/services.yml   services:     ...       demo.datagrid.datasource.reward_point:         class: Demo\Bundle\DemoBundle\Datagrid\RewardPointDatasource         arguments:             - '@doctrine'         tags:             - { name: oro_datagrid.datasource, type: reward-point }

class with DatasourceInterface:

PHP

<?php // src/Demo/Bundle/DemoBundle/Datagrid/RewardPointDatasource.php namespace Demo\Bundle\DemoBundle\Datagrid; use Doctrine\ORM\EntityRepository; use Symfony\Bridge\Doctrine\RegistryInterface; use Oro\Bundle\AccountBundle\Entity\Account; use Oro\Bundle\DataGridBundle\Datagrid\DatagridInterface; use Oro\Bundle\DataGridBundle\Datasource\DatasourceInterface; use Oro\Bundle\DataGridBundle\Datasource\ResultRecord; class RewardPointDatasource implements DatasourceInterface { /** @var RegistryInterface $registry */ protected $registry; /** * @param RegistryInterface $registry */ public function __construct(RegistryInterface $registry) { $this->registry = $registry; } /** * @return array */ public function getCustomerActionRewardPointAction() { $data = []; /** @var array $rewardPointUserActions */ $accounts = $this->getAccountRepository()->findAll(); /** @var Account[] $accounts */ foreach ($accounts as $account) { $currentData = [ 'id' => $account->getId(), 'email' => $account->getEmail(), ]; $data[] = new ResultRecord($currentData); } return $data; } /** * {@inheritdoc} */ public function process(DatagridInterface $grid, array $config) { $grid->setDatasource(clone $this); } /** * {@inheritdoc} */ public function getResults() { return $this->getCustomerActionRewardPointAction(); } /** * @return EntityRepository */ protected function getAccountRepository() { $manager = $this->registry->getManagerForClass(Account::class); return $manager->getRepository(Account::class); } }

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 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76

<?php // src/Demo/Bundle/DemoBundle/Datagrid/RewardPointDatasource.php   namespace Demo\Bundle\DemoBundle\Datagrid;   use Doctrine\ORM\EntityRepository;   use Symfony\Bridge\Doctrine\RegistryInterface;   use Oro\Bundle\AccountBundle\Entity\Account; use Oro\Bundle\DataGridBundle\Datagrid\DatagridInterface; use Oro\Bundle\DataGridBundle\Datasource\DatasourceInterface; use Oro\Bundle\DataGridBundle\Datasource\ResultRecord;   class RewardPointDatasource implements DatasourceInterface {     /** @var RegistryInterface $registry */     protected $registry;       /**      * @param RegistryInterface $registry      */     public function __construct(RegistryInterface $registry)     {         $this->registry = $registry;     }       /**      * @return array      */     public function getCustomerActionRewardPointAction()     {         $data = [];           /** @var array $rewardPointUserActions */         $accounts = $this->getAccountRepository()->findAll();           /** @var Account[] $accounts */         foreach ($accounts as $account) {             $currentData = [                 'id' => $account->getId(),                 'email' => $account->getEmail(),             ];               $data[] = new ResultRecord($currentData);         }           return $data;     }       /**      * {@inheritdoc}      */     public function process(DatagridInterface $grid, array $config)     {         $grid->setDatasource(clone $this);     }       /**      * {@inheritdoc}      */     public function getResults()     {         return $this->getCustomerActionRewardPointAction();     }       /**      * @return EntityRepository      */     protected function getAccountRepository()     {         $manager = $this->registry->getManagerForClass(Account::class);           return $manager->getRepository(Account::class);     } }

datagrid:

YAML

# src/Demo/Bundle/DemoBundle/Resources/config/oro/datagrids.yml datagrids: ... reward-points-grid: source: type: reward-point columns: id: label: "#ID" email: label: "Email"

1 2 3 4 5 6 7 8 9 10 11 12 13

# src/Demo/Bundle/DemoBundle/Resources/config/oro/datagrids.yml   datagrids:     ...       reward-points-grid:         source:             type: reward-point         columns:             id:                 label: "#ID"             email:                 label: "Email"

and have such results:

You can find some useful information in DatagridBundle documentation

Please, make sure that you don’t have any typo, and yours DataGrid is called on the page

XHTML

{# twig template #} {{ dataGrid.renderGrid('reward-points-grid', {}, {}) }}

1 2 3

{# twig template #}   {{ dataGrid.renderGrid('reward-points-grid', {}, {}) }}

[TylerParticipant]

vseniuk,

Thx for the answer.
Now I got this error :

PHP

Variable "entity" does not exist in vendor/oro/platform/src/Oro/Bundle/UIBundle/Resources/views/actions/view.html.twig at line 6.

1	Variable "entity" does not exist in vendor/oro/platform/src/Oro/Bundle/UIBundle/Resources/views/actions/view.html.twig at line 6.

I got this in my twig :

PHP

{% extends 'OroUIBundle:actions:view.html.twig' %} {% import 'OroDataGridBundle::macros.html.twig' as dataGrid %} {% block content %} {{ dataGrid.renderGrid('reward-points-grid', {}, {}) }} {% set pageTitle = 'Reward Point' %} {% endblock content %}

1 2 3 4 5 6

{% extends 'OroUIBundle:actions:view.html.twig' %} {% import 'OroDataGridBundle::macros.html.twig' as dataGrid %} {% block content %}     {{ dataGrid.renderGrid('reward-points-grid', {}, {}) }}     {% set pageTitle = 'Reward Point' %} {% endblock content %}

It’s seem, oro want something else, like the entity name.
But I do not know what and why, because it’s a dynamic datagrid, so I parse an array.
I will try with the array type.

[TylerParticipant]

It’s ok, I resolved my issue.

I had got an error in my doctrine action.
Then in my twig, I just put this :

PHP

{% extends 'OroUIBundle:actions:index.html.twig' %} {% set gridName = 'reward-points-grid' %} {% set pageTitle = 'Reward Point' %}

1 2 3

{% extends 'OroUIBundle:actions:index.html.twig' %} {% set gridName = 'reward-points-grid' %} {% set pageTitle = 'Reward Point' %}

[Author]

Replies