فهرست منبع

Fixed the phpdoc for the mappers to make the fluent api friendly with IDEs

Christophe Coevoet 13 سال پیش
والد
کامیت
3896ed5c24
4فایلهای تغییر یافته به همراه25 افزوده شده و 30 حذف شده
  1. 3 6
      Datagrid/DatagridMapper.php
  2. 5 7
      Datagrid/ListMapper.php
  3. 9 5
      Form/FormMapper.php
  4. 8 12
      Show/ShowMapper.php

+ 3 - 6
Datagrid/DatagridMapper.php

@@ -42,8 +42,8 @@ class DatagridMapper
 
     /**
      * @throws \RuntimeException
-     * @param $name
-     * @param null $type
+     * @param mixed $name
+     * @param mixed $type
      * @param array $fieldDescriptionOptions
      * @return DatagridMapper
      */
@@ -52,15 +52,12 @@ class DatagridMapper
         if ($name instanceof FieldDescriptionInterface) {
             $fieldDescription = $name;
             $fieldDescription->mergeOptions($fieldDescriptionOptions);
-
         } else if (is_string($name) && !$this->admin->hasFormFieldDescription($name)) {
-
             $fieldDescription = $this->admin->getModelManager()->getNewFieldDescriptionInstance(
                 $this->admin->getClass(),
                 $name,
                 $fieldDescriptionOptions
             );
-
         } else {
             throw new \RuntimeException('invalid state');
         }
@@ -98,4 +95,4 @@ class DatagridMapper
         $this->admin->removeFilterFieldDescription($key);
         $this->datagrid->remove($key);
     }
-}
+}

+ 5 - 7
Datagrid/ListMapper.php

@@ -44,25 +44,23 @@ class ListMapper
 
     /**
      * @throws \RuntimeException
-     * @param string $name
+     *
+     * @param mixed $name
+     * @param mixed $type
      * @param array $fieldDescriptionOptions
      * @return \Sonata\AdminBundle\Datagrid\ListMapper
      */
     public function add($name, $type = null, array $fieldDescriptionOptions = array())
     {
         if ($name instanceof FieldDescriptionInterface) {
-
             $fieldDescription = $name;
             $fieldDescription->mergeOptions($fieldDescriptionOptions);
-
         } else if (is_string($name) && !$this->admin->hasListFieldDescription($name)) {
-
             $fieldDescription = $this->admin->getModelManager()->getNewFieldDescriptionInstance(
                 $this->admin->getClass(),
                 $name,
                 $fieldDescriptionOptions
             );
-
         } else {
             throw new \RuntimeException('invalid state');
         }
@@ -92,7 +90,7 @@ class ListMapper
     }
 
     /**
-     * @param  $key
+     * @param  string $key
      * @return void
      */
     public function remove($key)
@@ -100,4 +98,4 @@ class ListMapper
         $this->admin->removeListFieldDescription($key);
         $this->list->remove($key);
     }
-}
+}

+ 9 - 5
Form/FormMapper.php

@@ -37,9 +37,9 @@ class FormMapper
     }
 
     /**
-     * @param $name
+     * @param string $name
      * @param array $options
-     * @return void
+     * @return \Sonata\AdminBundle\Form\FormMapper
      */
     public function with($name, array $options = array())
     {
@@ -58,7 +58,7 @@ class FormMapper
     }
 
     /**
-     * @return void
+     * @return \Sonata\AdminBundle\Form\FormMapper
      */
     public function end()
     {
@@ -72,7 +72,7 @@ class FormMapper
      * @param string $type
      * @param array $options
      * @param array $fieldDescriptionOptions
-     * @return \Symfony\Component\Form\FormInterface
+     * @return \Sonata\AdminBundle\Form\FormMapper
      */
     public function add($name, $type = null, array $options = array(), array $fieldDescriptionOptions = array())
     {
@@ -157,13 +157,17 @@ class FormMapper
      * @param string $name
      * @param mixed $type
      * @param array $options
-     * @return void
+     * @return \Symfony\Component\Form\FormBuilder
      */
     public function create($name, $type = null, array $options = array())
     {
         return $this->formBuilder->create($name, $type, $options);
     }
 
+    /**
+     * @param array $helps
+     * @return FormMapper
+     */
     public function setHelps(array $helps = array())
     {
         foreach($helps as $name => $help) {

+ 8 - 12
Show/ShowMapper.php

@@ -44,10 +44,10 @@ class ShowMapper
 
     /**
      * @throws \RuntimeException
-     * @param $name
-     * @param null $type
+     * @param mixed $name
+     * @param mixed $type
      * @param array $fieldDescriptionOptions
-     * @return ShowMapper
+     * @return \Sonata\AdminBundle\Show\ShowMapper
      */
     public function add($name, $type = null, array $fieldDescriptionOptions = array())
     {
@@ -61,18 +61,14 @@ class ShowMapper
 
 
         if ($name instanceof FieldDescriptionInterface) {
-
             $fieldDescription = $name;
             $fieldDescription->mergeOptions($fieldDescriptionOptions);
-
         } else if (is_string($name) && !$this->admin->hasShowFieldDescription($name)) {
-
             $fieldDescription = $this->admin->getModelManager()->getNewFieldDescriptionInstance(
                 $this->admin->getClass(),
                 $name,
                 $fieldDescriptionOptions
             );
-
         } else {
             throw new \RuntimeException('invalid state');
         }
@@ -102,7 +98,7 @@ class ShowMapper
     }
 
     /**
-     * @param  $key
+     * @param string $key
      * @return void
      */
     public function remove($key)
@@ -112,9 +108,9 @@ class ShowMapper
     }
 
     /**
-     * @param $name
+     * @param string $name
      * @param array $options
-     * @return void
+     * @return \Sonata\AdminBundle\Show\ShowMapper
      */
     public function with($name, array $options = array())
     {
@@ -131,7 +127,7 @@ class ShowMapper
     }
 
     /**
-     * @return void
+     * @return \Sonata\AdminBundle\Show\ShowMapper
      */
     public function end()
     {
@@ -139,4 +135,4 @@ class ShowMapper
 
         return $this;
     }
-}
+}