Introducing the Buffer instance (#554)

Introducing the Buffer instance

Author: nyamsprod

CHANGELOG.md

@@ -12,6 +12,7 @@ All Notable changes to `Csv` will be documented in this file
 - `ResultSet::from` and `ResultSet::tryFrom`
 - `RdbmsResult` class to allow converting RDBMS result into `ResultSet`
 - `TabularData` interface
+- `Buffer` class
 - `XMLConverter::supportsHeader`
 - `XMLConverter::when`
 - `HTMLConverter::when`

composer.json

@@ -32,18 +32,18 @@
     "require-dev": {
         "ext-dom": "*",
         "ext-xdebug": "*",
-        "friendsofphp/php-cs-fixer": "^3.68.1",
-        "phpbench/phpbench": "^1.3.1",
-        "phpstan/phpstan": "^1.12.15",
+        "friendsofphp/php-cs-fixer": "^3.69.0",
+        "phpbench/phpbench": "^1.4.0",
+        "phpstan/phpstan": "^1.12.18",
         "phpstan/phpstan-deprecation-rules": "^1.2.1",
         "phpstan/phpstan-phpunit": "^1.4.2",
-        "phpstan/phpstan-strict-rules": "^1.6.1",
-        "phpunit/phpunit": "^10.5.16 || ^11.5.3",
-        "symfony/var-dumper": "^6.4.8 || ^7.2.0"
+        "phpstan/phpstan-strict-rules": "^1.6.2",
+        "phpunit/phpunit": "^10.5.16 || ^11.5.7",
+        "symfony/var-dumper": "^6.4.8 || ^7.2.3"
     },
     "autoload": {
         "psr-4": {
-            "League\\Csv\\": "src/"
+            "League\\Csv\\": "src"
         },
         "files": ["src/functions_include.php"]
     },

docs/9.0/converter/xml.md

@@ -186,6 +186,49 @@ echo htmlentities($dom->saveXML());
 // </root>
 ```
 
+The result is different if you set the field element as `null`:
+
+```php
+$converter = new XMLConverter()
+    ->rootElement('csv')
+    ->recordElement('record', 'offset')
+    ->fieldElement(null)
+;
+
+$records = $stmt->process($csv);
+
+$dom = new DOMDocument('1.0');
+$dom->loadXML('<root><header><name>My CSV Document</name></header></root>');
+
+$data = $converter->import($records, $dom);
+$dom->appendChild($data);
+$dom->formatOutput = true;
+$dom->encoding = 'iso-8859-15';
+
+echo '<pre>', PHP_EOL;
+echo htmlentities($dom->saveXML());
+// <?xml version="1.0" encoding="iso-8859-15"?>
+// <root>
+//   <header>
+//     <name>My CSV Document</name>
+//   </header>
+//   <csv>
+//     <record offset="71">
+//       <prenoms>Anaïs</field>
+//       <nombre>137</field>
+//       <sexe>F</field>
+//       <annee>2004</field>
+//     </record>
+//     <record offset="1099">
+//       <prenoms>Anaïs</field>
+//       <nombre>124</field>
+//       <sexe>F</field>
+//       <annee>2005</field>
+//     </record>
+//   </csv>
+// </root>
+```
+
 ## Conversion
 
 <p class="message-notice">The method is deprecated in version <code>9.22.0</code> use <code>XMLConverter::import</code> instead</p>

docs/9.0/interoperability/tabular-data-importer.md

@@ -44,8 +44,6 @@ The `createFromTabularData` supports the following Database Extensions:
 As such using the instance on huge results will trigger high memory usage as all the data will be stored in a
 <code>ArrayIterator</code> instance for cache to allow rewinding and inspecting the tabular data.</p>
 
-Please refer to the [TabularData Importer](/9.0/interoperability/tabular-data-importer) for more information.
-
 ## Selecting records
 
 Please header over the [TabularDataReader documentation page](/9.0/reader/tabular-data-reader)

docs/9.0/reader/resultset.md

@@ -237,6 +237,30 @@ $exists = $resultSet->exists(fn (array $records) => in_array('twenty-five', $rec
 
 ## Selecting columns
 
+### fetchColumn
+
+The `fetchColumn` returns an Iterator containing all the values of a single column specified by its
+header offset if you provide an integer or its header name if you provide a string name that exists.
+
+```php
+$reader = Reader::createFromPath('/path/to/my/file.csv');
+$reader->setHeaderOffset(0);
+$records = (new Statement())->process($reader);
+foreach ($records->fetchColumn(3) as $value) {
+    //$value is a string representing the value
+    //of a given record for the selected column
+    //$value may be equal to 'john.doe@example.com'
+}
+
+foreach ($records->fetchColumn('3') as $value) {
+    //$value is a string representing the value
+    //of a given record for the selected column whose name is '3'
+    //$value may be equal to 'john.doe@example.com'
+}
+```
+
+Two additional methods are added to ease distinguish usage
+
 ### fetchColumnByName
 
 The `fetchColumnByName` returns an Iterator containing all the values of a single column specified by its header name if it exists.