sonata-project / SonataAdminBundle

src/Admin/AdminInterface.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 Knp\Menu\FactoryInterface;
use Knp\Menu\ItemInterface;
use Sonata\AdminBundle\Builder\DatagridBuilderInterface;
use Sonata\AdminBundle\Builder\FormContractorInterface;
use Sonata\AdminBundle\Builder\ListBuilderInterface;
use Sonata\AdminBundle\Builder\RouteBuilderInterface;
use Sonata\AdminBundle\Datagrid\DatagridInterface;
use Sonata\AdminBundle\Datagrid\ProxyQueryInterface;
use Sonata\AdminBundle\Filter\Persister\FilterPersisterInterface;
use Sonata\AdminBundle\Model\ModelManagerInterface;
use Sonata\AdminBundle\Object\MetadataInterface;
use Sonata\AdminBundle\Route\RouteGeneratorInterface;
use Sonata\AdminBundle\Security\Handler\SecurityHandlerInterface;
use Sonata\AdminBundle\Translator\LabelTranslatorStrategyInterface;
use Sonata\Exporter\Source\SourceIteratorInterface;
use Sonata\Form\Validator\ErrorElement;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Validator\Validator\ValidatorInterface;
use Symfony\Contracts\Translation\TranslatorInterface;

/**
 * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
 */
interface AdminInterface extends AccessRegistryInterface, FieldDescriptionRegistryInterface, LifecycleHookProviderInterface, MenuBuilderInterface, ParentAdminInterface, UrlGeneratorInterface
{
    public function setMenuFactory(FactoryInterface $menuFactory): void;

    public function getMenuFactory(): ?FactoryInterface;

    public function setFormContractor(FormContractorInterface $formContractor): void;

    public function setListBuilder(ListBuilderInterface $listBuilder): void;

    public function getListBuilder(): ?ListBuilderInterface;

    public function setDatagridBuilder(DatagridBuilderInterface $datagridBuilder): void;

    public function getDatagridBuilder(): ?DatagridBuilderInterface;

    public function setTranslator(TranslatorInterface $translator): void;

    public function setRequest(Request $request): void;

    public function setConfigurationPool(Pool $pool): void;

    /**
     * Returns subjectClass/class/subclass name managed
     * - subclass name if subclass parameter is defined
     * - subject class name if subject is defined
     * - class name if not.
     */
    public function getClass(): string;

    public function attachAdminClass(FieldDescriptionInterface $fieldDescription): void;

    public function getDatagrid(): DatagridInterface;

    public function getPagerType(): string;

    /**
     * Set base controller name.
     */
    public function setBaseControllerName(string $baseControllerName): void;

    /**
     * Get base controller name.
     */
    public function getBaseControllerName(): string;

    /**
     * Sets a list of templates.
     */
    public function setTemplates(array $templates): void;

    /**
     * Sets a specific template.
     */
    public function setTemplate(string $name, string $template): void;

    public function getModelManager(): ?ModelManagerInterface;

    /**
     * @return string the manager type of the admin
     */
    public function getManagerType(): ?string;

    public function createQuery(): ProxyQueryInterface;

    /**
     * @return FormBuilderInterface the form builder
     */
    public function getFormBuilder(): FormBuilderInterface;

    /**
     * Returns a form depend on the given $object.
     */
    public function getForm(): ?FormInterface;

    public function getRequest(): Request;

    /**
     * @return bool true if a request object is linked to this Admin, false
     *              otherwise
     */
    public function hasRequest(): bool;

    public function getCode(): string;

    public function getBaseCodeRoute(): string;

    /**
     * Return the roles and permissions per role
     * - different permissions per role for the acl handler
     * - one permission that has the same name as the role for the role handler
     * This should be used by experimented users.
     *
     * @return array 'role' => ['permission', 'permission']
     */
    public function getSecurityInformation(): array;

    public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription): void;

    /**
     * Get parent field description.
     *
     * @return FieldDescriptionInterface The parent field description
     */
    public function getParentFieldDescription(): ?FieldDescriptionInterface;

    /**
     * Returns true if the Admin is linked to a parent FieldDescription.
     */
    public function hasParentFieldDescription(): bool;

    /**
     * Returns the parameter representing request id, ie: id or childId.
     */
    public function getIdParameter(): string;

    /**
     * Returns true if the route $name is available.
     */
    public function hasRoute(string $name): bool;

    public function setSecurityHandler(SecurityHandlerInterface $securityHandler): void;

    public function getSecurityHandler(): ?SecurityHandlerInterface;

    /**
     * @param string|array $name
     */
    public function isGranted($name, ?object $object = null): bool;

    /**
     * @param mixed $model
     *
     * @return string a string representation of the identifiers for this instance
     */
    public function getNormalizedIdentifier($model): ?string;

    /**
     * Shorthand method for templating.
     *
     * @param object $model
     */
    public function id($model): ?string;

    public function setValidator(ValidatorInterface $validator): void;

    public function getValidator(): ?ValidatorInterface;

    public function getShow(): ?FieldDescriptionCollection;

    public function setFormTheme(array $formTheme): void;

    public function getList(): ?FieldDescriptionCollection;

    /**
     * @return string[]
     */
    public function getFormTheme(): array;

    public function setFilterTheme(array $filterTheme): void;

    /**
     * @return string[]
     */
    public function getFilterTheme(): array;

    public function addExtension(AdminExtensionInterface $extension): void;

    /**
     * Returns an array of extension related to the current Admin.
     *
     * @return AdminExtensionInterface[]
     */
    public function getExtensions(): array;

    public function setRouteBuilder(RouteBuilderInterface $routeBuilder): void;

    public function getRouteBuilder(): ?RouteBuilderInterface;

    /**
     * @param object $object
     */
    public function toString($object): string;

    public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy): void;

    public function getLabelTranslatorStrategy(): ?LabelTranslatorStrategyInterface;

    /**
     * Returning true will enable preview mode for
     * the target entity and show a preview button
     * when editing/creating an entity.
     */
    public function supportsPreviewMode(): bool;

    public function getNewInstance(): object;

    public function setUniqid(string $uniqId): void;

    /**
     * Returns the uniqid.
     */
    public function getUniqid(): string;

    /**
     * Returns the classname label.
     *
     * @return string the classname label
     */
    public function getClassnameLabel(): string;

    /**
     * @param mixed $id
     */
    public function getObject($id): ?object;

    public function setSubject(?object $subject): void;

    public function getSubject(): object;

    /**
     * Returns the array of allowed export formats.
     *
     * @return string[]
     */
    public function getExportFormats(): array;

    /**
     * Retuns a list of exported fields.
     */
    public function getExportFields(): array;

    /**
     * Returns SourceIterator.
     */
    public function getDataSourceIterator(): SourceIteratorInterface;

    /**
     * Call before the batch action, allow you to alter the query and the idx.
     */
    public function preBatchAction(string $actionName, ProxyQueryInterface $query, array &$idx, bool $allElements = false): void;

    /**
     * Return array of filter parameters.
     *
     * @return array<string, mixed>

The doc-type array<string, could not be parsed: Expected ">" at position 5, but found "end of type". (view supported doc-types)

     */
    public function getFilterParameters(): array;

    /**
     * Return true if the Admin is related to a subject.
     */
    public function hasSubject(): bool;

    /**
     * NEXT_MAJOR: remove this method.
     *
     * @param object $object
     *
     * @deprecated this feature cannot be stable, use a custom validator,
     *             the feature will be removed with Symfony 2.2
     */
    public function validate(ErrorElement $errorElement, $object): void;

    public function showIn(string $context): bool;

    /**
     * Add object security, fe. make the current user owner of the object.
     */
    public function createObjectSecurity(object $object): void;

    public function getParent(): self;

    public function setParent(self $admin): void;

    /**
     * Returns true if the Admin class has an Parent Admin defined.
     */
    public function isChild(): bool;

    /**
     * Set the translation domain.
     *
     * @param string $translationDomain the translation domain
     */
    public function setTranslationDomain(string $translationDomain): void;

    /**
     * Returns the translation domain.
     *
     * @return string the translation domain
     */
    public function getTranslationDomain(): string;

    /**
     * Return the form groups.
     *
     * @return array<string, mixed>

The doc-type array<string, could not be parsed: Expected ">" at position 5, but found "end of type". (view supported doc-types)

     */
    public function getFormGroups(): array;

    /**
     * Set the form groups.
     */
    public function setFormGroups(array $formGroups): void;

    /**
     * @return array<string, mixed>

The doc-type array<string, could not be parsed: Expected ">" at position 5, but found "end of type". (view supported doc-types)

     */
    public function getFormTabs(): array;

    public function setFormTabs(array $formTabs): void;

    /**
     * @return array<string, mixed>

The doc-type array<string, could not be parsed: Expected ">" at position 5, but found "end of type". (view supported doc-types)

     */
    public function getShowTabs(): array;

    public function setShowTabs(array $showTabs): void;

    /**
     * Remove a form group field.
     */
    public function removeFieldFromFormGroup(string $key): void;

    /**
     * Returns the show groups.
     *
     * @return array<string, mixed>

The doc-type array<string, could not be parsed: Expected ">" at position 5, but found "end of type". (view supported doc-types)

     */
    public function getShowGroups(): array;

    /**
     * Set the show groups.
     */
    public function setShowGroups(array $showGroups): void;

    /**
     * Reorder items in showGroup.
     */
    public function reorderShowGroup(string $group, array $keys): void;

    /**
     * Returns true if this admin uses ACL.
     */
    public function isAclEnabled(): bool;

    /**
     * Returns list of supported sub classes.
     */
    public function getSubClasses(): array;

    /**
     * Sets the list of supported sub classes.
     */
    public function setSubClasses(array $subClasses): void;

    /**
     * Returns true if the admin has the sub classes.
     *
     * @param string $name The name of the sub class
     */
    public function hasSubClass(string $name): bool;

    /**
     * Returns true if a subclass is currently active.
     */
    public function hasActiveSubClass(): bool;

    /**
     * Returns the currently active sub class.
     *
     * @return string the active sub class
     */
    public function getActiveSubClass(): string;

    /**
     * Returns the currently active sub class code.
     *
     * @return string the code for active sub class
     */
    public function getActiveSubclassCode(): string;

    /**
     * Returns the list of batchs actions.
     *
     * @return array<string, mixed> the list of batchs actions

The doc-type array<string, could not be parsed: Expected ">" at position 5, but found "end of type". (view supported doc-types)

     */
    public function getBatchActions(): array;

    /**
     * Returns Admin`s label.
     */
    public function getLabel(): ?string;

    /**
     * Returns an array of persistent parameters.
     *
     * @return array<string, mixed>

The doc-type array<string, could not be parsed: Expected ">" at position 5, but found "end of type". (view supported doc-types)

     */
    public function getPersistentParameters(): array;

    public function getPersistentParameter(string $name);

    /**
     * Set the current child status.
     */
    public function setCurrentChild(bool $currentChild): void;

    /**
     * Returns the current child status.
     */
    public function isCurrentChild(): bool;

    /**
     * Get translation label using the current TranslationStrategy.
     */
    public function getTranslationLabel(string $label, string $context = '', string $type = ''): string;

    /**
     * @param object $object
     */
    public function getObjectMetadata($object): MetadataInterface;

    /**
     * @return array<string, array<string, mixed>>

The doc-type array<string, could not be parsed: Expected ">" at position 5, but found "end of type". (view supported doc-types)

     */
    public function getListModes(): array;

    public function setListMode(string $mode): void;

    /**
     * return the list mode.
     */
    public function getListMode(): string;

    /**
     * Configure buttons for an action.
     */
    public function getActionButtons(string $action, ?object $object = null): array;

    /**
     * Get the list of actions that can be accessed directly from the dashboard.
     */
    public function getDashboardActions(): array;

    /**
     * Check the current request is given route or not.
     */
    public function isCurrentRoute(string $name, ?string $adminCode = null): bool;

    /**
     * Returns the result link for an object.
     */
    public function getSearchResultLink(object $object): ?string;

    /**
     * Setting to true will enable mosaic button for the admin screen.
     * Setting to false will hide mosaic button for the admin screen.
     */
    public function showMosaicButton(bool $isShown): void;

    public function configureActionButtons(array $buttonList, string $action, ?object $object = null): array;

    /**
     * Check object existence and access, without throwing Exception.
     */
    public function canAccessObject(string $action, ?object $object = null): bool;

    /**
     * Returns the master admin.
     */
    public function getRoot(): self;

    /**
     * Returns the root code.
     */
    public function getRootCode(): string;

    public function setFilterPersister(?FilterPersisterInterface $filterPersister = null): void;

    /**
     * Returns the baseRoutePattern used to generate the routing information.
     */
    public function getBaseRoutePattern(): string;

    /**
     * Returns the baseRouteName used to generate the routing information.
     */
    public function getBaseRouteName(): string;

    public function getSideMenu(string $action, ?self $childAdmin = null): ItemInterface;

    public function addParentAssociationMapping(string $code, string $value): void;

    public function getRouteGenerator(): ?RouteGeneratorInterface;

    /**
     * Returns the current child admin instance.
     */
    public function getCurrentChildAdmin(): ?self;

    /**
     * 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.
     */
    public function getParentAssociationMapping(): ?string;

    public function reorderFormGroup(string $group, array $keys): void;

    /**
     * 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): void;
}

class_exists(ErrorElement::class);