sonata-project / SonataAdminBundle

src/Admin/AdminInterface.php

Doc Comments +79 added lines, -1 removed lines

@@ -35,6 +35,9 @@ 
  */
 interface AdminInterface extends AccessRegistryInterface, FieldDescriptionRegistryInterface, LifecycleHookProviderInterface, MenuBuilderInterface, ParentAdminInterface, UrlGeneratorInterface
 {
+    /**
+     * @return void
+     */
     public function setMenuFactory(MenuFactoryInterface $menuFactory);
 
     /**
@@ -42,8 +45,14 @@ 
      */
     public function getMenuFactory();
 
+    /**
+     * @return void
+     */
     public function setFormContractor(FormContractorInterface $formContractor);
 
+    /**
+     * @return void
+     */
     public function setListBuilder(ListBuilderInterface $listBuilder);
 
     /**
@@ -51,6 +60,9 @@ 
      */
     public function getListBuilder();
 
+    /**
+     * @return void
+     */
     public function setDatagridBuilder(DatagridBuilderInterface $datagridBuilder);
 
     /**
@@ -58,6 +70,9 @@ 
      */
     public function getDatagridBuilder();
 
+    /**
+     * @return void
+     */
     public function setTranslator(TranslatorInterface $translator);
 
     /**
@@ -65,8 +80,14 @@ 
      */
     public function getTranslator();
 
+    /**
+     * @return void
+     */
     public function setRequest(Request $request);
 
+    /**
+     * @return void
+     */
     public function setConfigurationPool(Pool $pool);
 
     /**
@@ -79,6 +100,9 @@ 
      */
     public function getClass();
 
+    /**
+     * @return void
+     */
     public function attachAdminClass(FieldDescriptionInterface $fieldDescription);
 
     /**
@@ -90,6 +114,7 @@ 
      * Set base controller name.
      *
      * @param string $baseControllerName
+     * @return void
      */
     public function setBaseControllerName($baseControllerName);
 
@@ -102,6 +127,7 @@ 
 
     /**
      * Sets a list of templates.
+     * @return void
      */
     public function setTemplates(array $templates);
 
@@ -110,6 +136,7 @@ 
      *
      * @param string $name
      * @param string $template
+     * @return void
      */
     public function setTemplate($name, $template);
 
@@ -175,6 +202,9 @@ 
      */
     public function getSecurityInformation();
 
+    /**
+     * @return void
+     */
     public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription);
 
     /**
@@ -222,6 +252,9 @@ 
      */
     public function hasRoute($name);
 
+    /**
+     * @return void
+     */
     public function setSecurityHandler(SecurityHandlerInterface $securityHandler);
 
     /**
@@ -249,10 +282,13 @@ 
      *
      * @param object $entity
      *
-     * @return mixed
+     * @return string
      */
     public function id($entity);
 
+    /**
+     * @return void
+     */
     public function setValidator(ValidatorInterface $validator);
 
     /**
@@ -265,6 +301,9 @@ 
      */
     public function getShow();
 
+    /**
+     * @return void
+     */
     public function setFormTheme(array $formTheme);
 
     /**
@@ -272,6 +311,9 @@ 
      */
     public function getFormTheme();
 
+    /**
+     * @return void
+     */
     public function setFilterTheme(array $filterTheme);
 
     /**
@@ -279,6 +321,9 @@ 
      */
     public function getFilterTheme();
 
+    /**
+     * @return void
+     */
     public function addExtension(AdminExtensionInterface $extension);
 
     /**
@@ -288,6 +333,9 @@ 
      */
     public function getExtensions();
 
+    /**
+     * @return void
+     */
     public function setRouteBuilder(RouteBuilderInterface $routeBuilder);
 
     /**
@@ -302,6 +350,9 @@ 
      */
     public function toString($object);
 
+    /**
+     * @return void
+     */
     public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy);
 
     /**
@@ -325,6 +376,7 @@ 
 
     /**
      * @param string $uniqId
+     * @return void
      */
     public function setUniqid($uniqId);
 
@@ -351,6 +403,7 @@ 
 
     /**
      * @param object|null $subject
+     * @return void
      */
     public function setSubject($subject);
 
@@ -408,6 +461,7 @@ 
      *
      * @param string $actionName
      * @param bool   $allElements
+     * @return void
      */
     public function preBatchAction($actionName, ProxyQueryInterface $query, array &$idx, $allElements);
 
@@ -432,6 +486,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);
 
@@ -446,6 +501,7 @@ 
      * Add object security, fe. make the current user owner of the object.
      *
      * @param object $object
+     * @return void
      */
     public function createObjectSecurity($object);
 
@@ -454,6 +510,9 @@ 
      */
     public function getParent();
 
+    /**
+     * @return void
+     */
     public function setParent(self $admin);
 
     /**
@@ -467,6 +526,7 @@ 
      * Set the translation domain.
      *
      * @param string $translationDomain the translation domain
+     * @return void
      */
     public function setTranslationDomain($translationDomain);
 
@@ -486,21 +546,29 @@ 
 
     /**
      * Set the form groups.
+     * @return void
      */
     public function setFormGroups(array $formGroups);
 
     public function getFormTabs();
 
+    /**
+     * @return void
+     */
     public function setFormTabs(array $formTabs);
 
     public function getShowTabs();
 
+    /**
+     * @return void
+     */
     public function setShowTabs(array $showTabs);
 
     /**
      * Remove a form group field.
      *
      * @param string $key
+     * @return void
      */
     public function removeFieldFromFormGroup($key);
 
@@ -513,6 +581,7 @@ 
 
     /**
      * Set the show groups.
+     * @return void
      */
     public function setShowGroups(array $showGroups);
 
@@ -520,6 +589,7 @@ 
      * Reorder items in showGroup.
      *
      * @param string $group
+     * @return void
      */
     public function reorderShowGroup($group, array $keys);
 
@@ -527,6 +597,7 @@ 
      * add a FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function addFormFieldDescription($name, FieldDescriptionInterface $fieldDescription);
 
@@ -534,6 +605,7 @@ 
      * Remove a FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function removeFormFieldDescription($name);
 
@@ -553,11 +625,13 @@ 
      * Adds a new class to a list of supported sub classes.
      *
      * @param $subClass
+     * @return void
      */
     public function addSubClass($subClass);
 
     /**
      * Sets the list of supported sub classes.
+     * @return void
      */
     public function setSubClasses(array $subClasses);
 
@@ -618,6 +692,7 @@ 
      * Set the current child status.
      *
      * @param bool $currentChild
+     * @return void
      */
     public function setCurrentChild($currentChild);
 
@@ -653,6 +728,7 @@ 
 
     /**
      * @param string $mode
+     * @return void
      */
     public function setListMode($mode);
 
@@ -686,12 +762,14 @@ 
      * Returns the result link for an object.
      *
      * @param object $object
+     * @return string|null
      */
     public function getSearchResultLink($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;
 

src/Admin/AbstractAdmin.php

Doc Comments +7 added lines, -1 removed lines

@@ -942,6 +942,7 @@ 
 
     /**
      * NEXT_MAJOR: remove this method.
+     * @param string $subClass
      */
     public function addSubClass($subClass): void
     {
@@ -1097,6 +1098,9 @@ 
         return $this->routeGenerator->hasAdminRoute($this, $name);
     }
 
+    /**
+     * @param string $adminCode
+     */
     public function isCurrentRoute(string $name, ?string $adminCode = null): bool
     {
         if (!$this->hasRequest()) {
@@ -2119,7 +2123,7 @@ 
      *
      * @param string $context
      *
-     * @return array
+     * @return string[]
      */
     public function getPermissionsShow($context)
     {
@@ -2515,6 +2519,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param boolean $isShown
      */
     final public function showMosaicButton($isShown): void
     {
@@ -2651,6 +2656,7 @@ 
      * NEXT_MAJOR: remove this method.
      *
      * @deprecated Use configureTabMenu instead
+     * @param string $action
      */
     protected function configureSideMenu(ItemInterface $menu, $action, AdminInterface $childAdmin = null)
     {