1. class
  2. NoreSources
  3. \
  4. Data
  5. \
  6. Serialization
  7. \
  8. CsvSerializer

CsvSerializer

class CsvSerializer implements DataUnserializerInterface, DataSerializerInterface, DataFileUnerializerInterface, DataFileSerializerInterface (View source)

CSV (comma separated value) (de)serializer

Supported media type parameters - separator - enclosure - escape - eol (unserializer and PHP 8.1+ for serializer)

Traits

MediaTypeListTrait
DataFileExtensionTrait
DataFileSerializerTrait
DataFileUnserializerTrait
DataFileUnserializer base on DataUnserializer implementation
DataFileMediaTypeNormalizerTrait

Properties

string $separator Default field separator
string $enclosure Default field enclosure
string $escape Default escape character
string $eol Default End of line

Methods

buildMediaTypeList()

No description

getMediaTypes()

No description

from MediaTypeListTrait
matchMediaType(MediaTypeInterface $mediaType)

No description

from MediaTypeListTrait
setFileExtensions($array = array())

No description

from DataFileExtensionTrait
matchExtension($filename)

No description

from DataFileExtensionTrait
getSerializableFileMediaTypes()

No description

from DataFileSerializerTrait
canSerializeToFile($filename, $data, MediaTypeInterface $mediaType = null)

No description

from DataFileSerializerTrait
serializeToFile($filename, $data, MediaTypeInterface $mediaType = null)

No description

getMediaTypeFactoryFlags()

No description

from DataFileMediaTypeNormalizerTrait
getUnserializableFileMediaTypes()

No description

from DataFileUnserializerTrait
canUnserializeFromFile($filename, MediaTypeInterface $mediaType = null)

No description

from DataFileUnserializerTrait
mixed
unserializeFromFile(string $filename, MediaTypeInterface $mediaType = null)

No description

__construct()

No description

setStringifier(callable $callback)

Set the strigification function

MediaTypeInterface[]
getUnserializableDataMediaTypes()

No description

mixed
unserializeData(string $data, MediaTypeInterface $mediaType = null)

No description

TRUE
canUnserializeData(mixed $data, MediaTypeInterface $mediaType = null)

No description

MediaTypeInterface[]
getSerializableDataMediaTypes()

Get the list of content type supported by the serializer interface.

boolean
canSerializeData(mixed $data, MediaTypeInterface $mediaType = null)

Indicate if the given data can be unserialized to the given media type

string
serializeData(mixed $data, MediaTypeInterface $mediaType = null)

Serialize data to a given media type

static 
defaultStringifier($value)

No description

prepareSerialization($data)

No description

prepareFieldSerialization($data)

No description

retrieveParameters($separator, $enclosure, $escape, $eol, $mediaType)

No description

writeLinesToStream($stream, $lines, $mediaType)

No description

Details

at line 308
protected buildMediaTypeList()

in MediaTypeListTrait at line 21
protected getMediaTypes()

in MediaTypeListTrait at line 33
protected matchMediaType(MediaTypeInterface $mediaType)

Parameters

MediaTypeInterface $mediaType

in DataFileExtensionTrait at line 14
protected setFileExtensions($array = array())

Parameters

$array

in DataFileExtensionTrait at line 19
protected matchExtension($filename)

Parameters

$filename

in DataFileSerializerTrait at line 18
getSerializableFileMediaTypes()

in DataFileSerializerTrait at line 23
canSerializeToFile($filename, $data, MediaTypeInterface $mediaType = null)

Parameters

$filename
$data
MediaTypeInterface $mediaType

at line 197
serializeToFile($filename, $data, MediaTypeInterface $mediaType = null)

Parameters

$filename
$data
MediaTypeInterface $mediaType

in DataFileMediaTypeNormalizerTrait at line 44
protected getMediaTypeFactoryFlags()

in DataFileUnserializerTrait at line 27
getUnserializableFileMediaTypes()

in DataFileUnserializerTrait at line 32
canUnserializeFromFile($filename, MediaTypeInterface $mediaType = null)

Parameters

$filename
MediaTypeInterface $mediaType

at line 149
mixed unserializeFromFile(string $filename, MediaTypeInterface $mediaType = null)

Parameters

string $filename File to UnserializeExceptionArrayObjectAsset
MediaTypeInterface $mediaType File content tyep

Return Value

mixed

Exceptions

DataSerializationException::

at line 72
__construct()

at line 90
setStringifier(callable $callback)

Set the strigification function

Parameters

callable $callback Stringification function

Exceptions

InvalidArgumentException

at line 98
MediaTypeInterface[] getUnserializableDataMediaTypes()

Return Value

MediaTypeInterface[]

at line 103
mixed unserializeData(string $data, MediaTypeInterface $mediaType = null)

Parameters

string $data
MediaTypeInterface $mediaType Serialized content type

Return Value

mixed

at line 122
TRUE canUnserializeData(mixed $data, MediaTypeInterface $mediaType = null)

Parameters

mixed $data Data
MediaTypeInterface $mediaType Data media type

Return Value

TRUE if instance support de-serialization of $mediaType content

at line 132
MediaTypeInterface[] getSerializableDataMediaTypes()

Get the list of content type supported by the serializer interface.

Return Value

MediaTypeInterface[]

at line 137
boolean canSerializeData(mixed $data, MediaTypeInterface $mediaType = null)

Indicate if the given data can be unserialized to the given media type

Parameters

mixed $data Data to serialize
MediaTypeInterface $mediaType Data output format

Return Value

boolean TRUE if the instance can serialize $data to $mediaType format

at line 178
string serializeData(mixed $data, MediaTypeInterface $mediaType = null)

Serialize data to a given media type

Parameters

mixed $data Data to serialize
MediaTypeInterface $mediaType Serialization content type

Return Value

string

at line 212
static defaultStringifier($value)

Parameters

$value

at line 223
protected prepareSerialization($data)

Parameters

$data

at line 303
protected prepareFieldSerialization($data)

Parameters

$data

at line 320
protected retrieveParameters($separator, $enclosure, $escape, $eol, $mediaType)

Parameters

$separator
$enclosure
$escape
$eol
$mediaType

at line 337
protected writeLinesToStream($stream, $lines, $mediaType)

Parameters

$stream
$lines
$mediaType