Merge pull request #289 from symfony-cmf/strict-typing

strict typing
symfony-cmf · May 4, 2024 · e078761 · e078761
2 parents 672024c + 3b7fb6c
commit e078761
Show file tree

Hide file tree

Showing 8 changed files with 82 additions and 120 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@ Changelog
 * Drop support for old Symfony versions
 * Supprt PHP 8.1 - 8.3
 * Drop support for old PHP versions
+* TranslatableInterface now uses typehints, adjust your implementations accordingly.
 * Use DateTimeInterface instead of DateTime.
 * Adjust to doctrine and twig BC breaks. If you extended classes or customized services, check for old `Twig_*` classes or `Doctrine\Common\Persistence` namespace.
 

diff --git a/src/DependencyInjection/Compiler/AddPublishedVotersPass.php b/src/DependencyInjection/Compiler/AddPublishedVotersPass.php
@@ -39,7 +39,7 @@ public function process(ContainerBuilder $container): void
 
         $voters = new \SplPriorityQueue();
         foreach ($container->findTaggedServiceIds('cmf_published_voter') as $id => $attributes) {
-            $priority = isset($attributes[0]['priority']) ? $attributes[0]['priority'] : 0;
+            $priority = $attributes[0]['priority'] ?? 0;
             $voters->insert(new Reference($id), $priority);
         }
 

diff --git a/src/Templating/Helper/Cmf.php b/src/Templating/Helper/Cmf.php
diff --git a/src/Translatable/TranslatableInterface.php b/src/Translatable/TranslatableInterface.php
@@ -23,11 +23,11 @@ interface TranslatableInterface
      * @return string|bool The locale of this model or false if
      *                     translations are disabled in this project
      */
-    public function getLocale();
+    public function getLocale(): bool|string;
 
     /**
-     * @param string|bool $locale The local for this model, or false if
+     * @param bool|string $locale The local for this model, or false if
      *                            translations are disabled in this project
      */
-    public function setLocale($locale);
+    public function setLocale(bool|string $locale): void;
 }
diff --git a/tests/Functional/DependencyInjection/CmfCoreExtensionTest.php b/tests/Functional/DependencyInjection/CmfCoreExtensionTest.php
@@ -18,10 +18,7 @@
 
 class CmfCoreExtensionTest extends TestCase
 {
-    /**
-     * @var ContainerBuilder
-     */
-    private $container;
+    private ContainerBuilder $container;
 
     protected function setUp(): void
     {

diff --git a/tests/Functional/Templating/Helper/CmfHierarchyTest.php b/tests/Functional/Templating/Helper/CmfHierarchyTest.php
@@ -21,15 +21,8 @@
 
 class CmfHierarchyTest extends BaseTestCase
 {
-    /**
-     * @var AuthorizationCheckerInterface|MockObject
-     */
-    private $publishWorkflowChecker;
-
-    /**
-     * @var Cmf
-     */
-    private $helper;
+    private MockObject&AuthorizationCheckerInterface $publishWorkflowChecker;
+    private Cmf $helper;
 
     public function setUp(): void
     {
@@ -39,14 +32,14 @@ public function setUp(): void
         $this->publishWorkflowChecker = $this->createMock(AuthorizationCheckerInterface::class);
         $this->publishWorkflowChecker
             ->method('isGranted')
-            ->will($this->returnValue(true))
+            ->willReturn(true)
         ;
 
         $this->helper = new Cmf($this->publishWorkflowChecker);
         $this->helper->setDoctrineRegistry($dbManager->getRegistry(), 'default');
     }
 
-    public function testGetDescendants()
+    public function testGetDescendants(): void
     {
         $this->assertEquals([], $this->helper->getDescendants(null));
 
@@ -60,7 +53,7 @@ public function testGetDescendants()
     /**
      * @dataProvider getPrevData
      */
-    public function testGetPrev($expected, $path, $anchor = null, $depth = null, $class = 'Doctrine\ODM\PHPCR\Document\Generic')
+    public function testGetPrev(?string $expected, ?string $path, ?string $anchor = null, ?int $depth = null, string $class = Generic::class): void
     {
         $prev = $this->helper->getPrev($path, $anchor, $depth);
         if (null === $expected) {
@@ -71,7 +64,7 @@ public function testGetPrev($expected, $path, $anchor = null, $depth = null, $cl
         }
     }
 
-    public static function getPrevData()
+    public static function getPrevData(): array
     {
         return [
             [null, null],
@@ -99,7 +92,7 @@ public static function getPrevData()
     /**
      * @dataProvider getNextData
      */
-    public function testGetNext($expected, $path, $anchor = null, $depth = null, $class = Generic::class)
+    public function testGetNext(?string $expected, ?string $path, ?string $anchor = null, ?int $depth = null, string $class = Generic::class): void
     {
         $next = $this->helper->getNext($path, $anchor, $depth);
         if (null === $expected) {
@@ -110,7 +103,7 @@ public function testGetNext($expected, $path, $anchor = null, $depth = null, $cl
         }
     }
 
-    public static function getNextData()
+    public static function getNextData(): array
     {
         return [
             [null, null],
@@ -139,7 +132,7 @@ public static function getNextData()
     /**
      * @dataProvider getPrevLinkableData
      */
-    public function testGetPrevLinkable($expected, $path, $anchor = null, $depth = null)
+    public function testGetPrevLinkable(?string $expected, ?string $path, ?string $anchor = null, ?int $depth = null): void
     {
         $prev = $this->helper->getPrevLinkable($path, $anchor, $depth);
         if (null === $expected) {
@@ -150,7 +143,7 @@ public function testGetPrevLinkable($expected, $path, $anchor = null, $depth = n
         }
     }
 
-    public static function getPrevLinkableData()
+    public static function getPrevLinkableData(): array
     {
         // TODO: expand test case
         return [
@@ -164,7 +157,7 @@ public static function getPrevLinkableData()
     /**
      * @dataProvider getNextLinkableData
      */
-    public function testGetNextLinkable($expected, $path, $anchor = null, $depth = null)
+    public function testGetNextLinkable(?string $expected, ?string $path, ?string $anchor = null, ?int $depth = null): void
     {
         $next = $this->helper->getNextLinkable($path, $anchor, $depth);
         if (null === $expected) {
@@ -175,7 +168,7 @@ public function testGetNextLinkable($expected, $path, $anchor = null, $depth = n
         }
     }
 
-    public static function getNextLinkableData()
+    public static function getNextLinkableData(): array
     {
         // TODO: expand test case
         return [

diff --git a/tests/Functional/Twig/ServiceTest.php b/tests/Functional/Twig/ServiceTest.php
@@ -16,7 +16,7 @@
 
 class ServiceTest extends BaseTestCase
 {
-    public function testContainer()
+    public function testContainer(): void
     {
         /** @var \Twig\Environment $twig */
         $twig = $this->getContainer()->get('test.service_container')->get('twig');

diff --git a/tests/Unit/Twig/Extension/CmfExtensionTest.php b/tests/Unit/Twig/Extension/CmfExtensionTest.php
@@ -15,22 +15,17 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Cmf\Bundle\CoreBundle\Templating\Helper\Cmf;
 use Symfony\Cmf\Bundle\CoreBundle\Twig\Extension\CmfExtension;
-use Twig\Environment;
-use Twig\Loader\ArrayLoader;
 
 class CmfExtensionTest extends TestCase
 {
     private Cmf&MockObject $cmfHelper;
-    private Environment $env;
     private CmfExtension $cmfExtension;
 
     public function setUp(): void
     {
         $this->cmfHelper = $this->createMock(Cmf::class);
 
         $this->cmfExtension = new CmfExtension($this->cmfHelper);
-        $this->env = new Environment(new ArrayLoader([]));
-        $this->env->addExtension($this->cmfExtension);
     }
 
     /**
@@ -54,7 +49,7 @@ public function testFunctions($methodName, array $methodArguments, $helperMethod
     public function getFunctionsData(): array
     {
         return [
-            ['isPublished', ['document1']],
+            ['isPublished', [$this]],
             ['isLinkable', ['document1']],
             ['getChild', ['parent', 'name']],
             ['getChildren', ['parent', true], 'getChildren', ['parent', true, false, null, false, null]],