Extending Perspectives

Perspectives allow to create different views in the backend UI and even customize the standard perspective. They are using widgets to create unique views for the Pimcore Studio.

You can define:

• basic information like name, icon
• widgets on left, right and bottom
• limit the context menu permissions

How to add a custom context menu permissions

To add a custom context menu permission to the Pimcore Studio Backend, you need to implement your custom event subscriber and inject the Pimcore\Bundle\StudioBackendBundle\Perspective\Service\ContextPermissionsServiceInterface service.:

1. Define your subscriber service

services:
  _defaults:
    autowire: true
    autoconfigure: true
    public: false

  App\EventSubscriber\StudioContextPermissionsSubscriber: ~

2. (Optional) Conditionally add your subscriber

If the Studio is not a required bundle, but you still want to add the permissions to it once its enabled, you can follow the example below:

• Add your service to the separate configuration yaml file, for example pimcore_studio_backend.yaml.
• In your bundle extension class, e.g. AppExtension add following to the prepend method:

public function prepend(ContainerBuilder $container): void
{
    if ($container->hasExtension('pimcore_studio_backend')) {
        $loader = new YamlFileLoader(
            $container,
            new FileLocator(__DIR__ . '/../../config')
        );
        
        // Load your custom configuration file where you registered your Event Subscriber
        // In our example this is located in the `config` directory of your bundle
        $loader->load('pimcore_studio_backend.yaml');
    }
}

3. Implement your subscriber

<?php
declare(strict_types=1);

namespace App\EventSubscriber;

use Pimcore\Bundle\StudioBackendBundle\Perspective\Model\ContextPermissionData;
use Pimcore\Bundle\StudioBackendBundle\Perspective\Service\ContextPermissionsServiceInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\ControllerEvent;
use Symfony\Component\HttpKernel\KernelEvents;

final readonly class StudioContextPermissionsSubscriber implements EventSubscriberInterface
{
    public function __construct(
        private ContextPermissionsServiceInterface $permissionsService,
    ) {
    }

    public static function getSubscribedEvents(): array
    {
        return [
            KernelEvents::CONTROLLER => 'addContextPermissions',
        ];
    }

    public function addContextPermissions(ControllerEvent $event): void
    {
        // Add your custom permission (key, group name and default value)
        $this->permissionsService->add(new ContextPermissionData('my_custom_permission_key', 'group', false));
    }
}

Example perspective configuration

pimcore_studio_backend:
    studio_perspectives:
        7d540112_1cf5_49ba_ac34_d5a36ea3401f:
            name: "My Custom Perspective"
            icon: # Use null to use the default icon
                type: "path"
                value: "/path/to/custom/icon.svg"
            widgetsLeft:
                1efe7ac9_a03a_6334_9e48_13f662882599: "my_widget_type" # Array of widget ID => widget type
                d061699e_da42_4075_b504_c2c93c687819: "my_widget_type" # Array of widget ID => widget type
            widgetsRight: []
            widgetsBottom: []
            expandedLeft: "d061699e_da42_4075_b504_c2c93c687819" # ID of widget which should be expanded
            expandedRight: null
            contextPermissions: [] # When empty all registered permissions will be used with default values

info

You can see all default permissions and their values in Pimcore\Bundle\StudioBackendBundle\Perspective\Service\ContextPermissionService class.