SimpleExcel\Parser\CSVParser Class Reference

Inheritance diagram for SimpleExcel\Parser\CSVParser:

Collaboration diagram for SimpleExcel\Parser\CSVParser:

Public Member Functions
	loadFile ($file_path)
	Load the CSV file to be parsed. More...
	loadString ($str)
	Load the string to be parsed. More...
	setDelimiter ($delimiter)
	Set delimiter that should be used to parse CSV document. More...
Public Member Functions inherited from SimpleExcel\Parser\BaseParser
	__construct ($file_url=NULL)
	getCell ($row_num, $col_num, $val_only=true)
	Get value of the specified cell. More...
	getColumn ($col_num, $val_only=TRUE)
	Get data of the specified column as an array. More...
	getField ($val_only=TRUE)
	Get data of all cells as an array. More...
	getRow ($row_num, $val_only=TRUE)
	Get data of the specified row as an array. More...
	isCellExists ($row_num, $col_num)
	Check whether cell with specified row & column exists. More...
	isColumnExists ($col_num)
	Check whether a specified column exists. More...
	isRowExists ($row_num)
	Check whether a specified row exists. More...
	isFieldExists ()
	Check whether table exists. More...
	isFileReady ($file_path)
	Check whether file exists, valid, and readable. More...
	getCell ($row_num, $col_num, $val_only)
	getColumn ($col_num, $val_only)
	getRow ($row_num, $val_only)
	getField ($val_only)
	isCellExists ($row_num, $col_num)
	isColumnExists ($col_num)
	isRowExists ($row_num)
	isFieldExists ()
	isFileReady ($file_path)
	loadFile ($file_path)
	loadString ($str)

Protected Attributes
	$delimiter
	$file_extension = 'csv'
Protected Attributes inherited from SimpleExcel\Parser\BaseParser
	$table_arr
	$file_extension = ''

Detailed Description

Definition at line 13 of file CSVParser.php.

Member Function Documentation

loadFile()

SimpleExcel\Parser\CSVParser::loadFile

(

$file_path

)

Load the CSV file to be parsed.

Parameters

string

$file_path

Path to CSV file

Implements SimpleExcel\Parser\IParser.

Definition at line 36 of file CSVParser.php.

                                        {
    
        if (!$this->isFileReady($file_path)) {
            return;
        }
 
        $this->loadString(file_get_contents($file_path));
    }

References SimpleExcel\Parser\BaseParser\isFileReady(), and SimpleExcel\Parser\CSVParser\loadString().

Here is the call graph for this function:

loadString()

SimpleExcel\Parser\CSVParser::loadString

(

$str

)

Load the string to be parsed.

Parameters

string

$str

String with CSV format

Implements SimpleExcel\Parser\IParser.

Definition at line 50 of file CSVParser.php.

                                    {
        $this->table_arr = array();
        
        if(!isset($this->delimiter)){
            $numofcols = NULL;
            // assume the delimiter is semicolon
            while(($line = str_getcsv($str, ';')) !== FALSE){
                if($numofcols === NULL){
                    $numofcols = count($line);
                }
                // check the number of values in each line
                if(count($line) === $numofcols){
                    array_push($this->table_arr, $line);
                } else {
                    // maybe wrong delimiter
                    // empty the array back
                    $this->table_arr = array();
                    $numofcols = NULL;
                    break;
                }
            }
            // if null, check whether values are separated by commas
            if($numofcols === NULL){
                while(($line = str_getcsv($str, ',')) !== FALSE){
                    array_push($this->table_arr, $line);
                }
            }
        } else {
            while(($line = str_getcsv($str, $this->delimiter)) !== FALSE){
                array_push($this->table_arr, $line);
            }
        }
    }

Referenced by SimpleExcel\Parser\CSVParser\loadFile().

Here is the caller graph for this function:

setDelimiter()

SimpleExcel\Parser\CSVParser::setDelimiter

(

$delimiter

)

Set delimiter that should be used to parse CSV document.

Parameters

string

$delimiter

Delimiter character

Reimplemented in SimpleExcel\Parser\TSVParser.

Definition at line 89 of file CSVParser.php.

                                            {
        $this->delimiter = $delimiter;
    }

References SimpleExcel\Parser\CSVParser\$delimiter.

Field Documentation

$delimiter

SimpleExcel\Parser\CSVParser::$delimiter

protected

Definition at line 21 of file CSVParser.php.

Referenced by SimpleExcel\Parser\CSVParser\setDelimiter().

$file_extension

SimpleExcel\Parser\CSVParser::$file_extension = 'csv'

protected

Definition at line 29 of file CSVParser.php.

---

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

• Modules/DataCollection/libs/SimpleExcel/Parser/CSVParser.php