sonata-project / SonataAdminBundle

src/Admin/AdminInterface.php

Doc Comments +124 added lines

@@ -37,26 +37,59 @@ 
  */
 interface AdminInterface extends AccessRegistryInterface, FieldDescriptionRegistryInterface, LifecycleHookProviderInterface, MenuBuilderInterface, ParentAdminInterface, UrlGeneratorInterface
 {
+    /**
+     * @return void
+     */
     public function setMenuFactory(MenuFactoryInterface $menuFactory): void;
 
+    /**
+     * @return MenuFactoryInterface
+     */
     public function getMenuFactory(): ?MenuFactoryInterface;
 
+    /**
+     * @return void
+     */
     public function setFormContractor(FormContractorInterface $formContractor): void;
 
+    /**
+     * @return void
+     */
     public function setListBuilder(ListBuilderInterface $listBuilder): void;
 
+    /**
+     * @return ListBuilderInterface
+     */
     public function getListBuilder(): ?ListBuilderInterface;
 
+    /**
+     * @return void
+     */
     public function setDatagridBuilder(DatagridBuilderInterface $datagridBuilder): void;
 
+    /**
+     * @return DatagridBuilderInterface
+     */
     public function getDatagridBuilder(): ?DatagridBuilderInterface;
 
+    /**
+     * @return void
+     */
     public function setTranslator(TranslatorInterface $translator): void;
 
+    /**
+     * @return TranslatorInterface
+     */
     public function getTranslator(): ?TranslatorInterface;
 
+    /**
+     * @return void
+     */
     public function setRequest(Request $request): void;
 
+    /**
+     * @return void
+     */
     public function setConfigurationPool(Pool $pool): void;
 
     /**
@@ -67,12 +100,19 @@ 
      */
     public function getClass(): string;
 
+    /**
+     * @return void
+     */
     public function attachAdminClass(FieldDescriptionInterface $fieldDescription): void;
 
+    /**
+     * @return DatagridInterface|null
+     */
     public function getDatagrid(): ?DatagridInterface;
 
     /**
      * Set base controller name.
+     * @return void
      */
     public function setBaseControllerName(string $baseControllerName): void;
 
@@ -83,14 +123,19 @@ 
 
     /**
      * Sets a list of templates.
+     * @return void
      */
     public function setTemplates(array $templates): void;
 
     /**
      * Sets a specific template.
+     * @return void
      */
     public function setTemplate(string $name, string $template): void;
 
+    /**
+     * @return ModelManagerInterface
+     */
     public function getModelManager(): ?ModelManagerInterface;
 
     /**
@@ -110,6 +155,7 @@ 
 
     /**
      * Returns a form depend on the given $object.
+     * @return \Symfony\Component\Form\Form|null
      */
     public function getForm(): ?FormInterface;
 
@@ -140,6 +186,9 @@ 
      */
     public function getSecurityInformation(): array;
 
+    /**
+     * @return void
+     */
     public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription): void;
 
     /**
@@ -179,8 +228,14 @@ 
      */
     public function hasRoute(string $name): bool;
 
+    /**
+     * @return void
+     */
     public function setSecurityHandler(SecurityHandlerInterface $securityHandler): void;
 
+    /**
+     * @return SecurityHandlerInterface
+     */
     public function getSecurityHandler(): ?SecurityHandlerInterface;
 
     /**
@@ -199,17 +254,33 @@ 
      * Shorthand method for templating.
      *
      * @param object $model
+     * @return string
      */
     public function id($model): ?string;
 
+    /**
+     * @return void
+     */
     public function setValidator(ValidatorInterface $validator): void;
 
+    /**
+     * @return ValidatorInterface
+     */
     public function getValidator(): ?ValidatorInterface;
 
+    /**
+     * @return FieldDescriptionCollection|null
+     */
     public function getShow(): ?FieldDescriptionCollection;
 
+    /**
+     * @return void
+     */
     public function setFormTheme(array $formTheme): void;
 
+    /**
+     * @return FieldDescriptionCollection|null
+     */
     public function getList(): ?FieldDescriptionCollection;
 
     /**
@@ -217,6 +288,9 @@ 
      */
     public function getFormTheme(): array;
 
+    /**
+     * @return void
+     */
     public function setFilterTheme(array $filterTheme): void;
 
     /**
@@ -224,6 +298,9 @@ 
      */
     public function getFilterTheme(): array;
 
+    /**
+     * @return void
+     */
     public function addExtension(AdminExtensionInterface $extension): void;
 
     /**
@@ -233,8 +310,14 @@ 
      */
     public function getExtensions(): array;
 
+    /**
+     * @return void
+     */
     public function setRouteBuilder(RouteBuilderInterface $routeBuilder): void;
 
+    /**
+     * @return RouteBuilderInterface
+     */
     public function getRouteBuilder(): ?RouteBuilderInterface;
 
     /**
@@ -242,8 +325,14 @@ 
      */
     public function toString($object): string;
 
+    /**
+     * @return void
+     */
     public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy): void;
 
+    /**
+     * @return LabelTranslatorStrategyInterface
+     */
     public function getLabelTranslatorStrategy(): ?LabelTranslatorStrategyInterface;
 
     /**
@@ -255,6 +344,9 @@ 
 
     public function getNewInstance(): object;
 
+    /**
+     * @return void
+     */
     public function setUniqid(string $uniqId): void;
 
     /**
@@ -274,6 +366,9 @@ 
      */
     public function getObject($id): ?object;
 
+    /**
+     * @return void
+     */
     public function setSubject(?object $subject): void;
 
     /**
@@ -285,6 +380,7 @@ 
      * NEXT_MAJOR: Remove this method, since it's already in FieldDescriptionRegistryInterface.
      *
      * Returns a list FieldDescription.
+     * @return null|FieldDescriptionInterface
      */
     public function getListFieldDescription(string $name): ?FieldDescriptionInterface;
 
@@ -321,6 +417,7 @@ 
 
     /**
      * Call before the batch action, allow you to alter the query and the idx.
+     * @return void
      */
     public function preBatchAction(string $actionName, ProxyQueryInterface $query, array &$idx, bool $allElements = false): void;
 
@@ -343,6 +440,7 @@ 
      *
      * @deprecated this feature cannot be stable, use a custom validator,
      *             the feature will be removed with Symfony 2.2
+     * @return void
      */
     public function validate(ErrorElement $errorElement, $object): void;
 
@@ -350,6 +448,7 @@ 
 
     /**
      * Add object security, fe. make the current user owner of the object.
+     * @return void
      */
     public function createObjectSecurity(object $object): void;
 
@@ -358,6 +457,9 @@ 
      */
     public function getParent(): ?self;
 
+    /**
+     * @return void
+     */
     public function setParent(self $admin): void;
 
     /**
@@ -369,6 +471,7 @@ 
      * Set the translation domain.
      *
      * @param string $translationDomain the translation domain
+     * @return void
      */
     public function setTranslationDomain(string $translationDomain): void;
 
@@ -388,6 +491,7 @@ 
 
     /**
      * Set the form groups.
+     * @return void
      */
     public function setFormGroups(array $formGroups): void;
 
@@ -396,6 +500,9 @@ 
      */
     public function getFormTabs(): array;
 
+    /**
+     * @return void
+     */
     public function setFormTabs(array $formTabs): void;
 
     /**
@@ -403,10 +510,14 @@ 
      */
     public function getShowTabs(): array;
 
+    /**
+     * @return void
+     */
     public function setShowTabs(array $showTabs): void;
 
     /**
      * Remove a form group field.
+     * @return void
      */
     public function removeFieldFromFormGroup(string $key): void;
 
@@ -419,11 +530,13 @@ 
 
     /**
      * Set the show groups.
+     * @return void
      */
     public function setShowGroups(array $showGroups): void;
 
     /**
      * Reorder items in showGroup.
+     * @return void
      */
     public function reorderShowGroup(string $group, array $keys): void;
 
@@ -431,6 +544,7 @@ 
      * NEXT_MAJOR: Remove this method, since it's already in FieldDescriptionRegistryInterface.
      *
      * add a FieldDescription.
+     * @return void
      */
     public function addFormFieldDescription(string $name, FieldDescriptionInterface $fieldDescription): void;
 
@@ -438,6 +552,7 @@ 
      * NEXT_MAJOR: Remove this method, since it's already in FieldDescriptionRegistryInterface.
      *
      * Remove a FieldDescription.
+     * @return void
      */
     public function removeFormFieldDescription(string $name): void;
 
@@ -455,11 +570,13 @@ 
      * Adds a new class to a list of supported sub classes.
      *
      * @param $subClass
+     * @return void
      */
     public function addSubClass($subClass): void;
 
     /**
      * Sets the list of supported sub classes.
+     * @return void
      */
     public function setSubClasses(array $subClasses): void;
 
@@ -498,6 +615,7 @@ 
 
     /**
      * Returns Admin`s label.
+     * @return string
      */
     public function getLabel(): ?string;
 
@@ -512,6 +630,7 @@ 
 
     /**
      * Set the current child status.
+     * @return void
      */
     public function setCurrentChild(bool $currentChild): void;
 
@@ -537,6 +656,9 @@ 
      */
     public function getListModes(): array;
 
+    /**
+     * @return void
+     */
     public function setListMode(string $mode): void;
 
     /**
@@ -561,12 +683,14 @@ 
 
     /**
      * Returns the result link for an object.
+     * @return string|null
      */
     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.
+     * @return void
      */
     public function showMosaicButton(bool $isShown): void;