ilCSVReader Class Reference

Collaboration diagram for ilCSVReader:

Public Member Functions
	__construct ()
	Constructor. More...
	setSeparator ($a_sep)
	setDelimiter ($a_del)
	Set delimiter. More...
	setLength ($a_length)
	Set length. More...
	open ($file="")
	close ()
	getDataArrayFromCSVFile ()
	Get data as array from csv file. More...

Private Member Functions
	unquote ($a_str)
	@access private More...

Private Attributes
	$ptr_file = null
	$data = array()
	$separator = ';'
	$delimiter = '""'
	$length = 1024

Detailed Description

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

Definition at line 34 of file class.ilCSVReader.php.

Constructor & Destructor Documentation

__construct()

ilCSVReader::__construct

(

)

Constructor.

@access public

Parameters

Definition at line 49 of file class.ilCSVReader.php.

    {
    }

Member Function Documentation

close()

ilCSVReader::close

(

)

Definition at line 98 of file class.ilCSVReader.php.

    {
        // see open();
        ini_set("auto_detect_line_endings", $this->line_ends);
        
        return(@fclose($this->ptr_file));
    }

getDataArrayFromCSVFile()

ilCSVReader::getDataArrayFromCSVFile

(

)

Get data as array from csv file.

@access public

Returns

array $this->data Data of file

Definition at line 113 of file class.ilCSVReader.php.

    {
        $row = 0;
 
        while (($line = fgetcsv($this->ptr_file, $this->length, $this->separator)) !== false) {
            for ($col = 0; $col < count($line); $col++) {
                $this->data[$row][$col] = $this->unquote($line[$col]);
            }
            
            ++$row;
        }
        
        return $this->data;
    }

References $data, $row, data, and unquote().

Here is the call graph for this function:

open()

ilCSVReader::open

(

$file = ""

)

Definition at line 89 of file class.ilCSVReader.php.

    {
        // #16643
        $this->line_ends = ini_get("auto_detect_line_endings");
        ini_set("auto_detect_line_endings", true);
        
        return($this->ptr_file = @fopen(ilUtil::stripSlashes($file), "r"));
    }

References ilUtil\stripSlashes().

Here is the call graph for this function:

setDelimiter()

ilCSVReader::setDelimiter

(

$a_del

)

Set delimiter.

@access public

Parameters

string

field delimiter

Definition at line 72 of file class.ilCSVReader.php.

    {
        $this->delimiter = $a_del;
    }

setLength()

ilCSVReader::setLength

(

$a_length

)

Set length.

@access public

Parameters

int

length

Definition at line 84 of file class.ilCSVReader.php.

    {
        $this->length = $a_length;
    }

setSeparator()

ilCSVReader::setSeparator

(

$a_sep

)

Definition at line 60 of file class.ilCSVReader.php.

    {
        $this->separator = $a_sep;
    }

unquote()

ilCSVReader::unquote (   $a_str )

private

@access private

Parameters

string

field value

Definition at line 134 of file class.ilCSVReader.php.

    {
        return str_replace($this->delimiter . $this->delimiter, $this->delimiter, $a_str);
    }

Referenced by getDataArrayFromCSVFile().

Here is the caller graph for this function:

Field Documentation

$data

ilCSVReader::$data = array()

private

Definition at line 37 of file class.ilCSVReader.php.

Referenced by getDataArrayFromCSVFile().

$delimiter

ilCSVReader::$delimiter = '""'

private

Definition at line 39 of file class.ilCSVReader.php.

$length

ilCSVReader::$length = 1024

private

Definition at line 40 of file class.ilCSVReader.php.

$ptr_file

ilCSVReader::$ptr_file = null

private

Definition at line 36 of file class.ilCSVReader.php.

$separator

ilCSVReader::$separator = ';'

private

Definition at line 38 of file class.ilCSVReader.php.

---

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

• Services/Utilities/classes/class.ilCSVReader.php