class CSVParser implements Iterator (View source)

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

Methods

static Injectable
create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

__construct(string $filename, string $delimiter = ",", string $enclosure = '"')

Open a CSV file for parsing.

mapColumns(array $columnMap)

Re-map columns in the CSV file.

provideHeaderRow(array $headerRow)

If your CSV file doesn't have a header row, then you can call this function to provide one.

__destruct()

No description

rewind()

No description

current()

No description

key()

No description

next()

No description

valid()

No description

Details

static Injectable create(array ...$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'); $list = SiteTree::get();

Parameters

array ...$args

Return Value

Injectable

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).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

__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.

Parameters

string $filename

The name of the file. If relative, it will be relative to the site's base dir

string $delimiter

The character for seperating columns

string $enclosure

The character for quoting or enclosing columns

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', ));

Parameters

array $columnMap

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.

Parameters

array $headerRow

__destruct()

rewind()

current()

key()

next()

valid()