version 9.18.0

Added

• League\Csv\JsonConverter::chunkSize
• League\Csv\AbstractCsv::download

Deprecated

• League\Csv\AbstractCsv::output use League\Csv\AbstractCsv::download instead
• League\Csv\FragmentFinder and derived methods are marked as experimental as their results will be changed in the next major version.

Fixed

• League\Csv\JsonConverter::download the filename is now nullable
• League\Csv\XMLConverter::download the filename is now nullable
• League\Csv\JsonConverter::save throws a TypeError exception if the $destination type is not supported.

Remove

• None

version 9.17.0

Added

• League\Csv\SwapDelimiter::apppendTo
• League\Csv\SwapDelimiter::prependTo
• League\Csv\CharsetConverter::apppendTo
• League\Csv\CharsetConverter::prependTo
• League\Csv\XMLConverter::download
• League\Csv\JsonConverter
• League\Csv\Constraint\Criteria::andNot
• League\Csv\Constraint\Criteria::orNot
• League\Csv\Constraint\Criteria::xorNot
• League\Csv\Serializer\MapRecord attribute
• adding the convertEmptyStringToNull options to MapCell and to MapRecord to improve string and null conversion
• adding the trimFieldValueBeforeCasting options to MapCell and to MapRecord to improve string conversion
• adding the trimElementValueBeforeCasting option to CasToArray to improve conversion during denormalization
• adding the headerOffset option to CasToArray to improve conversion during denormalization. The optoon is only used with the CSV shape.

Deprecated

• None

Fixed

• Cast* methods accept more input type to improve Denormalization usage when Reader::addFormatter is used or when the collection contains data other than string and null.
• Stream::getSize is added to the internal Stream class
• Stream::getContents is added to the internal Stream class
• MapIterator::toIterator is added to the internal class MapIterator class to convert any iterable into an Iterator.
• Casting a CSV to an array it now will be a collection of array instead of a simple array.
• Added the internal class HttpHeaders to improve file download throughout the codebase.

Removed

• leage\csv-doctrine is no longer a sub-split of the main league/csv package.

version 9.16.0

Added

• Bom enum
• Stream::ftell
• Statement::orderByAsc
• Statement::orderByDesc
• Statement::andWhere
• Statement::whereNot
• Statement::orWhere
• Statement::xorWhere
• Statement::andWhereColumn
• Statement::whereNotColumn
• Statement::orWhereColumn
• Statement::xorWhereColumn
• Statement::andWhereOffset
• Statement::whereNotOffset
• Statement::orWhereOffset
• Statement::xorWhereOffset
• Query feature to allow easier filtering, ordering and querying tabular data

Deprecated

• ByteSequence Interface use the Bom enum instead
• Info::fetchBOMSequence use Bom::tryFromSequence instead
• League\Csv\Doctrine use the new League\Csv\Constraint feature instead
• League\Csv\Statement::create arguments; The method should be used without any argument at all. All arguments will be removed in the next major version.

Fixed

• Reader and ResultSet docblocks
• internal code uses Bom enum instead of Info::fetchBOMSequence
• the AbstractCsv BOM related properties are moved to being Bom instances instead of nullable string.
• setOutpuBOM will only accept valid BOM sequences all other values except the empty string will throw a ValueError exception;
• The package no longer requires the ext-mbstring extension to work. But you should have it install in your system in order to use the mbstring related stream filters.
• Issue #524 fix issue with ResultSet::chunkBy not working as documented.

Removed

• None

version 9.15.0

Added

• Statement::select
• TabularDataReader::getRecordsAsObject
• TabularDataReader::chunkBy
• TabularDataReader::mapHeader

Deprecated

• TabularDataReader::getObjects use TabularDataReader::getRecordsAsObject instead

Fixed

• Reader::select and ResultSet::select now internally use Statement::select
• Statement should not throw when LimitIterator is used in combinaison with ArrayIterator.
• Statement internal codebase improvement.
• Using the $header argument on Statement::process is no longer deprecated. E_USER_DEPRECATED is no longer triggered.
• BOM stripping no longer depends on the mbstring extension
• TabularDataReader::fetchColumn is no longer deprecated

Removed

• None

version 9.14.0

Added

• League\Csv\TabularDataReader::nthAsObject equivalent to nth but returns an object or null
• League\Csv\TabularDataReader::firstAsObject equivalent to first but returns an object or null
• League\Csv\Serializer\Denormalizer::types list all the registered types

Deprecated

• None

Fixed

• None

Removed

• None

version 9.13.0

Added

• League\Csv\SwapDelimiter stream filter to allow working with multibyte CSV delimiter
• League\Csv\Serializer\AfterMapping to work around the limitation of not using the class constructor during denormalization.
• League\Csv\Serializer\Denormalizer to allow registering type alias to improve callback usage.
• League\Csv\Serializer\MapCell has a new property ignore to allow ignoring a property or a method during denormalization.

Deprecated

• None

Fixed

• None

Removed

• None

version 9.12.0

Added

• TabulatDataReader::value
• TabulatDataReader::select
• TabulatDataReader::getObjects
• TabulatDataReader::matching
• TabulatDataReader::matchingFirst
• TabulatDataReader::matchingFirstOrFail
• ResultSet::fromRecords
• Stream::setMaxLineLen
• Stream::getMaxLineLen
• League\Csv\Serializer\Denormalizer to allow denormalizing records into objects #508
• League\Csv\FragmentFinder to implement RFC7111

Deprecated

• Using the $header argument on Statement::process is deprecated and will be removed in
  the next version. Use TabularDataReader::getRecords on the returned value instead.
  It's usage will trigger a E_USER_DEPRECATED call.

Fixed

• The optional $header argument for TabularDataReader;;getRecords becomes a full mapper between the records column offset and the column names #498
• ResultSet constructor now allows the records to be an array.
• The internal Stream object will throw a RuntimeException if the rewind action fails
• if calls to fseek fails (returns -1 ) a RuntimeException will be thrown.
• Stream can iterate and return the full line respecting SplFielObject flags. Previously it only returned the CSV records.
• MapIterator::fromIterable to instantiate a MapIterator object from any iterable structure.

Removed

• None

version 9.11.0

Added

• EscapeFormula::unescapeRecord does the opposite of EscapeFormula::escapeRecord
• TabularReader::each
• TabularReader::exists
• TabularReader::reduce
• TabularReader::filter
• TabularReader::slice
• TabularReader::sorted
• Reader::addFormatter

All the methods from the TabularReader interface are implemented on the Reader and the ResultSet objects.

Deprecated

• EscapeFormula::__invoke use EscapeFormula::__escapeRecord instead

Fixed

• None

Removed

• None

version 9.10.0

Added

• Writer::forceEnclosure and Writer::relaxEnclosure to control the presence of enclosure in the generated CSV
• Writer::getEndOfLine and Writer::setEndOfLine

Deprecated

• EncloseField stream filter in favor of the new Writer::forceEnclosure method.
• Writer::getNewline and Writer::setNewline in favor of Writer::getEndOfLine and Writer::setEndOfLine

Fixed

• Stream::fwrite to allow writing to a file in a normalized way. Internal use.
• Documentation Fixed removing unreleased documented feature by @nclavaud

Removed

• None

version 9.9.0

Added

• TabularDataWriter interface to represent how to write to a tabular data document.
• TabularDataReader::first to replace TabularDataReader::fetchOne
• TabularDataReader::nth to replace TabularDataReader::fetchOne
• CharsetConverter::addBOMSkippingTo to improve BOM skipping see bug #483

Deprecated

• TabularDataReader::fetchOne

Fixed

• Stream::createFromResource

• Stream::__construct is made private. The class is already marked as internal so BC break does not apply on it.

• Using PHP8 feature to rewrite internal codebase

• Replaced simple comparisons with strict comparison operator where types are obvious in internal codebase by @astepin

• Marked class constants explicitly as public by @astepin

• Minimal support version PHP8.1.2

• Fix Docblock and method signature using PHP8 feature (Union Type)

• Fix Internal codebase around seek usage and `#75917 requires PHP8.1.2

• Remove internal usage of deprecated methods

Removed

• Stream::fwrite The class is already marked as internal so BC break does not apply on it.
• Stream::fgets The class is already marked as internal so BC break does not apply on it.
• Drop support for PHP7 and PHP8.0
• Polyfill to enable using fputcsv $eol argument