Inheritance diagram for SimpleExcel\Parser\XMLParser:

Collaboration diagram for SimpleExcel\Parser\XMLParser:

Public Member Functions
	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...

	isColumnExists ($col_num)
	Check whether a specified column exists. More...

	isRowExists ($row_num)
	Check whether a specified row exists. More...

	loadFile ($file_path)
	Load the XML file to be parsed. More...

	loadString ($str)
	Load the string to be parsed. 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...

Protected Attributes
	$file_extension = 'xml'

Protected Attributes inherited from SimpleExcel\Parser\BaseParser
	$table_arr

	$file_extension = ''

Private Member Functions
	getAttributes ($attrs_obj)
	Extract attributes from SimpleXMLElement object. More...

	parseDOM ($xml)
	Process the loaded file/string. More...

Detailed Description

Definition at line 13 of file XMLParser.php.

Member Function Documentation

◆ getAttributes()

SimpleExcel\Parser\XMLParser::getAttributes ( $attrs_obj )

private

Extract attributes from SimpleXMLElement object.

private

Parameters

object $attrs_obj

Returns: array

Definition at line 30 of file XMLParser.php.

Referenced by SimpleExcel\Parser\XMLParser\parseDOM().

                                                {
         $attrs_arr = array();
         foreach ($attrs_obj as $attrs) {
             $attrs = (array) $attrs;
             foreach ($attrs as $attr) {
                 $attr_keys = array_keys($attr);
                 $attrs_arr[$attr_keys[0]] = $attr[$attr_keys[0]];
             }
         }
         return $attrs_arr;
     }

Here is the caller graph for this function:

◆ getCell()

SimpleExcel\Parser\XMLParser::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	Whether returns only it's value or complete data

Returns: array

Exceptions

Exception If the cell identified doesn't exist.

Implements SimpleExcel\Parser\IParser.

Definition at line 51 of file XMLParser.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);
         }
         if(is_array($this->table_arr['table_contents'][$row_num-1]['row_contents'])){
             if(array_key_exists($col_num-1, $this->table_arr['table_contents'][$row_num-1]['row_contents'])){
                 $cell = $this->table_arr['table_contents'][$row_num-1]['row_contents'][$col_num-1];
                 if(!$val_only){
                     return $cell;
                 } else {
                     return $cell['value'];
                 }
             }
         }
         return "";
     }

Here is the call graph for this function:

◆ getColumn()

SimpleExcel\Parser\XMLParser::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 (value only \| complete data) for every cell, default to TRUE

Returns: array

Exceptions

Exception If the column requested doesn't exist.

Implements SimpleExcel\Parser\IParser.

Definition at line 77 of file XMLParser.php.

References $row, SimpleExcel\Exception\SimpleExcelException\COLUMN_NOT_FOUND, and SimpleExcel\Parser\XMLParser\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['table_contents'] as $row) {
             if ($row['row_contents']) {
                 if(!$val_only) {
                     array_push($col_arr, $row['row_contents'][$col_num-1]);
                 } else {
                     array_push($col_arr, $row['row_contents'][$col_num-1]['value']);
                 }
             } else {
                 array_push($col_arr, "");
             }
         }
 
         // return the array
         return $col_arr;
     }

Here is the call graph for this function:

◆ getField()

SimpleExcel\Parser\XMLParser::getField ( $val_only = TRUE )

Get data of all cells as an array.

Parameters

bool $val_only Returns (value only | complete data) for every cell, default to TRUE

Returns: array

Exceptions

Exception If the field is not set.

Implements SimpleExcel\Parser\IParser.

Definition at line 108 of file XMLParser.php.

References $row, 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);           
         }
         if($val_only){
             $field = array();
             foreach($this->table_arr['table_contents'] as $row){
                 $cells = array();
                 if($row['row_contents']){
                     foreach($row['row_contents'] as $cell){
                         array_push($cells, $cell['value']);
                     }
                 }
                 array_push($field, $cells);
             }
             return $field;
         } else {
             return $this->table_arr;
         }
     }

Here is the call graph for this function:

◆ getRow()

SimpleExcel\Parser\XMLParser::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 (value only \| complete data) for every cell, default to TRUE

Returns: array

Exceptions

Exception When a row is requested that doesn't exist.

Implements SimpleExcel\Parser\IParser.

Definition at line 137 of file XMLParser.php.

References $row, SimpleExcel\Parser\XMLParser\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);
         }
         $row = $this->table_arr['table_contents'][$row_num-1]['row_contents'];
         $row_arr = array();
 
         // get the specified column within every row 
         foreach ($row as $cell) {
             if (!$val_only) {
                 array_push($row_arr, $cell);
             } else {
                 array_push($row_arr, $cell['value']);
             }
         }
 
         // return the array, if empty then return FALSE
         return $row_arr;
     }

Here is the call graph for this function:

◆ isColumnExists()

SimpleExcel\Parser\XMLParser::isColumnExists ( $col_num )

Check whether a specified column exists.

Parameters

int $col_num Column number

Returns: bool

Implements SimpleExcel\Parser\IParser.

Definition at line 163 of file XMLParser.php.

References $row.

Referenced by SimpleExcel\Parser\XMLParser\getColumn().

                                             {
         $exist = false;
         foreach($this->table_arr['table_contents'] as $row){
             if(is_array($row['row_contents'])){
                 if(array_key_exists($col_num-1, $row['row_contents'])){
                     $exist = true;
                 }
             }
         }
         return $exist;
     }

Here is the caller graph for this function:

◆ isRowExists()

SimpleExcel\Parser\XMLParser::isRowExists ( $row_num )

Check whether a specified row exists.

Parameters

int $row_num Row number

Returns: bool

Implements SimpleExcel\Parser\IParser.

Definition at line 181 of file XMLParser.php.

Referenced by SimpleExcel\Parser\XMLParser\getRow().

                                          {
         return array_key_exists($row_num-1, $this->table_arr['table_contents']);
     }

Here is the caller graph for this function:

◆ loadFile()

SimpleExcel\Parser\XMLParser::loadFile ( $file_path )

Load the XML file to be parsed.

Parameters

string $file_path Path to XML file

Returns: bool

Implements SimpleExcel\Parser\IParser.

Definition at line 303 of file XMLParser.php.

References SimpleExcel\Parser\BaseParser\isFileReady(), and SimpleExcel\Parser\XMLParser\parseDOM().

                                          {
     
         if (!$this->isFileReady($file_path)) {
             return false;
         }
 
         return $this->parseDOM(simplexml_load_file($file_path));
     }

Here is the call graph for this function:

◆ loadString()

SimpleExcel\Parser\XMLParser::loadString ( $str )

Load the string to be parsed.

Parameters

string $str String with XML format

Returns: bool

Implements SimpleExcel\Parser\IParser.

Definition at line 318 of file XMLParser.php.

References SimpleExcel\Parser\XMLParser\parseDOM().

                                     {
         return $this->parseDOM(simplexml_load_string($str));
     }

Here is the call graph for this function:

◆ parseDOM()

SimpleExcel\Parser\XMLParser::parseDOM ( $xml )

private

Process the loaded file/string.

Parameters

SimpleXMLElement $xml SimpleXMLElement object of XML

Exceptions

Exception If document namespace invalid

Returns: bool

Definition at line 192 of file XMLParser.php.

References $row, SimpleExcel\Parser\XMLParser\getAttributes(), and SimpleExcel\Exception\SimpleExcelException\INVALID_DOCUMENT_NAMESPACE.

Referenced by SimpleExcel\Parser\XMLParser\loadFile(), and SimpleExcel\Parser\XMLParser\loadString().

                                    {
     
         // get XML namespace
         $xmlns = $xml->getDocNamespaces();
 
         // check file extension and XML namespace
         if ($xmlns['ss'] != 'urn:schemas-microsoft-com:office:spreadsheet') {
             throw new \Exception('Document namespace isn\'t a valid Excel XML 2003 Spreadsheet', SimpleExcelException::INVALID_DOCUMENT_NAMESPACE);
         }
 
         // extract document properties
         $doc_props = (array)$xml->DocumentProperties;
         $this->table_arr['doc_props'] = $doc_props;
 
         $rows = $xml->Worksheet->Table->Row;
         $row_num = 1;
         $this->table_arr = array(
             'doc_props' => array(),
             'table_contents' => array()
         );
 
         // loop through all rows
         foreach ($rows as $row) {
 
             // check whether ss:Index attribute exist in this row
             $row_index = $row->xpath('@ss:Index');
 
             // if exist, push empty value until the specified index
             if (count($row_index) > 0) {
                 $gap = $row_index[0]-count($this->table_arr['table_contents']);
                 for($i = 1; $i < $gap; $i++){
                     array_push($this->table_arr['table_contents'], array(
                         'row_num' => $row_num,
                         'row_contents' => '',
                         //'row_attrs' => $row_attrs_arr
                     ));
                     $row_num += 1;
                 }
             }
 
             $cells = $row->Cell;
             $row_attrs = $row->xpath('@ss:*');
             $row_attrs_arr = $this->getAttributes($row_attrs);
             $row_arr = array();
             $col_num = 1;
 
             // loop through all row's cells
             foreach ($cells as $cell) { 
 
                 // check whether ss:Index attribute exist
                 $cell_index = $cell->xpath('@ss:Index');
 
                 // if exist, push empty value until the specified index
                 if (count($cell_index) > 0) {
                     $gap = $cell_index[0]-count($row_arr);
                     for ($i = 1; $i < $gap; $i++) {
                         array_push ($row_arr, array(
                             'row_num' => $row_num,
                             'col_num' => $col_num,
                             'datatype' => '',
                             'value' => '',
                             //'cell_attrs' => '',
                             //'data_attrs' => ''
                         ));
                         $col_num += 1;
                     }
                 }
 
                 // get all cell and data attributes
                 //$cell_attrs = $cell->xpath('@ss:*');
                 //$cell_attrs_arr = $this->getAttributes($cell_attrs);
                 $data_attrs = $cell->Data->xpath('@ss:*');
                 $data_attrs_arr = $this->getAttributes($data_attrs);
                 $cell_datatype = $data_attrs_arr['Type']; 
 
                 // extract data from cell
                 $cell_value = (string) $cell->Data;
 
                 // escape input from HTML tags
                 $cell_value = filter_var($cell_value, FILTER_SANITIZE_SPECIAL_CHARS);
 
                 // push column array
                 array_push($row_arr, array(
                     'row_num' => $row_num,
                     'col_num' => $col_num,
                     'datatype' => $cell_datatype,
                     'value' => $cell_value,
                     //'cell_attrs' => $cell_attrs_arr,
                     //'data_attrs' => $data_attrs_arr
                 ));
                 $col_num += 1;
             }
 
             // push row array
             array_push($this->table_arr['table_contents'], array(
                 'row_num' => $row_num,
                 'row_contents' => $row_arr,
                 //'row_attrs' => $row_attrs_arr
             ));
             $row_num += 1;
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $file_extension

SimpleExcel\Parser\XMLParser::$file_extension = 'xml'

protected

Definition at line 21 of file XMLParser.php.

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

Modules/DataCollection/libs/SimpleExcel/Parser/XMLParser.php

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ getAttributes()

◆ getCell()

◆ getColumn()

◆ getField()

◆ getRow()

◆ isColumnExists()

◆ isRowExists()

◆ loadFile()

◆ loadString()

◆ parseDOM()

Field Documentation

◆ $file_extension