SuiteCRM Developer Insights - Adding Service Decorators

This week Clemente Raposo, Lead Developer of SuiteCRM, takes you through the process of adding Service Decorators to SuiteCRM 8 core services.

Service Decorators are a convenient mechanism to extend core classes. In comparison with regular extensions, they have the advantage of allowing you to add many to the same class. This allows for multiple extensions to decorate the same class without having to know about each other, making it an ideal strategy to use as an extension and in plug-ins.

In today’s example, we are going to demo an alternative solution to adding custom entries to the module menu in the navigation bar using service decorators.

For those of you who are ready to get started right away, below you will find the code sample from the video.

Copy to Clipboard

public/legacy/custom/Extension/modules/Cases/Ext/Language/en_us.create-critical-error.php

Copy to Clipboard

<?php

namespace App\Extension\defaultExt\backend\Navbar;

use App\Engine\Service\AclManagerInterface;
use App\Navbar\Entity\Navbar;
use App\Routes\Service\NavigationProviderInterface;

class CreateCriticalCaseDecorator implements NavigationProviderInterface
{
    private NavigationProviderInterface $decorated;
    protected AclManagerInterface $aclManager;

/**
     * @param NavigationProviderInterface $decorated
     * @param AclManagerInterface $aclManager
     */
    public function __construct(
        NavigationProviderInterface $decorated,
        AclManagerInterface $aclManager
    )
    {
        $this->decorated = $decorated;
        $this->aclManager = $aclManager;
    }

public function getNavbar(): Navbar
    {
        $navigation = $this->decorated->getNavbar();
        $modules = $navigation->modules ?? [];

$cases = $modules['cases'] ?? [];
        $menu = $cases['menu'] ?? [];

if ($this->aclManager->checkAccess('cases', 'edit', true)) {
            $menu[] = [
                'module' => 'cases',
                'type' => 'create',
                'name' => 'Create',
                'labelKey' => 'LBL_CREATE_CRITICAL_ERROR_CASE',
                'actionLabelKey' => 'LBL_NEW',
                'process' => 'cases-create-critical-error',
                'icon' => 'plus',
                'quickAction' => true,
                'url' => './#/cases/edit',
                'params' => []
            ];
        }

$cases['menu'] = $menu;
        $modules['cases'] = $cases;
        $navigation->modules = $modules;
        return $navigation;
    }

public function getModuleRouting(): array
    {
        return $this->decorated->getModuleRouting();
    }
}

extensions/defaultExt/backend/Navbar/CreateCriticalCaseDecorator.php

Copy to Clipboard

extensions/defaultExt/config/services.yaml

Copy to Clipboard

<?php

namespace App\Extension\defaultExt\modules\Cases\Service\Create;

use ApiPlatform\Core\Exception\InvalidArgumentException;
use App\Engine\LegacyHandler\LegacyHandler;
use App\Process\Entity\Process;
use App\Process\Service\ProcessHandlerInterface;

class CaseCreateCriticalError extends LegacyHandler implements ProcessHandlerInterface
{
    protected const MSG_OPTIONS_NOT_FOUND = 'Process options are not defined';
    protected const MSG_INVALID_MODULE = 'Invalid Module';
    public const PROCESS_TYPE = 'cases-create-critical-error';

/**
     * @inheritDoc
     */
    public function getProcessType(): string
    {
        return self::PROCESS_TYPE;
    }

/**
     * @inheritDoc
     */
    public function getHandlerKey(): string
    {
        return self::PROCESS_TYPE;
    }

/**
     * @inheritDoc
     */
    public function requiredAuthRole(): string
    {
        return 'ROLE_USER';
    }

/**
     * @inheritDoc
     */
    public function getRequiredACLs(Process $process): array
    {
        $options = $process->getOptions();
        $module = $options['module'] ?? '';

return [
            $module => [
                [
                    'action' => 'edit',
                ]
            ],
        ];
    }

/**
     * @inheritDoc
     */
    public function configure(Process $process): void
    {
        //This process is synchronous
        //We aren't going to store a record on db
        //thus we will use process type as the id
        $process->setId(self::PROCESS_TYPE);
        $process->setAsync(false);
    }

/**
     * @inheritDoc
     */
    public function validate(Process $process): void
    {
        if (empty($process->getOptions())) {
            throw new InvalidArgumentException(self::MSG_OPTIONS_NOT_FOUND);
        }

$options = $process->getOptions();

if (empty($options['module']) || $options['module'] !== 'cases') {
            throw new InvalidArgumentException(self::MSG_INVALID_MODULE);
        }
    }

/**
     * @inheritDoc
     */
    public function run(Process $process)
    {
        $this->init();

$options = $process->getOptions();

/** @var \aCase $newCase */
        $newCase = \BeanFactory::newBean('Cases');
        $newCase->priority = 'P1';
        $newCase->name = 'Critical Error:';
        $newCase->type = 'User';
        $newCase->save();

//called module
        $module = 'cases';
        $action = 'edit';
        $recordId = $newCase->id;

$responseData = [
            'handler' => 'redirect',
            'params' => [
                'route' => $module . '/' . $action . '/' . $recordId,
                'queryParams' => []
            ]
        ];

$process->setStatus('success');
        $process->setMessages([]);
        $process->setData($responseData);

$this->close();
    }
}

extensions/defaultExt/modules/Cases/Service/Create/CaseCreateCriticalError.php

This sample can be used as an example to add your own Service Decorators based extension in SuiteCRM 8. In addition, you can learn more about them here

If you are looking for more development insights, the Development Team here at SalesAgility have created instructor-led master classes. 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 Service Decorators

About SuiteCRM

Share This Story, Choose Your Platform!