Csv Class Reference

Inheritance diagram for Csv:

Public Member Functions
	__construct (File $file)
	setLineLength ($length)
	setDelimiter ($delimiter)
	setEnclosure ($enclosure)
	getData ($file)
	getDataPairs ($file, $keyIndex=0, $valueIndex=1)
	saveData ($file, $data)
	appendData ($file, $data, $mode='w')

Protected Attributes
	$_lineLength = 0
	$_delimiter = ','
	$_enclosure = '"'
	$file

Detailed Description

Csv parse

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m

Definition at line 16 of file Csv.php.

Constructor & Destructor Documentation

__construct()

__construct

(

File

$file

)

Constructor

Parameters

File

$file

File Driver used for writing CSV

Definition at line 43 of file Csv.php.

    {
        $this->file = $file;
    }

Member Function Documentation

appendData()

appendData	(		$file,
			$data,
			$mode = 'w'
	)

Replace the saveData method by allowing to select the input mode

Parameters

string	$file
array	$data
string	$mode

Returns

$this

Exceptions

Definition at line 152 of file Csv.php.

    {
        $fileHandler = fopen($file, $mode);
        foreach ($data as $dataRow) {
            $this->file->filePutCsv($fileHandler, $dataRow, $this->_delimiter, $this->_enclosure);
        }
        fclose($fileHandler);

        return $this;
    }

getData()

getData

(

$file

)

Retrieve CSV file data as array

Parameters

string

$file

Returns

array

Exceptions

Definition at line 91 of file Csv.php.

    {
        $data = [];
        if (!file_exists($file)) {
            throw new \Exception('File "' . $file . '" does not exist');
        }

        $fh = fopen($file, 'r');
        while ($rowData = fgetcsv($fh, $this->_lineLength, $this->_delimiter, $this->_enclosure)) {
            $data[] = $rowData;
        }
        fclose($fh);
        return $data;
    }

getDataPairs()

getDataPairs	(		$file,
			$keyIndex = 0,
			$valueIndex = 1
	)

Retrieve CSV file data as pairs

Parameters

string	$file
int	$keyIndex
int	$valueIndex

Returns

array

Definition at line 114 of file Csv.php.

    {
        $data = [];
        $csvData = $this->getData($file);
        foreach ($csvData as $rowData) {
            if (isset($rowData[$keyIndex])) {
                $data[$rowData[$keyIndex]] = isset($rowData[$valueIndex]) ? $rowData[$valueIndex] : null;
            }
        }
        return $data;
    }

saveData()

saveData	(		$file,
			$data
	)

Saving data row array into file

Parameters

string	$file
array	$data

Returns

$this

Exceptions

Definition at line 136 of file Csv.php.

    {
        return $this->appendData($file, $data, 'w');
    }

setDelimiter()

setDelimiter

(

$delimiter

)

Set CSV column delimiter

Parameters

string

$delimiter

Returns

\Magento\Framework\File\Csv

Definition at line 66 of file Csv.php.

    {
        $this->_delimiter = $delimiter;
        return $this;
    }

setEnclosure()

setEnclosure

(

$enclosure

)

Set CSV column value enclosure

Parameters

string

$enclosure

Returns

\Magento\Framework\File\Csv

Definition at line 78 of file Csv.php.

    {
        $this->_enclosure = $enclosure;
        return $this;
    }

setLineLength()

setLineLength

(

$length

)

Set max file line length

Parameters

int

$length

Returns

\Magento\Framework\File\Csv

Definition at line 54 of file Csv.php.

    {
        $this->_lineLength = $length;
        return $this;
    }

Field Documentation

$_delimiter

$_delimiter = ','

protected

Definition at line 26 of file Csv.php.

$_enclosure

$_enclosure = '"'

protected

Definition at line 31 of file Csv.php.

$_lineLength

$_lineLength = 0

protected

Definition at line 21 of file Csv.php.

$file

$file

protected

Definition at line 36 of file Csv.php.

---

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

• vendor/magento/framework/File/Csv.php