Varien_File_Csv Class Reference

Inheritance diagram for Varien_File_Csv:

List of all members.

Public Member Functions
	__construct ()
	setLineLength ($length)
	setDelimiter ($delimiter)
	setEnclosure ($enclosure)
	getData ($file)
	getDataPairs ($file, $keyIndex=0, $valueIndex=1)
	saveData ($file, $data)
	fputcsv (&$handle, $fields=array(), $delimiter= ',', $enclosure= '"')
Protected Attributes
	$_lineLength = 0
	$_delimiter = ','
	$_enclosure = '"'

---

Detailed Description

Csv parse

Author:

Magento Core Team <core@magentocommerce.com>

Definition at line 32 of file Csv.php.

---

Constructor & Destructor Documentation

__construct

(

)

Definition at line 38 of file Csv.php.

    {
        
    }

---

Member Function Documentation

fputcsv	(	&$	handle,
		$	fields = array(),
		$	delimiter = ',',
		$	enclosure = '"'
	)

Definition at line 137 of file Csv.php.

                                                                                             {
        $str = '';
        $escape_char = '\\';
        foreach ($fields as $value) {
            if (strpos($value, $delimiter) !== false ||
                strpos($value, $enclosure) !== false ||
                strpos($value, "\n") !== false ||
                strpos($value, "\r") !== false ||
                strpos($value, "\t") !== false ||
                strpos($value, ' ') !== false) {
                $str2 = $enclosure;
                $escaped = 0;
                $len = strlen($value);
                for ($i=0;$i<$len;$i++) {
                    if ($value[$i] == $escape_char) {
                        $escaped = 1;
                    } else if (!$escaped && $value[$i] == $enclosure) {
                        $str2 .= $enclosure;
                    } else {
                        $escaped = 0;
                    }
                        $str2 .= $value[$i];
                }
                $str2 .= $enclosure;
                $str .= $str2.$delimiter;
            } else {
                $str .= $enclosure.$value.$enclosure.$delimiter;
            }
        }
        $str = substr($str,0,-1);
        $str .= "\n";
        return fwrite($handle, $str);
    }

getData

(

$

file

)

Retrieve CSV file data as array

Parameters:

string

$file

Returns:

array

Definition at line 85 of file Csv.php.

    {
        $data = array();
        if (!file_exists($file)) {
            throw new Exception('File "'.$file.'" do not exists');
        }
        
        $fh = fopen($file, 'r');
        while ($rowData = fgetcsv($fh, $this->_lineLength, $this->_delimiter, $this->_enclosure)) {
            $data[] = $rowData;
        }
        fclose($fh);
        return $data;
    }

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

Retrieve CSV file data as pairs

Parameters:

	string	$file
	int	$keyIndex
	int	$valueIndex

Returns:

array

Reimplemented in Varien_File_Csv_Multy.

Definition at line 108 of file Csv.php.

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

saveData	(	$	file,
		$	data
	)

Saving data row array into file

Parameters:

	string	$file
	array	$data

Returns:

Varien_File_Csv

Definition at line 127 of file Csv.php.

    {
        $fh = fopen($file, 'w');
        foreach ($data as $dataRow) {
            $this->fputcsv($fh, $dataRow, $this->_delimiter, $this->_enclosure);
        }
        fclose($fh);
        return $this;
    }

setDelimiter

(

$

delimiter

)

Set CSV column delimiter

Parameters:

string

$delimiter

Returns:

Varien_File_Csv

Definition at line 61 of file Csv.php.

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

setEnclosure

(

$

enclosure

)

Set CSV column value enclosure

Parameters:

string

$enclosure

Returns:

Varien_File_Csv

Definition at line 73 of file Csv.php.

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

setLineLength

(

$

length

)

Set max file line length

Parameters:

int

$length

Returns:

Varien_File_Csv

Definition at line 49 of file Csv.php.

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

---

Member Data Documentation

$_delimiter = ',' [protected]

Definition at line 35 of file Csv.php.

$_enclosure = '"' [protected]

Definition at line 36 of file Csv.php.

$_lineLength = 0 [protected]

Definition at line 34 of file Csv.php.

---

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

• lib/Varien/File/Csv.php