How to Create a Non-Removable Custom Filter for Portal Contact List View?

[jacao]

Hi,

I'd like to configure a custom filter for the Contact list view in the portal. My goal is for logged-in portal users to see only the contacts that have the isShownInPortal field set to true. This filter should be the default and users should not be able to disable or bypass it.

I tried using the accessControlFilter option with portalAll, but without success. I’ve searched the forum and half the internet ;-) but couldn’t find any guidance. Similar issues were mentioned in the following posts, but unfortunately without a solution.

https://forum.espocrm.com/forum/developer-help/developer-tutorials/90179-how-to-apply-a-default-filter-to-the-list-of-records-shown-when-editing-a-link-field

https://forum.espocrm.com/forum/developer-help/88614-apply-default-filter-using-accesscontrolfilter

I’d really appreciate any advice.

Best regards,
Jacek

[yuri]

portalAll access control filter will work when read access level is set to "all" for portal users. Maybe you did some mistake

[jacao]

I have a custom boolean field of Contact called cHasPortalAccess (Has Portal Access) - but it could be whatever eg. eyesColor Some contacts has is set to true:



Portal Users have access rights set to the Contact entity by Account level. Roles are apply directly with to Portal configuration:



I’d like to limit list of Contact shown for Portal Users only to the records with cHasPortalAccess = true.

As I understand I should create two files with my Custom configuration:

custom/Espo/Custom/Classes/Select/Contact/AccessControlFilters/isHasPortalAccess.php

<?php

namespace Espo\Custom\Classes\Select\Contact\AccessControlFilters;

use Espo\Core\Select\AccessControl\Filter;
use Espo\ORM\Query\SelectBuilder as QueryBuilder;

class IsHasPortalAccess implements Filter
{
public function apply(QueryBuilder $queryBuilder): void
{
$queryBuilder->where(['cHasPortalAccess' => true]);
}
}

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

{
"accessControlFilterClassNameMap": {
"isHasPortalAccess": "Espo\\Custom\\Classes\\Select\\Contact\\AccessCon trolFilters\\IsHasPortalAccess"
}
}

I tried with custom/Espo/Custom/Classes/Select/Contact/AccessControlFilters/isHasPortalAccess.php based on Espo\Core\Select\AccessControl\Filters\portalOnlyA ccount.php with:

if ($this->entityType === Contact::ENTITY_TYPE) {
$queryBuilder->andWhere([
'cHasPortalAccess' => true
]);
}

placed after line with: $queryBuilder->where($orGroup);


Unfortunatelley both doesn't works for me Please help!

Regards, Jacek

[yuri]

You the 'mandatory' filter. Not 'cHasPortalAccess'. Such a key is not supported.

https://docs.espocrm.com/development/metadata/select-defs/#accesscontrolfilterclassnamemap

[jacao]

Okay, now I get it Thak you Yuri for direction. The mandatory filter works for all users (both: regular and portal) but if someone would like set it only for portal usres then should use portalOnlyAccount filter if rights are set to the entity by Account scope. Below working files:

custom/Espo/Custom/Classes/Select/Contact/AccessControlFilters/PortalOnlyAccount.php

<?php

namespace Espo\Custom\Classes\Select\Contact\AccessControlFilters;

use Espo\Core\Select\AccessControl\Filter;
use Espo\ORM\Query\SelectBuilder as QueryBuilder;

class PortalOnlyAccount implements Filter
{
public function apply(QueryBuilder $queryBuilder): void
{
$queryBuilder->where(['cHasPortalAccess' => true]);
}
}

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

{
"accessControlFilterClassNameMap": {
"portalOnlyAccount": "Espo\\Custom\\Classes\\Select\\Contact\\AccessControlFilters\\PortalOnlyAccount"
}
}

Regards! Jacek