Add types

composer.json

@@ -16,22 +16,23 @@
         "symfony/security-core": "^5.2|^6.2",
         "symfony/serializer": "^5.2|^6.2",
         "twig/twig": "^2.4|^3.0",
-        "symfony/translation": "^5.2|^6.2"
+        "symfony/translation": "^5.2|^6.2",
+        "jms/translation-bundle": "^1.8",
+        "doctrine/annotations": "^2.0",
+        "doctrine/orm": "^2.13"
     },
     "require-dev": {
         "ext-intl": "*",
         "dg/bypass-finals": "^1.2",
         "symfony/framework-bundle": "^5.2|^6.2",
         "symfony/expression-language": "^5.2|^6.2",
         "symfony/phpunit-bridge": "^5.2|^6.2",
-        "phpunit/phpunit": "^9.5",
-        "doctrine/orm": "~2.4,>=2.4.5"
+        "phpunit/phpunit": "^9.5"
     },
     "suggest": {
         "ext-intl": "Translate the grid",
         "ext-mbstring": "Convert your data with the right charset",
-        "PHPExcel": "Export the grid (Excel, HTML or PDF)",
-        "doctrine/orm": "If you want to use Entity as source, please require doctrine/orm"
+        "PHPExcel": "Export the grid (Excel, HTML or PDF)"
     },
     "autoload": {
         "psr-4": {

src/APYDataGridBundle.php

@@ -19,7 +19,7 @@
 
 class APYDataGridBundle extends Bundle
 {
-    public function build(ContainerBuilder $container)
+    public function build(ContainerBuilder $container): void
     {
         parent::build($container);
 

src/DependencyInjection/APYDataGridExtension.php

@@ -20,7 +20,7 @@
 
 class APYDataGridExtension extends Extension
 {
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration();
         $config = $this->processConfiguration($configuration, $configs);

src/DependencyInjection/Compiler/GridExtensionPass.php

@@ -18,7 +18,7 @@
 
 class GridExtensionPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (false === $container->hasDefinition('grid')) {
             return;

src/DependencyInjection/Compiler/GridPass.php

@@ -20,7 +20,7 @@ class GridPass implements CompilerPassInterface
      *
      * @api
      */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition('apy_grid.registry')) {
             return;

src/DependencyInjection/Compiler/TranslationPass.php

@@ -16,7 +16,7 @@ class TranslationPass implements CompilerPassInterface
     /**
      * {@inheritdoc}
      */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition('jms_translation.extractor.file_extractor')) {
             return;

src/Grid/AbstractType.php

@@ -14,19 +14,19 @@ abstract class AbstractType implements GridTypeInterface
     /**
      * {@inheritdoc}
      */
-    public function buildGrid(GridBuilder $builder, array $options = [])
+    public function buildGrid(GridBuilder $builder, array $options = []): void
     {
     }
 
     /**
      * {@inheritdoc}
      */
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
     }
 
     /**
      * {@inheritdoc}
      */
-    abstract public function getName();
+    abstract public function getName(): string;
 }

src/Grid/Action/DeleteMassAction.php

@@ -14,12 +14,7 @@
 
 class DeleteMassAction extends MassAction
 {
-    /**
-     * Default DeleteMassAction constructor.
-     *
-     * @param bool $confirm Show confirm message if true
-     */
-    public function __construct($confirm = false)
+    public function __construct(bool $confirm = false)
     {
         parent::__construct('Delete', 'static::deleteAction', $confirm);
     }

src/Grid/Action/MassAction.php

@@ -14,187 +14,101 @@
 
 class MassAction implements MassActionInterface
 {
-    /** @var string */
-    protected $title;
-
-    /** @var string|null */
-    protected $callback;
-
-    /** @var bool */
-    protected $confirm;
-
-    /** @var string */
-    protected $confirmMessage;
-
-    /** @var array  */
-    protected $parameters = [];
-
-    /** @var string|null  */
-    protected $role;
-
-    /**
-     * Default MassAction constructor.
-     *
-     * @param string $title      Title of the mass action
-     * @param string $callback   Callback of the mass action
-     * @param bool   $confirm    Show confirm message if true
-     * @param array  $parameters Additional parameters
-     * @param string $role       Security role
-     */
-    public function __construct($title, $callback = null, $confirm = false, $parameters = [], $role = null)
-    {
-        $this->title = $title;
-        $this->callback = $callback;
-        $this->confirm = $confirm;
+    private string $title;
+
+    private \Closure|string|null $callback;
+
+    private bool $confirm;
+
+    private string $confirmMessage;
+
+    private array $parameters = [];
+
+    private ?string $role;
+
+    public function __construct(
+        string $title,
+        \Closure|string|null $callback = null,
+        bool $confirm = false,
+        array $parameters = [],
+        ?string $role = null
+    ) {
+        $this->title          = $title;
+        $this->callback       = $callback;
+        $this->confirm        = $confirm;
         $this->confirmMessage = 'Do you want to ' . strtolower($title) . ' the selected rows?';
-        $this->parameters = $parameters;
-        $this->role = $role;
+        $this->parameters     = $parameters;
+        $this->role           = $role;
     }
 
-    // @todo: has this setter sense? we passed the title from constructor
-    /**
-     * Set action title.
-     *
-     * @param string $title
-     *
-     * @return self
-     */
-    public function setTitle($title)
+    public function setTitle(string $title): self
     {
         $this->title = $title;
 
         return $this;
     }
 
-    /**
-     * get action title.
-     *
-     * @return string
-     */
-    public function getTitle()
+    public function getTitle(): string
     {
         return $this->title;
     }
 
-    /**
-     * Set action callback.
-     *
-     * @param string $callback
-     *
-     * @return self
-     */
-    public function setCallback($callback)
+    public function setCallback(\Closure|string|null $callback): self
     {
         $this->callback = $callback;
 
         return $this;
     }
 
-    /**
-     * get action callback.
-     *
-     * @return string
-     */
-    public function getCallback()
+    public function getCallback(): \Closure|string|null
     {
         return $this->callback;
     }
 
-    // @todo: we should change this to something like "enableConfirm" as "false" is the default value and has pretty much
-    // nosense to use setConfirm with false parameter.
-    /**
-     * Set action confirm.
-     *
-     * @param bool $confirm
-     *
-     * @return self
-     */
-    public function setConfirm($confirm)
+    public function setConfirm(bool $confirm): self
     {
         $this->confirm = $confirm;
 
         return $this;
     }
 
-    // @todo: could we change this to neddConfirm?
-    /**
-     * Get action confirm.
-     *
-     * @return bool
-     */
-    public function getConfirm()
+    public function getConfirm(): bool
     {
         return $this->confirm;
     }
 
-    /**
-     * Set action confirmMessage.
-     *
-     * @param string $confirmMessage
-     *
-     * @return self
-     */
-    public function setConfirmMessage($confirmMessage)
+    public function setConfirmMessage(string $confirmMessage): self
     {
         $this->confirmMessage = $confirmMessage;
 
         return $this;
     }
 
-    /**
-     * get action confirmMessage.
-     *
-     * @return string
-     */
-    public function getConfirmMessage()
+    public function getConfirmMessage(): string
     {
         return $this->confirmMessage;
     }
 
-    /**
-     * Set action/controller parameters.
-     *
-     * @param array $parameters
-     *
-     * @return $this
-     */
-    public function setParameters(array $parameters)
+    public function setParameters(array $parameters): self
     {
         $this->parameters = $parameters;
 
         return $this;
     }
 
-    /**
-     * Get action/controller parameters.
-     *
-     * @return array
-     */
-    public function getParameters()
+    public function getParameters(): array
     {
         return $this->parameters;
     }
 
-    /**
-     * set role.
-     *
-     * @param string $role
-     *
-     * @return self
-     */
-    public function setRole($role)
+    public function setRole(?string $role): self
     {
         $this->role = $role;
 
         return $this;
     }
 
-    /**
-     * Get role.
-     *
-     * @return string
-     */
-    public function getRole()
+    public function getRole(): ?string
     {
         return $this->role;
     }

src/Grid/Action/MassActionInterface.php

@@ -19,33 +19,33 @@ interface MassActionInterface
      *
      * @return string
      */
-    public function getTitle();
+    public function getTitle(): string;
 
     /**
      * get action callback.
      *
      * @return string
      */
-    public function getCallback();
+    public function getCallback(): \Closure|string|null;
 
     /**
      * get action confirm.
      *
      * @return bool
      */
-    public function getConfirm();
+    public function getConfirm(): bool;
 
     /**
      * get action confirmMessage.
      *
      * @return bool
      */
-    public function getConfirmMessage();
+    public function getConfirmMessage(): string;
 
     /**
      * get additional parameters.
      *
      * @return array
      */
-    public function getParameters();
+    public function getParameters(): array;
 }