Deprecating syntactic sugar named constructors

Author: nyamsprod

CHANGELOG.md

@@ -25,6 +25,10 @@ All Notable changes to `Csv` will be documented in this file
 - `ResultSet::createFromRecords` use `ResultSet::createFromTabularData`
 - `ResultSet::__construct` use `ResultSet::createFromTabularData`
 - `XMLConverter::convert` use `XMLConverter::import` instead
+- `XMLConverter::create` use `XMLConverter::__construct` instead
+- `HTMLConverter::create` use `HTMLConverter::__construct` instead
+- `Statement::create` use `Statement::__construct` instead
+- `FragmentFinder::create` use `FragmentFinder::__construct` instead
 
 ### Fixed
 

docs/9.0/converter/html.md

@@ -85,7 +85,7 @@ $sth = $dbh->prepare("SELECT firstname, lastname, email FROM users LIMIT 2");
 $sth->setFetchMode(PDO::FETCH_ASSOC);
 $sth->execute();
 
-$converter = (new HTMLConverter())
+$converter = new HTMLConverter()
     ->table('table-csv-data', 'users')
     ->tr('data-record-offset')
     ->td('title')

docs/9.0/converter/index.md

@@ -9,7 +9,6 @@ title: Records conversion in popular formats
 
 The package provides classes which convert any collection of CSV records into:
 
-- another collection encoded using the [CharsetConverter](/9.0/converter/charset/) class;
 - a `DOMDocument` object using the [XMLConverter](/9.0/converter/xml/) class;
 - an HTML table using the [HTMLConverter](/9.0/converter/html/) class;
 - an JSON document using the [JsonConverter](/9.0/converter/json/) class;

docs/9.0/converter/xml.md

@@ -100,15 +100,15 @@ $csv = Reader::createFromPath('/path/to/prenoms.csv', 'r');
 $csv->setDelimiter(';');
 $csv->setHeaderOffset(0);
 
-$stmt = (new Statement())
+$stmt = new Statement()
     ->where(function (array $record) {
         return 'Anaïs' === $record['prenoms'];
     })
     ->offset(0)
     ->limit(2)
 ;
 
-$converter = (new XMLConverter())
+$converter = new XMLConverter()
     ->rootElement('csv')
     ->recordElement('record', 'offset')
     ->fieldElement('field', 'name')
@@ -167,15 +167,15 @@ $csv = Reader::createFromPath('/path/to/prenoms.csv', 'r');
 $csv->setDelimiter(';');
 $csv->setHeaderOffset(0);
 
-$stmt = (new Statement())
+$stmt = new Statement()
     ->where(function (array $record) {
         return 'Anaïs' === $record['prenoms'];
     })
     ->offset(0)
     ->limit(2)
 ;
 
-$converter = (new XMLConverter())
+$converter = new XMLConverter()
     ->rootElement('csv')
     ->recordElement('record', 'offset')
     ->fieldElement('field', 'name')
@@ -233,7 +233,7 @@ header('Content-Type: text/xml; charset=UTF-8');
 header('Content-Description: File Transfer');
 header('Content-Disposition: attachment; filename="name-for-your-file.xml"');
 
-XMLConverter::create()->download($reader);
+new XMLConverter()->download($reader);
 die;
 ```
 
@@ -256,7 +256,7 @@ header('Cache-Control: no-cache, no-store, must-revalidate');
 header('Pragma: no-cache');
 header('Expires: 0');
  //the filename will be the name of the downloaded xml as shown by your HTTP client!
-XMLConverter::create()->download($reader, 'name-for-your-file.xml');
+new XMLConverter()->download($reader, 'name-for-your-file.xml');
 die;
 ```
 
@@ -275,7 +275,7 @@ $reader->setHeaderOffset(0);
 header('Cache-Control: no-cache, no-store, must-revalidate');
 header('Pragma: no-cache');
 header('Expires: 0');
-XMLConverter::create()->download(
+new XMLConverter()->download(
     records: $reader,
     filename: 'generated_file.xml',
     encoding: 'iso-8859-1',

docs/9.0/extensions/doctrine.md

@@ -28,7 +28,7 @@ $csv = Reader::createFromPath('/path/to/my/file.csv');
 $csv->setHeaderOffset(0);
 $csv->setDelimiter(';');
 
-$criteria = Statement::create()
+$criteria = (new Statement())
     ->andWhere('prenom', '=', 'Adam')
     ->orderByAsc('annee')
     ->orderByDesc('foo')
@@ -114,7 +114,7 @@ $csv = Reader::createFromPath('/path/to/my/file.csv');
 $csv->setHeaderOffset(0);
 $csv->setDelimiter(';');
 
-$stmt = Statement::create()
+$stmt = (new Statement())
     ->where(fn (array $row): bool => isset($row['email']) && str_ends_with($row['email'], '@github.com'));
 
 $collection = new RecordCollection($stmt->process($csv));

docs/9.0/index.md

@@ -28,7 +28,7 @@ $csv->setHeaderOffset(0); //set the CSV header offset
 $csv->setEscape(''); //required in PHP8.4+ to avoid deprecation notices
 
 //get 25 records starting from the 11th row
-$stmt = Statement::create()
+$stmt = new Statement()
     ->offset(10)
     ->limit(25)
 ;
@@ -140,7 +140,7 @@ $csv->setDelimiter(';');
 $csv->setHeaderOffset(0);
 $csv->setEscape(''); //required in PHP8.4+ to avoid deprecation notices
 
-$converter = (new XMLConverter())
+$converter = new XMLConverter()
     ->rootElement('csv')
     ->recordElement('record', 'offset')
     ->fieldElement('field', 'name')

docs/9.0/reader/resultset.md

@@ -82,7 +82,7 @@ foreach ($records as $record) {
 }
 
 $reader = Reader::createFromFileObject($tmp)->setHeaderOffset(0);
-$stmt = Statement::create()->offset(1)->limit(1);
+$stmt = (new Statement())->offset(1)->limit(1);
 $result = $stmt->process($reader);
 
 echo '<pre>', PHP_EOL;

docs/9.0/reader/statement.md

@@ -34,7 +34,7 @@ use League\Csv\Reader;
 use League\Csv\Statement;
 
 $reader = Reader::createFromPath('/path/to/file.csv');
-$records = Statement::create()->process($reader);
+$records = (new Statement())->process($reader);
 // $records is a League\Csv\ResultSet instance
 ```
 
@@ -63,7 +63,7 @@ use League\Csv\Reader;
 use League\Csv\Statement;
 
 $reader = Reader::createFromPath('/path/to/file.csv');
-$records = Statement::create()
+$records = (new Statement())
     ->where(fn (array $record): bool => false !== filter_var($record[2] ?? '', FILTER_VALIDATE_EMAIL))
     ->process($reader);
 // $records is a League\Csv\ResultSet instance
@@ -88,7 +88,7 @@ use League\Csv\Reader;
 use League\Csv\Statement;
 
 $reader = Reader::createFromPath('/path/to/file.csv');
-$records = Statement::create()
+$records = (new Statement())
     ->andWhere(1, '=', '10') //filtering is done of the second column
     ->orWhere('birthdate', 'regexp', '/\d{1,2}\/\d{1,2}\/\d{2,4}/') //filtering is done on the `birthdate` column
     ->whereNot('firstname', 'starts_with', 'P') //filtering is done case-sensitively on the first character of the column value
@@ -116,7 +116,7 @@ comparison is relaxed.
 ```php
 use League\Csv\Statement;
 
-$constraints = Statement::create()->orWhere('direction', 'not in', ['east', 'north']);
+$constraints = (new Statement())->orWhere('direction', 'not in', ['east', 'north']);
 ```
 
 The following parameter can only be used if the submitted value is a tuple
@@ -129,7 +129,7 @@ the range minimal value and the second argument, the range maximal value.
 ```php
 use League\Csv\Statement;
 
-$constraints = Statement::create()->andWhere('points', 'between', [3, 5]);
+$constraints = (new Statement())->andWhere('points', 'between', [3, 5]);
 ```
 
 The following parameters can only be used if the submitted value **and** the column value are `string`.
@@ -160,7 +160,7 @@ use League\Csv\Statement;
 $curDate = new DateTimeImmutable();
 
 $reader = Reader::createFromPath('/path/to/file.csv');
-$records = Statement::create()
+$records = (new Statement())
     ->andWhere(1, '=', '10') //filtering is done of the second column
     ->orWhere('birthdate', fn (string $value): bool => DateTimeImmutable::createFromFormat('Y-m-d', $value) < $curDate) //filtering is done on the `birthdate` column
     ->whereNot('firstname', 'starts_with', 'P') //filtering is done case-sensitively on the first character of the column value
@@ -180,7 +180,7 @@ use League\Csv\Reader;
 use League\Csv\Statement;
 
 $reader = Reader::createFromPath('/path/to/file.csv');
-$records = Statement::create()
+$records = (new Statement())
     ->andWhereColumn('created_at', '<', 'update_at') //filtering is done on both column value
     ->whereNotColumn('fullname', 'starts_with', 4)   //filtering is done on both column but the second column is specified via its offset
     ->process($reader);
@@ -195,7 +195,7 @@ use League\Csv\Reader;
 use League\Csv\Statement;
 
 $reader = Reader::createFromPath('/path/to/file.csv');
-$records = Statement::create()
+$records = (new Statement())
      ->andWhereColumn('created_at', '<', 'update_at') //filtering is done on both column value
     ->andWhereOffset(
         'fullname', 
@@ -216,7 +216,7 @@ use League\Csv\Reader;
 use League\Csv\Statement;
 
 $reader = Reader::createFromPath('/path/to/file.csv');
-$records = Statement::create()
+$records = (new Statement())
     ->andWhereOffset('<', 100) //filtering is done on the offset value only
     ->process($reader);
 // $records is a League\Csv\ResultSet instance
@@ -231,7 +231,7 @@ use League\Csv\Reader;
 use League\Csv\Statement;
 
 $reader = Reader::createFromPath('/path/to/file.csv');
-$records = Statement::create()
+$records = (new Statement())
     ->andWhereOffset(fn (string|int $value): bool => fmod((float) $value, 2) == 0) 
        // filtering is done on the record offset value
        // records are kept only if the value is even.
@@ -279,7 +279,7 @@ use League\Csv\Reader;
 use League\Csv\Statement;
 
 $reader = Reader::createFromPath('/path/to/file.csv');
-$records = Statement::create()
+$records = (new Statement())
     ->orderBy(fn (mixed $rA, mixed $rB): int => strcmp(Query\Row::from($rB)->field(1) ?? '', Query\Row::from($rA)->field(1) ?? '')))
     ->process($reader);
 // $records is a League\Csv\ResultSet instance
@@ -303,7 +303,7 @@ use League\Csv\Reader;
 use League\Csv\Statement;
 
 $reader = Reader::createFromPath('/path/to/file.csv');
-$records = Statement::create()
+$records = (new Statement())
     ->orderByDesc(1) //descending order according to the data of the 2nd column
     ->orderByAsc('foo', strcmp(...)) //ascending order according a callback compare function
     ->process($reader);
@@ -325,7 +325,7 @@ $sort = Query\Ordering\MultiSort::all(
 );
 
 $reader = Reader::createFromPath('/path/to/file.csv');
-$records = Statement::create()->orderBy($sort)->process($reader);
+$records = (new Statement())->orderBy($sort)->process($reader);
 // Will return the same content as in the previous example.
 ```
 
@@ -343,7 +343,7 @@ use League\Csv\Reader;
 use League\Csv\Statement;
 
 $reader = Reader::createFromPath('/path/to/file.csv');
-$records = Statement::create()
+$records = (new Statement())
     ->limit(5)
     ->offset(9)
     ->process($reader);
@@ -366,7 +366,7 @@ use League\Csv\Reader;
 use League\Csv\Statement;
 
 $reader = Reader::createFromPath('/path/to/file.csv');
-$records = Statement::create()
+$records = (new Statement())
     ->select(1, 3, 'field')
     ->process($reader);
 // $records is a League\Csv\ResultSet instance with only 3 fields
@@ -379,7 +379,7 @@ to query your CSV document as you want like in the following example.
 use League\Csv\Reader;
 use League\Csv\Statement;
 
-$constraints = Statement::create()
+$constraints = (new Statement())
     ->select('Integer', 'Text', 'Date and Time')
     ->andWhere('Float', '<', 1.3)
     ->orderByDesc('Integer')
@@ -410,7 +410,7 @@ In the event where you have a lot of fields to select but a few to remove you ma
 to select all the fields except the one you will specify as argument to the method:
 
 ```php
-$constraints = Statement::create()
+$constraints = (new Statement())
     ->selectAllExcept('Integer')
     ->andWhere('Float', '<', 1.3)
     ->orderByDesc('Integer')
@@ -435,7 +435,7 @@ statement, both methods are mutually exclusive.</p>
 The `Statement::class` now allows the building or the CSV query using conditions.
 
 ```php
-$stmt = Statement::create();
+$stmt = (new Statement());
 if ($condition) {
     $stmt = $stmt->where(fn (array $row) => $row['column'] !== 'data');
 } else {
@@ -446,7 +446,7 @@ if ($condition) {
 becomes
 
 ```php
-$stmt = Statement::create()
+$stmt = (new Statement())
     ->when(
         $condition,
         fn (Statement $q) => $q->where(fn (array $row) => $row['column'] !== 'data'),
@@ -516,7 +516,7 @@ use League\Csv\Reader;
 use League\Csv\FragmentFinder;
 
 $reader = Reader::createFromPath('/path/to/file.csv');
-$finder = FragmentFinder::create();
+$finder = new FragmentFinder();
 
 $finder->find('row=7-5;8-9', $reader);         // return an Iterator<TabularDataReader>
 $finder->findFirst('row=7-5;8-9', $reader);       // return an TabularDataReader

docs/9.0/reader/tabular-data-reader.md

@@ -97,7 +97,7 @@ Aboubakar,6,M,2004
 CSV;
 
 $reader = Reader::createFromString($csv);
-$resultSet = Statement::create()->process($reader);
+$resultSet = (new Statement())->process($reader);
 $records = $resultSet->getRecords([3 => 'Year', 0 => 'Firstname', 4 => 'Yolo']);
 var_dump([...$records][0]);
 //returns something like this
@@ -157,7 +157,7 @@ use League\Csv\Statement;
 $reader = Reader::createFromPath('/path/to/my/file.csv', 'r');
 $reader->setHeaderOffset(0);
 
-$stmt = Statement::create()
+$stmt = (new Statement())
     ->offset(10)
     ->limit(12)
 ;
@@ -188,7 +188,7 @@ use League\Csv\Statement;
 $reader = Reader::createFromPath('/path/to/my/file.csv', 'r');
 $reader->setHeaderOffset(0);
 
-$stmt = Statement::create()
+$stmt = (new Statement())
     ->offset(10)
     ->limit(12)
 ;
@@ -228,7 +228,7 @@ use League\Csv\Reader;
 use League\Csv\Statement;
 
 $reader = Reader::createFromPath('/path/to/my/file.csv', 'r');
-$resultSet = Statement::create()->process($reader);
+$resultSet = (new Statement())->process($reader);
 
 $exists = $resultSet->exists(fn (array $records) => in_array('twenty-five', $records, true));
 
@@ -244,7 +244,7 @@ The `fetchColumnByName` returns an Iterator containing all the values of a singl
 ```php
 $reader = Reader::createFromPath('/path/to/my/file.csv');
 $reader->setHeaderOffset(0);
-$records = Statement::create()->process($reader);
+$records = (new Statement())->process($reader);
 foreach ($records->fetchColumnByName('e-mail') as $value) {
     //$value is a string representing the value
     //of a given record for the selected column
@@ -262,7 +262,7 @@ header offset.
 ```php
 $reader = Reader::createFromPath('/path/to/my/file.csv');
 $reader->setHeaderOffset(0);
-$records = Statement::create()->process($reader);
+$records = (new Statement())->process($reader);
 foreach ($records->fetchColumnByOffset(3) as $value) {
     //$value is a string representing the value
     //of a given record for the selected column
@@ -295,7 +295,7 @@ sacha
 EOF;
 
 $reader = Reader::createFromString($str);
-$records = Statement::create()->process($reader);
+$records = (new Statement())->process($reader);
 
 foreach ($records->fetchPairs() as $firstname => $lastname) {
     // - first iteration
@@ -444,7 +444,7 @@ use League\Csv\Reader;
 use League\Csv\Statement;
 
 $reader = Reader::createFromPath('/path/to/my/file.csv', 'r');
-$resultSet = Statement::create()->process($reader);
+$resultSet = (new Statement())->process($reader);
 
 $records = $resultSet->slice(10, 25);
 
@@ -512,7 +512,7 @@ $tabularData = $reader
 
 //is equivalent to
 
-$tabularData = Statement::create()
+$tabularData = (new Statement())
     ->offset(0)
     ->limit(10)
     ->process($reader, [