Documentation

CsvComponent
in package

Table of Contents

Methods

detectDelimiter()  : mixed
Auto detect csv delimiter.
detectEnclosure()  : mixed
Auto detect cell enclosure.
detectNewLineSequence()  : string|null
Auto detect newline symbol
findMissingHeaders()  : mixed
findRowErrors()  : mixed
fullValidate()  : mixed
generator_readLinesAsAssocArray()  : Generator<string|int, array<string|int, string>>
toUtf8()  : string
Convert cell values to utf8.
_findRowErrors()  : mixed
validateRulesArray()  : mixed

Methods

detectDelimiter()

Auto detect csv delimiter.

public static detectDelimiter(string $csvFile[, int|null $line_max_length = 2048 ]) : mixed
Parameters
$csvFile : string
$line_max_length : int|null = 2048

detectEnclosure()

Auto detect cell enclosure.

public static detectEnclosure(string $csvFile, mixed $delimiter[, int|null $line_max_length = 2048 ]) : mixed
Parameters
$csvFile : string
$delimiter : mixed
$line_max_length : int|null = 2048

detectNewLineSequence()

Auto detect newline symbol

public static detectNewLineSequence(string $csvFile[, int|null $line_max_length = 2048 ]) : string|null
Parameters
$csvFile : string
$line_max_length : int|null = 2048
Return values
string|null

findMissingHeaders()

public static findMissingHeaders(string $csvFile, string|null $delimiter, string|null $enclosure, array<string|int, mixed> $requiredHeaders[, int $line_max_length = 2048 ]) : mixed
Parameters
$csvFile : string
$delimiter : string|null
$enclosure : string|null
$requiredHeaders : array<string|int, mixed>
$line_max_length : int = 2048

findRowErrors()

public static findRowErrors(string $csvFile, string $new_line, string|null $delimiter, string|null $enclosure, array<string, Closure> $rules[, int &$lines_counter = 0 ][, int $line_max_length = 2048 ]) : mixed
Parameters
$csvFile : string
$new_line : string
$delimiter : string|null
$enclosure : string|null
$rules : array<string, Closure>
$lines_counter : int = 0
$line_max_length : int = 2048

fullValidate()

public static fullValidate(string $csvFile, array<string|int, mixed> $requiredHeaders, array<string, Closure> $rules[, int &$lines_counter = 0 ][, int $line_max_length = 2048 ]) : mixed
Parameters
$csvFile : string
$requiredHeaders : array<string|int, mixed>
$rules : array<string, Closure>
$lines_counter : int = 0
$line_max_length : int = 2048

generator_readLinesAsAssocArray()

public static generator_readLinesAsAssocArray(mixed $csvFile) : Generator<string|int, array<string|int, string>>
Parameters
$csvFile : mixed
Tags
warning

does not validate will return lowercase keys

Return values
Generator<string|int, array<string|int, string>>

toUtf8()

Convert cell values to utf8.

public static toUtf8(string $string) : string
Parameters
$string : string
Return values
string

_findRowErrors()

private static _findRowErrors(string $csvFile, string $new_line, string|null $delimiter, string|null $enclosure, array<string|int, mixed> $rules[, int &$lines_counter = 0 ][, int $line_max_length = 2048 ]) : mixed
Parameters
$csvFile : string
$new_line : string
$delimiter : string|null
$enclosure : string|null
$rules : array<string|int, mixed>
$lines_counter : int = 0
$line_max_length : int = 2048

validateRulesArray()

private static validateRulesArray(mixed $rules, int $argumentNumber) : mixed
Parameters
$rules : mixed
$argumentNumber : int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results