How To: Own Primary Filter EspoCRM 7.0.x

[Sonja Hurter]

Hello! I have been busy solving my own primary filters a few days ago. The existing posts were only partly of help, as the basic structure (Select Manager to Select Builder) has been changed in version 7.

Attached is a little help. I hope it helps someone.

My initial situation: The entity contact has got a new enum field "ownState". Possible entries are "activce, feedback, inactive". The default value is "active". I wanted a filter like for the leads "actual" and "inactive".

Folders or files may need to be created.

/custom/Espo/Custom/Select/Contact/PrimaryFilters/Actual.php

<?php
namespace Espo\Custom\Select\Contact\PrimaryFilters;
use Espo\Core\Select\Primary\Filter;
use Espo\ORM\Query\SelectBuilder;
use Espo\ORM\Query\Part\Condition as Cond;
class Actual implements Filter
{
public function apply(SelectBuilder $queryBuilder): void
{
$queryBuilder->where(
Cond::in(
Cond::column('ownState'),
['active','feedback']
)
);
}
}

/custom/Espo/Custom/Select/Contact/PrimaryFilters/Inactive.php

<?php
namespace Espo\Custom\Select\Contact\PrimaryFilters;
use Espo\Core\Select\Primary\Filter;
use Espo\ORM\Query\SelectBuilder;
use Espo\ORM\Query\Part\Condition as Cond;
class Inactive implements Filter
{
public function apply(SelectBuilder $queryBuilder): void
{
$queryBuilder->where(
Cond::in(
Cond::column('ownState'),
['inactive']
)
);
}
}

/custom/Espo/Custom/Ressources/metadata/selectDefs/Contact.json

{
"primaryFilterClassNameMap": {
"actual": "Espo\\Custom\\Select\\Contact\\PrimaryFilters\\Actual",
"inactive": "Espo\\Custom\\Select\\Contact\\PrimaryFilters\\Inactive"
}
}

/custom/Espo/Custom/Ressources/metadata/clientDefs/Contact.json
Add the following value

"filterList":[
{
"name":"actual"
},
{
"name":"inactive"
}
]

/custom/Espo/Custom/Ressources/i18n/de_DE/Contact.json
Please select the appropriate language. In my case German. Add the following value

"presetFilters": {
"actual": "Aktuell",
"inactive": "Archiv"
}

Finally

• Administation: Clear Cache
• Reload Site in Browser

The description of the API for condition and more can be found under
/application/Espo/ORM/Query/Part/

[yuri]

The list of all metadata parameters related to Select framework is available here: https://docs.espocrm.com/development...a/select-defs/