Documentation

CsvFormatter extends AbstractFormatter
in package

Class CsvFormatter

Table of Contents

Methods

__construct()  : mixed
IniFormatter constructor.
__serialize()  : array<string|int, mixed>
__unserialize()  : void
decode()  : array<string|int, mixed>
Decode a string into data.
encode()  : string
Encode data into a string.
getDefaultFileExtension()  : string
Get default file extension from current formatter (with dot).
getDelimiter()  : string
Returns delimiter used to both encode and decode CSV.
getMimeType()  : string
getSupportedFileExtensions()  : array<string|int, string>
Get file extensions supported by current formatter (with dot).
serialize()  : string
unserialize()  : void
encodeLine()  : string
escape()  : string
getConfig()  : mixed
Get either full configuration or a single option.
getUnserializeAllowedClasses()  : array<string|int, mixed>|bool

Methods

__construct()

IniFormatter constructor.

public __construct([array<string|int, mixed> $config = [] ]) : mixed
Parameters
$config : array<string|int, mixed> = []

__serialize()

public __serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>

__unserialize()

public __unserialize(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>

decode()

Decode a string into data.

public decode(string $data[, string|null $delimiter = null ]) : array<string|int, mixed>
Parameters
$data : string
$delimiter : string|null = null
Tags
see
FileFormatterInterface::decode()
Return values
array<string|int, mixed>

encode()

Encode data into a string.

public encode(array<string|int, mixed> $data[, string|null $delimiter = null ]) : string
Parameters
$data : array<string|int, mixed>
$delimiter : string|null = null
Tags
see
FileFormatterInterface::encode()
Return values
string

getDelimiter()

Returns delimiter used to both encode and decode CSV.

public getDelimiter() : string
Return values
string

serialize()

public final serialize() : string
Return values
string

unserialize()

public final unserialize(string $serialized) : void
Parameters
$serialized : string

encodeLine()

protected encodeLine(array<string|int, mixed> $line, string $delimiter) : string
Parameters
$line : array<string|int, mixed>
$delimiter : string
Return values
string

escape()

protected escape(string $value) : string
Parameters
$value : string
Return values
string

getConfig()

Get either full configuration or a single option.

protected getConfig([string|null $name = null ]) : mixed
Parameters
$name : string|null = null

Configuration option (optional)

getUnserializeAllowedClasses()

protected getUnserializeAllowedClasses() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results