Documentation

Csv

Table of Contents

Namespaces

Query
Serializer

Interfaces

ByteSequence
Defines constants for common BOM sequences.
TabularData
TabularDataProvider
TabularDataReader
Represents a Tabular data.
TabularDataWriter
A class to insert records into a CSV Document.
UnableToProcessCsv

Classes

AbstractCsv
An abstract class to enable CSV document loading.
Buffer
CallbackStreamFilter
CannotInsertRecord
Thrown when a data is not added to the Csv Document.
CharsetConverter
Converts resource stream or tabular data content charset.
ColumnConsistency
Validates column consistency when inserting records into a CSV document.
EncloseField
A stream filter to improve enclosure character usage.
EnumFormatter
Formatting strategies (exclusive): - Name (UnitEnum::name) - Value (BackedEnum::value) - JSON (JsonSerializable) - callback
EscapeFormula
A Formatter to tackle CSV Formula Injection.
Exception
League Csv Base Exception.
FragmentFinder
EXPERIMENTAL WARNING! This class implementation will change in the next major point release.
FragmentNotFound
HTMLConverter
Converts tabular data into an HTML Table string.
Info
InvalidArgument
InvalidArgument Exception.
JsonConverter
Converts and store tabular data into a JSON string.
RdbmsResult
Reader
A class to parse and read records from a CSV document.
ResultSet
Represents the result set of a {@link Reader} processed by a {@link Statement}.
RFC4180Field
A stream filter to conform the CSV field to RFC4180.
Statement
Criteria to filter a {@link TabularData} object.
StreamFilter
SwapDelimiter
SyntaxError
SyntaxError Exception.
UnavailableFeature
StreamFilterSupportMissing Exception.
UnavailableStream
League Csv Base Exception.
Writer
A class to insert records into a CSV Document.
XMLConverter
Converts tabular data into a DOMDocument object.

Enums

Bom
JsonFormat

Functions

bom_match()  : string
DEPRECATION WARNING! This namespace function will be removed in the next major point release.
delimiter_detect()  : array<string, int>
DEPRECATION WARNING! This namespace function will be removed in the next major point release.

Functions

bom_match()

DEPRECATION WARNING! This namespace function will be removed in the next major point release.

since version 9.7.0

bom_match(string $str) : string
Parameters
$str : string
Tags
see
Bom::tryFromSequence()
codeCoverageIgnore

Returns the BOM sequence found at the start of the string.

If no valid BOM sequence is found an empty string is returned

Return values
string

delimiter_detect()

DEPRECATION WARNING! This namespace function will be removed in the next major point release.

since version 9.7.0

delimiter_detect(Reader $csv, array<string|int, string> $delimiters[, int<-1, max> $limit = 1 ]) : array<string, int>
Parameters
$csv : Reader
$delimiters : array<string|int, string>
$limit : int<-1, max> = 1
Tags
see
Info::getDelimiterStats()
codeCoverageIgnore

Detect Delimiters usage in a object.

Returns a associative array where each key represents a submitted delimiter and each value the number of CSV fields found when processing at most $limit CSV records with the given delimiter

Return values
array<string, int>

        
On this page

Search results