Merge pull request #731 from havvg/2.0

fix interfaces and phpDoc

Admin/Admin.php

@@ -91,7 +91,7 @@ abstract class Admin implements AdminInterface, DomainObjectInterface
     protected $formFieldDescriptions = array();
 
     /**
-     * @var DatagridInterface
+     * @var \Sonata\AdminBundle\Datagrid\DatagridInterface
      */
     private $filter;
 
@@ -243,7 +243,7 @@ abstract class Admin implements AdminInterface, DomainObjectInterface
      * Reference the parent FieldDescription related to this admin
      * only set for FieldDescription which is associated to an Sub Admin instance
      *
-     * @var FieldDescription
+     * @var FieldDescriptionInterface
      */
     protected $parentFieldDescription;
 
@@ -307,7 +307,7 @@ abstract class Admin implements AdminInterface, DomainObjectInterface
     /**
      * The related view builder
      *
-     * @var \Sonata\AdminBundle\View\ShowBuilderInterface
+     * @var ShowBuilderInterface
      */
     protected $showBuilder;
 
@@ -333,7 +333,7 @@ abstract class Admin implements AdminInterface, DomainObjectInterface
     /**
      * The router intance
      *
-     * @var \Sonata\AdminBundle\Route\RouterGeneratorInterface
+     * @var RouteGeneratorInterface
      */
     protected $routeGenerator;
 
@@ -361,7 +361,7 @@ abstract class Admin implements AdminInterface, DomainObjectInterface
     protected $menu;
 
     /**
-     * @var \Knp\Menu\MenuFactoryInterface
+     * @var \Knp\Menu\FactoryInterface
      */
     protected $menuFactory;
 

Admin/AdminHelper.php

@@ -79,7 +79,7 @@ class AdminHelper
      *
      * @throws \RuntimeException
      * @param \Sonata\AdminBundle\Admin\AdminInterface $admin
-     * @param sting $elementId
+     * @param string $elementId
      * @return array
      */
     public function appendFormFieldElement(AdminInterface $admin, $elementId)
@@ -170,4 +170,4 @@ class AdminHelper
     {
        return preg_replace(array('/(^|_| )+(.)/e', '/\.(.)/e'), array("strtoupper('\\2')", "'_'.strtoupper('\\1')"), $property);
     }
-}
+}

Admin/AdminInterface.php

@@ -76,7 +76,7 @@ interface AdminInterface
     /**
      * Returns the class name managed
      *
-     * @return void
+     * @return string
      */
     function getClass();
 
@@ -100,7 +100,7 @@ interface AdminInterface
     function generateUrl($name, array $parameters = array(), $absolute = false);
 
     /**
-     * @return \Sonata\AdminBundle\ModelManagerInterface;
+     * @return \Sonata\AdminBundle\Model\ModelManagerInterface;
      */
     function getModelManager();
 
@@ -426,8 +426,8 @@ interface AdminInterface
     /**
      * Returns the url defined by the $name
      *
-     * @param strinf $name
-     * @return Route
+     * @param string $name
+     * @return \Symfony\Component\Routing\Route
      */
     function getRoute($name);
 

Admin/BaseFieldDescription.php

@@ -398,7 +398,9 @@ abstract class BaseFieldDescription implements FieldDescriptionInterface
     }
 
     /**
-     * {@inheritdoc}
+     * Defines the help message
+     *
+     * @param string $help
      */
     public function setHelp($help)
     {

Builder/FormContractorInterface.php

@@ -23,7 +23,7 @@ interface FormContractorInterface
 
     /**
      * @abstract
-     * @param \Symfony\Component\Form\FieldFactory\FormFactoryInterface $formFactory
+     * @param \Symfony\Component\Form\FormFactoryInterface $formFactory
      */
     function __construct(FormFactoryInterface $formFactory);
 
@@ -39,7 +39,15 @@ interface FormContractorInterface
      * @abstract
      * @param string $name
      * @param array $options
-     * @return void
+     * @return FormBuilder
      */
     function getFormBuilder($name, array $options = array());
+
+    /**
+     * @abstract
+     * @param string $type
+     * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription
+     * @return array
+     */
+    function getDefaultOptions($type, FieldDescriptionInterface $fieldDescription);
 }

Builder/ListBuilderInterface.php

@@ -22,7 +22,7 @@ interface ListBuilderInterface
     /**
      * @abstract
      * @param array $options
-     * @return void
+     * @return \Sonata\AdminBundle\Admin\FieldDescriptionCollection
      */
     function getBaseList(array $options = array());
 

Controller/CRUDController.php

@@ -126,7 +126,7 @@ class CRUDController extends Controller
      * @param $view
      * @param array $parameters
      * @param null|\Symfony\Component\HttpFoundation\Response $response
-     * @return \Symfony\Bundle\FrameworkBundle\Controller\Response
+     * @return Response
      */
     public function render($view, array $parameters = array(), Response $response = null)
     {
@@ -188,7 +188,7 @@ class CRUDController extends Controller
     /**
      * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException|\Symfony\Component\Security\Core\Exception\AccessDeniedException
      * @param $id
-     * @return \Symfony\Bundle\FrameworkBundle\Controller\Response|\Symfony\Component\HttpFoundation\RedirectResponse
+     * @return Response|RedirectResponse
      */
     public function deleteAction($id)
     {
@@ -474,7 +474,7 @@ class CRUDController extends Controller
     /**
      * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException|\Symfony\Component\Security\Core\Exception\AccessDeniedException
      * @param mixed $id
-     * @return \Symfony\Bundle\FrameworkBundle\Controller\Response
+     * @return Response
      */
     public function historyAction($id = null)
     {
@@ -510,7 +510,7 @@ class CRUDController extends Controller
     /**
      * @param null $id
      * @param $revision
-     * @return \Symfony\Bundle\FrameworkBundle\Controller\Response
+     * @return Response
      */
     public function historyViewRevisionAction($id = null, $revision = null)
     {
@@ -572,4 +572,4 @@ class CRUDController extends Controller
 
         return $this->get('sonata.admin.exporter')->getResponse($format, $filename, $this->admin->getDataSourceIterator());
     }
-}
+}

Datagrid/Datagrid.php

@@ -165,7 +165,7 @@ class Datagrid implements DatagridInterface
     }
 
     /**
-     * @return array
+     * @return FilterInterface[]
      */
     public function getFilters()
     {

Datagrid/Pager.php

@@ -410,7 +410,7 @@ abstract class Pager implements \Iterator, \Countable, \Serializable, PagerInter
     /**
      * Returns the current pager's parameter holder.
      *
-     * @return sfParameterHolder
+     * @return array
      */
     public function getParameters()
     {
@@ -630,4 +630,4 @@ abstract class Pager implements \Iterator, \Countable, \Serializable, PagerInter
     {
         return $this->query;
     }
-}
+}

Datagrid/PagerInterface.php

@@ -12,5 +12,12 @@ namespace Sonata\AdminBundle\Datagrid;
 
 interface PagerInterface
 {
-
-}
+    /**
+     * Initialize the Pager.
+     *
+     * @abstract
+     *
+     * @return void
+     */
+    function init();
+}

Form/FormMapper.php

@@ -142,7 +142,7 @@ class FormMapper
 
     /**
      * @param string $name
-     * @return \Symfony\Component\Form\FieldInterface
+     * @return \Symfony\Component\Form\FormInterface
      */
     public function get($name)
     {
@@ -211,4 +211,4 @@ class FormMapper
 
         return $this;
     }
-}
+}

Model/ModelManagerInterface.php

@@ -104,7 +104,7 @@ interface ModelManagerInterface
      * @abstract
      * @param string $class
      * @param string $alias
-     * @return mixed a query instance
+     * @return ProxyQueryInterface
      */
     function createQuery($class, $alias = 'o');
 
@@ -188,7 +188,7 @@ interface ModelManagerInterface
      *
      * @param \Sonata\AdminBundle\Admin\FieldDescriptionInterface $fieldDescription
      * @param \Sonata\AdminBundle\Datagrid\DatagridInterface $datagrid
-     * @return string
+     * @return array
      */
     function getSortParameters(FieldDescriptionInterface $fieldDescription, DatagridInterface $datagrid);
 
@@ -223,7 +223,7 @@ interface ModelManagerInterface
      * @param array $fields
      * @param null $firstResult
      * @param null $maxResult
-     * @return void
+     * @return \Exporter\Source\SourceIteratorInterface
      */
     function getDataSourceIterator(DatagridInterface $datagrid, array $fields, $firstResult = null, $maxResult = null);