Add Symfony 7.2 and PHP 8.4 to test matrix, add typing, fix deprecations and remove superfluous docblock (#351)

Author: ker0x

.github/workflows/tests.yml

@@ -24,12 +24,12 @@ jobs:
             symfony-version: 5.4.*
           - php-version: 8.1
             symfony-version: 6.4.*
-          - php-version: 8.3
+          - php-version: 8.4
             symfony-version: 6.4.*
           - php-version: 8.2
-            symfony-version: 7.1.*
-          - php-version: 8.3
-            symfony-version: 7.1.*
+            symfony-version: 7.2.*
+          - php-version: 8.4
+            symfony-version: 7.2.*
 
     steps:
       - name: "Checkout"
@@ -61,8 +61,8 @@ jobs:
     strategy:
       matrix:
         include:
-          - php-version: 8.3
-            symfony-version: 7.1.*
+          - php-version: 8.4
+            symfony-version: 7.2.*
 
     steps:
       - name: "Checkout"
@@ -100,8 +100,8 @@ jobs:
     strategy:
       matrix:
         include:
-          - php-version: 8.3
-            symfony-version: 7.1.*
+          - php-version: 8.4
+            symfony-version: 7.2.*
 
     steps:
       - name: "Checkout"
@@ -133,8 +133,8 @@ jobs:
     strategy:
       matrix:
         include:
-          - php-version: 8.3
-            symfony-version: 7.1.*
+          - php-version: 8.4
+            symfony-version: 7.2.*
 
     steps:
       - name: "Checkout"

phpstan-baseline.neon

@@ -1,5 +1,10 @@
 parameters:
 	ignoreErrors:
+		-
+			message: "#^Offset 1 does not exist on array\\{0\\?\\: string, 1\\?\\: non\\-empty\\-string, 2\\?\\: '\\.gz'\\}\\.$#"
+			count: 1
+			path: src/Service/Dumper.php
+
 		-
 			message: "#^Offset 'uri' on array\\{timed_out\\: bool, blocked\\: bool, eof\\: bool, unread_bytes\\: int, stream_type\\: string, wrapper_type\\: string, wrapper_data\\: mixed, mode\\: string, \\.\\.\\.\\} in isset\\(\\) always exists and is not nullable\\.$#"
 			count: 1

src/Event/SitemapPopulateEvent.php

@@ -47,7 +47,7 @@ class SitemapPopulateEvent extends Event
     public function __construct(
         UrlContainerInterface $urlContainer,
         UrlGeneratorInterface $urlGenerator,
-        string $section = null
+        ?string $section = null
     ) {
         $this->urlContainer = $urlContainer;
         $this->section = $section;

src/Messenger/DumpSitemapMessage.php

@@ -43,9 +43,9 @@ class DumpSitemapMessage
      * @param array<string, mixed> $options
      */
     public function __construct(
-        string $section = null,
-        string $baseUrl = null,
-        string $targetDir = null,
+        ?string $section = null,
+        ?string $baseUrl = null,
+        ?string $targetDir = null,
         array $options = []
     ) {
         $this->section = $section;

src/Service/AbstractGenerator.php

@@ -65,7 +65,7 @@ abstract class AbstractGenerator implements UrlContainerInterface
     public function __construct(
         EventDispatcherInterface $dispatcher,
         UrlGeneratorInterface $urlGenerator,
-        int $itemsBySet = null
+        ?int $itemsBySet = null
     ) {
         $this->dispatcher = $dispatcher;
         // We add one to LIMIT_ITEMS because it was used as an index, not a quantity
@@ -146,14 +146,14 @@ public function getUrlset(string $name): Urlset
      *
      * @return Urlset
      */
-    abstract protected function newUrlset(string $name, \DateTimeInterface $lastmod = null): Urlset;
+    abstract protected function newUrlset(string $name, ?\DateTimeInterface $lastmod = null): Urlset;
 
     /**
      * Dispatches SitemapPopulate Event - the listeners should use it to add their URLs to the sitemap
      *
      * @param string|null $section
      */
-    protected function populate(string $section = null): void
+    protected function populate(?string $section = null): void
     {
         $event = new SitemapPopulateEvent($this, $this->urlGenerator, $section);
 

src/Service/Dumper.php

@@ -58,7 +58,7 @@ public function __construct(
         Filesystem $filesystem,
         UrlGeneratorInterface $urlGenerator,
         string $sitemapFilePrefix = Configuration::DEFAULT_FILENAME,
-        int $itemsBySet = null
+        ?int $itemsBySet = null
     ) {
         parent::__construct($dispatcher, $urlGenerator, $itemsBySet);
 
@@ -69,7 +69,7 @@ public function __construct(
     /**
      * @inheritdoc
      */
-    public function dump(string $targetDir, string $host, string $section = null, array $options = [])
+    public function dump(string $targetDir, string $host, ?string $section = null, array $options = [])
     {
         /** @var array{gzip: bool} $options */
         $options = array_merge(['gzip' => false], $options);
@@ -262,7 +262,7 @@ protected function deleteExistingSitemaps(string $targetDir): void
      *
      * @return DumpingUrlset|Urlset
      */
-    protected function newUrlset(string $name, \DateTimeInterface $lastmod = null, bool $gzExtension = false): Urlset
+    protected function newUrlset(string $name, ?\DateTimeInterface $lastmod = null, bool $gzExtension = false): Urlset
     {
         $url = $this->baseUrl . $this->sitemapFilePrefix . '.' . $name . '.xml';
         if ($gzExtension) {

src/Service/DumperInterface.php

@@ -26,5 +26,5 @@ interface DumperInterface extends UrlContainerInterface
      *
      * @return array<int, string>|bool
      */
-    public function dump(string $targetDir, string $host, string $section = null, array $options = []);
+    public function dump(string $targetDir, string $host, ?string $section = null, array $options = []);
 }

src/Service/Generator.php

@@ -34,7 +34,7 @@ class Generator extends AbstractGenerator implements GeneratorInterface
     public function __construct(
         EventDispatcherInterface $dispatcher,
         UrlGeneratorInterface $router,
-        int $itemsBySet = null
+        ?int $itemsBySet = null
     ) {
         parent::__construct($dispatcher, $router, $itemsBySet);
 
@@ -65,7 +65,7 @@ public function fetch(string $name): ?XmlConstraint
     /**
      * @inheritdoc
      */
-    protected function newUrlset(string $name, \DateTimeInterface $lastmod = null): Urlset
+    protected function newUrlset(string $name, ?\DateTimeInterface $lastmod = null): Urlset
     {
         return new Urlset(
             $this->router->generate(

src/Sitemap/Url/GoogleImage.php

@@ -56,10 +56,10 @@ class GoogleImage
      */
     public function __construct(
         string $location,
-        string $caption = null,
-        string $geoLocation = null,
-        string $title = null,
-        string $license = null
+        ?string $caption = null,
+        ?string $geoLocation = null,
+        ?string $title = null,
+        ?string $license = null
     ) {
         $this->setLocation($location);
         $this->setCaption($caption);

src/Sitemap/Url/GoogleMultilangUrlDecorator.php

@@ -43,7 +43,7 @@ class GoogleMultilangUrlDecorator extends UrlDecorator
      *
      * @return GoogleMultilangUrlDecorator
      */
-    public function addLink(string $href, string $hreflang, string $rel = null): self
+    public function addLink(string $href, string $hreflang, ?string $rel = null): self
     {
         $this->linkXml .= $this->generateLinkXml($href, $hreflang, $rel);
 
@@ -57,7 +57,7 @@ public function addLink(string $href, string $hreflang, string $rel = null): sel
      *
      * @return string
      */
-    protected function generateLinkXml(string $href, string $hreflang, string $rel = null): string
+    protected function generateLinkXml(string $href, string $hreflang, ?string $rel = null): string
     {
         if (null == $rel) {
             $rel = self::REL_ALTERNATE;

src/Sitemap/Url/GoogleVideo.php

@@ -528,7 +528,7 @@ public function setPublicationDate(DateTimeInterface $publicationDate): self
      *
      * @return GoogleVideo
      */
-    public function setFamilyFriendly(string $familyFriendly = null): self
+    public function setFamilyFriendly(?string $familyFriendly = null): self
     {
         if (null == $familyFriendly) {
             $familyFriendly = self::FAMILY_FRIENDLY_YES;
@@ -881,7 +881,7 @@ public function getLive(): ?string
      *
      * @return GoogleVideo
      */
-    public function addPrice($amount, string $currency, string $type = null, string $resolution = null): self
+    public function addPrice($amount, string $currency, ?string $type = null, ?string $resolution = null): self
     {
         $this->prices[] = [
             'amount' => $amount,

src/Sitemap/Url/UrlConcrete.php

@@ -59,8 +59,8 @@ class UrlConcrete implements Url
      */
     public function __construct(
         string $loc,
-        DateTimeInterface $lastmod = null,
-        string $changefreq = null,
+        ?DateTimeInterface $lastmod = null,
+        ?string $changefreq = null,
         $priority = null
     ) {
         $this->setLoc($loc);
@@ -116,7 +116,7 @@ public function getLastmod(): ?DateTimeInterface
      *
      * @return UrlConcrete
      */
-    public function setChangefreq(string $changefreq = null): self
+    public function setChangefreq(?string $changefreq = null): self
     {
         $frequencies = [
             self::CHANGEFREQ_ALWAYS,

src/Sitemap/Urlset.php

@@ -48,7 +48,7 @@ class Urlset extends XmlConstraint
      * @param string                 $loc
      * @param DateTimeInterface|null $lastmod
      */
-    public function __construct(string $loc, DateTimeInterface $lastmod = null)
+    public function __construct(string $loc, ?DateTimeInterface $lastmod = null)
     {
         $this->loc = $loc;
         $this->lastmod = $lastmod ?? new \DateTimeImmutable();

tests/Integration/config/6.1/framework.yaml

@@ -149,7 +149,7 @@ public function baseUrls(): \Generator
         yield 'Custom https port' => ['https://host.org:8080', 'https://host.org:8080/'];
     }
 
-    private function executeCommand(?string $section, bool $gzip, string $baseUrl = null): array
+    private function executeCommand(?string $section, bool $gzip, ?string $baseUrl = null): array
     {
         $options = ['target' => self::TARGET_DIR, '--gzip' => $gzip];
         if ($section !== null) {