SimpleExcel\Parser\BaseParser Class Reference

Inheritance diagram for SimpleExcel\Parser\BaseParser:

Collaboration diagram for SimpleExcel\Parser\BaseParser:

Public Member Functions
	__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...
Public Member Functions inherited from SimpleExcel\Parser\IParser
	loadFile ($file_path)
	loadString ($str)

Protected Attributes
	$table_arr
	$file_extension = ''

Detailed Description

Definition at line 13 of file BaseParser.php.

Constructor & Destructor Documentation

__construct()

SimpleExcel\Parser\BaseParser::__construct

(

$file_url = NULL

)

Parameters

string

$file_url

Path to file (optional)

Definition at line 34 of file BaseParser.php.

References SimpleExcel\Parser\IParser\loadFile().

                                                  {
        if(isset($file_url)) {
            $this->loadFile($file_url);
        }
    }

Here is the call graph for this function:

Member Function Documentation

getCell()

SimpleExcel\Parser\BaseParser::getCell	(		$row_num,
			$col_num,
			$val_only = true
	)

Get value of the specified cell.

Parameters

int	$row_num	Row number
int	$col_num	Column number
int	$val_only

Returns

array

Exceptions

Exception

If the cell identified doesn't exist.

Implements SimpleExcel\Parser\IParser.

Definition at line 49 of file BaseParser.php.

References SimpleExcel\Exception\SimpleExcelException\CELL_NOT_FOUND, and SimpleExcel\Parser\BaseParser\isCellExists().

                                                                  {
        // check whether the cell exists
        if (!$this->isCellExists($row_num, $col_num)) {
            throw new \Exception('Cell '.$row_num.','.$col_num.' doesn\'t exist', SimpleExcelException::CELL_NOT_FOUND);
        }
        return $this->table_arr[$row_num-1][$col_num-1];
    }

Here is the call graph for this function:

getColumn()

SimpleExcel\Parser\BaseParser::getColumn	(		$col_num,
			$val_only = TRUE
	)

Get data of the specified column as an array.

Parameters

int	$col_num	Column number
bool	$val_only

Returns

array

Exceptions

Exception

If the column requested doesn't exist.

Implements SimpleExcel\Parser\IParser.

Definition at line 65 of file BaseParser.php.

References $row, SimpleExcel\Exception\SimpleExcelException\COLUMN_NOT_FOUND, and SimpleExcel\Parser\BaseParser\isColumnExists().

                                                          {
        $col_arr = array();

        if(!$this->isColumnExists($col_num)){
            throw new \Exception('Column '.$col_num.' doesn\'t exist', SimpleExcelException::COLUMN_NOT_FOUND);
        }

        // get the specified column within every row
        foreach($this->table_arr as $row){
            array_push($col_arr, $row[$col_num-1]);
        }

        // return the array
        return $col_arr;
    }

Here is the call graph for this function:

getField()

SimpleExcel\Parser\BaseParser::getField

(

$val_only = TRUE

)

Get data of all cells as an array.

Parameters

bool

$val_only

Returns

array

Exceptions

Exception

If the field is not set.

Implements SimpleExcel\Parser\IParser.

Definition at line 88 of file BaseParser.php.

References SimpleExcel\Parser\BaseParser\$table_arr, SimpleExcel\Exception\SimpleExcelException\FIELD_NOT_FOUND, and SimpleExcel\Parser\BaseParser\isFieldExists().

                                               {
        if(!$this->isFieldExists()){
            throw new \Exception('Field is not set', SimpleExcelException::FIELD_NOT_FOUND);
        }
        
        // return the array
        return $this->table_arr;
    }

Here is the call graph for this function:

getRow()

SimpleExcel\Parser\BaseParser::getRow	(		$row_num,
			$val_only = TRUE
	)

Get data of the specified row as an array.

Parameters

int	$row_num	Row number
bool	$val_only

Returns

array

Exceptions

Exception

When a row is requested that doesn't exist.

Implements SimpleExcel\Parser\IParser.

Definition at line 105 of file BaseParser.php.

References SimpleExcel\Parser\BaseParser\isRowExists(), and SimpleExcel\Exception\SimpleExcelException\ROW_NOT_FOUND.

                                                       {
        if(!$this->isRowExists($row_num)){
            throw new \Exception('Row '.$row_num.' doesn\'t exist', SimpleExcelException::ROW_NOT_FOUND);
        }

        // return the array
        return $this->table_arr[$row_num-1];
    }

Here is the call graph for this function:

isCellExists()

SimpleExcel\Parser\BaseParser::isCellExists	(		$row_num,
			$col_num
	)

Check whether cell with specified row & column exists.

Parameters

int	$row_num	Row number
int	$col_num	Column number

Returns

bool

Implements SimpleExcel\Parser\IParser.

Definition at line 121 of file BaseParser.php.

References SimpleExcel\Parser\BaseParser\isColumnExists(), and SimpleExcel\Parser\BaseParser\isRowExists().

Referenced by SimpleExcel\Parser\BaseParser\getCell(), and SimpleExcel\Parser\XMLParser\getCell().

                                                    {
        return $this->isRowExists($row_num) && $this->isColumnExists($col_num);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isColumnExists()

SimpleExcel\Parser\BaseParser::isColumnExists

(

$col_num

)

Check whether a specified column exists.

Parameters

int

$col_num

Column number

Returns

bool

Implements SimpleExcel\Parser\IParser.

Definition at line 131 of file BaseParser.php.

References $row.

Referenced by SimpleExcel\Parser\BaseParser\getColumn(), and SimpleExcel\Parser\BaseParser\isCellExists().

                                            {
        $exist = false;
        foreach($this->table_arr as $row){
            if(array_key_exists($col_num-1, $row)){
                $exist = true;
            }
        }
        return $exist;
    }

Here is the caller graph for this function:

isFieldExists()

SimpleExcel\Parser\BaseParser::isFieldExists

(

)

Check whether table exists.

Returns

bool

Implements SimpleExcel\Parser\IParser.

Definition at line 156 of file BaseParser.php.

Referenced by SimpleExcel\Parser\BaseParser\getField(), and SimpleExcel\Parser\XMLParser\getField().

                                   {
        return isset($this->table_arr);
    }

Here is the caller graph for this function:

isFileReady()

SimpleExcel\Parser\BaseParser::isFileReady

(

$file_path

)

Check whether file exists, valid, and readable.

Parameters

string

$file_path

Path to file

Returns

bool

Exceptions

Exception	If file being loaded doesn't exist
Exception	If file extension doesn't match
Exception	If error reading the file

Implements SimpleExcel\Parser\IParser.

Definition at line 169 of file BaseParser.php.

References SimpleExcel\Parser\BaseParser\$file_extension, SimpleExcel\Exception\SimpleExcelException\ERROR_READING_FILE, SimpleExcel\Exception\SimpleExcelException\FILE_EXTENSION_MISMATCH, and SimpleExcel\Exception\SimpleExcelException\FILE_NOT_FOUND.

Referenced by SimpleExcel\Parser\JSONParser\loadFile(), SimpleExcel\Parser\CSVParser\loadFile(), SimpleExcel\Parser\HTMLParser\loadFile(), and SimpleExcel\Parser\XMLParser\loadFile().

                                            {
    
        // file exists?
        if (!file_exists($file_path)) {
        
            throw new \Exception('File '.$file_path.' doesn\'t exist', SimpleExcelException::FILE_NOT_FOUND);
        
        // extension valid?
        } else if (strtoupper(pathinfo($file_path, PATHINFO_EXTENSION))!= strtoupper($this->file_extension)){

            throw new \Exception('File extension '.$file_extension.' doesn\'t match with '.$this->file_extension, SimpleExcelException::FILE_EXTENSION_MISMATCH);
        
        // file readable?
        } else if (($handle = fopen($file_path, 'r')) === FALSE) {            
        
            throw new \Exception('Error reading the file in'.$file_path, SimpleExcelException::ERROR_READING_FILE);
            fclose($handle);

        // okay then
        } else {
            
            return TRUE;
        }
    }

Here is the caller graph for this function:

isRowExists()

SimpleExcel\Parser\BaseParser::isRowExists

(

$row_num

)

Check whether a specified row exists.

Parameters

int

$row_num

Row number

Returns

bool

Implements SimpleExcel\Parser\IParser.

Definition at line 147 of file BaseParser.php.

Referenced by SimpleExcel\Parser\BaseParser\getRow(), and SimpleExcel\Parser\BaseParser\isCellExists().

                                         {
        return array_key_exists($row_num-1, $this->table_arr);
    }

Here is the caller graph for this function:

Field Documentation

$file_extension

SimpleExcel\Parser\BaseParser::$file_extension = ''

protected

Definition at line 29 of file BaseParser.php.

Referenced by SimpleExcel\Parser\BaseParser\isFileReady().

$table_arr

SimpleExcel\Parser\BaseParser::$table_arr

protected

Definition at line 21 of file BaseParser.php.

Referenced by SimpleExcel\Parser\BaseParser\getField(), and SimpleExcel\Parser\XMLParser\getField().

---

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

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