Merge 3.x into 4.x

sonata-project · Jun 2, 2023 · 080d589 · 080d589
2 parents f9cd8b5 + ac18c5d
commit 080d589
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 3 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -42,6 +42,7 @@
     'multiline_whitespace_before_semicolons' => ['strategy' => 'no_multi_line'],
     'no_useless_else' => true,
     'no_useless_return' => true,
+    'no_superfluous_phpdoc_tags' => ['allow_mixed' => true, 'remove_inheritdoc' => true],
     'nullable_type_declaration_for_default_null_value' => ['use_nullable_type_declaration' => true],
     'ordered_class_elements' => true,
     'ordered_imports' => ['sort_algorithm' => 'alpha', 'imports_order' => ['class', 'function', 'const']],

diff --git a/src/Writer/CsvWriter.php b/src/Writer/CsvWriter.php
@@ -94,9 +94,9 @@ public function write(array $data): void
             ++$this->position;
         }
 
-        if (1 !== \strlen($this->delimiter) ||
-            1 !== \strlen($this->enclosure) ||
-            1 !== \strlen($this->escape)) {
+        if (1 !== \strlen($this->delimiter)
+            || 1 !== \strlen($this->enclosure)
+            || 1 !== \strlen($this->escape)) {
             throw new InvalidDataFormatException(<<<'EXCEPTION'
                 Context: trying to write CSV data
                 Problem: delimiter, enclosure or escape character is actually a

diff --git a/src/Writer/SitemapWriter.php b/src/Writer/SitemapWriter.php
@@ -42,6 +42,8 @@ final class SitemapWriter implements WriterInterface
      * @param string   $groupName Name of sub-sitemap (optional)
      * @param string[] $headers   Indicate the need for namespace in the header sitemap
      * @param bool     $autoIndex If you want to generate index of sitemap (optional)
+     *
+     * @phpstan-param non-empty-string $folder
      */
     public function __construct(
         private string $folder,
@@ -111,6 +113,9 @@ public function close(): void
      * @param string $filename A sitemap file name, optional
      *
      * @throws \RuntimeException
+     *
+     * @phpstan-param non-empty-string $folder
+     * @phpstan-param non-empty-string $pattern
      */
     public static function generateSitemapIndex(string $folder, string $baseUrl, string $pattern = 'sitemap*.xml', string $filename = 'sitemap.xml'): void
     {

diff --git a/tests/Writer/SitemapWriterTest.php b/tests/Writer/SitemapWriterTest.php
@@ -18,6 +18,9 @@
 
 final class SitemapWriterTest extends TestCase
 {
+    /**
+     * @phpstan-var non-empty-string
+     */
     private string $folder;
 
     protected function setUp(): void