ILIAS\Survey\CSVReader Class Reference

Collaboration diagram for ILIAS\Survey\CSVReader:

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

Deprecated:

11 This component will be removed with ILIAS 11

Definition at line 27 of file CSVReader.php.

Member Function Documentation

close()

ILIAS\Survey\CSVReader::close

(

)

Definition at line 79 of file CSVReader.php.

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

getCsvAsArray()

ILIAS\Survey\CSVReader::getCsvAsArray

(

)

Definition at line 84 of file CSVReader.php.

                                   : array
    {
        $this->parse();
 
        return $this->data;
    }

References ILIAS\Survey\CSVReader\$data, and ILIAS\Survey\CSVReader\parse().

Here is the call graph for this function:

open()

ILIAS\Survey\CSVReader::open

(

string

$path_to_file

)

Definition at line 69 of file CSVReader.php.

                                              : 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;
    }

References ilUtil\stripSlashes().

Here is the call graph for this function:

parse()

ILIAS\Survey\CSVReader::parse ( )

private

Definition at line 40 of file CSVReader.php.

                            : 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;
        }
    }

References ILIAS\Survey\CSVReader\unquote().

Referenced by ILIAS\Survey\CSVReader\getCsvAsArray().

Here is the call graph for this function:

Here is the caller graph for this function:

setDelimiter()

ILIAS\Survey\CSVReader::setDelimiter

(

string

$a_del

)

Definition at line 59 of file CSVReader.php.

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

setLength()

ILIAS\Survey\CSVReader::setLength

(

int

$a_length

)

Definition at line 64 of file CSVReader.php.

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

setSeparator()

ILIAS\Survey\CSVReader::setSeparator

(

string

$a_sep

)

Definition at line 54 of file CSVReader.php.

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

unquote()

ILIAS\Survey\CSVReader::unquote ( string  $a_str )

private

Definition at line 91 of file CSVReader.php.

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

Referenced by ILIAS\Survey\CSVReader\parse().

Here is the caller graph for this function:

Field Documentation

$data

array ILIAS\Survey\CSVReader::$data = []

private

Definition at line 34 of file CSVReader.php.

Referenced by ILIAS\Survey\CSVReader\getCsvAsArray().

$delimiter

string ILIAS\Survey\CSVReader::$delimiter = '""'

private

Definition at line 36 of file CSVReader.php.

$escape

string ILIAS\Survey\CSVReader::$escape = '\\'

private

Definition at line 37 of file CSVReader.php.

$file_resource

ILIAS\Survey\CSVReader::$file_resource

private

Definition at line 32 of file CSVReader.php.

$length

int ILIAS\Survey\CSVReader::$length = 1024

private

Definition at line 38 of file CSVReader.php.

$line_ends

string ILIAS\Survey\CSVReader::$line_ends

private

Definition at line 33 of file CSVReader.php.

$separator

string ILIAS\Survey\CSVReader::$separator = ';'

private

Definition at line 35 of file CSVReader.php.

---

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

• components/ILIAS/Survey/CSV/CSVReader.php