CsvToArray Class Reference

Public Member Functions
	__construct ($csv_path='', $delimiter=',', $enclosure=null)
	ParseData ()
	IsLinesToProcess ()
	CloseFile ()

Protected Member Functions
	InitResponseArray ()
	Set ($prop, $value)
	SetFileObject ($file)
	SetArrayTemplate ()
	CombineCsvArray ($line='')
	DataMatchesTemplateLength ($data)
	CreateAssociativeArrays ($data)
	ReturnResponse ()
	IsErrors ()

Protected Attributes
	$delimiter = null
	$enclosure = null
	$response = []
	$line_num = 0
	$SplFileObj = null
	$array_template = []

Detailed Description

Copyright

HomeCu 05/2019

A wrapper class for str_getcsv() to parse a CSV file into an array. Leaves off escape param, can be added if needed . . . . ASSUMES (and really should be) first row of CSV are field names. It is shifted off the stack and used as field names for associative array as below.

Usage: $obj = new CsvToArray([path to dummie data CSV file], [optional string delimiter], [optional string enclosure]); $obj->ParseData();

"Enclosure" is better known as "qualifier" as in quote-qualified fields.

Returns array [ 'errors' => [], 'data' => [ [int row index] => [ [string field] => [mixed value], .... ] ];

Definition at line 26 of file CsvToArray.php.

Constructor & Destructor Documentation

__construct()

CsvToArray::__construct	(		$csv_path = '',
			$delimiter = ',',
			$enclosure = null
	)

Constructor, initialize response and set path to CSV. Set delimiter and enclosure first, setArrayTemplate() uses them.

Parameters

string	$csv_path
string	$delimiter
string	$enclosure

Returns

void

Definition at line 57 of file CsvToArray.php.

                                                                                   {

    $this
      ->InitResponseArray()
      ->Set('delimiter', $delimiter)
      ->Set('enclosure', $enclosure)
      ->SetFileObject($csv_path)
      ->SetArrayTemplate();
  }

Member Function Documentation

CloseFile()

CsvToArray::CloseFile

(

)

Close filehandles by setting SplFileObject to null. Public so if the requested number of records is less than file length we can close it.

Returns

$this

Definition at line 204 of file CsvToArray.php.

                              {

    if ($this->SplFileObj) {
      $this->SplFileObj = null;
    }

    return $this;
  }

CombineCsvArray()

CsvToArray::CombineCsvArray (   $line = '' )

protected

Leverage str_getcsv()to parse the CSV file.

Parameters

string

$line

Returns

$this

Definition at line 158 of file CsvToArray.php.

                                                 {

    if ($this->IsErrors()) {
      return $this;
    }

    $data = str_getcsv($line, $this->delimiter, $this->enclosure);

    if (! $this->DataMatchesTemplateLength($data)) {

      $this->response['errors'][] = "
        The data length is incorrect, please check the CSV file.
        The columns in the header MUST match the columns in the data rows." . PHP_EOL;
      return $this;
    }

    $this->response['data'] = $this->CreateAssociativeArrays($data);

    return $this;
  }

CreateAssociativeArrays()

CsvToArray::CreateAssociativeArrays (   $data )

protected

Map the data to the first row of fields so we have an associative array.

Parameters

array

$data

Returns

array

Definition at line 194 of file CsvToArray.php.

                                                    {

    return array_combine($this->array_template, $data);
  }

DataMatchesTemplateLength()

CsvToArray::DataMatchesTemplateLength (   $data )

protected

Validate we can do array_combine

Parameters

array

$data

Returns

bool

Definition at line 184 of file CsvToArray.php.

                                                      {

    return count($data) == count($this->array_template);
  }

InitResponseArray()

CsvToArray::InitResponseArray ( )

protected

Initialize the response

Returns

$this

Definition at line 100 of file CsvToArray.php.

                                         {

    $this->response = [
      'errors'  => [],
      'data'    => []
    ];

    return $this;
  }

IsErrors()

CsvToArray::IsErrors ( )

protected

Got errors?

Returns

bool

Definition at line 226 of file CsvToArray.php.

                                {

    return count($this->response['errors']) > 0;
  }

IsLinesToProcess()

CsvToArray::IsLinesToProcess

(

)

Check that the SplFileObject is still an object (not null)

Returns

bool

Definition at line 91 of file CsvToArray.php.

                                     {

    return ! is_null($this->SplFileObj);
  }

ParseData()

CsvToArray::ParseData

(

)

Get the associative array of $this->array_template mapped to CSV data rows.

Returns

array|false

Definition at line 71 of file CsvToArray.php.

                              {

    $this->line_num++;
    $this->SplFileObj->seek($this->line_num);

    if ($this->SplFileObj->eof())  {
      $this->CloseFile();
      return false;
    }

    return $this
      ->CombineCsvArray($this->SplFileObj->current())
      ->ReturnResponse();
  }

ReturnResponse()

CsvToArray::ReturnResponse ( )

protected

Return a response, this approach allows chaining of methods above it.

Returns

array

Definition at line 217 of file CsvToArray.php.

                                      {

    return $this->response;
  }

Set()

CsvToArray::Set (   $prop,   $value  )

protected

A typical setter, sets internal properties (delimiter, enclosure) Usually setters are public, don't think we'll need it externally

Parameters

string	$prop	property identifier
string	$value	property to set

Returns

$this

Definition at line 117 of file CsvToArray.php.

                                        {

    if (! $value || empty($value)) {
      return $this;
  }

    $this->{$prop} = $value;

    return $this;
  }

SetArrayTemplate()

CsvToArray::SetArrayTemplate ( )

protected

Initialize $this->array_template from the first row in the CSV.

Returns

$this

Definition at line 145 of file CsvToArray.php.

                                        {

    $this->SplFileObj->seek(0);
    $this->array_template = str_getcsv($this->SplFileObj->current(), $this->delimiter, $this->enclosure);

    return $this;
  }

SetFileObject()

CsvToArray::SetFileObject (   $file )

protected

Instantiate the native SplFileObject. We could call it directly, setting it as a property makes it a little more visible.

Parameters

string

$file

Returns

$this

Definition at line 134 of file CsvToArray.php.

                                          {

    $this->SplFileObj = new SplFileObject($file);

    return $this;
  }

---

The documentation for this class was generated from the following file:

• app/web/shared/library/classes/CsvToArray/CsvToArray.php