CsvEncoder
class CsvEncoder implements EncoderInterface, DecoderInterface
Encodes CSV data.
Constants
FORMAT | |
DELIMITER_KEY | |
ENCLOSURE_KEY | |
ESCAPE_CHAR_KEY | |
KEY_SEPARATOR_KEY | |
HEADERS_KEY |
Methods
__construct(string $delimiter = ',', string $enclosure = '"', string $escapeChar = '\\', string $keySeparator = '.') | ||
scalar | encode(mixed $data, string $format, array $context = array()) Encodes data into the given format. |
|
bool | supportsEncoding(string $format) Checks whether the serializer can encode to given format. |
|
mixed | decode(string $data, string $format, array $context = array()) Decodes a string into PHP data. |
|
bool | supportsDecoding(string $format) Checks whether the deserializer can decode from given format. |
Details
__construct(string $delimiter = ',', string $enclosure = '"', string $escapeChar = '\\', string $keySeparator = '.')
Parameters
string | $delimiter | |
string | $enclosure | |
string | $escapeChar | |
string | $keySeparator |
scalar encode(mixed $data, string $format, array $context = array())
Encodes data into the given format.
Parameters
mixed | $data | Data to encode |
string | $format | Format name |
array | $context | Options that normalizers/encoders have access to |
Return Value
scalar |
Exceptions
UnexpectedValueException |
bool supportsEncoding(string $format)
Checks whether the serializer can encode to given format.
Parameters
string | $format | Format name |
Return Value
bool |
mixed decode(string $data, string $format, array $context = array())
Decodes a string into PHP data.
Parameters
string | $data | Data to decode |
string | $format | Format name |
array | $context | Options that decoders have access to The format parameter specifies which format the data is in; valid values depend on the specific implementation. Authors implementing this interface are encouraged to document which formats they support in a non-inherited phpdoc comment. |
Return Value
mixed |
Exceptions
UnexpectedValueException |
bool supportsDecoding(string $format)
Checks whether the deserializer can decode from given format.
Parameters
string | $format | Format name |
Return Value
bool |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/Serializer/Encoder/CsvEncoder.html