CSVParser deprecated
class CSVParser implements Iterator (View source)
deprecated
Class to handle parsing of CSV files, where the column headers are in the first row.
The idea is that you pass it another object to handle the actual processing of the data in the CSV file.
Usage:
$parser = new CSVParser('myfile.csv');
$parser->mapColumns(array(
'first name' => 'FirstName',
'lastname' => 'Surname',
'last name' => 'Surname',
));
foreach($parser as $row) {
// $row is a map of column name => column value
$obj = new MyDataObject();
$obj->update($row);
$obj->write();
}Traits
A class that can be instantiated or replaced via DI
Properties
| protected | string | $filename | ||
| protected | resource | $fileHandle | ||
| protected | array | $columnMap | Map of source columns to output columns. |
|
| protected | array | $headerRow | The header row used to map data in the CSV file. |
|
| protected | array | $providedHeaderRow | A custom header row provided by the caller. |
|
| protected | array | $currentRow | The data of the current row. |
|
| protected | int | $rowNum | The current row number. |
|
| protected | string | $delimiter | The character for separating columns. |
|
| protected | string | $enclosure | The character for quoting columns. |
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Open a CSV file for parsing.
If your CSV file doesn't have a header row, then you can call this function to provide one.
Map the contents of a header array using $this->mappedColumns.
Details
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
__construct(string $filename, string $delimiter = ",", string $enclosure = '"')
Open a CSV file for parsing.
You can use the object returned in a foreach loop to extract the data.
mapColumns(array $columnMap)
Re-map columns in the CSV file.
This can be useful for identifying synonyms in the file. For example:
$csv->mapColumns(array(
'firstname' => 'FirstName',
'last name' => 'Surname',
));
provideHeaderRow(array $headerRow)
If your CSV file doesn't have a header row, then you can call this function to provide one.
If you call this function, then the first row of the CSV will be included in the data returned.
protected
openFile()
Open the CSV file for reading.
protected
closeFile()
Close the CSV file and re-set all of the internal variables.
protected
fetchCSVHeader()
Get a header row from the CSV file.
protected array
remapHeader(array $header)
Map the contents of a header array using $this->mappedColumns.
protected array
fetchCSVRow()
Get a row from the CSV file and update $this->currentRow;
__destruct()
No description
rewind()
No description
current()
No description
key()
No description
next()
No description
valid()
No description