Csv Class Reference

Inheritance diagram for Csv:

Public Member Functions
	__construct ( $file, \Magento\Framework\Filesystem\Directory\Read $directory, $delimiter=',', $enclosure='"' )
	destruct ()
	rewind ()
Public Member Functions inherited from AbstractSource
	__construct (array $colNames)
	getColNames ()
	current ()
	next ()
	key ()
	valid ()
	rewind ()
	seek ($position)

Protected Member Functions
	_getNextRow ()
Protected Member Functions inherited from AbstractSource
	_getNextRow ()

Protected Attributes
	$_file
	$_delimiter = ','
	$_enclosure = ''
Protected Attributes inherited from AbstractSource
	$_colNames = []
	$_colQty
	$_row = []
	$_key = -1
	$_foundWrongQuoteFlag = false

Detailed Description

CSV import adapter

Definition at line 11 of file Csv.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$file,
		\Magento\Framework\Filesystem\Directory\Read	$directory,
			$delimiter = ',',
			$enclosure = '"'
	)

Open file and detect column names

There must be column names in the first line

Parameters

string	$file
\Magento\Framework\Filesystem\Directory\Read	$directory
string	$delimiter
string	$enclosure

Exceptions

Definition at line 41 of file Csv.php.

      {
        register_shutdown_function([$this, 'destruct']);
        try {
            $this->_file = $directory->openFile($directory->getRelativePath($file), 'r');
        } catch (\Magento\Framework\Exception\FileSystemException $e) {
            throw new \LogicException("Unable to open file: '{$file}'");
        }
        if ($delimiter) {
            $this->_delimiter = $delimiter;
        }
        $this->_enclosure = $enclosure;
        parent::__construct($this->_getNextRow());
    }

Member Function Documentation

_getNextRow()

_getNextRow ( )

protected

Read next line from CSV-file

Returns

array|bool

Definition at line 77 of file Csv.php.

    {
        $parsed = $this->_file->readCsv(0, $this->_delimiter, $this->_enclosure);
        if (is_array($parsed) && count($parsed) != $this->_colQty) {
            foreach ($parsed as $element) {
                if (strpos($element, "'") !== false) {
                    $this->_foundWrongQuoteFlag = true;
                    break;
                }
            }
        } else {
            $this->_foundWrongQuoteFlag = false;
        }
        return is_array($parsed) ? $parsed : [];
    }

destruct()

destruct

(

)

Close file handle

Returns

void

Definition at line 65 of file Csv.php.

    {
        if (is_object($this->_file)) {
            $this->_file->close();
        }
    }

rewind()

rewind

(

)

Rewind the \Iterator to the first element (\Iterator interface)

Returns

void

Definition at line 98 of file Csv.php.

    {
        $this->_file->seek(0);
        $this->_getNextRow();
        // skip first line with the header
        parent::rewind();
    }

Field Documentation

$_delimiter

$_delimiter = ','

protected

Definition at line 23 of file Csv.php.

$_enclosure

$_enclosure = ''

protected

Definition at line 28 of file Csv.php.

$_file

$_file

protected

Definition at line 16 of file Csv.php.

---

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

• vendor/magento/module-import-export/Model/Import/Source/Csv.php