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

dbu · web-flow · commit e0787616a260 · 2024-05-04T22:29:20.000+02:00
strict typing
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]],

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public function process(ContainerBuilder $container): void`
`39`	`39`
`40`	`40`	`$voters = new \SplPriorityQueue();`
`41`	`41`	`foreach ($container->findTaggedServiceIds('cmf_published_voter') as $id => $attributes) {`
`42`		`- $priority = isset($attributes[0]['priority']) ? $attributes[0]['priority'] : 0;`
	`42`	`+ $priority = $attributes[0]['priority'] ?? 0;`
`43`	`43`	`$voters->insert(new Reference($id), $priority);`
`44`	`44`	`}`
`45`	`45`
Original file line number	Diff line number	Diff line change
`@@ -18,10 +18,7 @@`
`18`	`18`
`19`	`19`	`class CmfCoreExtensionTest extends TestCase`
`20`	`20`	`{`
`21`		`- /**`
`22`		`- * @var ContainerBuilder`
`23`		`- */`
`24`		`- private $container;`
	`21`	`+ private ContainerBuilder $container;`
`25`	`22`
`26`	`23`	`protected function setUp(): void`
`27`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,15 +21,8 @@`
`21`	`21`
`22`	`22`	`class CmfHierarchyTest extends BaseTestCase`
`23`	`23`	`{`
`24`		`- /**`
`25`		`- * @var AuthorizationCheckerInterface\|MockObject`
`26`		`- */`
`27`		`- private $publishWorkflowChecker;`
`28`		`-`
`29`		`- /**`
`30`		`- * @var Cmf`
`31`		`- */`
`32`		`- private $helper;`
	`24`	`+ private MockObject&AuthorizationCheckerInterface $publishWorkflowChecker;`
	`25`	`+ private Cmf $helper;`
`33`	`26`
`34`	`27`	`public function setUp(): void`
`35`	`28`	`{`
`@@ -39,14 +32,14 @@ public function setUp(): void`
`39`	`32`	`$this->publishWorkflowChecker = $this->createMock(AuthorizationCheckerInterface::class);`
`40`	`33`	`$this->publishWorkflowChecker`
`41`	`34`	`->method('isGranted')`
`42`		`- ->will($this->returnValue(true))`
	`35`	`+ ->willReturn(true)`
`43`	`36`	`;`
`44`	`37`
`45`	`38`	`$this->helper = new Cmf($this->publishWorkflowChecker);`
`46`	`39`	`$this->helper->setDoctrineRegistry($dbManager->getRegistry(), 'default');`
`47`	`40`	`}`
`48`	`41`
`49`		`- public function testGetDescendants()`
	`42`	`+ public function testGetDescendants(): void`
`50`	`43`	`{`
`51`	`44`	`$this->assertEquals([], $this->helper->getDescendants(null));`
`52`	`45`
`@@ -60,7 +53,7 @@ public function testGetDescendants()`
`60`	`53`	`/**`
`61`	`54`	`* @dataProvider getPrevData`
`62`	`55`	`*/`
`63`		`- public function testGetPrev($expected, $path, $anchor = null, $depth = null, $class = 'Doctrine\ODM\PHPCR\Document\Generic')`
	`56`	`+ public function testGetPrev(?string $expected, ?string $path, ?string $anchor = null, ?int $depth = null, string $class = Generic::class): void`
`64`	`57`	`{`
`65`	`58`	`$prev = $this->helper->getPrev($path, $anchor, $depth);`
`66`	`59`	`if (null === $expected) {`
`@@ -71,7 +64,7 @@ public function testGetPrev($expected, $path, $anchor = null, $depth = null, $cl`
`71`	`64`	`}`
`72`	`65`	`}`
`73`	`66`
`74`		`- public static function getPrevData()`
	`67`	`+ public static function getPrevData(): array`
`75`	`68`	`{`
`76`	`69`	`return [`
`77`	`70`	`[null, null],`
`@@ -99,7 +92,7 @@ public static function getPrevData()`
`99`	`92`	`/**`
`100`	`93`	`* @dataProvider getNextData`
`101`	`94`	`*/`
`102`		`- public function testGetNext($expected, $path, $anchor = null, $depth = null, $class = Generic::class)`
	`95`	`+ public function testGetNext(?string $expected, ?string $path, ?string $anchor = null, ?int $depth = null, string $class = Generic::class): void`
`103`	`96`	`{`
`104`	`97`	`$next = $this->helper->getNext($path, $anchor, $depth);`
`105`	`98`	`if (null === $expected) {`
`@@ -110,7 +103,7 @@ public function testGetNext($expected, $path, $anchor = null, $depth = null, $cl`
`110`	`103`	`}`
`111`	`104`	`}`
`112`	`105`
`113`		`- public static function getNextData()`
	`106`	`+ public static function getNextData(): array`
`114`	`107`	`{`
`115`	`108`	`return [`
`116`	`109`	`[null, null],`
`@@ -139,7 +132,7 @@ public static function getNextData()`
`139`	`132`	`/**`
`140`	`133`	`* @dataProvider getPrevLinkableData`
`141`	`134`	`*/`
`142`		`- public function testGetPrevLinkable($expected, $path, $anchor = null, $depth = null)`
	`135`	`+ public function testGetPrevLinkable(?string $expected, ?string $path, ?string $anchor = null, ?int $depth = null): void`
`143`	`136`	`{`
`144`	`137`	`$prev = $this->helper->getPrevLinkable($path, $anchor, $depth);`
`145`	`138`	`if (null === $expected) {`
`@@ -150,7 +143,7 @@ public function testGetPrevLinkable($expected, $path, $anchor = null, $depth = n`
`150`	`143`	`}`
`151`	`144`	`}`
`152`	`145`
`153`		`- public static function getPrevLinkableData()`
	`146`	`+ public static function getPrevLinkableData(): array`
`154`	`147`	`{`
`155`	`148`	`// TODO: expand test case`
`156`	`149`	`return [`
`@@ -164,7 +157,7 @@ public static function getPrevLinkableData()`
`164`	`157`	`/**`
`165`	`158`	`* @dataProvider getNextLinkableData`
`166`	`159`	`*/`
`167`		`- public function testGetNextLinkable($expected, $path, $anchor = null, $depth = null)`
	`160`	`+ public function testGetNextLinkable(?string $expected, ?string $path, ?string $anchor = null, ?int $depth = null): void`
`168`	`161`	`{`
`169`	`162`	`$next = $this->helper->getNextLinkable($path, $anchor, $depth);`
`170`	`163`	`if (null === $expected) {`
`@@ -175,7 +168,7 @@ public function testGetNextLinkable($expected, $path, $anchor = null, $depth = n`
`175`	`168`	`}`
`176`	`169`	`}`
`177`	`170`
`178`		`- public static function getNextLinkableData()`
	`171`	`+ public static function getNextLinkableData(): array`
`179`	`172`	`{`
`180`	`173`	`// TODO: expand test case`
`181`	`174`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`
`17`	`17`	`class ServiceTest extends BaseTestCase`
`18`	`18`	`{`
`19`		`- public function testContainer()`
	`19`	`+ public function testContainer(): void`
`20`	`20`	`{`
`21`	`21`	`/** @var \Twig\Environment $twig */`
`22`	`22`	`$twig = $this->getContainer()->get('test.service_container')->get('twig');`