SuiteCRM Developer Insights - Adding Subpanel Filters

This week, Clemente Raposo, Lead Developer of SuiteCRM, shares a step-by-step guide on enabling subpanel filters in SuiteCRM 8.

Subpanel filters let you search the data displayed in subpanels, making it easier to manage and organise information. In SuiteCRM 8, enabling these filters is straightforward and just a matter of configuration.

In this example, we’ll demonstrate how to enable subpanel filters using a SuiteCRM 8 extension. Specifically, we’ll show you how to add a filter to the Contacts subpanel within the Accounts module. Watch this week’s video for a complete walkthrough, and don’t forget to check below for the code example to help you get started!

For those of you who are keen to get started, you can find the code sample from the video below:

Copy to Clipboard

<?php

namespace App\Extension\defaultExt\modules\Accounts\ViewDefinitions\Mappers;

use App\FieldDefinitions\Entity\FieldDefinition;
use App\ViewDefinitions\Entity\ViewDefinition;
use App\ViewDefinitions\LegacyHandler\ViewDefinitionMapperInterface;

class EnableContactsSubpanelFilter implements ViewDefinitionMapperInterface
{

/**
     * @inheritDoc
     */
    public function getKey(): string
    {
        return 'record-view-accounts-enable-contacts-subpanel-filter';
    }

/**
     * @inheritDoc
     */
    public function getModule(): string
    {
        return 'accounts';
    }

/**
     * @inheritDoc
     */
    public function map(ViewDefinition $definition, FieldDefinition $fieldDefinition): void
    {
        // 1. Get panel metadata definition
        $subpanels = $definition->getSubPanel() ?? [];
        $contactsSubpanel = $subpanels['contacts'] ?? [];

// 2. Add filter and clear buttons to contacts subpanel
        $contactsSubpanel['top_buttons'][] = [
            "key" => "show-filter",
            "icon" => "filter",
            "labelKey" => "LBL_FILTER",
            "action" => "show-filter",
            "params" => [
                "expanded" => true
            ],
            "modes" => [
                "list"
            ],
        ];

$contactsSubpanel['top_buttons'][] = [
            "key" => "clear-filter",
            "labelKey" => "LBL_CLEAR_FILTER",
            "action" => "clear-filter",
            "params" => [
                "expanded" => true
            ],
            "modes" => [
                "list"
            ],
        ];

// 3. Add searchdefs for subpanel
        // (optional) If not defined fallsback to contacts searchdefs
        $contactsSubpanel['searchdefs'] = [
            "name" => [
                "name" => "name",
                "label" => "LBL_NAME",
                "default" => true,
                "fieldDefinition" => [
                    "name" => "name",
                    "type" => "varchar",
                    "vname" => "LBL_NAME",
                    "default" => true,
                ]
            ],
            "primary_address_city" => [
                "name" => "primary_address_city",
                "label" => "LBL_LIST_CITY",
                "default" => true,
                "fieldDefinition" => [
                    "name" => "primary_address_city",
                    "type" => "varchar",
                    "vname" => "LBL_LIST_CITY",
                    "default" => true,
                ]
            ],
            "primary_address_state" => [
                "name" => "primary_address_state",
                "label" => "LBL_LIST_STATE",
                "default" => true,
                "fieldDefinition" => [
                    "name" => "primary_address_state",
                    "type" => "varchar",
                    "vname" => "LBL_LIST_STATE",
                    "default" => true,
                ]
            ]
        ];

// 4. Re-set panel metadata definition
        $subpanels['contacts'] = $contactsSubpanel;
        $definition->setSubPanel($subpanels);

// 5. Run Quick Repair&Rebuild or Clear cache
    }

}

extensions/defaultExt/modules/Accounts/ViewDefinitions/Mappers/EnableContactsSubpanelFilter.php

The above can be used as an example of adding subpanel filters to your modules in SuiteCRM 8.

If you are looking for more development insights, the Development Team here at SalesAgility have created instructor-led Masterclasses. Designed for developers, covering both SuiteCRM 8.x and SuiteCRM 7.x, head over to the MasterClasses to find out more.

About SuiteCRM

SuiteCRM is one of the world’s most popular CRM applications. Our feature-rich enterprise-ready alternative to Salesforce enables your sales teams to sell, market & service smarter. Providing all the benefits of CRM at substantially lower costs, with the freedoms and flexibility of Open Source.

You can download and host SuiteCRM on your own servers, in the public cloud / private cloud or try our SAAS offering SuiteCRM Hosted. It is the ultimate freedom, allowing you to stay in full control over your business data. Try SuiteCRM for free here.

Help support the SuiteCRM project by becoming a sponsor today!

SuiteCRM Developer Insights – Adding Subpanel Filters

About SuiteCRM

Share This Story, Choose Your Platform!