Minor CS and doc fixes, declared missing properties, fixed deprecated…

… logger->err calls Fixed Tests namespaces CS fix Fix minor doc issues in interfaces
db306 · Jan 2, 2015 · cc0181e · cc0181e
1 parent c7d545d
commit cc0181e
Show file tree

Hide file tree

Showing 68 changed files with 144 additions and 217 deletions.
diff --git a/Admin/Admin.php b/Admin/Admin.php
@@ -12,7 +12,6 @@
 namespace Sonata\AdminBundle\Admin;
 
 use Sonata\AdminBundle\Datagrid\ProxyQueryInterface;
-use Sonata\AdminBundle\Route\RoutesCache;
 use Sonata\CoreBundle\Model\Metadata;
 use Symfony\Component\Form\Form;
 use Symfony\Component\Form\FormBuilder;
@@ -28,7 +27,6 @@
 use Sonata\AdminBundle\Datagrid\DatagridMapper;
 use Sonata\AdminBundle\Show\ShowMapper;
 
-use Sonata\AdminBundle\Admin\Pool;
 use Sonata\AdminBundle\Validator\ErrorElement;
 use Sonata\AdminBundle\Validator\Constraints\InlineConstraint;
 
@@ -264,7 +262,7 @@ abstract class Admin implements AdminInterface, DomainObjectInterface
     /**
      * Reference the parent collection
      *
-     * @var Admin
+     * @var AdminInterface|null
      */
     protected $parent = null;
 
@@ -541,7 +539,7 @@ protected function configureSideMenu(MenuItemInterface $menu, $action, AdminInte
      * Configures the tab menu in your admin
      *
      * @param MenuItemInterface $menu
-     * @param                   $action
+     * @param string            $action
      * @param AdminInterface    $childAdmin
      *
      * @return mixed
@@ -1355,7 +1353,7 @@ protected function attachInlineValidator()
 
         $metadata->addConstraint(new InlineConstraint(array(
             'service' => $this,
-            'method'  => function(ErrorElement $errorElement, $object) use ($admin) {
+            'method'  => function (ErrorElement $errorElement, $object) use ($admin) {
                 /* @var \Sonata\AdminBundle\Admin\AdminInterface $admin */
 
                 // This avoid the main validation to be cascaded to children
@@ -2101,6 +2099,7 @@ public function getBreadcrumbs($action)
 
         $breadcrumbs = array_reverse($breadcrumbs);
         array_shift($breadcrumbs);
+
         return $breadcrumbs;
     }
 
@@ -2216,13 +2215,13 @@ public function trans($id, array $parameters = array(), $domain = null, $locale
     }
 
     /**
-     * translate a message id
+     * Translate a message id
      *
-     * @param string  $id
-     * @param integer $count
-     * @param array   $parameters
-     * @param null    $domain
-     * @param null    $locale
+     * @param string      $id
+     * @param integer     $count
+     * @param array       $parameters
+     * @param string|null $domain
+     * @param string|null $locale
      *
      * @return string the translated string
      */

diff --git a/Admin/AdminExtension.php b/Admin/AdminExtension.php
@@ -16,7 +16,6 @@
 use Sonata\AdminBundle\Show\ShowMapper;
 use Sonata\AdminBundle\Route\RouteCollection;
 use Sonata\AdminBundle\Validator\ErrorElement;
-use Sonata\AdminBundle\Admin\AdminInterface;
 use Sonata\AdminBundle\Datagrid\ProxyQueryInterface;
 
 use Knp\Menu\ItemInterface as MenuItemInterface;

diff --git a/Admin/AdminExtensionInterface.php b/Admin/AdminExtensionInterface.php
@@ -16,7 +16,6 @@
 use Sonata\AdminBundle\Show\ShowMapper;
 use Sonata\AdminBundle\Route\RouteCollection;
 use Sonata\AdminBundle\Validator\ErrorElement;
-use Sonata\AdminBundle\Admin\AdminInterface;
 use Sonata\AdminBundle\Datagrid\ProxyQueryInterface;
 
 use Knp\Menu\ItemInterface as MenuItemInterface;

diff --git a/Admin/AdminHelper.php b/Admin/AdminHelper.php
@@ -17,7 +17,6 @@
 use Sonata\AdminBundle\Exception\NoValueException;
 use Sonata\AdminBundle\Util\FormViewIterator;
 use Sonata\AdminBundle\Util\FormBuilderIterator;
-use Sonata\AdminBundle\Admin\BaseFieldDescription;
 
 class AdminHelper
 {

diff --git a/Admin/AdminInterface.php b/Admin/AdminInterface.php
@@ -11,8 +11,6 @@
 
 namespace Sonata\AdminBundle\Admin;
 
-use Sonata\AdminBundle\Admin\Pool;
-use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
 use Sonata\AdminBundle\Builder\FormContractorInterface;
 use Sonata\AdminBundle\Builder\ListBuilderInterface;
 use Sonata\AdminBundle\Builder\DatagridBuilderInterface;
@@ -24,7 +22,6 @@
 use Sonata\AdminBundle\Route\RouteGeneratorInterface;
 
 use Knp\Menu\FactoryInterface as MenuFactoryInterface;
-use Knp\Menu\ItemInterface as MenuItemInterface;
 
 use Sonata\CoreBundle\Model\Metadata;
 use Symfony\Component\Validator\ValidatorInterface;
@@ -180,7 +177,7 @@ public function generateUrl($name, array $parameters = array(), $absolute = fals
     public function generateMenuUrl($name, array $parameters = array(), $absolute = false);
 
     /**
-     * @return \Sonata\AdminBundle\Model\ModelManagerInterface;
+     * @return \Sonata\AdminBundle\Model\ModelManagerInterface
      */
     public function getModelManager();
 
@@ -233,7 +230,7 @@ public function getRequest();
 
     /**
      * @return boolean true if a request object is linked to this Admin, false
-     *      otherwise.
+     *                 otherwise.
      */
     public function hasRequest();
 
@@ -570,7 +567,7 @@ public function getChildren();
      *
      * @param string $code
      *
-     * @return array|null
+     * @return AdminInterface|null
      */
     public function getChild($code);
 
@@ -601,7 +598,7 @@ public function getUniqid();
     public function getObject($id);
 
     /**
-     * @param string $subject
+     * @param object $subject
      *
      * @return mixed
      */
@@ -850,7 +847,7 @@ public function setShowTabs(array $showTabs);
     /**
      * Remove a form group field
      *
-     * @param $key
+     * @param string $key
      *
      * @return void
      */

diff --git a/Admin/BaseFieldDescription.php b/Admin/BaseFieldDescription.php
@@ -11,7 +11,6 @@
 
 namespace Sonata\AdminBundle\Admin;
 
-use Sonata\AdminBundle\Admin\AdminInterface;
 use Sonata\AdminBundle\Exception\NoValueException;
 use Symfony\Component\DependencyInjection\Container;
 
@@ -106,17 +105,17 @@ abstract class BaseFieldDescription implements FieldDescriptionInterface
     protected $options = array();
 
     /**
-     * @var Admin|null the parent Admin instance
+     * @var AdminInterface|null the parent Admin instance
      */
     protected $parent = null;
 
     /**
-     * @var Admin the related admin instance
+     * @var AdminInterface the related admin instance
      */
     protected $admin;
 
     /**
-     * @var Admin the associated admin class if the object is associated to another entity
+     * @var AdminInterface the associated admin class if the object is associated to another entity
      */
     protected $associationAdmin;
 
@@ -293,9 +292,6 @@ public function getParentAssociationMappings()
     }
 
     /**
-     * set the association admin instance (only used if the field is linked to an Admin)
-     *
-     * @param \Sonata\AdminBundle\Admin\AdminInterface $associationAdmin the associated admin
      * {@inheritdoc}
      */
     public function setAssociationAdmin(AdminInterface $associationAdmin)
@@ -479,6 +475,6 @@ public function getSortParentAssociationMapping()
      */
     public function getTranslationDomain()
     {
-        return $this->getOption('translation_domain') ? : $this->getAdmin()->getTranslationDomain();
+        return $this->getOption('translation_domain') ?: $this->getAdmin()->getTranslationDomain();
     }
 }
diff --git a/Admin/FieldDescriptionCollection.php b/Admin/FieldDescriptionCollection.php
@@ -10,8 +10,6 @@
  */
 namespace Sonata\AdminBundle\Admin;
 
-use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
-
 class FieldDescriptionCollection implements \ArrayAccess, \Countable
 {
     protected $elements = array();

diff --git a/Admin/FieldDescriptionInterface.php b/Admin/FieldDescriptionInterface.php
@@ -11,8 +11,6 @@
 
 namespace Sonata\AdminBundle\Admin;
 
-use Sonata\AdminBundle\Admin\AdminInterface;
-
 interface FieldDescriptionInterface
 {
 

diff --git a/Admin/Pool.php b/Admin/Pool.php
@@ -207,7 +207,7 @@ public function getInstance($id)
     }
 
     /**
-     * @return null|\Symfony\Component\DependencyInjection\ContainerInterface
+     * @return ContainerInterface|null
      */
     public function getContainer()
     {

diff --git a/Block/AdminListBlockService.php b/Block/AdminListBlockService.php
@@ -14,14 +14,11 @@
 use Sonata\BlockBundle\Block\BlockContextInterface;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
-
 use Sonata\AdminBundle\Form\FormMapper;
 use Sonata\AdminBundle\Validator\ErrorElement;
 use Sonata\AdminBundle\Admin\Pool;
-
 use Sonata\BlockBundle\Model\BlockInterface;
 use Sonata\BlockBundle\Block\BaseBlockService;
-use Symfony\Component\OptionsResolver\OptionsResolver;
 use Symfony\Component\OptionsResolver\OptionsResolverInterface;
 
 /**

diff --git a/Builder/FormContractorInterface.php b/Builder/FormContractorInterface.php
@@ -12,8 +12,6 @@
 namespace Sonata\AdminBundle\Builder;
 
 use Sonata\AdminBundle\Admin\FieldDescriptionInterface;
-use Sonata\AdminBundle\Admin\AdminInterface;
-
 use Symfony\Component\Form\FormBuilder;
 use Symfony\Component\Form\FormFactoryInterface;
 

diff --git a/DependencyInjection/Compiler/ExtensionCompilerPass.php b/DependencyInjection/Compiler/ExtensionCompilerPass.php
@@ -83,7 +83,7 @@ public function process(ContainerBuilder $container)
     protected function getExtensionsForAdmin($id, Definition $admin, ContainerBuilder $container, array $extensionMap)
     {
         $extensions = array();
-        $class = $classReflection = $subjectReflection = null;
+        $classReflection = $subjectReflection = null;
 
         $excludes = $extensionMap['excludes'];
         unset($extensionMap['excludes']);

diff --git a/Export/Exporter.php b/Export/Exporter.php
@@ -11,7 +11,6 @@
 
 namespace Sonata\AdminBundle\Export;
 
-use Symfony\Component\HttpFoundation\StreamedResponse;
 use Sonata\CoreBundle\Exporter\Exporter as BaseExporter;
 
 /**

diff --git a/Filter/Filter.php b/Filter/Filter.php
@@ -11,8 +11,6 @@
 
 namespace Sonata\AdminBundle\Filter;
 
-use Sonata\AdminBundle\Filter\FilterInterface;
-
 abstract class Filter implements FilterInterface
 {
     protected $name = null;

diff --git a/Form/ChoiceList/ModelChoiceList.php b/Form/ChoiceList/ModelChoiceList.php
@@ -194,9 +194,9 @@ public function getEntities()
      * If they have single identifiers, they are either fetched from the
      * internal entity cache (if filled) or loaded from the database.
      *
-     * @param string $key The choice key (for entities with composite
-     *                      identifiers) or entity ID (for entities with single
-     *                      identifiers)
+     * @param  string $key The choice key (for entities with composite
+     *                     identifiers) or entity ID (for entities with single
+     *                     identifiers)
      * @return object The matching entity
      */
     public function getEntity($key)
@@ -241,7 +241,7 @@ private function getReflProperty($property)
      *
      * @param  object                   $entity The entity for which to get the identifier
      * @throws InvalidArgumentException If the entity does not exist in Doctrine's
-     *                                  identity map
+     *                                         identity map
      * @return array
      */
     public function getIdentifierValues($entity)

diff --git a/Form/Extension/Field/Type/MopaCompatibilityTypeFieldExtension.php b/Form/Extension/Field/Type/MopaCompatibilityTypeFieldExtension.php
@@ -57,4 +57,4 @@ public function getExtendedType()
     {
         return 'form';
     }
-}
+}
diff --git a/Form/Type/AdminType.php b/Form/Type/AdminType.php
@@ -16,7 +16,6 @@
 use Symfony\Component\Form\FormInterface;
 use Symfony\Component\Form\FormView;
 
-use Symfony\Component\Form\ReversedTransformer;
 use Symfony\Component\OptionsResolver\Options;
 use Symfony\Component\OptionsResolver\OptionsResolverInterface;
 

diff --git a/Generator/AdminGenerator.php b/Generator/AdminGenerator.php
@@ -33,7 +33,7 @@ class AdminGenerator extends Generator
 
     /**
      * @param ModelManagerInterface $modelManager
-     * @param array|string $skeletonDirectories
+     * @param array|string          $skeletonDirectories
      */
     public function __construct(ModelManagerInterface $modelManager, $skeletonDirectories)
     {
@@ -42,9 +42,9 @@ public function __construct(ModelManagerInterface $modelManager, $skeletonDirect
     }
 
     /**
-     * @param BundleInterface $bundle
-     * @param string $adminClassBasename
-     * @param string $modelClass
+     * @param  BundleInterface   $bundle
+     * @param  string            $adminClassBasename
+     * @param  string            $modelClass
      * @throws \RuntimeException
      */
     public function generate(BundleInterface $bundle, $adminClassBasename, $modelClass)

diff --git a/Generator/ControllerGenerator.php b/Generator/ControllerGenerator.php
@@ -36,8 +36,8 @@ public function __construct($skeletonDirectory)
     }
 
     /**
-     * @param BundleInterface $bundle
-     * @param string $controllerClassBasename
+     * @param  BundleInterface   $bundle
+     * @param  string            $controllerClassBasename
      * @throws \RuntimeException
      */
     public function generate(BundleInterface $bundle, $controllerClassBasename)

diff --git a/Guesser/TypeGuesserChain.php b/Guesser/TypeGuesserChain.php
@@ -12,7 +12,6 @@
 
 namespace Sonata\AdminBundle\Guesser;
 
-use Sonata\AdminBundle\Guesser\TypeGuesserInterface;
 use Symfony\Component\Form\Exception\UnexpectedTypeException;
 use Symfony\Component\Form\Guess\Guess;
 use Sonata\AdminBundle\Model\ModelManagerInterface;
@@ -61,7 +60,7 @@ public function guessType($class, $property, ModelManagerInterface $modelManager
      * return values
      *
      * @param \Closure $closure The closure to execute. Accepts a guesser
-     *                            as argument and should return a Guess instance
+     *                          as argument and should return a Guess instance
      *
      * @return Guess The guess with the highest confidence
      */

diff --git a/Manipulator/ServicesManipulator.php b/Manipulator/ServicesManipulator.php
@@ -12,8 +12,6 @@
 
 namespace Sonata\AdminBundle\Manipulator;
 
-use Symfony\Component\HttpKernel\Bundle\BundleInterface;
-use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\Yaml\Yaml;
 
 /**
@@ -42,11 +40,11 @@ public function __construct($file)
     }
 
     /**
-     * @param string $serviceId
-     * @param string $modelClass
-     * @param string $adminClass
-     * @param string $controllerName
-     * @param string $managerType
+     * @param  string            $serviceId
+     * @param  string            $modelClass
+     * @param  string            $adminClass
+     * @param  string            $controllerName
+     * @param  string            $managerType
      * @throws \RuntimeException
      */
     public function addResource($serviceId, $modelClass, $adminClass, $controllerName, $managerType)
-Original file line number
+Diff line change
@@ Expand Up / @@ -11,8 +11,6 @@ @@
     namespace Sonata\AdminBundle\Admin;
-    use Sonata\AdminBundle\Admin\AdminInterface;
     interface FieldDescriptionInterface
     {
@@ Expand Down @@