Sort object bricks by name

[mjanser]

No description provided.

[github-actions]

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

[mjanser]

I have read the CLA Document and I hereby sign the CLA

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[mjanser]

This is what I did in the meantime. It additionally sorts the object bricks by the translated title.

<?php

declare(strict_types=1);

namespace App\Pimcore\Objectbrick;

use Pimcore\Bundle\AdminBundle\Event\AdminEvents;
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
use Symfony\Component\EventDispatcher\GenericEvent;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Contracts\Translation\TranslatorInterface;

final readonly class ObjectbrickSorter
{
    public function __construct(
        private RequestStack $requestStack,
        private TranslatorInterface $translator,
    ) {
    }

    #[AsEventListener(AdminEvents::CLASS_OBJECTBRICK_LIST_PRE_SEND_DATA)]
    public function sortObjectbricks(GenericEvent $event): void
    {
        $language = 'en';
        $request = $this->requestStack->getCurrentRequest();
        if (null !== $request) {
            $language = $request->getLocale();
        }

        $definitions = $event->getArgument('list');
        if (is_array($definitions)) {
            usort($definitions, static function (mixed $a, mixed $b): int {
                if (! is_array($a) || ! is_array($b)) {
                    return 0;
                }

                if (array_key_exists('children', $a) && ! array_key_exists('children', $b)) {
                    return 1;
                }
                if (array_key_exists('children', $b) && ! array_key_exists('children', $a)) {
                    return -1;
                }

                return $a['text'] <=> $b['text'];
            });

            if (null !== $event->getArgument('objectId')) {
                // Sort children by their translated title when displayed on objects
                foreach ($definitions as &$definition) {
                    if (is_array($definition) && array_key_exists('children', $definition) && is_array($definition['children'])) {
                        usort($definition['children'], function (mixed $a, mixed $b) use ($language): int {
                            if (! is_array($a) || ! array_key_exists('title', $a) || ! is_string($a['title']) || ! is_array($b) || ! array_key_exists('title', $b) || ! is_string($b['title'])) {
                                return 0;
                            }

                            $titleA = $this->translator->trans($a['title'], domain: 'admin', locale: $language);
                            $titleB = $this->translator->trans($b['title'], domain: 'admin', locale: $language);

                            return $titleA <=> $titleB;
                        });
                    }
                }
            }

            $event->setArgument('list', $definitions);
        }
    }
}