AbstractAdmin.php

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\AdminBundle\Admin;

use Doctrine\Common\Util\ClassUtils;
use Knp\Menu\ItemInterface;
use Sonata\AdminBundle\Datagrid\DatagridInterface;
use Sonata\AdminBundle\Datagrid\DatagridMapper;
use Sonata\AdminBundle\Datagrid\ListMapper;
use Sonata\AdminBundle\Datagrid\ProxyQueryInterface;
use Sonata\AdminBundle\DependencyInjection\Admin\AbstractTaggedAdmin;
use Sonata\AdminBundle\Exception\AdminClassNotFoundException;
use Sonata\AdminBundle\Exporter\DataSourceInterface;
use Sonata\AdminBundle\FieldDescription\FieldDescriptionCollection;
use Sonata\AdminBundle\FieldDescription\FieldDescriptionInterface;
use Sonata\AdminBundle\Form\FormMapper;
use Sonata\AdminBundle\Form\Type\ModelHiddenType;
use Sonata\AdminBundle\Manipulator\ObjectManipulator;
use Sonata\AdminBundle\Object\Metadata;
use Sonata\AdminBundle\Route\RouteCollection;
use Sonata\AdminBundle\Security\Handler\AclSecurityHandlerInterface;
use Sonata\AdminBundle\Show\ShowMapper;
use Sonata\AdminBundle\Templating\MutableTemplateRegistryInterface;
// NEXT_MAJOR: Uncomment next line.
// use Sonata\AdminBundle\Util\Instantiator;
use Sonata\AdminBundle\Util\ParametersManipulator;
use Sonata\Form\Validator\Constraints\InlineConstraint;
use Sonata\Form\Validator\ErrorElement;
use Symfony\Component\Form\Extension\Core\Type\HiddenType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\FormEvent;
use Symfony\Component\Form\FormEvents;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\HttpFoundation\InputBag;
use Symfony\Component\HttpFoundation\ParameterBag;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\PropertyAccess\Exception\AccessException;
use Symfony\Component\PropertyAccess\Exception\UninitializedPropertyException;
use Symfony\Component\PropertyAccess\PropertyAccess;
use Symfony\Component\PropertyAccess\PropertyPath;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface as RoutingUrlGeneratorInterface;
use Symfony\Component\Security\Acl\Model\DomainObjectInterface;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;
use Symfony\Component\Validator\Mapping\GenericMetadata;

/**
 * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
 *
 * @phpstan-import-type FieldDescriptionOptions from FieldDescriptionInterface
 *
 * @phpstan-template T of object
 * @phpstan-extends AbstractTaggedAdmin<T>
 * @phpstan-implements AdminInterface<T>
 */
abstract class AbstractAdmin extends AbstractTaggedAdmin implements AdminInterface, DomainObjectInterface, AdminTreeInterface
{
    public const CONTEXT_MENU = 'menu';
    public const CONTEXT_DASHBOARD = 'dashboard';

    public const CLASS_REGEX =
        '@
        (?:([A-Za-z0-9]*)\\\)?        # vendor name / app name
        (Bundle\\\)?                  # optional bundle directory
        ([A-Za-z0-9]+?)(?:Bundle)?\\\ # bundle name, with optional suffix
        (
            Entity|Document|Model|PHPCR|CouchDocument|Phpcr|
            Doctrine\\\Orm|Doctrine\\\Phpcr|Doctrine\\\MongoDB|Doctrine\\\CouchDB
        )\\\(.*)@x';

    private const ACTION_TREE = 1;
    private const ACTION_SHOW = 2;
    private const ACTION_EDIT = 4;
    private const ACTION_DELETE = 8;
    private const ACTION_ACL = 16;
    private const ACTION_HISTORY = 32;
    private const ACTION_LIST = 64;
    private const ACTION_BATCH = 128;
    private const INTERNAL_ACTIONS = [
        'tree' => self::ACTION_TREE,
        'show' => self::ACTION_SHOW,
        'edit' => self::ACTION_EDIT,
        'delete' => self::ACTION_DELETE,
        'acl' => self::ACTION_ACL,
        'history' => self::ACTION_HISTORY,
        'list' => self::ACTION_LIST,
        'batch' => self::ACTION_BATCH,
    ];
    private const MASK_OF_ACTION_CREATE = self::ACTION_TREE | self::ACTION_SHOW | self::ACTION_EDIT | self::ACTION_DELETE | self::ACTION_LIST | self::ACTION_BATCH;
    private const MASK_OF_ACTION_SHOW = self::ACTION_EDIT | self::ACTION_HISTORY | self::ACTION_ACL;
    private const MASK_OF_ACTION_EDIT = self::ACTION_SHOW | self::ACTION_DELETE | self::ACTION_ACL | self::ACTION_HISTORY;
    private const MASK_OF_ACTION_HISTORY = self::ACTION_SHOW | self::ACTION_EDIT | self::ACTION_ACL;
    private const MASK_OF_ACTION_ACL = self::ACTION_EDIT | self::ACTION_HISTORY;
    private const MASK_OF_ACTION_LIST = self::ACTION_SHOW | self::ACTION_EDIT | self::ACTION_DELETE | self::ACTION_ACL | self::ACTION_BATCH;
    private const MASK_OF_ACTIONS_USING_OBJECT = self::MASK_OF_ACTION_SHOW | self::MASK_OF_ACTION_EDIT | self::MASK_OF_ACTION_HISTORY | self::MASK_OF_ACTION_ACL;

    private const DEFAULT_LIST_PER_PAGE_RESULTS = 32;
    private const DEFAULT_LIST_PER_PAGE_OPTIONS = [16, 32, 64, 128, 256];

    /**
     * The list FieldDescription constructed from the configureListField method.
     *
     * @var array<string, FieldDescriptionInterface>
     */
    protected $listFieldDescriptions = [];

    /**
     * The show FieldDescription constructed from the configureShowFields method.
     *
     * @var FieldDescriptionInterface[]
     */
    protected $showFieldDescriptions = [];

    /**
     * The list FieldDescription constructed from the configureFormField method.
     *
     * @var FieldDescriptionInterface[]
     */
    protected $formFieldDescriptions = [];

    /**
     * The filter FieldDescription constructed from the configureFilterField method.
     *
     * @var FieldDescriptionInterface[]
     */
    protected $filterFieldDescriptions = [];

    /**
     * NEXT_MAJOR: Remove this property.
     *
     * The number of result to display in the list.
     *
     * @deprecated since sonata-project/admin-bundle 3.67.
     *
     * @var int
     */
    protected $maxPerPage = self::DEFAULT_LIST_PER_PAGE_RESULTS;

    /**
     * The maximum number of page numbers to display in the list.
     *
     * @var int
     */
    protected $maxPageLinks = 25;

    /**
     * The base route name used to generate the routing information.
     *
     * @var string|null
     */
    protected $baseRouteName;

    /**
     * The base route pattern used to generate the routing information.
     *
     * @var string|null
     */
    protected $baseRoutePattern;

    /**
     * The label class name  (used in the title/breadcrumb ...).
     *
     * @var string|null
     */
    protected $classnameLabel;

    /**
     * The translation domain to be used to translate messages.
     *
     * @var string
     */
    protected $translationDomain = 'messages';

    /**
     * Options to set to the form (ie, validation_groups).
     *
     * @deprecated since sonata-project/admin-bundle 3.89, use configureFormOptions() instead.
     *
     * @var array<string, mixed>
     */
    protected $formOptions = [];

    /**
     * NEXT_MAJOR: Remove this property.
     *
     * Default values to the datagrid.
     *
     * @deprecated since sonata-project/admin-bundle 3.67, use configureDefaultSortValues() instead.
     *
     * @var array
     */
    protected $datagridValues = [
        DatagridInterface::PAGE => 1,
        DatagridInterface::PER_PAGE => self::DEFAULT_LIST_PER_PAGE_RESULTS,
    ];

    /**
     * NEXT_MAJOR: Remove this property.
     *
     * Predefined per page options.
     *
     * @deprecated since sonata-project/admin-bundle 3.67.
     *
     * @var array
     */
    protected $perPageOptions = self::DEFAULT_LIST_PER_PAGE_OPTIONS;

    /**
     * Array of routes related to this admin.
     *
     * @var RouteCollection|null
     */
    protected $routes;

    /**
     * The subject only set in edit/update/create mode.
     *
     * @var object|null
     *
     * @phpstan-var T|null
     */
    protected $subject;

    /**
     * Define a Collection of child admin, ie /admin/order/{id}/order-element/{childId}.
     *
     * @var array<string, AdminInterface>
     */
    protected $children = [];

    /**
     * Reference the parent admin.
     *
     * @var AdminInterface|null
     */
    protected $parent;

    /**
     * The base code route refer to the prefix used to generate the route name.
     *
     * NEXT_MAJOR: remove this attribute.
     *
     * @deprecated This attribute is deprecated since sonata-project/admin-bundle 3.24 and will be removed in 4.0
     *
     * @var string
     */
    protected $baseCodeRoute = '';

    /**
     * NEXT_MAJOR: should be default array and private.
     *
     * @var array<string, mixed>|string|null
     */
    protected $parentAssociationMapping;

    /**
     * Reference the parent FieldDescription related to this admin
     * only set for FieldDescription which is associated to an Sub Admin instance.
     *
     * @var FieldDescriptionInterface|null
     */
    protected $parentFieldDescription;

    /**
     * If true then the current admin is part of the nested admin set (from the url).
     *
     * @var bool
     */
    protected $currentChild = false;

    /**
     * NEXT_MAJOR: Rename $uniqId.
     *
     * The uniqId is used to avoid clashing with 2 admin related to the code
     * ie: a Block linked to a Block.
     *
     * @var string|null
     */
    protected $uniqid;

    /**
     * The current request object.
     *
     * @var Request|null
     */
    protected $request;

    /**
     * The datagrid instance.
     *
     * @var DatagridInterface|null
     */
    protected $datagrid;

    /**
     * The generated breadcrumbs.
     *
     * NEXT_MAJOR : remove this property
     *
     * @var array<string, ItemInterface|null>
     */
    protected $breadcrumbs = [];

    /**
     * @var ItemInterface|null
     */
    protected $menu;

    /**
     * @var array<string, bool>
     */
    protected $loaded = [
        'view_fields' => false, // NEXT_MAJOR: Remove this unused value.
        'view_groups' => false, // NEXT_MAJOR: Remove this unused value.
        'routes' => false,
        'tab_menu' => false,
        'show' => false,
        'list' => false,
        'form' => false,
        'datagrid' => false,
    ];

    /**
     * @var string[]
     */
    protected $formTheme = [];

    /**
     * @var string[]
     */
    protected $filterTheme = [];

    /**
     * @var array<string, string>
     *
     * @deprecated since sonata-project/admin-bundle 3.34, will be dropped in 4.0. Use TemplateRegistry services instead
     */
    protected $templates = [];

    /**
     * @var AdminExtensionInterface[]
     */
    protected $extensions = [];

    /**
     * Setting to true will enable preview mode for
     * the entity and show a preview button in the
     * edit/create forms.
     *
     * @var bool
     */
    protected $supportsPreviewMode = false;

    /**
     * @var array<string, bool>
     */
    protected $cacheIsGranted = [];

    /**
     * Action list for the search result.
     *
     * @var string[]
     */
    protected $searchResultActions = ['edit', 'show'];

    /**
     * The Access mapping.
     *
     * @var array<string, string|string[]> [action1 => requiredRole1, action2 => [requiredRole2, requiredRole3]]
     */
    protected $accessMapping = [];

    /**
     * @var MutableTemplateRegistryInterface|null
     */
    private $templateRegistry;

    /**
     * The subclasses supported by the admin class.
     *
     * @var array<string, string>
     */
    private $subClasses = [];

    /**
     * The list collection.
     *
     * @var FieldDescriptionCollection|null
     */
    private $list;

    /**
     * @var FieldDescriptionCollection|null
     */
    private $show;

    /**
     * @var FormInterface|null
     */
    private $form;

    /**
     * The cached base route name.
     *
     * @var string|null
     */
    private $cachedBaseRouteName;

    /**
     * The cached base route pattern.
     *
     * @var string|null
     */
    private $cachedBaseRoutePattern;

    /**
     * The form group disposition.
     *
     * NEXT_MAJOR: must have `[]` as default value and remove the possibility to
     * hold boolean values.
     *
     * @var array|bool
     */
    private $formGroups = false;

    /**
     * The form tabs disposition.
     *
     * NEXT_MAJOR: must have `[]` as default value and remove the possibility to
     * hold boolean values.
     *
     * @var array|bool
     */
    private $formTabs = false;

    /**
     * The view group disposition.
     *
     * NEXT_MAJOR: must have `[]` as default value and remove the possibility to
     * hold boolean values.
     *
     * @var array|bool
     */
    private $showGroups = false;

    /**
     * The view tab disposition.
     *
     * NEXT_MAJOR: must have `[]` as default value and remove the possibility to
     * hold boolean values.
     *
     * @var array|bool
     */
    private $showTabs = false;

    /**
     * The breadcrumbsBuilder component.
     *
     * @var BreadcrumbsBuilderInterface|null
     */
    private $breadcrumbsBuilder;

    /**
     * NEXT_MAJOR: Remove the construct override.
     *
     * @phpstan-param class-string<T> $class
     */
    public function __construct($code, $class, $baseControllerName = null)
    {
        parent::__construct($code, $class, $baseControllerName);

        // NEXT_MAJOR: Remove this line.
        $this->predefinePerPageOptions();

        // NEXT_MAJOR: Remove this line.
        $this->datagridValues[DatagridInterface::PER_PAGE] = $this->maxPerPage;
    }

    /**
     * {@inheritdoc}
     */
    public function getExportFormats()
    {
        return [
            'json', 'xml', 'csv', 'xls',
        ];
    }

    /**
     * @final since sonata-project/admin-bundle 3.76
     *
     * @return string[]
     */
    public function getExportFields()
    {
        $fields = $this->configureExportFields();

        foreach ($this->getExtensions() as $extension) {
            if (method_exists($extension, 'configureExportFields')) {
                $fields = $extension->configureExportFields($this, $fields);
            }
        }

        return $fields;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getDataSourceIterator()
    {
        $datagrid = $this->getDatagrid();
        $datagrid->buildPager();

        $fields = [];

        foreach ($this->getExportFields() as $key => $field) {
            // NEXT_MAJOR: Remove the following code in favor of the commented one.
            $label = $this->getTranslationLabel($field, 'export', 'label');
            $transLabel = $this->getTranslator()->trans($label, [], $this->getTranslationDomain());
            if ($transLabel === $label) {
                $fields[$key] = $field;
            } else {
                $fields[$transLabel] = $field;
            }
//            if (!\is_string($key)) {
//                $label = $this->getTranslationLabel($field, 'export', 'label');
//                $key = $this->getTranslator()->trans($label, [], $this->getTranslationDomain());
//            }
//
//            $fields[$key] = $field;
        }

        if ($this->getDataSource()) {
            $query = $datagrid->getQuery();

            return $this->getDataSource()->createIterator($query, $fields);
        }

        @trigger_error(sprintf(
            'Using "%s()" without setting a "%s" instance in the admin is deprecated since sonata-project/admin-bundle 3.79'
            .' and won\'t be possible in 4.0.',
            __METHOD__,
            DataSourceInterface::class
        ), \E_USER_DEPRECATED);

        return $this->getModelManager()->getDataSourceIterator($datagrid, $fields);
    }

    /**
     * NEXT_MAJOR: Remove this method.
     *
     * @deprecated since sonata-project/admin-bundle 3.82, use configureFormOptions() to set $formOptions['constraints'] instead.
     */
    public function validate(ErrorElement $errorElement, $object)
    {
        if ('sonata_deprecation_mute' !== (\func_get_args()[2] ?? null)) {
            @trigger_error(sprintf(
                'The %s method is deprecated since version 3.82 and will be removed in 4.0.',
                __METHOD__
            ), \E_USER_DEPRECATED);
        }
    }

    /**
     * @final since sonata-admin/admin-bundle 3.84
     */
    public function initialize()
    {
        if (!$this->classnameLabel) {
            /* NEXT_MAJOR: remove cast to string, null is not supposed to be
            supported but was documented as such */
            $this->classnameLabel = substr(
                (string) $this->getClass(),
                strrpos((string) $this->getClass(), '\\') + 1
            );
        }

        // NEXT_MAJOR: Remove this line.
        $this->baseCodeRoute = $this->getCode();

        $this->configure();

        foreach ($this->getExtensions() as $extension) {
            // NEXT_MAJOR: remove method_exists check
            if (method_exists($extension, 'configure')) {
                $extension->configure($this);
            }
        }
    }

    /**
     * NEXT_MAJOR: Restrict visibility to protected.
     */
    public function configure()
    {
    }

    public function update($object)
    {
        $this->preUpdate($object);
        foreach ($this->getExtensions() as $extension) {
            $extension->preUpdate($this, $object);
        }

        $result = $this->getModelManager()->update($object);
        // BC compatibility
        if (null !== $result) {
            $object = $result;
        }

        $this->postUpdate($object);
        foreach ($this->getExtensions() as $extension) {
            $extension->postUpdate($this, $object);
        }

        return $object;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function create($object)
    {
        $this->prePersist($object);
        foreach ($this->getExtensions() as $extension) {
            $extension->prePersist($this, $object);
        }

        $result = $this->getModelManager()->create($object);
        // BC compatibility
        if (null !== $result) {
            $object = $result;
        }

        $this->postPersist($object);
        foreach ($this->getExtensions() as $extension) {
            $extension->postPersist($this, $object);
        }

        $this->createObjectSecurity($object);

        return $object;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function delete($object)
    {
        $this->preRemove($object);
        foreach ($this->getExtensions() as $extension) {
            $extension->preRemove($this, $object);
        }

        $this->getSecurityHandler()->deleteObjectSecurity($this, $object);
        $this->getModelManager()->delete($object);

        $this->postRemove($object);
        foreach ($this->getExtensions() as $extension) {
            $extension->postRemove($this, $object);
        }
    }

    /**
     * NEXT_MAJOR: Change visibility to protected.
     *
     * @param object $object
     *
     * @phpstan-param T $object
     */
    public function preValidate($object)
    {
    }

    public function preUpdate($object)
    {
    }

    public function postUpdate($object)
    {
    }

    public function prePersist($object)
    {
    }

    public function postPersist($object)
    {
    }

    public function preRemove($object)
    {
    }

    public function postRemove($object)
    {
    }

    public function preBatchAction($actionName, ProxyQueryInterface $query, array &$idx, $allElements)
    {
    }

    final public function getDefaultFilterParameters(): array
    {
        return array_merge(
            /* @phpstan-ignore-next-line */
            $this->getModelManager()->getDefaultSortValues($this->getClass(), 'sonata_deprecation_mute'), // NEXT_MAJOR: Remove this line.
            $this->datagridValues, // NEXT_MAJOR: Remove this line.
            $this->getDefaultSortValues(),
            $this->getDefaultFilterValues()
        );
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @return array<string, mixed>
     */
    public function getFilterParameters()
    {
        $parameters = $this->getDefaultFilterParameters();

        // build the values array
        if ($this->hasRequest()) {
            /** @var InputBag|ParameterBag $bag */
            $bag = $this->getRequest()->query;
            if ($bag instanceof InputBag) {
                // symfony 5.1+
                $filters = $bag->all('filter');
            } else {
                $filters = $bag->get('filter', []);
            }
            if (isset($filters[DatagridInterface::PAGE])) {
                $filters[DatagridInterface::PAGE] = (int) $filters[DatagridInterface::PAGE];
            }
            if (isset($filters[DatagridInterface::PER_PAGE])) {
                $filters[DatagridInterface::PER_PAGE] = (int) $filters[DatagridInterface::PER_PAGE];
            }

            // if filter persistence is configured
            // NEXT_MAJOR: remove `$this->persistFilters !== false` from the condition
            if (false !== $this->persistFilters && $this->hasFilterPersister()) {
                // if reset filters is asked, remove from storage
                if ('reset' === $this->getRequest()->query->get('filters')) {
                    $this->getFilterPersister()->reset($this->getCode());
                }

                // if no filters, fetch from storage
                // otherwise save to storage
                if (empty($filters)) {
                    $filters = $this->getFilterPersister()->get($this->getCode());
                } else {
                    $this->getFilterPersister()->set($this->getCode(), $filters);
                }
            }

            $parameters = ParametersManipulator::merge($parameters, $filters);

            // always force the parent value
            if ($this->isChild() && $this->getParentAssociationMapping()) {
                $name = str_replace('.', '__', $this->getParentAssociationMapping());
                $parameters[$name] = ['value' => $this->getRequest()->get($this->getParent()->getIdParameter())];
            }
        }

        if (!isset($parameters[DatagridInterface::PER_PAGE]) || !$this->determinedPerPageValue($parameters[DatagridInterface::PER_PAGE])) {
            $parameters[DatagridInterface::PER_PAGE] = $this->getMaxPerPage();
        }

        $parameters = $this->configureFilterParameters($parameters);

        foreach ($this->getExtensions() as $extension) {
            // NEXT_MAJOR: remove method_exists check
            if (method_exists($extension, 'configureFilterParameters')) {
                $parameters = $extension->configureFilterParameters($this, $parameters);
            }
        }

        return $parameters;
    }

    /**
     * NEXT_MAJOR: Change the visibility to private.
     */
    public function buildDatagrid()
    {
        if ('sonata_deprecation_mute' !== (\func_get_args()[0] ?? null)) {
            @trigger_error(sprintf(
                'The %s() method is deprecated since sonata-project/admin-bundle 3.92'
                .' and will become private in version 4.0.',
                __METHOD__
            ), \E_USER_DEPRECATED);
        }

        if ($this->loaded['datagrid']) {
            return;
        }

        $this->loaded['datagrid'] = true;

        $filterParameters = $this->getFilterParameters();

        // transform DatagridInterface::SORT_BY from a string to a FieldDescriptionInterface for the datagrid.
        if (isset($filterParameters[DatagridInterface::SORT_BY]) && \is_string($filterParameters[DatagridInterface::SORT_BY])) {
            if ($this->hasListFieldDescription($filterParameters[DatagridInterface::SORT_BY])) {
                $filterParameters[DatagridInterface::SORT_BY] = $this->getListFieldDescription($filterParameters[DatagridInterface::SORT_BY]);
            } else {
                $filterParameters[DatagridInterface::SORT_BY] = $this->createFieldDescription(
                    $filterParameters[DatagridInterface::SORT_BY]
                );

                $this->getListBuilder()->buildField(null, $filterParameters[DatagridInterface::SORT_BY], $this);
            }
        }

        // initialize the datagrid
        $this->datagrid = $this->getDatagridBuilder()->getBaseDatagrid($this, $filterParameters);

        $this->datagrid->getPager()->setMaxPageLinks($this->getMaxPageLinks());

        $mapper = new DatagridMapper($this->getDatagridBuilder(), $this->datagrid, $this);

        // build the datagrid filter
        $this->configureDatagridFilters($mapper);

        // ok, try to limit to add parent filter
        if ($this->isChild() && $this->getParentAssociationMapping() && !$mapper->has($this->getParentAssociationMapping())) {
            $mapper->add($this->getParentAssociationMapping(), null, [
                'show_filter' => false,
                'label' => false,
                'field_type' => ModelHiddenType::class,
                'field_options' => [
                    'model_manager' => $this->getModelManager(),
                ],
                'operator_type' => HiddenType::class,
            ], [
                'admin_code' => $this->getParent()->getCode(),
            ]);
        }

        foreach ($this->getExtensions() as $extension) {
            $extension->configureDatagridFilters($mapper);
        }
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * Returns the name of the parent related field, so the field can be use to set the default
     * value (ie the parent object) or to filter the object.
     *
     * @throws \LogicException
     *
     * @return string|null
     */
    public function getParentAssociationMapping()
    {
        if (!$this->isChild()) {
            // NEXT_MAJOR: Uncomment the exception.
            @trigger_error(sprintf(
                'Calling %s() when the admin is not a child admin is deprecated since sonata-project/admin-bundle 3.103'
                .' and will throw a %s exception in 4.0.',
                __METHOD__,
                \LogicException::class
            ), \E_USER_DEPRECATED);
//            throw new \LogicException(sprintf(
//                'Admin "%s" has no parent.',
//                static::class
//            ));

            return $this->parentAssociationMapping;
        }

        $parent = $this->getParent()->getCode();

        // NEXT_MAJOR: remove this.
        if (!\is_array($this->parentAssociationMapping)) {
            return $this->parentAssociationMapping;
        }

        // NEXT_MAJOR: Return $this->parentAssociationMapping[$parent] without checks.
        if (\array_key_exists($parent, $this->parentAssociationMapping)) {
            return $this->parentAssociationMapping[$parent];
        }

        // NEXT_MAJOR: Remove this exception
        throw new \InvalidArgumentException(sprintf(
            'There\'s no association between "%s" and "%s".',
            $this->getCode(),
            $this->getParent()->getCode()
        ));
    }

    /**
     * NEXT_MAJOR: Remove this method.
     *
     * @deprecated since sonata-project/admin-bundle 3.103 and will be removed in 4.0.
     *
     * @param string $code
     * @param string $value
     */
    final public function addParentAssociationMapping($code, $value)
    {
        if (\is_string($this->parentAssociationMapping)) {
            @trigger_error(sprintf(
                'Calling "%s" when $this->parentAssociationMapping is string is deprecated since sonata-project/admin-bundle 3.75 and will be removed in 4.0.',
                __METHOD__
            ), \E_USER_DEPRECATED);
        }

        @trigger_error(sprintf(
            'Method "%s()" is deprecated since sonata-project/admin-bundle 3.103 and will be removed in 4.0.',
            __METHOD__
        ), \E_USER_DEPRECATED);

        $this->parentAssociationMapping[$code] = $value;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * Returns the baseRoutePattern used to generate the routing information.
     *
     * @throws \RuntimeException // NEXT_MAJOR: Remove this tag
     *
     * @return string the baseRoutePattern used to generate the routing information
     */
    public function getBaseRoutePattern()
    {
        if (null !== $this->cachedBaseRoutePattern) {
            return $this->cachedBaseRoutePattern;
        }

        if ($this->isChild()) { // the admin class is a child, prefix it with the parent route pattern
            $baseRoutePattern = $this->baseRoutePattern;
            if (!$this->baseRoutePattern) {
                preg_match(self::CLASS_REGEX, $this->class, $matches);

                if (!$matches) {
                    // NEXT_MAJOR: Throw \LogicException instead
                    throw new \RuntimeException(sprintf(
                        'Please define a default `baseRoutePattern` value for the admin class `%s`',
                        static::class
                    ));
                }
                $baseRoutePattern = $this->urlize($matches[5], '-');
            }

            $this->cachedBaseRoutePattern = sprintf(
                '%s/%s/%s',
                $this->getParent()->getBaseRoutePattern(),
                $this->getParent()->getRouterIdParameter(),
                $baseRoutePattern
            );
        } elseif ($this->baseRoutePattern) {
            $this->cachedBaseRoutePattern = $this->baseRoutePattern;
        } else {
            preg_match(self::CLASS_REGEX, $this->class, $matches);

            if (!$matches) {
                // NEXT_MAJOR: Throw \LogicException instead
                throw new \RuntimeException(sprintf(
                    'Please define a default `baseRoutePattern` value for the admin class `%s`',
                    static::class
                ));
            }

            $this->cachedBaseRoutePattern = sprintf(
                '/%s%s/%s',
                empty($matches[1]) ? '' : $this->urlize($matches[1], '-').'/',
                $this->urlize($matches[3], '-'),
                $this->urlize($matches[5], '-')
            );
        }

        return $this->cachedBaseRoutePattern;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * Returns the baseRouteName used to generate the routing information.
     *
     * @throws \RuntimeException // NEXT_MAJOR: Remove this tag
     *
     * @return string the baseRouteName used to generate the routing information
     */
    public function getBaseRouteName()
    {
        if (null !== $this->cachedBaseRouteName) {
            return $this->cachedBaseRouteName;
        }

        if ($this->isChild()) { // the admin class is a child, prefix it with the parent route name
            $baseRouteName = $this->baseRouteName;
            if (!$this->baseRouteName) {
                preg_match(self::CLASS_REGEX, $this->class, $matches);

                if (!$matches) {
                    // NEXT_MAJOR: Throw \LogicException instead
                    throw new \RuntimeException(sprintf(
                        'Cannot automatically determine base route name,'
                        .' please define a default `baseRouteName` value for the admin class `%s`',
                        static::class
                    ));
                }
                $baseRouteName = $this->urlize($matches[5]);
            }

            $this->cachedBaseRouteName = sprintf(
                '%s_%s',
                $this->getParent()->getBaseRouteName(),
                $baseRouteName
            );
        } elseif ($this->baseRouteName) {
            $this->cachedBaseRouteName = $this->baseRouteName;
        } else {
            preg_match(self::CLASS_REGEX, $this->class, $matches);

            if (!$matches) {
                // NEXT_MAJOR: Throw \LogicException instead
                throw new \RuntimeException(sprintf(
                    'Cannot automatically determine base route name,'
                    .' please define a default `baseRouteName` value for the admin class `%s`',
                    static::class
                ));
            }

            $this->cachedBaseRouteName = sprintf(
                'admin_%s%s_%s',
                empty($matches[1]) ? '' : $this->urlize($matches[1]).'_',
                $this->urlize($matches[3]),
                $this->urlize($matches[5])
            );
        }

        return $this->cachedBaseRouteName;
    }

    /**
     * urlize the given word.
     *
     * @param string $word
     * @param string $sep  the separator
     *
     * @return string
     */
    public function urlize($word, $sep = '_')
    {
        return strtolower(preg_replace('/[^a-z0-9_]/i', $sep.'$1', $word));
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getClass()
    {
        if ($this->hasActiveSubClass()) {
            if ($this->hasParentFieldDescription()) {
                // NEXT_MAJOR: Throw \LogicException instead
                throw new \RuntimeException('Feature not implemented: an embedded admin cannot have subclass');
            }

            $subClass = $this->getRequest()->query->get('subclass');

            if (!$this->hasSubClass($subClass)) {
                // NEXT_MAJOR: Throw \LogicException instead
                throw new \RuntimeException(sprintf('Subclass "%s" is not defined.', $subClass));
            }

            return $this->getSubClass($subClass);
        }

        // Do not use `$this->hasSubject()` and `$this->getSubject()` here to avoid infinite loop.
        // `getSubject` use `hasSubject()` which use `getObject()` which use `getClass()`.
        if (null !== $this->subject) {
            /** @phpstan-var class-string<T> $class */
            $class = ClassUtils::getClass($this->subject);

            return $class;
        }

        return $this->class;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getSubClasses()
    {
        return $this->subClasses;
    }

    /**
     * NEXT_MAJOR: remove this method.
     */
    public function addSubClass($subClass)
    {
        @trigger_error(sprintf(
            'Method "%s" is deprecated since sonata-project/admin-bundle 3.30 and will be removed in 4.0.',
            __METHOD__
        ), \E_USER_DEPRECATED);

        if (!\in_array($subClass, $this->subClasses, true)) {
            $this->subClasses[] = $subClass;
        }
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function setSubClasses(array $subClasses)
    {
        $this->subClasses = $subClasses;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function hasSubClass($name)
    {
        return isset($this->subClasses[$name]);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function hasActiveSubClass()
    {
        if (\count($this->subClasses) > 0 && $this->hasRequest()) {
            return null !== $this->getRequest()->query->get('subclass');
        }

        return false;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getActiveSubClass()
    {
        if (!$this->hasActiveSubClass()) {
            @trigger_error(sprintf(
                'Calling %s() when there is no active subclass is deprecated since sonata-project/admin-bundle 3.52'
                .' and will throw an exception in 4.0.'
                .' Use %s::hasActiveSubClass() to know if there is an active subclass.',
                __METHOD__,
                __CLASS__
            ), \E_USER_DEPRECATED);
            // NEXT_MAJOR : remove the previous `trigger_error()` call, the `return null` statement, uncomment the following exception and declare string as return type
            // throw new \LogicException(sprintf(
            //    'Admin "%s" has no active subclass.',
            //    static::class
            // ));

            return null;
        }

        return $this->getSubClass($this->getActiveSubclassCode());
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getActiveSubclassCode()
    {
        if (!$this->hasActiveSubClass()) {
            @trigger_error(sprintf(
                'Calling %s() when there is no active subclass is deprecated since sonata-project/admin-bundle 3.52'
                .' and will throw an exception in 4.0.'
                .' Use %s::hasActiveSubClass() to know if there is an active subclass.',
                __METHOD__,
                __CLASS__
            ), \E_USER_DEPRECATED);
            // NEXT_MAJOR : remove the previous `trigger_error()` call, the `return null` statement, uncomment the following exception and declare string as return type
            // throw new \LogicException(sprintf(
            //    'Admin "%s" has no active subclass.',
            //    static::class
            // ));

            return null;
        }

        $subClass = (string) $this->getRequest()->query->get('subclass');

        if (!$this->hasSubClass($subClass)) {
            @trigger_error(sprintf(
                'Calling %s() when there is no active subclass is deprecated since sonata-project/admin-bundle 3.52'
                .' and will throw an exception in 4.0.'
                .' Use %s::hasActiveSubClass() to know if there is an active subclass.',
                __METHOD__,
                __CLASS__
            ), \E_USER_DEPRECATED);
            // NEXT_MAJOR : remove the previous `trigger_error()` call, the `return null` statement, uncomment the following exception and declare string as return type
            // throw new \LogicException(sprintf(
            //    'Admin "%s" has no active subclass.',
            //    static::class
            // ));

            return null;
        }

        return $subClass;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getBatchActions()
    {
        $actions = [];

        if ($this->hasRoute('delete') && $this->hasAccess('delete')) {
            $actions['delete'] = [
                'label' => 'action_delete',
                'translation_domain' => 'SonataAdminBundle',
                'ask_confirmation' => true, // by default always true
            ];
        }

        $actions = $this->configureBatchActions($actions);

        foreach ($this->getExtensions() as $extension) {
            // NEXT_MAJOR: remove method check
            if (method_exists($extension, 'configureBatchActions')) {
                $actions = $extension->configureBatchActions($this, $actions);
            }
        }

        foreach ($actions  as $name => &$action) {
            if (!\array_key_exists('label', $action)) {
                $action['label'] = $this->getTranslationLabel($name, 'batch', 'label');
            }

            if (!\array_key_exists('translation_domain', $action)) {
                $action['translation_domain'] = $this->getTranslationDomain();
            }
        }

        return $actions;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getRoutes()
    {
        $this->buildRoutes();

        return $this->routes;
    }

    public function getRouterIdParameter()
    {
        return sprintf('{%s}', $this->getIdParameter());
    }

    public function getIdParameter()
    {
        $parameter = 'id';

        for ($i = 0; $i < $this->getChildDepth(); ++$i) {
            $parameter = sprintf('child%s', ucfirst($parameter));
        }

        return $parameter;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function hasRoute($name)
    {
        // NEXT_MAJOR: Remove this check.
        if (!$this->routeGenerator) {
            throw new \RuntimeException('RouteGenerator cannot be null');
        }

        return $this->getRouteGenerator()->hasAdminRoute($this, $name);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @param string      $name
     * @param string|null $adminCode
     *
     * @return bool
     */
    public function isCurrentRoute($name, $adminCode = null)
    {
        if (!$this->hasRequest()) {
            return false;
        }

        $request = $this->getRequest();
        $route = $request->get('_route');

        if ($adminCode) {
            $admin = $this->getConfigurationPool()->getAdminByAdminCode($adminCode);
        } else {
            $admin = $this;
        }

        if (!$admin) {
            return false;
        }

        return $admin->getRoutes()->getRouteName($name) === $route;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function generateObjectUrl($name, $object, array $parameters = [], $referenceType = RoutingUrlGeneratorInterface::ABSOLUTE_PATH)
    {
        $parameters[$this->getIdParameter()] = $this->getUrlSafeIdentifier($object);

        return $this->generateUrl($name, $parameters, $referenceType);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function generateUrl($name, array $parameters = [], $referenceType = RoutingUrlGeneratorInterface::ABSOLUTE_PATH)
    {
        return $this->getRouteGenerator()->generateUrl($this, $name, $parameters, $referenceType);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function generateMenuUrl($name, array $parameters = [], $referenceType = RoutingUrlGeneratorInterface::ABSOLUTE_PATH)
    {
        return $this->getRouteGenerator()->generateMenuUrl($this, $name, $parameters, $referenceType);
    }

    final public function setTemplateRegistry(MutableTemplateRegistryInterface $templateRegistry): void
    {
        $this->templateRegistry = $templateRegistry;
    }

    public function setTemplates(array $templates)
    {
        // NEXT_MAJOR: Remove this line
        $this->templates = $templates;

        $this->getTemplateRegistry()->setTemplates($templates);
    }

    public function setTemplate($name, $template)
    {
        // NEXT_MAJOR: Remove this line
        $this->templates[$name] = $template;

        $this->getTemplateRegistry()->setTemplate($name, $template);
    }

    /**
     * @deprecated since sonata-project/admin-bundle 3.34, will be dropped in 4.0. Use TemplateRegistry services instead
     *
     * @return array<string, string>
     */
    public function getTemplates()
    {
        return $this->getTemplateRegistry()->getTemplates();
    }

    /**
     * @deprecated since sonata-project/admin-bundle 3.34, will be dropped in 4.0. Use TemplateRegistry services instead
     *
     * @param string $name
     *
     * @return string|null
     */
    public function getTemplate($name)
    {
        return $this->getTemplateRegistry()->getTemplate($name);
    }

    /**
     * @final since sonata-project/admin-bundle 3.89
     */
    public function getNewInstance()
    {
        $object = $this->createNewInstance();

        $this->appendParentObject($object);
        $this->alterNewInstance($object);

        foreach ($this->getExtensions() as $extension) {
            $extension->alterNewInstance($this, $object);
        }

        return $object;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getFormBuilder()
    {
        $this->formOptions['data_class'] = $this->getClass();

        $formBuilder = $this->getFormContractor()->getFormBuilder(
            $this->getUniqid(),
            // NEXT_MAJOR : remove the merge with $this->formOptions
            array_merge($this->getFormOptions(), $this->formOptions)
        );

        $this->defineFormBuilder($formBuilder);

        return $formBuilder;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * This method is being called by the main admin class and the child class,
     * the getFormBuilder is only call by the main admin class.
     */
    public function defineFormBuilder(FormBuilderInterface $formBuilder)
    {
        if (!$this->hasSubject()) {
            @trigger_error(sprintf(
                'Calling %s() when there is no subject is deprecated since sonata-project/admin-bundle 3.65'
                .' and will throw an exception in 4.0. Use %s::setSubject() to set the subject.',
                __METHOD__,
                __CLASS__
            ), \E_USER_DEPRECATED);
            // NEXT_MAJOR : remove the previous `trigger_error()` call and uncomment the following exception
            // throw new \LogicException(sprintf(
            //    'Admin "%s" has no subject.',
            //    static::class
            // ));
        }

        $mapper = new FormMapper($this->getFormContractor(), $formBuilder, $this);

        $this->configureFormFields($mapper);

        foreach ($this->getExtensions() as $extension) {
            $extension->configureFormFields($mapper);
        }

        // NEXT_MAJOR: Remove this line.
        $this->attachInlineValidator('sonata_deprecation_mute');
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function attachAdminClass(FieldDescriptionInterface $fieldDescription)
    {
        $pool = $this->getConfigurationPool();

        try {
            $admin = $pool->getAdminByFieldDescription($fieldDescription);
        } catch (AdminClassNotFoundException $exception) {
            // Using a fieldDescription with no admin class for the target model is a valid case.
            // Since there is no easy way to check for this case, we catch the exception instead.
            return;
        }

        // NEXT_MAJOR: Remove this check
        if (!$admin) {
            return;
        }

        if ($this->hasRequest()) {
            $admin->setRequest($this->getRequest());
        }

        $fieldDescription->setAssociationAdmin($admin);
    }

    /**
     * @final since sonata-project/admin-bundle 3.90
     */
    public function getObject($id)
    {
        if (null === $id) {
            return null;
        }

        $object = $this->getModelManager()->find($this->getClass(), $id);
        if (null === $object) {
            return null;
        }

        $this->alterObject($object);
        foreach ($this->getExtensions() as $extension) {
            $extension->alterObject($this, $object);
        }

        return $object;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getForm()
    {
        // NEXT_MAJOR: Remove the `'sonata_deprecation_mute'` param
        $this->buildForm('sonata_deprecation_mute');

        return $this->form;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getList()
    {
        // NEXT_MAJOR: Remove the `'sonata_deprecation_mute'` param
        $this->buildList('sonata_deprecation_mute');

        return $this->list;
    }

    /**
     * @final since sonata-project/admin-bundle 3.63.0
     */
    public function createQuery($context = 'list')
    {
        if (\func_num_args() > 0) {
            @trigger_error(sprintf(
                'The $context argument of %s is deprecated since 3.3, to be removed in 4.0.',
                __METHOD__
            ), \E_USER_DEPRECATED);
        }

        $query = $this->getModelManager()->createQuery($this->getClass());

        $query = $this->configureQuery($query);
        foreach ($this->getExtensions() as $extension) {
            $extension->configureQuery($this, $query, $context);
        }

        return $query;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getDatagrid()
    {
        // NEXT_MAJOR: Remove the `'sonata_deprecation_mute'` param
        $this->buildDatagrid('sonata_deprecation_mute');

        return $this->datagrid;
    }

    /**
     * NEXT_MAJOR: Change the visibility to private and return type to void.
     *
     * @deprecated since sonata-project/admin-bundle 3.95
     */
    public function buildTabMenu($action, ?AdminInterface $childAdmin = null)
    {
        if ('sonata_deprecation_mute' !== (\func_get_args()[2] ?? null)) {
            @trigger_error(sprintf(
                'The "%s()" method is deprecated since sonata-project/admin-bundle 3.95 and will be removed in version 4.0.',
                __METHOD__
            ), \E_USER_DEPRECATED);
        }

        if ($this->loaded['tab_menu']) {
            return $this->menu;
        }

        $this->loaded['tab_menu'] = true;

        $menu = $this->getMenuFactory()->createItem('root');
        $menu->setChildrenAttribute('class', 'nav navbar-nav');
        $menu->setExtra('translation_domain', $this->getTranslationDomain());

        // Prevents BC break with KnpMenuBundle v1.x
        if (method_exists($menu, 'setCurrentUri')) {
            $menu->setCurrentUri($this->getRequest()->getBaseUrl().$this->getRequest()->getPathInfo());
        }

        $this->configureTabMenu($menu, $action, $childAdmin);

        foreach ($this->getExtensions() as $extension) {
            $extension->configureTabMenu($this, $menu, $action, $childAdmin);
        }

        $this->menu = $menu;

        return $this->menu;
    }

    /**
     * NEXT_MAJOR: Remove this method.
     *
     * @deprecated since sonata-project/admin-bundle 3.95
     */
    public function buildSideMenu($action, ?AdminInterface $childAdmin = null)
    {
        if ('sonata_deprecation_mute' !== (\func_get_args()[2] ?? null)) {
            @trigger_error(sprintf(
                'The "%s()" method is deprecated since sonata-project/admin-bundle 3.95 and will be removed in version 4.0.',
                __METHOD__
            ), \E_USER_DEPRECATED);
        }

        return $this->buildTabMenu($action, $childAdmin, 'sonata_deprecation_mute');
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @param string $action
     *
     * @return ItemInterface
     *
     * @phpstan-param AdminInterface<object>|null $childAdmin
     */
    public function getSideMenu($action, ?AdminInterface $childAdmin = null)
    {
        if ($this->isChild()) {
            return $this->getParent()->getSideMenu($action, $this);
        }

        $this->buildSideMenu($action, $childAdmin, 'sonata_deprecation_mute');

        return $this->menu;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @return string the root code
     */
    public function getRootCode()
    {
        return $this->getRoot()->getCode();
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @return AdminInterface the root admin class
     */
    public function getRoot()
    {
        if (!$this->hasParentFieldDescription()) {
            return $this;
        }

        return $this->getParentFieldDescription()->getAdmin()->getRoot();
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function setBaseControllerName($baseControllerName)
    {
        $this->baseControllerName = $baseControllerName;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getBaseControllerName()
    {
        return $this->baseControllerName;
    }

    /**
     * @param bool $persist
     *
     * NEXT_MAJOR: remove this method
     *
     * @deprecated since sonata-project/admin-bundle 3.34, to be removed in 4.0.
     */
    public function setPersistFilters($persist)
    {
        @trigger_error(sprintf(
            'The %s method is deprecated since version 3.34 and will be removed in 4.0.',
            __METHOD__
        ), \E_USER_DEPRECATED);

        $this->persistFilters = $persist;
    }

    /**
     * NEXT_MAJOR: Remove this method.
     *
     * @deprecated since sonata-project/admin-bundle 3.67, to be removed in 4.0.
     *
     * @param int $maxPerPage
     */
    public function setMaxPerPage($maxPerPage)
    {
        @trigger_error(sprintf(
            'The method %s is deprecated since sonata-project/admin-bundle 3.67 and will be removed in 4.0.',
            __METHOD__
        ), \E_USER_DEPRECATED);

        $this->maxPerPage = $maxPerPage;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @return int
     */
    public function getMaxPerPage()
    {
        // NEXT_MAJOR: Remove this line and uncomment the following.
        return $this->maxPerPage;
        // $sortValues = $this->getDefaultSortValues();

        // return $sortValues[DatagridInterface::PER_PAGE] ?? self::DEFAULT_LIST_PER_PAGE_RESULTS;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @param int $maxPageLinks
     */
    public function setMaxPageLinks($maxPageLinks)
    {
        $this->maxPageLinks = $maxPageLinks;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @return int
     */
    public function getMaxPageLinks()
    {
        return $this->maxPageLinks;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getFormGroups()
    {
        if (!\is_array($this->formGroups) && 'sonata_deprecation_mute' !== (\func_get_args()[0] ?? null)) {
            @trigger_error(sprintf(
                'Returning other type than array in method %s() is deprecated since sonata-project/admin-bundle 3.65.'
                .' It will return only array in version 4.0.',
                __METHOD__
            ), \E_USER_DEPRECATED);
        }

        return $this->formGroups;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function setFormGroups(array $formGroups)
    {
        $this->formGroups = $formGroups;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function removeFieldFromFormGroup($key)
    {
        foreach ($this->formGroups as $name => $formGroup) {
            unset($this->formGroups[$name]['fields'][$key]);

            if (empty($this->formGroups[$name]['fields'])) {
                unset($this->formGroups[$name]);
            }
        }
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @param string $group
     */
    public function reorderFormGroup($group, array $keys)
    {
        // NEXT_MAJOR: Remove the argument "sonata_deprecation_mute" in the following call.
        $formGroups = $this->getFormGroups('sonata_deprecation_mute');
        $formGroups[$group]['fields'] = array_merge(array_flip($keys), $formGroups[$group]['fields']);
        $this->setFormGroups($formGroups);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getFormTabs()
    {
        if (!\is_array($this->formTabs) && 'sonata_deprecation_mute' !== (\func_get_args()[0] ?? null)) {
            @trigger_error(sprintf(
                'Returning other type than array in method %s() is deprecated since sonata-project/admin-bundle 3.65.'
                .' It will return only array in version 4.0.',
                __METHOD__
            ), \E_USER_DEPRECATED);
        }

        return $this->formTabs;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function setFormTabs(array $formTabs)
    {
        $this->formTabs = $formTabs;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getShowTabs()
    {
        if (!\is_array($this->showTabs) && 'sonata_deprecation_mute' !== (\func_get_args()[0] ?? null)) {
            @trigger_error(sprintf(
                'Returning other type than array in method %s() is deprecated since sonata-project/admin-bundle 3.65.'
                .' It will return only array in version 4.0.',
                __METHOD__
            ), \E_USER_DEPRECATED);
        }

        return $this->showTabs;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function setShowTabs(array $showTabs)
    {
        $this->showTabs = $showTabs;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getShowGroups()
    {
        if (!\is_array($this->showGroups) && 'sonata_deprecation_mute' !== (\func_get_args()[0] ?? null)) {
            @trigger_error(sprintf(
                'Returning other type than array in method %s() is deprecated since sonata-project/admin-bundle 3.65.'
                .' It will return only array in version 4.0.',
                __METHOD__
            ), \E_USER_DEPRECATED);
        }

        return $this->showGroups;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function setShowGroups(array $showGroups)
    {
        $this->showGroups = $showGroups;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function reorderShowGroup($group, array $keys)
    {
        // NEXT_MAJOR: Remove the argument "sonata_deprecation_mute" in the following call.
        $showGroups = $this->getShowGroups('sonata_deprecation_mute');
        $showGroups[$group]['fields'] = array_merge(array_flip($keys), $showGroups[$group]['fields']);
        $this->setShowGroups($showGroups);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription)
    {
        $this->parentFieldDescription = $parentFieldDescription;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getParentFieldDescription()
    {
        if (!$this->hasParentFieldDescription()) {
            @trigger_error(sprintf(
                'Calling %s() when there is no parent field description is deprecated since'
                .' sonata-project/admin-bundle 3.66 and will throw an exception in 4.0.'
                .' Use %s::hasParentFieldDescription() to know if there is a parent field description.',
                __METHOD__,
                __CLASS__
            ), \E_USER_DEPRECATED);
            // NEXT_MAJOR : remove the previous `trigger_error()` call, the `return null` statement, uncomment the following exception and declare FieldDescriptionInterface as return type
            // throw new \LogicException(sprintf(
            //    'Admin "%s" has no parent field description.',
            //    static::class
            // ));

            return null;
        }

        return $this->parentFieldDescription;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function hasParentFieldDescription()
    {
        return $this->parentFieldDescription instanceof FieldDescriptionInterface;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function setSubject($subject)
    {
        if (\is_object($subject) && !is_a($subject, $this->getClass(), true)) {
            $message = <<<'EOT'
You are trying to set entity an instance of "%s",
which is not the one registered with this admin class ("%s").
This is deprecated since 3.5 and will no longer be supported in 4.0.
EOT;

            // NEXT_MAJOR : throw an exception instead
            @trigger_error(sprintf($message, \get_class($subject), $this->getClass()), \E_USER_DEPRECATED);
        }

        $this->subject = $subject;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getSubject()
    {
        if (!$this->hasSubject()) {
            @trigger_error(sprintf(
                'Calling %s() when there is no subject is deprecated since sonata-project/admin-bundle 3.66'
                .' and will throw an exception in 4.0. Use %s::hasSubject() to know if there is a subject.',
                __METHOD__,
                __CLASS__
            ), \E_USER_DEPRECATED);
            // NEXT_MAJOR : remove the previous `trigger_error()` call, the `return null` statement, uncomment the following exception and update the return type
            // throw new \LogicException(sprintf(
            //    'Admin "%s" has no subject.',
            //    static::class
            // ));

            return null;
        }

        return $this->subject;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function hasSubject()
    {
        if (null === $this->subject && $this->hasRequest() && !$this->hasParentFieldDescription()) {
            $id = $this->getRequest()->get($this->getIdParameter());

            if (null !== $id) {
                $this->subject = $this->getObject($id);
            }
        }

        return null !== $this->subject;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getFormFieldDescriptions()
    {
        // NEXT_MAJOR: Remove the `'sonata_deprecation_mute'` param
        $this->buildForm('sonata_deprecation_mute');

        return $this->formFieldDescriptions;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getFormFieldDescription($name)
    {
        // NEXT_MAJOR: Remove the `'sonata_deprecation_mute'` param
        $this->buildForm('sonata_deprecation_mute');

        if (!$this->hasFormFieldDescription($name)) {
            @trigger_error(sprintf(
                'Calling %s() when there is no form field description is deprecated since'
                .' sonata-project/admin-bundle 3.69 and will throw an exception in 4.0.'
                .' Use %s::hasFormFieldDescription() to know if there is a form field description.',
                __METHOD__,
                __CLASS__
            ), \E_USER_DEPRECATED);
            // NEXT_MAJOR : remove the previous `trigger_error()` call, the `return null` statement, uncomment the following exception and declare FieldDescriptionInterface as return type
            // throw new \LogicException(sprintf(
            //    'Admin "%s" has no form field description for the field %s.',
            //    static::class,
            //    $name
            // ));

            return null;
        }

        return $this->formFieldDescriptions[$name];
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @param string $name
     *
     * @return bool
     */
    public function hasFormFieldDescription($name)
    {
        // NEXT_MAJOR: Remove the `'sonata_deprecation_mute'` param
        $this->buildForm('sonata_deprecation_mute');

        return \array_key_exists($name, $this->formFieldDescriptions);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function addFormFieldDescription($name, FieldDescriptionInterface $fieldDescription)
    {
        $this->formFieldDescriptions[$name] = $fieldDescription;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @param string $name
     */
    public function removeFormFieldDescription($name)
    {
        unset($this->formFieldDescriptions[$name]);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * build and return the collection of form FieldDescription.
     *
     * @return FieldDescriptionInterface[] collection of form FieldDescription
     */
    public function getShowFieldDescriptions()
    {
        // NEXT_MAJOR: Remove the `'sonata_deprecation_mute'` param
        $this->buildShow('sonata_deprecation_mute');

        return $this->showFieldDescriptions;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * Returns the form FieldDescription with the given $name.
     *
     * @param string $name
     *
     * @return FieldDescriptionInterface
     */
    public function getShowFieldDescription($name)
    {
        // NEXT_MAJOR: Remove the `'sonata_deprecation_mute'` param
        $this->buildShow('sonata_deprecation_mute');

        if (!$this->hasShowFieldDescription($name)) {
            @trigger_error(sprintf(
                'Calling %s() when there is no show field description is deprecated since'
                .' sonata-project/admin-bundle 3.69 and will throw an exception in 4.0.'
                .' Use %s::hasFormFieldDescription() to know if there is a show field description.',
                __METHOD__,
                __CLASS__
            ), \E_USER_DEPRECATED);
            // NEXT_MAJOR : remove the previous `trigger_error()` call, the `return null` statement, uncomment the following exception and declare FieldDescriptionInterface as return type
            // throw new \LogicException(sprintf(
            //    'Admin "%s" has no show field description for the field %s.',
            //    static::class,
            //    $name
            // ));

            return null;
        }

        return $this->showFieldDescriptions[$name];
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function hasShowFieldDescription($name)
    {
        // NEXT_MAJOR: Remove the `'sonata_deprecation_mute'` param
        $this->buildShow('sonata_deprecation_mute');

        return \array_key_exists($name, $this->showFieldDescriptions);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function addShowFieldDescription($name, FieldDescriptionInterface $fieldDescription)
    {
        $this->showFieldDescriptions[$name] = $fieldDescription;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function removeShowFieldDescription($name)
    {
        unset($this->showFieldDescriptions[$name]);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getListFieldDescriptions()
    {
        // NEXT_MAJOR: Remove the `'sonata_deprecation_mute'` param
        $this->buildList('sonata_deprecation_mute');

        return $this->listFieldDescriptions;
    }

    public function getListFieldDescription($name)
    {
        // NEXT_MAJOR: Remove the `'sonata_deprecation_mute'` param
        $this->buildList('sonata_deprecation_mute');

        if (!$this->hasListFieldDescription($name)) {
            @trigger_error(sprintf(
                'Calling %s() when there is no list field description is deprecated since'
                .' sonata-project/admin-bundle 3.66 and will throw an exception in 4.0.'
                .' Use %s::hasListFieldDescription(\'%s\') to know if there is a list field description.',
                __METHOD__,
                __CLASS__,
                $name
            ), \E_USER_DEPRECATED);
            // NEXT_MAJOR : remove the previous `trigger_error()` call, the `return null` statement, uncomment the following exception and declare FieldDescriptionInterface as return type
            // throw new \LogicException(sprintf(
            //    'Admin "%s" has no list field description for %s.',
            //    static::class,
            //    $name
            // ));

            return null;
        }

        return $this->listFieldDescriptions[$name];
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function hasListFieldDescription($name)
    {
        // NEXT_MAJOR: Remove the `'sonata_deprecation_mute'` param
        $this->buildList('sonata_deprecation_mute');

        return \array_key_exists($name, $this->listFieldDescriptions);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function addListFieldDescription($name, FieldDescriptionInterface $fieldDescription)
    {
        $this->listFieldDescriptions[$name] = $fieldDescription;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function removeListFieldDescription($name)
    {
        unset($this->listFieldDescriptions[$name]);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getFilterFieldDescription($name)
    {
        // NEXT_MAJOR: Remove the `'sonata_deprecation_mute'` param
        $this->buildDatagrid('sonata_deprecation_mute');

        if (!$this->hasFilterFieldDescription($name)) {
            @trigger_error(sprintf(
                'Calling %s() when there is no filter field description is deprecated since'
                .' sonata-project/admin-bundle 3.69 and will throw an exception in 4.0.'
                .' Use %s::hasFilterFieldDescription() to know if there is a filter field description.',
                __METHOD__,
                __CLASS__
            ), \E_USER_DEPRECATED);
            // NEXT_MAJOR : remove the previous `trigger_error()` call, the `return null` statement, uncomment the following exception and declare FieldDescriptionInterface as return type
            // throw new \LogicException(sprintf(
            //    'Admin "%s" has no filter field description for the field %s.',
            //    static::class,
            //    $name
            // ));

            return null;
        }

        return $this->filterFieldDescriptions[$name];
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function hasFilterFieldDescription($name)
    {
        // NEXT_MAJOR: Remove the `'sonata_deprecation_mute'` param
        $this->buildDatagrid('sonata_deprecation_mute');

        return \array_key_exists($name, $this->filterFieldDescriptions);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function addFilterFieldDescription($name, FieldDescriptionInterface $fieldDescription)
    {
        $this->filterFieldDescriptions[$name] = $fieldDescription;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function removeFilterFieldDescription($name)
    {
        unset($this->filterFieldDescriptions[$name]);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getFilterFieldDescriptions()
    {
        // NEXT_MAJOR: Remove the `'sonata_deprecation_mute'` param
        $this->buildDatagrid('sonata_deprecation_mute');

        return $this->filterFieldDescriptions;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function addChild(AdminInterface $child)
    {
        $parentAdmin = $this;
        while ($parentAdmin->isChild() && $parentAdmin->getCode() !== $child->getCode()) {
            $parentAdmin = $parentAdmin->getParent();
        }

        if ($parentAdmin->getCode() === $child->getCode()) {
            // NEXT_MAJOR: Throw \LogicException instead
            throw new \RuntimeException(sprintf(
                'Circular reference detected! The child admin `%s` is already in the parent tree of the `%s` admin.',
                $child->getCode(),
                $this->getCode()
            ));
        }

        $this->children[$child->getCode()] = $child;

        // NEXT_MAJOR: remove $args and add $field parameter to this function on next Major

        $args = \func_get_args();

        if (isset($args[1])) {
            $child->setParent($this, $args[1]);
        } else {
            $child->setParent($this);
            @trigger_error(
                'Calling "addChild" without second argument is deprecated since sonata-project/admin-bundle 3.35 and will not be allowed in 4.0.',
                \E_USER_DEPRECATED
            );
        }
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function hasChild($code)
    {
        return isset($this->children[$code]);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getChildren()
    {
        return $this->children;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getChild($code)
    {
        if (!$this->hasChild($code)) {
            @trigger_error(sprintf(
                'Calling %s() when there is no child is deprecated since sonata-project/admin-bundle 3.69'
                .' and will throw an exception in 4.0. Use %s::hasChild() to know if the child exists.',
                __METHOD__,
                __CLASS__
            ), \E_USER_DEPRECATED);
            // NEXT_MAJOR : remove the previous `trigger_error()` call, the `return null` statement, uncomment the following exception and declare AdminInterface as return type
            // throw new \LogicException(sprintf(
            //    'Admin "%s" has no child for the code %s.',
            //    static::class,
            //    $code
            // ));

            return null;
        }

        return $this->getChildren()[$code];
    }

    /**
     * NEXT_MAJOR: Uncomment the `$parentAssociationMapping` argument.
     *
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function setParent(AdminInterface $parent/* , string $parentAssociationMapping */)
    {
        $this->parent = $parent;

        // NEXT_MAJOR: Uncomment the following line
        // $this->parentAssociationMapping[$parent->getCode()] = $parentAssociationMapping;

        // NEXT_MAJOR: Remove next line.
        $args = \func_get_args();

        // NEXT_MAJOR: Remove this entire if-else block.
        if (\array_key_exists(1, $args)) {
            if (!\is_string($args[1])) {
                throw new \TypeError(sprintf(
                    'Argument 2 passed to "%s()" must be of the type string, "%s" given.',
                    __METHOD__,
                    \is_object($args[1]) ? \get_class($args[1]) : \gettype($args[1])
                ));
            }

            $this->parentAssociationMapping[$parent->getCode()] = $args[1];
        } else {
            @trigger_error(sprintf(
                'Not passing argument 2 to "%s()" is deprecated since'
                .' sonata-project/admin-bundle 3.103 and will not be allowed in 4.0.',
                __METHOD__
            ), \E_USER_DEPRECATED);
        }
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getParent()
    {
        if (!$this->isChild()) {
            @trigger_error(sprintf(
                'Calling %s() when there is no parent is deprecated since sonata-project/admin-bundle 3.66'
                .' and will throw an exception in 4.0. Use %s::isChild() to know if there is a parent.',
                __METHOD__,
                __CLASS__
            ), \E_USER_DEPRECATED);
            // NEXT_MAJOR : remove the previous `trigger_error()` call, the `return null` statement, uncomment the following exception and declare AdminInterface as return type
            // throw new \LogicException(sprintf(
            //    'Admin "%s" has no parent.',
            //    static::class
            // ));

            return null;
        }

        return $this->parent;
    }

    final public function getRootAncestor()
    {
        $parent = $this;

        while ($parent->isChild()) {
            $parent = $parent->getParent();
        }

        return $parent;
    }

    final public function getChildDepth()
    {
        $parent = $this;
        $depth = 0;

        while ($parent->isChild()) {
            $parent = $parent->getParent();
            ++$depth;
        }

        return $depth;
    }

    final public function getCurrentLeafChildAdmin()
    {
        $child = $this->getCurrentChildAdmin();

        if (null === $child) {
            return null;
        }

        for ($c = $child; null !== $c; $c = $child->getCurrentChildAdmin()) {
            $child = $c;
        }

        return $child;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function isChild()
    {
        return $this->parent instanceof AdminInterface;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @return bool if the admin has children
     */
    public function hasChildren()
    {
        return \count($this->children) > 0;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function setUniqid($uniqId)
    {
        $this->uniqid = $uniqId;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getUniqid()
    {
        if (!$this->uniqid) {
            $this->uniqid = sprintf('s%s', uniqid());
        }

        return $this->uniqid;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @return string the classname label
     */
    public function getClassnameLabel()
    {
        if (null === $this->classnameLabel) {
            // NEXT_MAJOR: Remove this deprecation and uncomment the following exception
            @trigger_error(sprintf(
                'Calling %s() when no classname label is set is deprecated since sonata-project/admin-bundle 3.84'
                .' and will throw a LogicException in 4.0',
                __METHOD__,
            ), \E_USER_DEPRECATED);
//            throw new \LogicException(sprintf(
//                'Admin "%s" has no classname label. Did you forgot to initialize the admin ?',
//                static::class
//            ));
        }

        return $this->classnameLabel;
    }

    /**
     * @final since sonata-project/admin-bundle 3.90
     */
    public function getPersistentParameters()
    {
        $parameters = $this->configurePersistentParameters();
        foreach ($this->getExtensions() as $extension) {
            // NEXT_MAJOR: Remove the check and the else part.
            if (method_exists($extension, 'configurePersistentParameters')) {
                $parameters = $extension->configurePersistentParameters($this, $parameters);
            } else {
                $params = $extension->getPersistentParameters($this);

                // NEXT_MAJOR: Remove this check, since return typehint is added
                if (!\is_array($params)) {
                    throw new \RuntimeException(sprintf(
                        'Method "%s::getPersistentParameters()" must return an array.',
                        \get_class($extension)
                    ));
                }

                $parameters = array_merge($parameters, $params);
            }
        }

        return $parameters;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @param string $name
     *
     * @return mixed|null
     */
    public function getPersistentParameter($name)
    {
        $parameters = $this->getPersistentParameters();

        return $parameters[$name] ?? null;
    }

    public function getBreadcrumbs($action)
    {
        @trigger_error(sprintf(
            'The %s method is deprecated since version 3.2 and will be removed in 4.0.'
            .' Use %s::getBreadcrumbs instead.',
            __METHOD__,
            BreadcrumbsBuilder::class
        ), \E_USER_DEPRECATED);

        return $this->getBreadcrumbsBuilder()->getBreadcrumbs($this, $action);
    }

    /**
     * Generates the breadcrumbs array.
     *
     * Note: the method will be called by the top admin instance (parent => child)
     *
     * @param string $action
     *
     * @return ItemInterface|null
     */
    public function buildBreadcrumbs($action, ?ItemInterface $menu = null)
    {
        @trigger_error(sprintf(
            'The %s method is deprecated since version 3.2 and will be removed in 4.0.',
            __METHOD__
        ), \E_USER_DEPRECATED);

        if (isset($this->breadcrumbs[$action])) {
            return $this->breadcrumbs[$action];
        }

        return $this->breadcrumbs[$action] = $this->getBreadcrumbsBuilder()
            ->buildBreadcrumbs($this, $action, $menu);
    }

    /**
     * NEXT_MAJOR : remove this method.
     *
     * @return BreadcrumbsBuilderInterface
     */
    final public function getBreadcrumbsBuilder()
    {
        @trigger_error(sprintf(
            'The %s method is deprecated since version 3.2 and will be removed in 4.0.'
            .' Use the sonata.admin.breadcrumbs_builder service instead.',
            __METHOD__
        ), \E_USER_DEPRECATED);
        if (null === $this->breadcrumbsBuilder) {
            $this->breadcrumbsBuilder = new BreadcrumbsBuilder(
                $this->getConfigurationPool()->getContainer('sonata_deprecation_mute')->getParameter('sonata.admin.configuration.breadcrumbs')
            );
        }

        return $this->breadcrumbsBuilder;
    }

    /**
     * NEXT_MAJOR : remove this method.
     *
     * @return AbstractAdmin
     */
    final public function setBreadcrumbsBuilder(BreadcrumbsBuilderInterface $value)
    {
        @trigger_error(sprintf(
            'The %s method is deprecated since version 3.2 and will be removed in 4.0.'
            .' Use the sonata.admin.breadcrumbs_builder service instead.',
            __METHOD__
        ), \E_USER_DEPRECATED);
        $this->breadcrumbsBuilder = $value;

        return $this;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function setCurrentChild($currentChild)
    {
        $this->currentChild = $currentChild;
    }

    /**
     * NEXT_MAJOR: Remove this method.
     *
     * @deprecated since sonata-project/admin-bundle 3.65, to be removed in 4.0
     */
    public function getCurrentChild()
    {
        @trigger_error(sprintf(
            'The %s() method is deprecated since version 3.65 and will be removed in 4.0.'
            .' Use %s::isCurrentChild() instead.',
            __METHOD__,
            __CLASS__
        ), \E_USER_DEPRECATED);

        return $this->currentChild;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function isCurrentChild(): bool
    {
        return $this->currentChild;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @return AdminInterface|null the current child admin instance
     */
    public function getCurrentChildAdmin()
    {
        foreach ($this->getChildren() as $child) {
            // NEXT_MAJOR: Remove method_exists check and delete elseif case
            if (method_exists($child, 'isCurrentChild')) {
                if ($child->isCurrentChild()) {
                    return $child;
                }
            } else {
                if ($child->getCurrentChild()) {
                    return $child;
                }
            }
        }

        return null;
    }

    public function trans($id, array $parameters = [], $domain = null, $locale = null)
    {
        @trigger_error(sprintf(
            'The %s method is deprecated since version 3.9 and will be removed in 4.0.',
            __METHOD__
        ), \E_USER_DEPRECATED);

        $domain = $domain ?: $this->getTranslationDomain();

        return $this->getTranslator()->trans($id, $parameters, $domain, $locale);
    }

    /**
     * Translate a message id.
     *
     * NEXT_MAJOR: remove this method
     *
     * @param string      $id
     * @param int         $count
     * @param string|null $domain
     * @param string|null $locale
     *
     * @return string the translated string
     *
     * @deprecated since sonata-project/admin-bundle 3.9, to be removed with 4.0
     */
    public function transChoice($id, $count, array $parameters = [], $domain = null, $locale = null)
    {
        @trigger_error(sprintf(
            'The %s method is deprecated since version 3.9 and will be removed in 4.0.',
            __METHOD__
        ), \E_USER_DEPRECATED);

        $domain = $domain ?: $this->getTranslationDomain();

        return $this->getTranslator()->transChoice($id, $count, $parameters, $domain, $locale);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function setTranslationDomain($translationDomain)
    {
        $this->translationDomain = $translationDomain;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getTranslationDomain()
    {
        return $this->translationDomain;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getTranslationLabel($label, $context = '', $type = '')
    {
        return $this->getLabelTranslatorStrategy()->getLabel($label, $context, $type);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function setRequest(Request $request)
    {
        $this->request = $request;

        foreach ($this->getChildren() as $children) {
            $children->setRequest($request);
        }
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getRequest()
    {
        if (!$this->request) {
            // NEXT_MAJOR: Throw \LogicException instead.
            throw new \RuntimeException('The Request object has not been set');
        }

        return $this->request;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function hasRequest()
    {
        return null !== $this->request;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getCode()
    {
        return $this->code;
    }

    /**
     * NEXT_MAJOR: Remove this function.
     *
     * @deprecated This method is deprecated since sonata-project/admin-bundle 3.24 and will be removed in 4.0
     *
     * @param string $baseCodeRoute
     */
    public function setBaseCodeRoute($baseCodeRoute)
    {
        @trigger_error(sprintf(
            'The %s is deprecated since 3.24 and will be removed in 4.0.',
            __METHOD__
        ), \E_USER_DEPRECATED);

        $this->baseCodeRoute = $baseCodeRoute;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getBaseCodeRoute()
    {
        // NEXT_MAJOR: Uncomment the following lines.
        // if ($this->isChild()) {
        //     return sprintf('%s|%s', $this->getParent()->getBaseCodeRoute(), $this->getCode());
        // }
        //
        // return $this->getCode();

        // NEXT_MAJOR: Remove all the code below.
        if ($this->isChild()) {
            $parentCode = $this->getParent()->getCode();

            if ($this->getParent()->isChild()) {
                $parentCode = $this->getParent()->getBaseCodeRoute();
            }

            return sprintf('%s|%s', $parentCode, $this->getCode());
        }

        return $this->baseCodeRoute;
    }

    public function getObjectIdentifier()
    {
        return $this->getCode();
    }

    /**
     * NEXT_MAJOR: Change visibility to protected.
     *
     * Return the list of permissions the user should have in order to display the admin.
     *
     * @param string $context
     *
     * @return string[]
     */
    public function getPermissionsShow($context)
    {
        return ['LIST'];
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function showIn($context)
    {
        return $this->isGranted($this->getPermissionsShow($context));
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function createObjectSecurity($object)
    {
        $this->getSecurityHandler()->createObjectSecurity($this, $object);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function isGranted($name, $object = null)
    {
        $objectRef = $object ? sprintf('/%s#%s', spl_object_hash($object), $this->id($object)) : '';
        $key = md5(json_encode($name).$objectRef);

        if (!\array_key_exists($key, $this->cacheIsGranted)) {
            $this->cacheIsGranted[$key] = $this->getSecurityHandler()->isGranted($this, $name, $object ?: $this);
        }

        return $this->cacheIsGranted[$key];
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getUrlSafeIdentifier($model)
    {
        return $this->getModelManager()->getUrlSafeIdentifier($model);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getNormalizedIdentifier($model)
    {
        return $this->getModelManager()->getNormalizedIdentifier($model);
    }

    public function id($model)
    {
        return $this->getNormalizedIdentifier($model);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getShow()
    {
        // NEXT_MAJOR: Remove the `'sonata_deprecation_mute'` param
        $this->buildShow('sonata_deprecation_mute');

        return $this->show;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function setFormTheme(array $formTheme)
    {
        $this->formTheme = $formTheme;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getFormTheme()
    {
        return $this->formTheme;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function setFilterTheme(array $filterTheme)
    {
        $this->filterTheme = $filterTheme;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getFilterTheme()
    {
        return $this->filterTheme;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function addExtension(AdminExtensionInterface $extension)
    {
        $this->extensions[] = $extension;
    }

    final public function removeExtension(AdminExtensionInterface $extension): void
    {
        $key = array_search($extension, $this->extensions, true);
        if (false === $key) {
            throw new \InvalidArgumentException(
                sprintf('The extension "%s" was not set to the "%s" admin.', \get_class($extension), __CLASS__)
            );
        }

        unset($this->extensions[$key]);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getExtensions()
    {
        return $this->extensions;
    }

    public function toString($object)
    {
        // NEXT_MAJOR: Remove this check and use object as param typehint.
        if (!\is_object($object)) {
            @trigger_error(sprintf(
                'Passing %s as argument 1 for %s() is deprecated since sonata-project/admin-bundle 3.76.'
                .' Only object will be allowed in version 4.0.',
                \gettype($object),
                __METHOD__
            ), \E_USER_DEPRECATED);

            return '';
        }

        if (method_exists($object, '__toString') && null !== $object->__toString()) {
            return $object->__toString();
        }

        return sprintf('%s:%s', ClassUtils::getClass($object), spl_object_hash($object));
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function supportsPreviewMode()
    {
        return $this->supportsPreviewMode;
    }

    /**
     * NEXT_MAJOR: Remove this.
     *
     * @deprecated since sonata-project/admin-bundle 3.67, to be removed in 4.0.
     *
     * Set custom per page options.
     */
    public function setPerPageOptions(array $options)
    {
        @trigger_error(sprintf(
            'The method %s is deprecated since sonata-project/admin-bundle 3.67 and will be removed in 4.0.',
            __METHOD__
        ), \E_USER_DEPRECATED);

        $this->perPageOptions = $options;
    }

    /**
     * Returns predefined per page options.
     *
     * @return array<string, mixed>
     */
    public function getPerPageOptions()
    {
        // NEXT_MAJOR: Remove this line and uncomment the following
        return $this->perPageOptions;
//        $perPageOptions = self::DEFAULT_LIST_PER_PAGE_OPTIONS;
//        $perPageOptions[] = $this->getMaxPerPage();
//
//        $perPageOptions = array_unique($perPageOptions);
//        sort($perPageOptions);
//
//        return $perPageOptions;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @param int $perPage
     *
     * @return bool
     */
    public function determinedPerPageValue($perPage)
    {
        return \in_array($perPage, $this->getPerPageOptions(), true);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function isAclEnabled()
    {
        return $this->getSecurityHandler() instanceof AclSecurityHandlerInterface;
    }

    public function getObjectMetadata($object)
    {
        return new Metadata($this->toString($object));
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function setListMode($mode)
    {
        $this->getRequest()->getSession()->set(sprintf('%s.list_mode', $this->getCode()), $mode);
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function getListMode()
    {
        if (!$this->hasRequest() || !$this->getRequest()->hasSession()) {
            return 'list';
        }

        return $this->getRequest()->getSession()->get(sprintf('%s.list_mode', $this->getCode()), 'list');
    }

    public function getAccessMapping()
    {
        return $this->accessMapping;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     */
    public function checkAccess($action, $object = null)
    {
        $access = $this->getAccess();

        if (!\array_key_exists($action, $access)) {
            throw new \InvalidArgumentException(sprintf(
                'Action "%s" could not be found in access mapping.'
                .' Please make sure your action is defined into your admin class accessMapping property.',
                $action
            ));
        }

        if (!\is_array($access[$action])) {
            $access[$action] = [$access[$action]];
        }

        foreach ($access[$action] as $role) {
            if (false === $this->isGranted($role, $object)) {
                throw new AccessDeniedException(sprintf('Access Denied to the action %s and role %s', $action, $role));
            }
        }
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * Hook to handle access authorization, without throw Exception.
     *
     * @param string      $action
     * @param object|null $object
     *
     * @return bool
     *
     * @phpstan-param T|null $object
     */
    public function hasAccess($action, $object = null)
    {
        $access = $this->getAccess();

        if (!\array_key_exists($action, $access)) {
            return false;
        }

        if (!\is_array($access[$action])) {
            $access[$action] = [$access[$action]];
        }

        foreach ($access[$action] as $role) {
            if (false === $this->isGranted($role, $object)) {
                return false;
            }
        }

        return true;
    }

    /**
     * @param string      $action
     * @param object|null $object
     *
     * @return array<string, array<string, mixed>>
     *
     * @phpstan-param T|null $object
     */
    public function configureActionButtons($action, $object = null)
    {
        // nothing to do for non-internal actions
        if (!isset(self::INTERNAL_ACTIONS[$action])) {
            return [];
        }

        $actionBit = self::INTERNAL_ACTIONS[$action];

        $list = [];

        if (self::MASK_OF_ACTION_CREATE & $actionBit
            && $this->hasRoute('create')
            && $this->hasAccess('create')
        ) {
            $list['create'] = [
                // NEXT_MAJOR: Remove this line and use commented line below it instead
                'template' => $this->getTemplate('button_create'),
//                'template' => $this->getTemplateRegistry()->getTemplate('button_create'),
            ];
        }

        $canAccessObject = self::MASK_OF_ACTIONS_USING_OBJECT & $actionBit && null !== $object && null !== $this->id($object);

        if ($canAccessObject
            && self::MASK_OF_ACTION_EDIT & $actionBit
            && $this->hasRoute('edit')
            // NEXT_MAJOR: Replace by `$this->hasAccess`
            && $this->canAccessObject('edit', $object, 'sonata_deprecation_mute')
        ) {
            $list['edit'] = [
                // NEXT_MAJOR: Remove this line and use commented line below it instead
                'template' => $this->getTemplate('button_edit'),
                // 'template' => $this->getTemplateRegistry()->getTemplate('button_edit'),
            ];
        }

        if ($canAccessObject
            && self::MASK_OF_ACTION_HISTORY & $actionBit
            && $this->hasRoute('history')
            // NEXT_MAJOR: Replace by `$this->hasAccess`
            && $this->canAccessObject('history', $object, 'sonata_deprecation_mute')
        ) {
            $list['history'] = [
                // NEXT_MAJOR: Remove this line and use commented line below it instead
                'template' => $this->getTemplate('button_history'),
                // 'template' => $this->getTemplateRegistry()->getTemplate('button_history'),
            ];
        }

        if ($canAccessObject
            && self::MASK_OF_ACTION_ACL & $actionBit
            && $this->isAclEnabled()
            && $this->hasRoute('acl')
            // NEXT_MAJOR: Replace by `$this->hasAccess`
            && $this->canAccessObject('acl', $object, 'sonata_deprecation_mute')
        ) {
            $list['acl'] = [
                // NEXT_MAJOR: Remove this line and use commented line below it instead
                'template' => $this->getTemplate('button_acl'),
                // 'template' => $this->getTemplateRegistry()->getTemplate('button_acl'),
            ];
        }

        if ($canAccessObject
            && self::MASK_OF_ACTION_SHOW & $actionBit
            && $this->hasRoute('show')
            // NEXT_MAJOR: Replace by `$this->hasAccess`
            && $this->canAccessObject('show', $object, 'sonata_deprecation_mute')
            && \count($this->getShow()) > 0
        ) {
            $list['show'] = [
                // NEXT_MAJOR: Remove this line and use commented line below it instead
                'template' => $this->getTemplate('button_show'),
                // 'template' => $this->getTemplateRegistry()->getTemplate('button_show'),
            ];
        }

        if (self::MASK_OF_ACTION_LIST & $actionBit
            && $this->hasRoute('list')
            && $this->hasAccess('list')
        ) {
            $list['list'] = [
                // NEXT_MAJOR: Remove this line and use commented line below it instead
                'template' => $this->getTemplate('button_list'),
                // 'template' => $this->getTemplateRegistry()->getTemplate('button_list'),
            ];
        }

        return $list;
    }

    /**
     * @final since sonata-project/admin-bundle 3.102.
     *
     * @param string      $action
     * @param object|null $object
     *
     * @return array<string, array<string, mixed>>
     *
     * @phpstan-param T|null $object
     */
    public function getActionButtons($action, $object = null)
    {
        $list = $this->configureActionButtons($action, $object);

        foreach ($this->getExtensions() as $extension) {
            // NEXT_MAJOR: remove method check
            if (method_exists($extension, 'configureActionButtons')) {
                $list = $extension->configureActionButtons($this, $list, $action, $object);
            }
        }

        return $list;
    }

    /**
     * @final since sonata-project/admin-bundle 3.93.
     *
     * Get the list of actions that can be accessed directly from the dashboard.
     *
     * @return array<string, array<string, mixed>>
     */
    public function getDashboardActions()
    {
        $actions = [];

        if ($this->hasRoute('create') && $this->hasAccess('create')) {
            $actions['create'] = [
                'label' => 'link_add',
                'translation_domain' => 'SonataAdminBundle',
                // NEXT_MAJOR: Remove this line and use commented line below it instead
                'template' => $this->getTemplate('action_create'),
                // 'template' => $this->getTemplateRegistry()->getTemplate('action_create'),
                'url' => $this->generateUrl('create'),
                'icon' => 'fa fa-plus-circle',
            ];
        }

        if ($this->hasRoute('list') && $this->hasAccess('list')) {
            $actions['list'] = [
                'label' => 'link_list',
                'translation_domain' => 'SonataAdminBundle',
                'url' => $this->generateUrl('list'),
                'icon' => 'fa fa-list',
            ];
        }

        $actions = $this->configureDashboardActions($actions);

        // NEXT_MAJOR: Remove this code.
        $newActions = $this->configureDashboardButtons($actions);
        if ($newActions !== $actions) {
            @trigger_error(sprintf(
                'The "%s::configureDashboardButtons()" method is deprecated since sonata-project/admin-bundle 3.94'
                .' and will not be used in version 4.0. Use "configureDashboardActions()" instead.',
                __CLASS__
            ), \E_USER_DEPRECATED);

            $actions = $newActions;
        }

        foreach ($this->getExtensions() as $extension) {
            // NEXT_MAJOR: remove method check
            if (method_exists($extension, 'configureDashboardActions')) {
                $actions = $extension->configureDashboardActions($this, $actions);
            }
            // NEXT_MAJOR: remove this code.
            if (method_exists($extension, 'configureDashboardButtons')) {
                $newActions = $extension->configureDashboardButtons($this, $actions);

                if ($newActions !== $actions) {
                    @trigger_error(
                        'configureDashboardButtons() is deprecated since sonata-project/admin-bundle 3.94'
                        .' and will not be used in version 4.0. Use configureDashboardActions() instead.',
                        \E_USER_DEPRECATED
                    );

                    $actions = $newActions;
                }
            }
        }

        return $actions;
    }

    /**
     * @param object $object
     *
     * @phpstan-param T $object
     */
    final public function getSearchResultLink($object)
    {
        foreach ($this->searchResultActions as $action) {
            if ($this->hasRoute($action) && $this->hasAccess($action, $object)) {
                return $this->generateObjectUrl($action, $object);
            }
        }

        return null;
    }

    /**
     * NEXT_MAJOR: remove this method.
     *
     * Checks if a filter type is set to a default value.
     *
     * @param string $name
     *
     * @return bool
     */
    final public function isDefaultFilter($name)
    {
        @trigger_error(sprintf(
            'Method "%s" is deprecated since sonata-project/admin-bundle 3.76.',
            __METHOD__
        ), \E_USER_DEPRECATED);

        $filter = $this->getFilterParameters();
        $default = $this->getDefaultFilterValues();

        if (!\array_key_exists($name, $filter) || !\array_key_exists($name, $default)) {
            return false;
        }

        return $filter[$name] === $default[$name];
    }

    /**
     * NEXT_MAJOR: Remove this method.
     *
     * Check object existence and access, without throw Exception.
     *
     * @param string $action
     * @param object $object
     *
     * @return bool
     *
     * @phpstan-param T $object
     */
    public function canAccessObject($action, $object)
    {
        if ('sonata_deprecation_mute' !== (\func_get_args()[2] ?? null)) {
            @trigger_error(sprintf(
                'The method %s() is deprecated since sonata-project/admin-bundle 3.92'
                .' and will be removed an in 4.0. Use `hasAccess()` instead',
                __METHOD__,
            ), \E_USER_DEPRECATED);
        }

        if (!\is_object($object)) {
            return false;
        }
        if (!$this->id($object)) {
            return false;
        }

        return $this->hasAccess($action, $object);
    }

    final public function getTemplateRegistry(): ?MutableTemplateRegistryInterface
    {
        // NEXT_MAJOR: Remove the deprecation and uncomment the exception.
        if (!$this->hasTemplateRegistry()) {
            @trigger_error(sprintf(
                'Calling %s() when there is no template registry is deprecated since sonata-project/admin-bundle 3.76'
                .' and will throw an exception in 4.0.'
                .' Use %s::hasTemplateRegistry() to know if the template registry is set.',
                __METHOD__,
                __CLASS__
            ), \E_USER_DEPRECATED);
        }
        // if (false === $this->hasTemplateRegistry()) {
        //    throw new \LogicException(sprintf('Unable to find the template registry for admin `%s`.', static::class));
        // }

        return $this->templateRegistry;
    }

    final public function hasTemplateRegistry(): bool
    {
        return null !== $this->templateRegistry;
    }

    /**
     * NEXT_MAJOR: Move this phpdoc to the interface.
     *
     * @phpstan-param FieldDescriptionOptions $options
     */
    final public function createFieldDescription(string $propertyName, array $options = []): FieldDescriptionInterface
    {
        $fieldDescriptionFactory = $this->getFieldDescriptionFactory();

        // NEXT_MAJOR: Remove the "if" block and leave the "else" one.
        if (null === $fieldDescriptionFactory) {
            $fieldDescription = $this->getModelManager()->getNewFieldDescriptionInstance(
                $this->getClass(),
                $propertyName,
                $options
            );
        } else {
            $fieldDescription = $fieldDescriptionFactory->create($this->getClass(), $propertyName, $options);
        }

        $fieldDescription->setAdmin($this);

        return $fieldDescription;
    }

    /**
     * @phpstan-return T
     */
    protected function createNewInstance(): object
    {
        // NEXT_MAJOR: Uncomment next line and remove the other one.
        // return Instantiator::instantiate($this->getClass());
        /* @phpstan-ignore-next-line */
        return $this->getModelManager()->getModelInstance($this->getClass(), 'sonata_deprecation_mute');
    }

    /**
     * @phpstan-param T $object
     */
    protected function alterNewInstance(object $object): void
    {
    }

    /**
     * @phpstan-param T $object
     */
    protected function alterObject(object $object): void
    {
    }

    /**
     * @return array<string, mixed>
     */
    protected function configurePersistentParameters(): array
    {
        return [];
    }

    /**
     * @return string[]
     */
    protected function configureExportFields(): array
    {
        return $this->getModelManager()->getExportFields($this->getClass());
    }

    protected function configureQuery(ProxyQueryInterface $query): ProxyQueryInterface
    {
        return $query;
    }

    /**
     * @param array<string, mixed> $parameters
     *
     * @return array<string, mixed>
     */
    protected function configureFilterParameters(array $parameters): array
    {
        return $parameters;
    }

    /**
     * Returns a list of default sort values.
     *
     * @phpstan-return array{
     *     _page?: int,
     *     _per_page?: int,
     *     _sort_by?: string,
     *     _sort_order?: string
     * }
     */
    final protected function getDefaultSortValues(): array
    {
        // NEXT_MAJOR: Use the next line instead.
        $defaultSortValues = [];
        // $defaultSortValues = [DatagridInterface::PAGE => 1, DatagridInterface::PER_PAGE => self::DEFAULT_LIST_PER_PAGE_RESULTS];

        $this->configureDefaultSortValues($defaultSortValues);

        foreach ($this->getExtensions() as $extension) {
            // NEXT_MAJOR: remove method check
            if (method_exists($extension, 'configureDefaultSortValues')) {
                $extension->configureDefaultSortValues($this, $defaultSortValues);
            }
        }

        return $defaultSortValues;
    }

    /**
     * Returns a list of default filters.
     *
     * @return array<string, mixed>
     */
    final protected function getDefaultFilterValues()
    {
        $defaultFilterValues = [];

        $this->configureDefaultFilterValues($defaultFilterValues);

        foreach ($this->getExtensions() as $extension) {
            // NEXT_MAJOR: remove method check
            if (method_exists($extension, 'configureDefaultFilterValues')) {
                $extension->configureDefaultFilterValues($this, $defaultFilterValues);
            }
        }

        return $defaultFilterValues;
    }

    /**
     * Returns a list of form options.
     *
     * @return array<string, mixed>
     */
    final protected function getFormOptions()
    {
        $formOptions = [];

        $this->configureFormOptions($formOptions);

        foreach ($this->getExtensions() as $extension) {
            // NEXT_MAJOR: remove method check
            if (method_exists($extension, 'configureFormOptions')) {
                $extension->configureFormOptions($this, $formOptions);
            }
        }

        return $formOptions;
    }

    /**
     * @phpstan-param FormMapper<T> $form
     */
    protected function configureFormFields(FormMapper $form)
    {
    }

    /**
     * @phpstan-param ListMapper<T> $list
     */
    protected function configureListFields(ListMapper $list)
    {
    }

    /**
     * @phpstan-param DatagridMapper<T> $filter
     */
    protected function configureDatagridFilters(DatagridMapper $filter)
    {
    }

    /**
     * @phpstan-param ShowMapper<T> $show
     */
    protected function configureShowFields(ShowMapper $show)
    {
    }

    protected function configureRoutes(RouteCollection $collection)
    {
    }

    /**
     * Allows you to customize batch actions.
     *
     * @param array<string, array<string, mixed>> $actions List of actions
     *
     * @return array<string, array<string, mixed>>
     */
    protected function configureBatchActions($actions)
    {
        return $actions;
    }

    /**
     * @param array<string, array<string, mixed>> $actions
     *
     * @return array<string, array<string, mixed>>
     */
    protected function configureDashboardActions(array $actions): array
    {
        return $actions;
    }

    /**
     * NEXT_MAJOR: Remove this method.
     *
     * @param array<string, array<string, mixed>> $actions
     *
     * @return array<string, array<string, mixed>>
     */
    protected function configureDashboardButtons(array $actions): array
    {
        return $actions;
    }

    /**
     * NEXT_MAJOR: remove this method.
     *
     * @deprecated Use configureTabMenu instead
     *
     * @phpstan-param AdminInterface<object>|null $childAdmin
     */
    protected function configureSideMenu(ItemInterface $menu, string $action, ?AdminInterface $childAdmin = null)
    {
    }

    /**
     * Configures the tab menu in your admin.
     *
     * @param string $action
     *
     * @phpstan-param AdminInterface<object>|null $childAdmin
     */
    protected function configureTabMenu(ItemInterface $menu, $action, ?AdminInterface $childAdmin = null)
    {
        // Use configureSideMenu not to mess with previous overrides
        // NEXT_MAJOR: remove this line
        $this->configureSideMenu($menu, $action, $childAdmin);
    }

    /**
     * NEXT_MAJOR: Change the visibility to private.
     */
    protected function buildShow()
    {
        if ('sonata_deprecation_mute' !== (\func_get_args()[0] ?? null)) {
            @trigger_error(sprintf(
                'The %s() method is deprecated since sonata-project/admin-bundle 3.92'
                .' and will become private in version 4.0.',
                __METHOD__
            ), \E_USER_DEPRECATED);
        }

        if ($this->loaded['show']) {
            return;
        }

        $this->loaded['show'] = true;

        $this->show = $this->getShowBuilder()->getBaseList();
        $mapper = new ShowMapper($this->getShowBuilder(), $this->show, $this);

        $this->configureShowFields($mapper);

        foreach ($this->getExtensions() as $extension) {
            $extension->configureShowFields($mapper);
        }
    }

    /**
     * NEXT_MAJOR: Change visibility to private.
     *
     * @deprecated since sonata-project/admin-bundle 3.92 will be private in 4.0
     */
    protected function buildList()
    {
        if ('sonata_deprecation_mute' !== (\func_get_args()[0] ?? null)) {
            @trigger_error(sprintf(
                'The %s() method is deprecated since sonata-project/admin-bundle 3.92'
                .' and will become private in version 4.0.',
                __METHOD__
            ), \E_USER_DEPRECATED);
        }

        if ($this->loaded['list']) {
            return;
        }

        $this->loaded['list'] = true;

        $this->list = $this->getListBuilder()->getBaseList();
        $mapper = new ListMapper($this->getListBuilder(), $this->list, $this);

        if (\count($this->getBatchActions()) > 0 && $this->hasRequest() && !$this->getRequest()->isXmlHttpRequest()) {
            $mapper->add(ListMapper::NAME_BATCH, ListMapper::TYPE_BATCH, [
                'label' => 'batch',
                // NEXT_MAJOR: Remove this code.
                'code' => '_batch',
                'sortable' => false,
                'virtual_field' => true,
                // NEXT_MAJOR: Remove this line and use commented line below it instead
                'template' => $this->getTemplate('batch'),
                // 'template' => $this->getTemplateRegistry()->getTemplate('batch'),
            ]);
        }

        $this->configureListFields($mapper);

        foreach ($this->getExtensions() as $extension) {
            $extension->configureListFields($mapper);
        }

        if ($this->hasRequest()
            && $this->getRequest()->isXmlHttpRequest()
            && $this->getRequest()->query->getBoolean('select', true) // NEXT_MAJOR: Change the default value to `false` in version 5
        ) {
            $mapper->remove(ListMapper::NAME_ACTIONS);
            $mapper->add(ListMapper::NAME_SELECT, ListMapper::TYPE_SELECT, [
                'label' => false,
                // NEXT_MAJOR: Remove this code.
                'code' => '_select',
                'sortable' => false,
                'virtual_field' => false,
                // NEXT_MAJOR: Remove this line and use commented line below it instead
                'template' => $this->getTemplate('select'),
                // 'template' => $this->getTemplateRegistry()->getTemplate('select'),
            ]);
        }
    }

    /**
     * NEXT_MAJOR: Change visibility to private.
     *
     * @deprecated since sonata-project/admin-bundle 3.92 will be private in 4.0
     */
    protected function buildForm()
    {
        if ('sonata_deprecation_mute' !== (\func_get_args()[0] ?? null)) {
            @trigger_error(sprintf(
                'The %s() method is deprecated since sonata-project/admin-bundle 3.92'
                .' and will become private in version 4.0.',
                __METHOD__
            ), \E_USER_DEPRECATED);
        }

        if ($this->loaded['form']) {
            return;
        }

        $this->loaded['form'] = true;

        $formBuilder = $this->getFormBuilder();
        $formBuilder->addEventListener(FormEvents::POST_SUBMIT, function (FormEvent $event) {
            $this->preValidate($event->getData());
        }, 100);

        $this->form = $formBuilder->getForm();
    }

    /**
     * Gets the subclass corresponding to the given name.
     *
     * @param string $name The name of the sub class
     *
     * @return string the subclass
     *
     * @phpstan-return class-string<T>
     */
    protected function getSubClass($name)
    {
        if ($this->hasSubClass($name)) {
            return $this->subClasses[$name];
        }

        // NEXT_MAJOR: Throw \LogicException instead.
        throw new \RuntimeException(sprintf('Unable to find the subclass `%s` for admin `%s`', $name, static::class));
    }

    /**
     * Attach the inline validator to the model metadata, this must be done once per admin.
     *
     * NEXT_MAJOR: Remove this method.
     *
     * @deprecated since sonata-project/admin-bundle 3.82.
     */
    protected function attachInlineValidator()
    {
        if ('sonata_deprecation_mute' !== \func_get_args()[0] ?? null) {
            @trigger_error(sprintf(
                'The %s method is deprecated since version 3.82 and will be removed in 4.0.',
                __METHOD__
            ), \E_USER_DEPRECATED);
        }

        $admin = $this;

        // add the custom inline validation option
        $metadata = $this->validator->getMetadataFor($this->getClass());
        if (!$metadata instanceof GenericMetadata) {
            throw new \UnexpectedValueException(
                sprintf(
                    'Cannot add inline validator for %s because its metadata is an instance of %s instead of %s',
                    $this->getClass(),
                    \get_class($metadata),
                    GenericMetadata::class
                )
            );
        }

        $metadata->addConstraint(new InlineConstraint([
            'service' => $this,
            'method' => static function (ErrorElement $errorElement, $object) use ($admin) {
                /* @var \Sonata\AdminBundle\Admin\AdminInterface $admin */

                // This avoid the main validation to be cascaded to children
                // The problem occurs when a model Page has a collection of Page as property
                if ($admin->hasSubject() && spl_object_hash($object) !== spl_object_hash($admin->getSubject())) {
                    return;
                }

                $admin->validate($errorElement, $object, 'sonata_deprecation_mute');

                foreach ($admin->getExtensions() as $extension) {
                    /* @phpstan-ignore-next-line */
                    $extension->validate($admin, $errorElement, $object, 'sonata_deprecation_mute');
                }
            },
            'serializingWarning' => true,
        ]));
    }

    /**
     * NEXT_MAJOR: Remove this function.
     *
     * @deprecated since sonata-project/admin-bundle 3.67, to be removed in 4.0.
     *
     * Predefine per page options.
     */
    protected function predefinePerPageOptions()
    {
        array_unshift($this->perPageOptions, $this->maxPerPage);
        $this->perPageOptions = array_unique($this->perPageOptions);
        sort($this->perPageOptions);
    }

    /**
     * Return list routes with permissions name.
     *
     * @return array<string, string|string[]>
     *
     * @final since sonata-project/admin-bundle 3.x.
     */
    protected function getAccess()
    {
        $access = array_merge([
            'acl' => 'MASTER',
            'export' => 'EXPORT',
            'historyCompareRevisions' => 'EDIT',
            'historyViewRevision' => 'EDIT',
            'history' => 'EDIT',
            'edit' => 'EDIT',
            'show' => 'VIEW',
            'create' => 'CREATE',
            'delete' => 'DELETE',
            'batchDelete' => 'DELETE',
            'list' => 'LIST',
        ], $this->getAccessMapping());

        foreach ($this->getExtensions() as $extension) {
            // NEXT_MAJOR: remove method check
            if (method_exists($extension, 'getAccessMapping')) {
                $access = array_merge($access, $extension->getAccessMapping($this));
            }
        }

        return $access;
    }

    /**
     * Configures a list of default filters.
     *
     * @param array<string, mixed> $filterValues
     */
    protected function configureDefaultFilterValues(array &$filterValues)
    {
    }

    /**
     * Configures a list of form options.
     *
     * @param array<string, mixed> $formOptions
     */
    protected function configureFormOptions(array &$formOptions)
    {
    }

    /**
     * Configures a list of default sort values.
     *
     * Example:
     *   $sortValues[DatagridInterface::SORT_BY] = 'foo'
     *   $sortValues[DatagridInterface::SORT_ORDER] = 'DESC'
     *
     * @phpstan-param array{
     *     _page?: int,
     *     _per_page?: int,
     *     _sort_by?: string,
     *     _sort_order?: string
     * } $sortValues
     */
    protected function configureDefaultSortValues(array &$sortValues)
    {
    }

    /**
     * Set the parent object, if any, to the provided object.
     *
     * @phpstan-param T $object
     */
    final protected function appendParentObject(object $object): void
    {
        if ($this->isChild() && $this->getParentAssociationMapping()) {
            $parentAdmin = $this->getParent();
            $parentObject = $parentAdmin->getObject($this->getRequest()->get($parentAdmin->getIdParameter()));

            if (null !== $parentObject) {
                $propertyAccessor = PropertyAccess::createPropertyAccessor();
                $propertyPath = new PropertyPath($this->getParentAssociationMapping());

                try {
                    $value = $propertyAccessor->getValue($object, $propertyPath);
                } catch (AccessException $e) {
                    // @todo: Catching and checking AccessException here as BC for symfony/property-access < 5.1.
                    //        Catch UninitializedPropertyException and remove the check when dropping support < 5.1
                    if (!$e instanceof UninitializedPropertyException && AccessException::class !== \get_class($e)) {
                        throw $e; // Re-throw. We only want to "ignore" pure AccessException (Sf < 5.1) and UninitializedPropertyException (Sf >= 5.1)
                    }
                    $value = null;
                }

                if (\is_array($value) || $value instanceof \ArrayAccess) {
                    $value[] = $parentObject;
                    $propertyAccessor->setValue($object, $propertyPath, $value);
                } else {
                    $propertyAccessor->setValue($object, $propertyPath, $parentObject);
                }
            }
        } elseif ($this->hasParentFieldDescription()) {
            $parentAdmin = $this->getParentFieldDescription()->getAdmin();
            $parentObject = $parentAdmin->getObject($this->getRequest()->get($parentAdmin->getIdParameter()));

            if (null !== $parentObject) {
                ObjectManipulator::setObject($object, $parentObject, $this->getParentFieldDescription());
            }
        }
    }

    /**
     * Build all the related urls to the current admin.
     */
    private function buildRoutes(): void
    {
        if ($this->loaded['routes']) {
            return;
        }

        $this->loaded['routes'] = true;

        $this->routes = new RouteCollection(
            $this->getBaseCodeRoute(),
            $this->getBaseRouteName(),
            $this->getBaseRoutePattern(),
            $this->getBaseControllerName()
        );

        $this->getRouteBuilder()->build($this, $this->routes);

        $this->configureRoutes($this->routes);

        foreach ($this->getExtensions() as $extension) {
            $extension->configureRoutes($this, $this->routes);
        }
    }
}

class_exists(\Sonata\Form\Validator\ErrorElement::class);
// NEXT_MAJOR: Remove next line.
class_exists(\Sonata\AdminBundle\FieldDescription\FieldDescriptionInterface::class);