Merge pull request #2712 from Koc/phpdoc-fixes

Fix some PHPDoc for better IDE autocompletion

Form/FormMapper.php

@@ -24,9 +24,9 @@ class FormMapper extends BaseGroupedMapper
     protected $formBuilder;
 
     /**
-     * @param \Sonata\AdminBundle\Builder\FormContractorInterface $formContractor
-     * @param \Symfony\Component\Form\FormBuilder                 $formBuilder
-     * @param \Sonata\AdminBundle\Admin\AdminInterface            $admin
+     * @param FormContractorInterface $formContractor
+     * @param FormBuilder                 $formBuilder
+     * @param AdminInterface            $admin
      */
     public function __construct(FormContractorInterface $formContractor, FormBuilder $formBuilder, AdminInterface $admin)
     {
@@ -35,9 +35,7 @@ class FormMapper extends BaseGroupedMapper
     }
 
     /**
-     * @param array $keys field names
-     *
-     * @return \Sonata\AdminBundle\Form\FormMapper
+     * {@inheritdoc}
      */
     public function reorder(array $keys)
     {
@@ -52,7 +50,7 @@ class FormMapper extends BaseGroupedMapper
      * @param array  $options
      * @param array  $fieldDescriptionOptions
      *
-     * @return \Sonata\AdminBundle\Form\FormMapper
+     * @return $this
      */
     public function add($name, $type = null, array $options = array(), array $fieldDescriptionOptions = array())
     {
@@ -136,9 +134,7 @@ class FormMapper extends BaseGroupedMapper
     }
 
     /**
-     * @param string $name
-     *
-     * @return \Symfony\Component\Form\FormInterface
+     * {@inheritdoc}
      */
     public function get($name)
     {
@@ -146,9 +142,7 @@ class FormMapper extends BaseGroupedMapper
     }
 
     /**
-     * @param string $key
-     *
-     * @return boolean
+     * {@inheritdoc}
      */
     public function has($key)
     {
@@ -156,9 +150,7 @@ class FormMapper extends BaseGroupedMapper
     }
 
     /**
-     * @param string $key
-     *
-     * @return \Sonata\AdminBundle\Form\FormMapper
+     * {@inheritdoc}
      */
     public function remove($key)
     {
@@ -170,7 +162,7 @@ class FormMapper extends BaseGroupedMapper
     }
 
     /**
-     * @return \Symfony\Component\Form\FormBuilder
+     * @return FormBuilder
      */
     public function getFormBuilder()
     {
@@ -182,7 +174,7 @@ class FormMapper extends BaseGroupedMapper
      * @param mixed  $type
      * @param array  $options
      *
-     * @return \Symfony\Component\Form\FormBuilder
+     * @return FormBuilder
      */
     public function create($name, $type = null, array $options = array())
     {

Mapper/BaseGroupedMapper.php

@@ -31,7 +31,7 @@ abstract class BaseGroupedMapper extends BaseMapper
      * @param string $name
      * @param array  $options
      *
-     * @return BaseGroupedMapper
+     * @return $this
      *
      * @throws \RuntimeException
      */
@@ -141,7 +141,7 @@ abstract class BaseGroupedMapper extends BaseMapper
      * @param string $name
      * @param array  $options
      *
-     * @return BaseGroupedMapper
+     * @return $this
      */
     public function tab($name, array $options = array())
     {
@@ -151,7 +151,7 @@ abstract class BaseGroupedMapper extends BaseMapper
     /**
      * Close the current group or tab
      *
-     * @return BaseGroupedMapper
+     * @return $this
      *
      * @throws \RuntimeException
      */
@@ -169,7 +169,7 @@ abstract class BaseGroupedMapper extends BaseMapper
     }
 
     /**
-     * Add the fieldname to the current group
+     * Add the field name to the current group
      *
      * @param string $fieldName
      */

Mapper/BaseMapper.php

@@ -19,14 +19,13 @@ use Sonata\AdminBundle\Builder\BuilderInterface;
  */
 abstract class BaseMapper
 {
-
     protected $admin;
 
     protected $builder;
 
     /**
-     * @param \Sonata\AdminBundle\Builder\BuilderInterface $builder
-     * @param \Sonata\AdminBundle\Admin\AdminInterface     $admin
+     * @param BuilderInterface   $builder
+     * @param AdminInterface     $admin
      */
     public function __construct(BuilderInterface $builder, AdminInterface $admin)
     {
@@ -35,7 +34,7 @@ abstract class BaseMapper
     }
 
     /**
-     * @return \Sonata\AdminBundle\Admin\AdminInterface
+     * @return AdminInterface
      */
     public function getAdmin()
     {
@@ -59,14 +58,14 @@ abstract class BaseMapper
     /**
      * @param string $key
      *
-     * @return \Sonata\AdminBundle\Mapper\BaseMapper
+     * @return $this
      */
     abstract public function remove($key);
 
     /**
      * @param array $keys field names
      *
-     * @return \Sonata\AdminBundle\Mapper\BaseMapper
+     * @return $this
      */
     abstract public function reorder(array $keys);
 }

Show/ShowMapper.php

@@ -25,9 +25,9 @@ class ShowMapper extends BaseGroupedMapper
     protected $list;
 
     /**
-     * @param \Sonata\AdminBundle\Builder\ShowBuilderInterface     $showBuilder
-     * @param \Sonata\AdminBundle\Admin\FieldDescriptionCollection $list
-     * @param \Sonata\AdminBundle\Admin\AdminInterface             $admin
+     * @param ShowBuilderInterface       $showBuilder
+     * @param FieldDescriptionCollection $list
+     * @param AdminInterface             $admin
      */
     public function __construct(ShowBuilderInterface $showBuilder, FieldDescriptionCollection $list, AdminInterface $admin)
     {
@@ -42,7 +42,7 @@ class ShowMapper extends BaseGroupedMapper
      * @param mixed $type
      * @param array $fieldDescriptionOptions
      *
-     * @return \Sonata\AdminBundle\Show\ShowMapper
+     * @return $this
      */
     public function add($name, $type = null, array $fieldDescriptionOptions = array())
     {
@@ -76,9 +76,7 @@ class ShowMapper extends BaseGroupedMapper
     }
 
     /**
-     * @param string $name
-     *
-     * @return array
+     * {@inheritdoc}
      */
     public function get($name)
     {
@@ -86,9 +84,7 @@ class ShowMapper extends BaseGroupedMapper
     }
 
     /**
-     * @param string $key
-     *
-     * @return bool
+     * {@inheritdoc}
      */
     public function has($key)
     {
@@ -96,9 +92,7 @@ class ShowMapper extends BaseGroupedMapper
     }
 
     /**
-     * @param string $key
-     *
-     * @return \Sonata\AdminBundle\Show\ShowMapper
+     * {@inheritdoc}
      */
     public function remove($key)
     {
@@ -109,9 +103,7 @@ class ShowMapper extends BaseGroupedMapper
     }
 
     /**
-     * @param array $keys field names
-     *
-     * @return \Sonata\AdminBundle\Show\ShowMapper
+     * {@inheritdoc}
      */
     public function reorder(array $keys)
     {