Your IP : 216.73.217.79
<?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 Knp\Menu\ItemInterface as MenuItemInterface;
use Sonata\AdminBundle\Datagrid\DatagridMapper;
use Sonata\AdminBundle\Datagrid\ListMapper;
use Sonata\AdminBundle\Datagrid\ProxyQueryInterface;
use Sonata\AdminBundle\Form\FormMapper;
use Sonata\AdminBundle\Route\RouteCollectionInterface;
use Sonata\AdminBundle\Show\ShowMapper;
/**
* @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
*
* NEXT_MAJOR: Uncomment the actual definition of below methods inside the interface and remove these annotations.
*
* @method void preBatchAction(AdminInterface $admin, string $actionName, ProxyQueryInterface $query, array &$idx, bool $allElements)
*
* @phpstan-method void preBatchAction(AdminInterface<T> $admin, string $actionName, ProxyQueryInterface<T> $query, array<mixed> &$idx, bool $allElements)
*
* @phpstan-template T of object
*/
interface AdminExtensionInterface
{
/**
* @phpstan-param FormMapper<T> $form
*/
public function configureFormFields(FormMapper $form): void;
/**
* @phpstan-param ListMapper<T> $list
*/
public function configureListFields(ListMapper $list): void;
/**
* @phpstan-param DatagridMapper<T> $filter
*/
public function configureDatagridFilters(DatagridMapper $filter): void;
/**
* @phpstan-param ShowMapper<T> $show
*/
public function configureShowFields(ShowMapper $show): void;
/**
* @phpstan-param AdminInterface<T> $admin
*/
public function configureRoutes(AdminInterface $admin, RouteCollectionInterface $collection): void;
/**
* Builds the tab menu.
*
* @phpstan-template TChild of object
* @phpstan-param AdminInterface<T> $admin
* @phpstan-param AdminInterface<TChild>|null $childAdmin
*/
public function configureTabMenu(
AdminInterface $admin,
MenuItemInterface $menu,
string $action,
?AdminInterface $childAdmin = null,
): void;
/**
* @phpstan-param AdminInterface<T> $admin
* @phpstan-param ProxyQueryInterface<T> $query
*/
public function configureQuery(AdminInterface $admin, ProxyQueryInterface $query): void;
/**
* Get a chance to modify a newly created instance.
*
* @phpstan-param AdminInterface<T> $admin
* @phpstan-param T $object
*/
public function alterNewInstance(AdminInterface $admin, object $object): void;
/**
* Get a chance to modify object instance.
*
* @phpstan-param AdminInterface<T> $admin
* @phpstan-param T $object
*/
public function alterObject(AdminInterface $admin, object $object): void;
/**
* Get a chance to configure admin before used.
*
* @phpstan-param AdminInterface<T> $admin
*/
public function configure(AdminInterface $admin): void;
/**
* NEXT_MAJOR: Add return typehint `array`.
*
* Get a chance to add persistent parameters.
*
* @param array<string, mixed> $parameters
*
* @return array<string, mixed>
*
* @phpstan-param AdminInterface<T> $admin
*/
public function configurePersistentParameters(AdminInterface $admin, array $parameters);
/**
* Return the controller access mapping.
*
* @return array<string, string[]|string>
*
* @phpstan-param AdminInterface<T> $admin
*/
public function getAccessMapping(AdminInterface $admin): array;
/**
* Returns the list of batch actions.
*
* @param array<string, array<string, mixed>> $actions
*
* @return array<string, array<string, mixed>>
*
* @phpstan-param AdminInterface<T> $admin
*/
public function configureBatchActions(AdminInterface $admin, array $actions): array;
// NEXT_MAJOR: Uncomment the method definition
// /**
// * @param mixed[] $idx
// * @phpstan-param AdminInterface<T> $admin
// * @phpstan-param ProxyQueryInterface<T> $query
// */
// public function preBatchAction(AdminInterface $admin, string $actionName, ProxyQueryInterface $query, array &$idx, bool $allElements): void;
/**
* Get a chance to modify export fields.
*
* @param string[] $fields
*
* @return string[]
*
* @phpstan-param AdminInterface<T> $admin
*/
public function configureExportFields(AdminInterface $admin, array $fields): array;
/**
* @phpstan-param AdminInterface<T> $admin
* @phpstan-param T $object
*/
public function preUpdate(AdminInterface $admin, object $object): void;
/**
* @phpstan-param AdminInterface<T> $admin
* @phpstan-param T $object
*/
public function postUpdate(AdminInterface $admin, object $object): void;
/**
* @phpstan-param AdminInterface<T> $admin
* @phpstan-param T $object
*/
public function prePersist(AdminInterface $admin, object $object): void;
/**
* @phpstan-param AdminInterface<T> $admin
* @phpstan-param T $object
*/
public function postPersist(AdminInterface $admin, object $object): void;
/**
* @phpstan-param AdminInterface<T> $admin
* @phpstan-param T $object
*/
public function preRemove(AdminInterface $admin, object $object): void;
/**
* Get all action buttons for an action.
*
* @phpstan-param AdminInterface<T> $admin
* @phpstan-param T $object
*/
public function postRemove(AdminInterface $admin, object $object): void;
/**
* Get all action buttons for an action.
*
* @param array<string, array<string, mixed>> $list
*
* @return array<string, array<string, mixed>>
*
* @phpstan-param AdminInterface<T> $admin
* @phpstan-param T $object
*/
public function configureActionButtons(
AdminInterface $admin,
array $list,
string $action,
?object $object = null,
): array;
/**
* @param array<string, array<string, mixed>> $actions
*
* @return array<string, array<string, mixed>>
*
* @phpstan-param AdminInterface<T> $admin
*/
public function configureDashboardActions(AdminInterface $admin, array $actions): array;
/**
* Returns a list of default filters.
*
* @param array<string, array<string, mixed>> $filterValues
*
* @phpstan-param AdminInterface<T> $admin
*/
public function configureDefaultFilterValues(AdminInterface $admin, array &$filterValues): void;
/**
* Returns a list of default sort values.
*
* @param array{_page?: int, _per_page?: int, _sort_by?: string, _sort_order?: string} $sortValues
*
* @phpstan-param AdminInterface<T> $admin
*/
public function configureDefaultSortValues(AdminInterface $admin, array &$sortValues): void;
/**
* Returns a list of form options.
*
* @param array<string, mixed> $formOptions
*
* @phpstan-param AdminInterface<T> $admin
*/
public function configureFormOptions(AdminInterface $admin, array &$formOptions): void;
/**
* @param array<string, mixed> $parameters
*
* @return array<string, mixed>
*
* @phpstan-param AdminInterface<T> $admin
*/
public function configureFilterParameters(AdminInterface $admin, array $parameters): array;
}