Update documentation landing page

CHANGELOG.md

@@ -16,6 +16,7 @@ All Notable changes to `Csv` will be documented in this file
 
 - `Comparison::CONTAINS` must check the value is a string before calling `str_compare` [#548](https://github.com/thephpleague/csv/pull/548) by [cage-is](https://github.com/cage-is)
 - Fix testing to improve Debian integration [#549](https://github.com/thephpleague/csv/pull/549) by [David Prévot and tenzap](https://github.com/tenzap)
+- `Bom::tryFromSequence` and `Bom::fromSequence` supports the `Reader` and `Writer` class.
 
 ### Removed
 

docs/index.md

@@ -127,14 +127,13 @@ PHP stream filters can directly be used to ease manipulating CSV document
 
 ```php
 use League\Csv\Reader;
+use League\Csv\Bom;
 
 $csv = Reader::createFromPath('/path/to/your/csv/file.csv', 'r');
 $csv->setHeaderOffset(0);
 
-$input_bom = $csv->getInputBOM();
-
-if ($input_bom === Reader::BOM_UTF16_LE || $input_bom === Reader::BOM_UTF16_BE) {
-    $csv->addStreamFilter('convert.iconv.UTF-16/UTF-8');
+if (Bom::tryFromSequence($csv)?->isUtf16() ?? false) {
+    $csv->appendStreamFilterOnRead('convert.iconv.UTF-16/UTF-8');
 }
 
 foreach ($csv as $record) {

src/Bom.php

@@ -38,6 +38,7 @@ public static function tryFromSequence(mixed $sequence): ?self
             $sequence instanceof SplFileObject,
             $sequence instanceof Stream => self::getContents($sequence, 4, 0),
             is_resource($sequence) => stream_get_contents($sequence, 4, 0),
+            $sequence instanceof AbstractCsv => $sequence->getInputBOM(),
             $sequence instanceof Stringable,
             is_string($sequence) => substr((string) $sequence, 0, 4),
             default => $sequence,

src/BomTest.php

@@ -21,7 +21,7 @@
 final class BomTest extends TestCase
 {
     #[DataProvider('BomSequencesProvider')]
-    public function test_bom_detection_from_sequence(string $sequence, ?Bom $expected): void
+    public function test_bom_detection_from_sequence(string|AbstractCsv $sequence, ?Bom $expected): void
     {
         self::assertSame($expected, Bom::tryFromSequence($sequence));
     }
@@ -54,6 +54,10 @@ public static function BomSequencesProvider(): array
                 'sequence' => chr(255).chr(254).chr(0).chr(0),
                 'expected' => Bom::Utf32Le,
             ],
+            'UTF32 LE BOM sequence in Reader class' => [
+                'sequence' => Reader::createFromString(chr(255).chr(254).chr(0).chr(0)),
+                'expected' => Bom::Utf32Le,
+            ],
         ];
     }