ilCSVReader Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilCSVReader:

Public Member Functions
	setSeparator (string $a_sep)
	setDelimiter (string $a_del)
	setLength (int $a_length)
	open (string $path_to_file)
	close ()
	getCsvAsArray ()

Private Member Functions
	parse ()
	unquote (string $a_str)

Private Attributes
	$file_resource
string	$line_ends
array	$data = []
string	$separator = ';'
string	$delimiter = '""'
string	$escape = '\\'
int	$length = 1024

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Member Function Documentation

close()

ilCSVReader::close

(

)

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

                           : bool
    {
        return fclose($this->file_resource);
    }

getCsvAsArray()

ilCSVReader::getCsvAsArray

(

)

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

References $data, and parse().

                                   : array
    {
        $this->parse();

        return $this->data;
    }

Here is the call graph for this function:

open()

ilCSVReader::open

(

string

$path_to_file

)

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

References ilUtil\stripSlashes().

                                              : bool
    {
        $this->file_resource = fopen(ilUtil::stripSlashes($path_to_file), "r");

        if (!is_resource($this->file_resource)) {
            throw new RuntimeException('sould not open stream to ' . $path_to_file);
        }
        return true;
    }

Here is the call graph for this function:

parse()

ilCSVReader::parse ( )

private

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

References unquote().

Referenced by getCsvAsArray().

                            : void
    {
        $row = 0;

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

            ++$row;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setDelimiter()

ilCSVReader::setDelimiter

(

string

$a_del

)

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

                                               : void
    {
        $this->delimiter = $a_del;
    }

setLength()

ilCSVReader::setLength

(

int

$a_length

)

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

                                            : void
    {
        $this->length = $a_length;
    }

setSeparator()

ilCSVReader::setSeparator

(

string

$a_sep

)

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

                                               : void
    {
        $this->separator = $a_sep;
    }

unquote()

ilCSVReader::unquote ( string  $a_str )

private

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

Referenced by parse().

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

Here is the caller graph for this function:

Field Documentation

$data

array ilCSVReader::$data = []

private

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

Referenced by getCsvAsArray().

$delimiter

string ilCSVReader::$delimiter = '""'

private

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

$escape

string ilCSVReader::$escape = '\\'

private

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

$file_resource

ilCSVReader::$file_resource

private

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

$length

int ilCSVReader::$length = 1024

private

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

$line_ends

string ilCSVReader::$line_ends

private

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

$separator

string ilCSVReader::$separator = ';'

private

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

---

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

• components/ILIAS/CSV/classes/class.ilCSVReader.php