sonata-project / SonataAdminBundle

Datagrid/ListMapper.php

Doc Comments +1 added lines, -1 removed lines

@@ -67,7 +67,7 @@
      * @throws \RuntimeException
      *
      * @param mixed $name
-     * @param mixed $type
+     * @param string|null $type
      * @param array $fieldDescriptionOptions
      *
      * @return ListMapper

Generator/AdminGenerator.php

Doc Comments +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
 
     /**
      * @param ModelManagerInterface $modelManager
-     * @param array|string          $skeletonDirectories
+     * @param string          $skeletonDirectories
      */
     public function __construct(ModelManagerInterface $modelManager, $skeletonDirectories)
     {

Generator/ControllerGenerator.php

Doc Comments +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
     private $file;
 
     /**
-     * @param array|string $skeletonDirectory
+     * @param string $skeletonDirectory
      */
     public function __construct($skeletonDirectory)
     {

Tests/Datagrid/DatagridMapperTest.php

Doc Comments +6 added lines

@@ -257,6 +257,12 @@
         ), array_keys($this->datagrid->getFilters()));
     }
 
+    /**
+     * @param string $name
+     * @param string $label
+     *
+     * @return string
+     */
     private function getFieldDescriptionMock($name = null, $label = null)
     {
         $fieldDescription = $this->getMockForAbstractClass('Sonata\AdminBundle\Admin\BaseFieldDescription');

Tests/Datagrid/ListMapperTest.php

Doc Comments +4 added lines

@@ -245,6 +245,10 @@
         ), true), print_r($this->fieldDescriptionCollection->getElements(), true));
     }
 
+    /**
+     * @param string $name
+     * @param string $label
+     */
     private function getFieldDescriptionMock($name = null, $label = null)
     {
         $fieldDescription = $this->getMockForAbstractClass('Sonata\AdminBundle\Admin\BaseFieldDescription');

Tests/Datagrid/PagerTest.php

Doc Comments +4 added lines

@@ -640,6 +640,10 @@
         $this->assertSame(null, $this->pager->getQuery());
     }
 
+    /**
+     * @param Pager $obj
+     * @param string $name
+     */
     protected function callMethod($obj, $name, array $args = array())
     {
         $class = new \ReflectionClass($obj);

Tests/Fixtures/Admin/PostAdmin.php

Doc Comments +3 added lines

@@ -8,6 +8,9 @@
 {
     protected $metadataClass = null;
 
+    /**
+     * @param string $associationMapping
+     */
     public function setParentAssociationMapping($associationMapping)
     {
         $this->parentAssociationMapping = $associationMapping;

Admin/Admin.php

Doc Comments +7 added lines, -6 removed lines

@@ -515,7 +515,7 @@ 
      * Configures the tab menu in your admin.
      *
      * @param MenuItemInterface $menu
-     * @param                   $action
+     * @param                   string $action
      * @param AdminInterface    $childAdmin
      *
      * @return mixed
@@ -879,7 +879,7 @@ 
      * 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.
      *
-     * @return string the name of the parent related field
+     * @return \ReflectionProperty the name of the parent related field
      */
     public function getParentAssociationMapping()
     {
@@ -1588,6 +1588,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $key
      */
     public function removeFieldFromFormGroup($key)
     {
@@ -2179,7 +2180,7 @@ 
      * @param string $id
      * @param int    $count
      * @param array  $parameters
-     * @param null   $domain
+     * @param string   $domain
      * @param null   $locale
      *
      * @return string the translated string
@@ -2430,7 +2431,7 @@ 
     /**
      * Set the roles and permissions per role.
      *
-     * @param array $information
+     * @param string[] $information
      */
     public function setSecurityInformation(array $information)
     {
@@ -2450,7 +2451,7 @@ 
      *
      * @param string $context
      *
-     * @return array
+     * @return string[]
      */
     public function getPermissionsShow($context)
     {
@@ -2686,7 +2687,7 @@ 
     /**
      * Set custom per page options.
      *
-     * @param array $options
+     * @param integer[] $options
      */
     public function setPerPageOptions(array $options)
     {

Admin/AdminInterface.php

Doc Comments +51 added lines, -6 removed lines

@@ -30,6 +30,7 @@ 
 {
     /**
      * @param \Sonata\AdminBundle\Builder\FormContractorInterface $formContractor
+     * @return void
      */
     public function setFormContractor(FormContractorInterface $formContractor);
 
@@ -37,6 +38,7 @@ 
      * Set ListBuilder.
      *
      * @param ListBuilderInterface $listBuilder
+     * @return void
      */
     public function setListBuilder(ListBuilderInterface $listBuilder);
 
@@ -51,6 +53,7 @@ 
      * Set DatagridBuilder.
      *
      * @param \Sonata\AdminBundle\Builder\DatagridBuilderInterface $datagridBuilder
+     * @return void
      */
     public function setDatagridBuilder(DatagridBuilderInterface $datagridBuilder);
 
@@ -65,6 +68,7 @@ 
      * Set translator.
      *
      * @param \Symfony\Component\Translation\TranslatorInterface $translator
+     * @return void
      */
     public function setTranslator(TranslatorInterface $translator);
 
@@ -77,16 +81,19 @@ 
 
     /**
      * @param \Symfony\Component\HttpFoundation\Request $request
+     * @return void
      */
     public function setRequest(Request $request);
 
     /**
      * @param Pool $pool
+     * @return void
      */
     public function setConfigurationPool(Pool $pool);
 
     /**
      * @param \Sonata\AdminBundle\Route\RouteGeneratorInterface $routeGenerator
+     * @return void
      */
     public function setRouteGenerator(RouteGeneratorInterface $routeGenerator);
 
@@ -102,6 +109,7 @@ 
 
     /**
      * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription
+     * @return void
      */
     public function attachAdminClass(FieldDescriptionInterface $fieldDescription);
 
@@ -114,6 +122,7 @@ 
      * Set base controller name.
      *
      * @param string $baseControllerName
+     * @return void
      */
     public function setBaseControllerName($baseControllerName);
 
@@ -159,7 +168,7 @@ 
     public function generateMenuUrl($name, array $parameters = array(), $absolute = false);
 
     /**
-     * @return \Sonata\AdminBundle\Model\ModelManagerInterface;
+     * @return \Sonata\AdminBundle\Model\ModelManagerInterface
      */
     public function getModelManager();
 
@@ -238,6 +247,7 @@ 
 
     /**
      * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $parentFieldDescription
+     * @return void
      */
     public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription);
 
@@ -260,7 +270,7 @@ 
      *
      * @param string $id
      * @param array  $parameters
-     * @param null   $domain
+     * @param string   $domain
      * @param null   $locale
      *
      * @return string the translated string
@@ -302,6 +312,7 @@ 
      *
      * @param string                                              $name
      * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription
+     * @return void
      */
     public function addShowFieldDescription($name, FieldDescriptionInterface $fieldDescription);
 
@@ -309,6 +320,7 @@ 
      * Remove a ShowFieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function removeShowFieldDescription($name);
 
@@ -317,6 +329,7 @@ 
      *
      * @param string                                              $name
      * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription
+     * @return void
      */
     public function addListFieldDescription($name, FieldDescriptionInterface $fieldDescription);
 
@@ -324,6 +337,7 @@ 
      * Remove a list FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function removeListFieldDescription($name);
 
@@ -341,6 +355,7 @@ 
      *
      * @param string                                              $name
      * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription
+     * @return void
      */
     public function addFilterFieldDescription($name, FieldDescriptionInterface $fieldDescription);
 
@@ -348,6 +363,7 @@ 
      * Remove a filter FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function removeFilterFieldDescription($name);
 
@@ -367,6 +383,7 @@ 
 
     /**
      * @param \Sonata\AdminBundle\Security\Handler\SecurityHandlerInterface $securityHandler
+     * @return void
      */
     public function setSecurityHandler(SecurityHandlerInterface $securityHandler);
 
@@ -385,11 +402,13 @@ 
 
     /**
      * @param mixed $entity
+     * @return string
      */
     public function getUrlsafeIdentifier($entity);
 
     /**
      * @param mixed $entity
+     * @return string
      */
     public function getNormalizedIdentifier($entity);
 
@@ -398,12 +417,13 @@ 
      *
      * @param object $entity
      *
-     * @return mixed
+     * @return string
      */
     public function id($entity);
 
     /**
      * @param \Symfony\Component\Validator\ValidatorInterface $validator
+     * @return void
      */
     public function setValidator(ValidatorInterface $validator);
 
@@ -413,12 +433,13 @@ 
     public function getValidator();
 
     /**
-     * @return array
+     * @return FieldDescriptionCollection
      */
     public function getShow();
 
     /**
      * @param array $formTheme
+     * @return void
      */
     public function setFormTheme(array $formTheme);
 
@@ -429,6 +450,7 @@ 
 
     /**
      * @param array $filterTheme
+     * @return void
      */
     public function setFilterTheme(array $filterTheme);
 
@@ -439,6 +461,7 @@ 
 
     /**
      * @param AdminExtensionInterface $extension
+     * @return void
      */
     public function addExtension(AdminExtensionInterface $extension);
 
@@ -451,6 +474,7 @@ 
 
     /**
      * @param \Knp\Menu\FactoryInterface $menuFactory
+     * @return void
      */
     public function setMenuFactory(MenuFactoryInterface $menuFactory);
 
@@ -461,6 +485,7 @@ 
 
     /**
      * @param \Sonata\AdminBundle\Builder\RouteBuilderInterface $routeBuilder
+     * @return void
      */
     public function setRouteBuilder(RouteBuilderInterface $routeBuilder);
 
@@ -478,6 +503,7 @@ 
 
     /**
      * @param \Sonata\Adminbundle\Translator\LabelTranslatorStrategyInterface $labelTranslatorStrategy
+     * @return void
      */
     public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $labelTranslatorStrategy);
 
@@ -499,6 +525,7 @@ 
      * add an Admin child to the current one.
      *
      * @param \Sonata\AdminBundle\Admin\AdminInterface $child
+     * @return void
      */
     public function addChild(AdminInterface $child);
 
@@ -593,7 +620,7 @@ 
     /**
      * Returns the array of allowed export formats.
      *
-     * @return array
+     * @return string[]
      */
     public function getExportFormats();
 
@@ -604,6 +631,9 @@ 
      */
     public function getDataSourceIterator();
 
+    /**
+     * @return void
+     */
     public function configure();
 
     /**
@@ -676,6 +706,7 @@ 
      * @param ProxyQueryInterface $query
      * @param array               $idx
      * @param bool                $allElements
+     * @return void
      */
     public function preBatchAction($actionName, ProxyQueryInterface $query, array &$idx, $allElements);
 
@@ -699,6 +730,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);
 
@@ -713,6 +745,7 @@ 
      * Add object security, fe. make the current user owner of the object.
      *
      * @param mixed $object
+     * @return void
      */
     public function createObjectSecurity($object);
 
@@ -723,6 +756,7 @@ 
 
     /**
      * @param AdminInterface $admin
+     * @return void
      */
     public function setParent(AdminInterface $admin);
 
@@ -746,6 +780,7 @@ 
      * Set the translation domain.
      *
      * @param string $translationDomain the translation domain
+     * @return void
      */
     public function setTranslationDomain($translationDomain);
 
@@ -767,6 +802,7 @@ 
      * Set the form groups.
      *
      * @param array $formGroups
+     * @return void
      */
     public function setFormGroups(array $formGroups);
 
@@ -777,6 +813,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @return void
      */
     public function setFormTabs(array $formTabs);
 
@@ -787,13 +824,15 @@ 
 
     /**
      * {@inheritdoc}
+     * @return void
      */
     public function setShowTabs(array $showTabs);
 
     /**
      * Remove a form group field.
      *
-     * @param $key
+     * @param string $key
+     * @return void
      */
     public function removeFieldFromFormGroup($key);
 
@@ -808,6 +847,7 @@ 
      * Set the show groups.
      *
      * @param array $showGroups
+     * @return void
      */
     public function setShowGroups(array $showGroups);
 
@@ -816,6 +856,7 @@ 
      *
      * @param string $group
      * @param array  $keys
+     * @return void
      */
     public function reorderShowGroup($group, array $keys);
 
@@ -824,6 +865,7 @@ 
      *
      * @param string                                              $name
      * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription
+     * @return void
      */
     public function addFormFieldDescription($name, FieldDescriptionInterface $fieldDescription);
 
@@ -831,6 +873,7 @@ 
      * Remove a FieldDescription.
      *
      * @param string $name
+     * @return void
      */
     public function removeFormFieldDescription($name);
 
@@ -845,6 +888,7 @@ 
      * Sets the list of supported sub classes.
      *
      * @param array $subClasses the list of sub classes
+     * @return void
      */
     public function setSubClasses(array $subClasses);
 
@@ -912,6 +956,7 @@ 
      * Set the current child status.
      *
      * @param bool $currentChild
+     * @return void
      */
     public function setCurrentChild($currentChild);