sonata-project / SonataAdminBundle

src/Admin/AbstractAdmin.php

Doc Comments +10 added lines, -1 removed lines

@@ -1024,6 +1024,7 @@ 
 
     /**
      * NEXT_MAJOR: remove this method.
+     * @param string $subClass
      */
     public function addSubClass($subClass)
     {
@@ -1146,6 +1147,10 @@ 
         return $this->routeGenerator->hasAdminRoute($this, $name);
     }
 
+    /**
+     * @param string $name
+     * @param string $adminCode
+     */
     public function isCurrentRoute($name, $adminCode = null)
     {
         if (!$this->hasRequest()) {
@@ -2291,7 +2296,7 @@ 
      *
      * @param string $context
      *
-     * @return array
+     * @return string[]
      */
     public function getPermissionsShow($context)
     {
@@ -2596,6 +2601,9 @@ 
         return true;
     }
 
+    /**
+     * @param string $action
+     */
     public function configureActionButtons($action, $object = null)
     {
         $list = [];
@@ -2847,6 +2855,7 @@ 
     /**
      * NEXT_MAJOR: remove this method.
      *
+     * @param string $action
      * @return mixed
      *
      * @deprecated Use configureTabMenu instead

src/Twig/GlobalVariables.php

Doc Comments +5 added lines, -3 removed lines

@@ -67,7 +67,7 @@ 
     /**
      * @param string $code
      * @param string $action
-     * @param array  $parameters
+     * @param string[]  $parameters
      * @param int    $absolute
      *
      * @return string
@@ -82,8 +82,8 @@ 
     /**
      * @param string $code
      * @param string $action
-     * @param mixed  $object
-     * @param array  $parameters
+     * @param string  $object
+     * @param string[]  $parameters
      * @param int    $absolute
      *
      * @return string
@@ -96,6 +96,8 @@ 
     }
 
     /**
+     * @param string $code
+     * @param string $action
      * @return array
      */
     private function getCodeAction($code, $action)

src/Admin/AdminInterface.php

Doc Comments +78 added lines, -4 removed lines

@@ -32,6 +32,9 @@ 
  */
 interface AdminInterface extends AccessRegistryInterface, FieldDescriptionRegistryInterface, LifecycleHookProviderInterface, MenuBuilderInterface, ParentAdminInterface, UrlGeneratorInterface
 {
+    /**
+     * @return void
+     */
     public function setMenuFactory(MenuFactoryInterface $menuFactory);
 
     /**
@@ -39,8 +42,14 @@ 
      */
     public function getMenuFactory();
 
+    /**
+     * @return void
+     */
     public function setFormContractor(FormContractorInterface $formContractor);
 
+    /**
+     * @return void
+     */
     public function setListBuilder(ListBuilderInterface $listBuilder);
 
     /**
@@ -48,6 +57,9 @@ 
      */
     public function getListBuilder();
 
+    /**
+     * @return void
+     */
     public function setDatagridBuilder(DatagridBuilderInterface $datagridBuilder);
 
     /**
@@ -55,6 +67,9 @@ 
      */
     public function getDatagridBuilder();
 
+    /**
+     * @return void
+     */
     public function setTranslator(TranslatorInterface $translator);
 
     /**
@@ -62,8 +77,14 @@ 
      */
     public function getTranslator();
 
+    /**
+     * @return void
+     */
     public function setRequest(Request $request);
 
+    /**
+     * @return void
+     */
     public function setConfigurationPool(Pool $pool);
 
     /**
@@ -76,6 +97,9 @@ 
      */
     public function getClass();
 
+    /**
+     * @return void
+     */
     public function attachAdminClass(FieldDescriptionInterface $fieldDescription);
 
     /**
@@ -87,6 +111,7 @@ 
      * Set base controller name.
      *
      * @param string $baseControllerName
+     * @return void
      */
     public function setBaseControllerName($baseControllerName);
 
@@ -159,6 +184,9 @@ 
      */
     public function getSecurityInformation();
 
+    /**
+     * @return void
+     */
     public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription);
 
     /**
@@ -223,6 +251,9 @@ 
      */
     // public function isCurrentRoute($name, $adminCode = null);
 
+    /**
+     * @return void
+     */
     public function setSecurityHandler(SecurityHandlerInterface $securityHandler);
 
     /**
@@ -250,12 +281,13 @@ 
      *
      * @param object $entity
      *
-     * @return mixed
+     * @return string
      */
     public function id($entity);
 
     /**
      * @param ValidatorInterface $validator
+     * @return void
      */
     public function setValidator($validator);
 
@@ -265,10 +297,13 @@ 
     public function getValidator();
 
     /**
-     * @return array
+     * @return FieldDescriptionCollection
      */
     public function getShow();
 
+    /**
+     * @return void
+     */
     public function setFormTheme(array $formTheme);
 
     /**
@@ -276,6 +311,9 @@ 
      */
     public function getFormTheme();
 
+    /**
+     * @return void
+     */
     public function setFilterTheme(array $filterTheme);
 
     /**
@@ -283,6 +321,9 @@ 
      */
     public function getFilterTheme();
 
+    /**
+     * @return void
+     */
     public function addExtension(AdminExtensionInterface $extension);
 
     /**
@@ -292,6 +333,9 @@ 
      */
     public function getExtensions();
 
+    /**
+     * @return void
+     */
     public function setRouteBuilder(RouteBuilderInterface $routeBuilder);
 
     /**
@@ -306,6 +350,9 @@ 
      */
     public function toString($object);
 
+    /**
+     * @return void
+     */
     public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy);
 
     /**
@@ -329,6 +376,7 @@ 
 
     /**
      * @param string $uniqId
+     * @return void
      */
     public function setUniqid($uniqId);
 
@@ -348,6 +396,7 @@ 
 
     /**
      * @param object $subject
+     * @return void
      */
     public function setSubject($subject);
 
@@ -384,7 +433,7 @@ 
     /**
      * Returns the array of allowed export formats.
      *
-     * @return array
+     * @return string[]
      */
     public function getExportFormats();
 
@@ -395,6 +444,9 @@ 
      */
     public function getDataSourceIterator();
 
+    /**
+     * @return void
+     */
     public function configure();
 
     /**
@@ -403,6 +455,7 @@ 
      * @param string $actionName
      * @param array  $idx
      * @param bool   $allElements
+     * @return void
      */
     public function preBatchAction($actionName, ProxyQueryInterface $query, array &$idx, $allElements);
 
@@ -427,6 +480,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);
 
@@ -441,14 +495,18 @@ 
      * Add object security, fe. make the current user owner of the object.
      *
      * @param mixed $object
+     * @return void
      */
     public function createObjectSecurity($object);
 
     /**
-     * @return ?AdminInterface
+     * @return AdminInterface|null
      */
     public function getParent();
 
+    /**
+     * @return void
+     */
     public function setParent(self $admin);
 
     /**
@@ -473,6 +531,7 @@ 
      * Set the translation domain.
      *
      * @param string $translationDomain the translation domain
+     * @return void
      */
     public function setTranslationDomain($translationDomain);
 
@@ -492,21 +551,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);
 
@@ -519,6 +586,7 @@ 
 
     /**
      * Set the show groups.
+     * @return void
      */
     public function setShowGroups(array $showGroups);
 
@@ -526,6 +594,7 @@ 
      * Reorder items in showGroup.
      *
      * @param string $group
+     * @return void
      */
     public function reorderShowGroup($group, array $keys);
 
@@ -533,6 +602,7 @@ 
      * add a FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function addFormFieldDescription($name, FieldDescriptionInterface $fieldDescription);
 
@@ -540,6 +610,7 @@ 
      * Remove a FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function removeFormFieldDescription($name);
 
@@ -552,6 +623,7 @@ 
 
     /**
      * Sets the list of supported sub classes.
+     * @return void
      */
     public function setSubClasses(array $subClasses);
 
@@ -620,6 +692,7 @@ 
      * Set the current child status.
      *
      * @param bool $currentChild
+     * @return void
      */
     public function setCurrentChild($currentChild);
 
@@ -653,6 +726,7 @@ 
 
     /**
      * @param string $mode
+     * @return void
      */
     public function setListMode($mode);
 

src/Admin/FieldDescriptionInterface.php

Doc Comments +13 added lines, -1 removed lines

@@ -20,6 +20,7 @@ 
      * set the field name.
      *
      * @param string $fieldName
+     * @return void
      */
     public function setFieldName($fieldName);
 
@@ -34,6 +35,7 @@ 
      * Set the name.
      *
      * @param string $name
+     * @return void
      */
     public function setName($name);
 
@@ -59,6 +61,7 @@ 
      *
      * @param string $name
      * @param mixed  $value
+     * @return void
      */
     public function setOption($name, $value);
 
@@ -68,6 +71,7 @@ 
      *   - template.
      *
      * Then the value are copied across to the related property value
+     * @return void
      */
     public function setOptions(array $options);
 
@@ -82,6 +86,7 @@ 
      * return the template used to render the field.
      *
      * @param string $template
+     * @return void
      */
     public function setTemplate($template);
 
@@ -97,6 +102,7 @@ 
      * or the logic associated to the current FieldDescription object.
      *
      * @param string $type
+     * @return void
      */
     public function setType($type);
 
@@ -109,6 +115,7 @@ 
 
     /**
      * set the parent Admin (only used in nested admin).
+     * @return void
      */
     public function setParent(AdminInterface $parent);
 
@@ -170,13 +177,14 @@ 
      * set the association admin instance (only used if the field is linked to an Admin).
      *
      * @param AdminInterface $associationAdmin the associated admin
+     * @return void
      */
     public function setAssociationAdmin(AdminInterface $associationAdmin);
 
     /**
      * return the associated Admin instance (only used if the field is linked to an Admin).
      *
-     * @return ?AdminInterface
+     * @return AdminInterface
      */
     public function getAssociationAdmin();
 
@@ -198,6 +206,7 @@ 
 
     /**
      * set the admin class linked to this FieldDescription.
+     * @return void
      */
     public function setAdmin(AdminInterface $admin);
 
@@ -213,11 +222,13 @@ 
      * @param string $name
      *
      * @throws \RuntimeException
+     * @return void
      */
     public function mergeOption($name, array $options = []);
 
     /**
      * merge options values.
+     * @return void
      */
     public function mergeOptions(array $options = []);
 
@@ -225,6 +236,7 @@ 
      * set the original mapping type (only used if the field is linked to an entity).
      *
      * @param string|int $mappingType
+     * @return void
      */
     public function setMappingType($mappingType);
 

src/Command/Validators.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
      *
      * @throws \InvalidArgumentException
      *
-     * @return array
+     * @return string[]
      */
     public static function validateEntityName($shortcut)
     {

src/Datagrid/DatagridInterface.php

Doc Comments +7 added lines, -1 removed lines

@@ -35,6 +35,9 @@ 
      */
     public function getResults();
 
+    /**
+     * @return void
+     */
     public function buildPager();
 
     /**
@@ -49,6 +52,7 @@ 
 
     /**
      * Reorder filters.
+     * @return void
      */
     public function reorderFilters(array $keys);
 
@@ -65,7 +69,8 @@ 
     /**
      * @param string  $name
      * @param ?string $operator
-     * @param mixed   $value
+     * @param string   $value
+     * @return void
      */
     public function setValue($name, $operator, $value);
 
@@ -90,6 +95,7 @@ 
 
     /**
      * @param string $name
+     * @return void
      */
     public function removeFilter($name);
 

src/Datagrid/ProxyQueryInterface.php

Doc Comments +2 added lines, -2 removed lines

@@ -64,7 +64,7 @@ 
     public function getSingleScalarResult();
 
     /**
-     * @param ?int $firstResult
+     * @param null|integer $firstResult
      *
      * @return ProxyQueryInterface
      */
@@ -76,7 +76,7 @@ 
     public function getFirstResult();
 
     /**
-     * @param ?int $maxResults
+     * @param null|integer $maxResults
      *
      * @return ProxyQueryInterface
      */