sonata-project / SonataAdminBundle

src/Admin/AdminInterface.php

Doc Comments +76 added lines, -2 removed lines

@@ -49,6 +49,9 @@ 
  */
 interface AdminInterface extends AccessRegistryInterface, FieldDescriptionRegistryInterface, LifecycleHookProviderInterface, MenuBuilderInterface, ParentAdminInterface, UrlGeneratorInterface
 {
+    /**
+     * @return void
+     */
     public function setMenuFactory(MenuFactoryInterface $menuFactory);
 
     /**
@@ -56,8 +59,14 @@ 
      */
     public function getMenuFactory();
 
+    /**
+     * @return void
+     */
     public function setFormContractor(FormContractorInterface $formContractor);
 
+    /**
+     * @return void
+     */
     public function setListBuilder(ListBuilderInterface $listBuilder);
 
     /**
@@ -65,6 +74,9 @@ 
      */
     public function getListBuilder();
 
+    /**
+     * @return void
+     */
     public function setDatagridBuilder(DatagridBuilderInterface $datagridBuilder);
 
     /**
@@ -72,6 +84,9 @@ 
      */
     public function getDatagridBuilder();
 
+    /**
+     * @return void
+     */
     public function setTranslator(TranslatorInterface $translator);
 
     /**
@@ -79,8 +94,14 @@ 
      */
     public function getTranslator();
 
+    /**
+     * @return void
+     */
     public function setRequest(Request $request);
 
+    /**
+     * @return void
+     */
     public function setConfigurationPool(Pool $pool);
 
     /**
@@ -93,6 +114,9 @@ 
      */
     public function getClass();
 
+    /**
+     * @return void
+     */
     public function attachAdminClass(FieldDescriptionInterface $fieldDescription);
 
     /**
@@ -104,6 +128,7 @@ 
      * Set base controller name.
      *
      * @param string $baseControllerName
+     * @return void
      */
     public function setBaseControllerName($baseControllerName);
 
@@ -178,6 +203,9 @@ 
      */
     public function getSecurityInformation();
 
+    /**
+     * @return void
+     */
     public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription);
 
     /**
@@ -225,6 +253,9 @@ 
      */
     public function hasRoute($name);
 
+    /**
+     * @return void
+     */
     public function setSecurityHandler(SecurityHandlerInterface $securityHandler);
 
     /**
@@ -252,12 +283,13 @@ 
      *
      * @param object $model
      *
-     * @return mixed
+     * @return string
      */
     public function id($model);
 
     /**
      * @param ValidatorInterface $validator
+     * @return void
      */
     public function setValidator($validator);
 
@@ -274,6 +306,9 @@ 
 //    NEXT_MAJOR: uncomment this method in 4.0
 //    public function getList(): ?FieldDescriptionCollection;
 
+    /**
+     * @return void
+     */
     public function setFormTheme(array $formTheme);
 
     /**
@@ -281,6 +316,9 @@ 
      */
     public function getFormTheme();
 
+    /**
+     * @return void
+     */
     public function setFilterTheme(array $filterTheme);
 
     /**
@@ -288,6 +326,9 @@ 
      */
     public function getFilterTheme();
 
+    /**
+     * @return void
+     */
     public function addExtension(AdminExtensionInterface $extension);
 
     /**
@@ -297,6 +338,9 @@ 
      */
     public function getExtensions();
 
+    /**
+     * @return void
+     */
     public function setRouteBuilder(RouteBuilderInterface $routeBuilder);
 
     /**
@@ -311,6 +355,9 @@ 
      */
     public function toString($object);
 
+    /**
+     * @return void
+     */
     public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy);
 
     /**
@@ -334,6 +381,7 @@ 
 
     /**
      * @param string $uniqId
+     * @return void
      */
     public function setUniqid($uniqId);
 
@@ -353,6 +401,7 @@ 
 
     /**
      * @param object|null $subject
+     * @return void
      */
     public function setSubject($subject);
 
@@ -390,7 +439,7 @@ 
      *
      * Returns the collection of list FieldDescriptions.
      *
-     * @return array
+     * @return FieldDescriptionInterface[]
      */
     public function getListFieldDescriptions();
 
@@ -408,6 +457,9 @@ 
      */
     public function getDataSourceIterator();
 
+    /**
+     * @return void
+     */
     public function configure();
 
     /**
@@ -415,6 +467,7 @@ 
      *
      * @param string $actionName
      * @param bool   $allElements
+     * @return void
      */
     public function preBatchAction($actionName, ProxyQueryInterface $query, array &$idx, $allElements);
 
@@ -439,6 +492,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);
 
@@ -453,6 +507,7 @@ 
      * Add object security, fe. make the current user owner of the object.
      *
      * @param object $object
+     * @return void
      */
     public function createObjectSecurity($object);
 
@@ -461,6 +516,9 @@ 
      */
     public function getParent();
 
+    /**
+     * @return void
+     */
     public function setParent(self $admin);
 
     /**
@@ -485,6 +543,7 @@ 
      * Set the translation domain.
      *
      * @param string $translationDomain the translation domain
+     * @return void
      */
     public function setTranslationDomain($translationDomain);
 
@@ -506,6 +565,7 @@ 
 
     /**
      * Set the form groups.
+     * @return void
      */
     public function setFormGroups(array $formGroups);
 
@@ -514,6 +574,9 @@ 
      */
     public function getFormTabs();
 
+    /**
+     * @return void
+     */
     public function setFormTabs(array $formTabs);
 
     /**
@@ -521,12 +584,16 @@ 
      */
     public function getShowTabs();
 
+    /**
+     * @return void
+     */
     public function setShowTabs(array $showTabs);
 
     /**
      * Remove a form group field.
      *
      * @param string $key
+     * @return void
      */
     public function removeFieldFromFormGroup($key);
 
@@ -541,6 +608,7 @@ 
 
     /**
      * Set the show groups.
+     * @return void
      */
     public function setShowGroups(array $showGroups);
 
@@ -548,6 +616,7 @@ 
      * Reorder items in showGroup.
      *
      * @param string $group
+     * @return void
      */
     public function reorderShowGroup($group, array $keys);
 
@@ -557,6 +626,7 @@ 
      * add a FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function addFormFieldDescription($name, FieldDescriptionInterface $fieldDescription);
 
@@ -566,6 +636,7 @@ 
      * Remove a FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function removeFormFieldDescription($name);
 
@@ -578,6 +649,7 @@ 
 
     /**
      * Sets the list of supported sub classes.
+     * @return void
      */
     public function setSubClasses(array $subClasses);
 
@@ -646,6 +718,7 @@ 
      * Set the current child status.
      *
      * @param bool $currentChild
+     * @return void
      */
     public function setCurrentChild($currentChild);
 
@@ -695,6 +768,7 @@ 
 
     /**
      * @param string $mode
+     * @return void
      */
     public function setListMode($mode);