CSV File Loader
Load CSV & TSV files and strings using PHP generators. It uses memory like fopen but requires less code., (*1)
How to Install
Install the luchaninov/csv-file-loader package using composer:, (*2)
$ composer require luchaninov/csv-file-loader
Basic Usage
$loader = new CsvFileLoader('/path/to/your_data.csv');
foreach ($loader->getItems() as $item) {
var_dump($item); // do something here
}
If you have CSV-file, (*3)
id,name,surname
1,Jack,Black
2,John,Doe
you'll get 2 items, (*4)
['id' => '1', 'name' => 'Jack', 'surname' => 'Black']
['id' => '2', 'name' => 'John', 'surname' => 'Doe']
It uses fgetcsv function so it understands enclosed values like, (*5)
item1,"item2,still item2",item3
and even, (*6)
item1,"item2
still item2",item3
If you have simple string, no need to save it to the file. Use, (*7)
(new CsvStringLoader($s))->getItemsArray();
(new TsvStringLoader($s))->getItemsArray();
(new AutoStringLoader($s))->getItemsArray();
Advanced Usage
If file is not large you can load all items at once without generators using getItemsArray()., (*8)
If you have custom delimiters use setDelimiter like $loader->setDelimiter(';'). Same with encloser - setEncloser.
Default delimiter is , for CsvFileLoader and \t for TsvFileLoader; default encloser is ".
If you are not sure - use delimiter auto, it detects delimiter automatically by the first 10,000 characters., (*9)
If you have TSV instead of CSV you can set use setDelimiter("\t") or use TsvFileLoader.
If you are not sure - use AutoFileLoader, it detects delimiter automatically., (*10)
By default it assumes that the first row of the file contains headers - it doesn't return this row as item but uses as keys for next rows.
If you don't have headers in the first row - you can:
- set your own keys - setHeaders(['key1', 'key2', ...])
- use numerical keys [0, 1, 2, ...] - setHeaders(false), (*11)
If there are more cols in some rows than there are cols in headers then they are truncated.
If you prefer to add extra values with numerical keys use setAddUnknownColumns(true)., (*12)
To count items use countItems(). In case of CSV it's not always the same with rows count - wc -l, because one item can have several rows., (*13)
You can use same loader to load several files - $loader->setFilename('other_file.csv'). If you iterate during some file when calling
setFilename then there will be no more items from the first file, foreach will just finish., (*14)
Code is very simple - look at sources and tests., (*15)
TxtFileLoader
If you have simple text file use TxtFileLoader., (*16)
It makes from file, (*17)
text1
text2
text3
array ['text1', 'text2', 'text3']., (*18)
setSkipEmptyRows
Skips empty rows or containing only whitespaces trim($s) === ''. Default: true., (*19)
Skips rows that start with # or \s+#. Default: false., (*20)
Wallogit.com
