Custom Contact List Grid

Hi,

I know custom Contact list grid can be saved through the frontend GUI. How do I add a custom grid via code?

Topic

[Yurii MuratovParticipant]

Hi, @zhex900.

The predefined data views configures with views_list parameter of your grid config. The value of this parameter is the service that extended from Oro\Bundle\DataGridBundle\Extension\GridViews\AbstractViewsList abstract class.

This class have abstract function getViewsLis that returns an array of available views.

For your example, let’s add two new views to the contact grid.
The definition of the contacts grid available at crm/src/Oro/Bundle/ContactBundle/Resources/config/oro/datagrids.yml. The name of this datagrid is contacts-grid.

As you can see, this datagrid config already have the views_list parameter with @oro_contact.contacts_view_list value. If you open this service (Oro\Bundle\ContactBundle\Datagrid\ContactsViewList class), you will see, that here we add the Duplicates view.

So, create new class ContactsExtraViewList somewhere in your bundle and extend it from the ContactsViewList. At this class, let’s rewrite getViewsList method and new views:

PHP

<?php namespace Acme\DemoBundle\Datagrid; use Oro\Bundle\ContactBundle\Datagrid\ContactsViewList; use Oro\Bundle\DataGridBundle\Extension\GridViews\View; class ContactExtraViewList extends ContactsViewList { /** * {@inheritdoc} */ protected function getViewsList() { $view1 = new View('oro_contact.one', ['firstName' => ['value' => 'foo', 'type' => '1']]); $view1->setLabel($this->translator->trans('the first custom view')); $view2 = new View('oro_contact.two', ['lastName' => ['value' => 'bar', 'type' => '1']]); $view2->setLabel($this->translator->trans('the second custom view')); return array_merge(parent::getViewsList(), [$view1, $view2]); } }

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

<?php   namespace Acme\DemoBundle\Datagrid;   use Oro\Bundle\ContactBundle\Datagrid\ContactsViewList; use Oro\Bundle\DataGridBundle\Extension\GridViews\View;   class ContactExtraViewList extends ContactsViewList {     /**      * {@inheritdoc}      */     protected function getViewsList()     {         $view1 = new View('oro_contact.one', ['firstName' => ['value' => 'foo', 'type' => '1']]);         $view1->setLabel($this->translator->trans('the first custom view'));           $view2 = new View('oro_contact.two', ['lastName' => ['value' => 'bar', 'type' => '1']]);         $view2->setLabel($this->translator->trans('the second custom view'));           return array_merge(parent::getViewsList(), [$view1, $view2]);     } }

At this example we add two new views. The first one has the filter by firstName field and ‘foo’ value, and the second one has the filter by lastName field with ‘bar’ value.

After that, you should register your class as service:

YAML

your_bundle.contact_grid_view_list: class: Acme\DemoBundle\Datagrid arguments: - @translator

1 2 3 4

your_bundle.contact_grid_view_list:         class: Acme\DemoBundle\Datagrid         arguments:             - @translator

And the last step is to change the views_list parameter for contacts-grid datagrid. To do this, add
Resources/config/oro/datagrids.yml file at your bundle with content:

YAML

datagrids: contacts-grid: views_list: @your_bundle.contact_grid_view_list

1 2 3

datagrids:     contacts-grid:         views_list: @your_bundle.contact_grid_view_list

And after the cache reset, you will have new two grid views:

[zhex900Participant]

Thank you! It worked. Another question. How do I filter owner column?

PHP

protected function getViewsList() { /** @var User $owner */ $owner = $this->tokenStorage->getToken()->getUser(); file_put_contents('/tmp/a.log',$owner->getFirstName().' '.$owner->getLastName(), FILE_APPEND); $owner_view = new View('oro_contact.owner', ['owner' => ['value' => $owner->getFirstName().' '.$owner->getLastName(), 'type' => '1']]); $owner_view->setLabel($this->translator->trans('oro.contact.gridview.owner.label')); // $view2 = new View('oro_contact.two', ['lastName' => ['value' => 'bar', 'type' => '1']]); //$view2->setLabel($this->translator->trans('the second custom view')); return array_merge(parent::getViewsList(), [$owner_view]);//, $view2]); }

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

protected function getViewsList()     {         /** @var User $owner */         $owner = $this->tokenStorage->getToken()->getUser();         file_put_contents('/tmp/a.log',$owner->getFirstName().' '.$owner->getLastName(), FILE_APPEND);         $owner_view = new View('oro_contact.owner', ['owner' => ['value' => $owner->getFirstName().' '.$owner->getLastName(), 'type' => '1']]);         $owner_view->setLabel($this->translator->trans('oro.contact.gridview.owner.label'));         //  $view2 = new View('oro_contact.two', ['lastName' => ['value' => 'bar', 'type' => '1']]);         //$view2->setLabel($this->translator->trans('the second custom view'));           return array_merge(parent::getViewsList(), [$owner_view]);//, $view2]);     }

[Yurii MuratovParticipant]

Hi, @zhex900.

The owner field receive the entity id as the value.

So, your view will be like:

PHP

$owner_view = new View('oro_contact.owner', ['owner' => ['value' => $owner->getId(), 'type' => '1']]);

1	$owner_view = new View('oro_contact.owner', ['owner' => ['value' => $owner->getId(), 'type' => '1']]);

You can easy test what value format support the filter. In the grid just set some value and see the ajax request data for the grid with this filter. For example, for the owner field the request will be like:

[zhex900Participant]

One more question.
$followup_view->setColumnsData(['firstName' => ['order' => 1]]);
What is wrong with this line? I want to control what columns are displayed in the view.

[zhex900Participant]

I have found the answer myself. FirstName should be replaced with first_name.

[Author]

Replies