324 lines
10 KiB
PHP
324 lines
10 KiB
PHP
<?php
|
|
|
|
namespace SimpleExcel\Parser;
|
|
|
|
use SimpleExcel\Exception\SimpleExcelException;
|
|
|
|
/**
|
|
* SimpleExcel class for parsing Microsoft Excel 2003 XML Spreadsheet
|
|
*
|
|
* @author Faisalman
|
|
* @package SimpleExcel
|
|
*/
|
|
class XMLParser extends BaseParser implements IParser
|
|
{
|
|
/**
|
|
* Defines valid file extension
|
|
*
|
|
* @access protected
|
|
* @var string
|
|
*/
|
|
protected $file_extension = 'xml';
|
|
|
|
/**
|
|
* Extract attributes from SimpleXMLElement object
|
|
*
|
|
* @access private
|
|
* @param object $attrs_obj
|
|
* @return array
|
|
*/
|
|
private function getAttributes($attrs_obj) {
|
|
$attrs_arr = array();
|
|
if (!$attrs_obj) {
|
|
return $attrs_arr;
|
|
}
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Get value of the specified cell
|
|
*
|
|
* @param int $row_num Row number
|
|
* @param int $col_num Column number
|
|
* @param int $val_only Whether returns only it's value or complete data
|
|
* @return array
|
|
* @throws Exception If the cell identified doesn't exist.
|
|
*/
|
|
public function getCell($row_num, $col_num, $val_only = true) {
|
|
// 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 "";
|
|
}
|
|
|
|
/**
|
|
* Get data of the specified column as an array
|
|
*
|
|
* @param int $col_num Column number
|
|
* @param bool $val_only Returns (value only | complete data) for every cell, default to TRUE
|
|
* @return array
|
|
* @throws Exception If the column requested doesn't exist.
|
|
*/
|
|
public function getColumn($col_num, $val_only = TRUE) {
|
|
$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;
|
|
}
|
|
|
|
/**
|
|
* Get data of all cells as an array
|
|
*
|
|
* @param bool $val_only Returns (value only | complete data) for every cell, default to TRUE
|
|
* @return array
|
|
* @throws Exception If the field is not set.
|
|
*/
|
|
public function getField($val_only = TRUE) {
|
|
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;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get data of the specified row as an array
|
|
*
|
|
* @param int $row_num Row number
|
|
* @param bool $val_only Returns (value only | complete data) for every cell, default to TRUE
|
|
* @return array
|
|
* @throws Exception When a row is requested that doesn't exist.
|
|
*/
|
|
public function getRow($row_num, $val_only = TRUE) {
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Check whether a specified column exists
|
|
*
|
|
* @param int $col_num Column number
|
|
* @return bool
|
|
*/
|
|
public function isColumnExists($col_num){
|
|
$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;
|
|
}
|
|
|
|
/**
|
|
* Check whether a specified row exists
|
|
*
|
|
* @param int $row_num Row number
|
|
* @return bool
|
|
*/
|
|
public function isRowExists($row_num){
|
|
return array_key_exists($row_num-1, $this->table_arr['table_contents']);
|
|
}
|
|
|
|
/**
|
|
* Process the loaded file/string
|
|
*
|
|
* @param SimpleXMLElement $xml SimpleXMLElement object of XML
|
|
* @throws Exception If document namespace invalid
|
|
* @return bool
|
|
*/
|
|
private function parseDOM($xml){
|
|
|
|
// 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 = isset($data_attrs_arr['Type']) ? $data_attrs_arr['Type'] : 'String';
|
|
|
|
// 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;
|
|
}
|
|
|
|
/**
|
|
* Load the XML file to be parsed
|
|
*
|
|
* @param string $file_path Path to XML file
|
|
* @return bool
|
|
*/
|
|
public function loadFile($file_path) {
|
|
|
|
if (!$this->isFileReady($file_path)) {
|
|
return false;
|
|
}
|
|
|
|
return $this->parseDOM(simplexml_load_file($file_path));
|
|
}
|
|
|
|
/**
|
|
* Load the string to be parsed
|
|
*
|
|
* @param string $str String with XML format
|
|
* @return bool
|
|
*/
|
|
public function loadString($str){
|
|
return $this->parseDOM(simplexml_load_string($str));
|
|
}
|
|
}
|