PHPExcel_Reader_HTML Class Reference

Inheritance diagram for PHPExcel_Reader_HTML:

Collaboration diagram for PHPExcel_Reader_HTML:

Public Member Functions
	__construct ()
	Create a new PHPExcel_Reader_HTML. More...
	load ($pFilename)
	Loads PHPExcel from file. More...
	setInputEncoding ($pValue='ANSI')
	Set input encoding. More...
	getInputEncoding ()
	Get input encoding. More...
	loadIntoExisting ($pFilename, PHPExcel $objPHPExcel)
	Loads PHPExcel from file into PHPExcel instance. More...
	getSheetIndex ()
	Get sheet index. More...
	setSheetIndex ($pValue=0)
	Set sheet index. More...
	securityScan ($xml)
	Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks. More...
Public Member Functions inherited from PHPExcel_Reader_Abstract
	getReadDataOnly ()
	Read data only? If this is true, then the Reader will only read data values for cells, it will not read any formatting information. More...
	setReadDataOnly ($pValue=FALSE)
	Set read data only Set to true, to advise the Reader only to read data values for cells, and to ignore any formatting information. More...
	getIncludeCharts ()
	Read charts in workbook? If this is true, then the Reader will include any charts that exist in the workbook. More...
	setIncludeCharts ($pValue=FALSE)
	Set read charts in workbook Set to true, to advise the Reader to include any charts that exist in the workbook. More...
	getLoadSheetsOnly ()
	Get which sheets to load Returns either an array of worksheet names (the list of worksheets that should be loaded), or a null indicating that all worksheets in the workbook should be loaded. More...
	setLoadSheetsOnly ($value=NULL)
	Set which sheets to load. More...
	setLoadAllSheets ()
	Set all sheets to load Tells the Reader to load all worksheets from the workbook. More...
	getReadFilter ()
	Read filter. More...
	setReadFilter (PHPExcel_Reader_IReadFilter $pValue)
	Set read filter. More...
	canRead ($pFilename)
	Can the current PHPExcel_Reader_IReader read the file? More...
	securityScan ($xml)
	Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks. More...
	securityScanFile ($filestream)
	Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks. More...
	canRead ($pFilename)
	Can the current PHPExcel_Reader_IReader read the file? More...
	load ($pFilename)

Protected Member Functions
	_isValidFormat ()
	Validate that the current file is an HTML file. More...
	_setTableStartColumn ($column)
	_getTableStartColumn ()
	_releaseTableStartColumn ()
	_flushCell ($sheet, $column, $row, &$cellContent)
	_processDomElement (DOMNode $element, $sheet, &$row, &$column, &$cellContent, $format=null)
Protected Member Functions inherited from PHPExcel_Reader_Abstract
	_openFile ($pFilename)
	Open file for reading. More...

Protected Attributes
	$_inputEncoding = 'ANSI'
	$_sheetIndex = 0
	$_formats
	$rowspan = array()
	$_dataArray = array()
	$_tableLevel = 0
	$_nestedColumn = array('A')
Protected Attributes inherited from PHPExcel_Reader_Abstract
	$_readDataOnly = FALSE
	$_includeCharts = FALSE
	$_loadSheetsOnly = NULL
	$_readFilter = NULL
	$_fileHandle = NULL

Detailed Description

Definition at line 44 of file HTML.php.

Constructor & Destructor Documentation

__construct()

PHPExcel_Reader_HTML::__construct

(

)

Create a new PHPExcel_Reader_HTML.

Definition at line 109 of file HTML.php.

    {
        $this->_readFilter = new PHPExcel_Reader_DefaultReadFilter();
    }

Member Function Documentation

_flushCell()

PHPExcel_Reader_HTML::_flushCell (   $sheet,   $column,   $row, &  $cellContent  )

protected

Definition at line 196 of file HTML.php.

    {
        if (is_string($cellContent)) {
            //  Simple String content
            if (trim($cellContent) > '') {
                //      Only actually write it if there's content in the string
//                              echo 'FLUSH CELL: ' , $column , $row , ' => ' , $cellContent , '<br />';
                //      Write to worksheet to be done here...
                //      ... we return the cell so we can mess about with styles more easily
                $sheet->setCellValue($column . $row, $cellContent, true);
                $this->_dataArray[$row][$column] = $cellContent;
            }
        } else {
            //  We have a Rich Text run
            //  TODO
            $this->_dataArray[$row][$column] = 'RICH TEXT: ' . $cellContent;
        }
        $cellContent = (string) '';
    }

References $column, and $row.

Referenced by _processDomElement().

Here is the caller graph for this function:

_getTableStartColumn()

PHPExcel_Reader_HTML::_getTableStartColumn ( )

protected

Definition at line 184 of file HTML.php.

    {
        return $this->_nestedColumn[$this->_tableLevel];
    }

References $_tableLevel.

Referenced by _processDomElement().

Here is the caller graph for this function:

_isValidFormat()

PHPExcel_Reader_HTML::_isValidFormat ( )

protected

Validate that the current file is an HTML file.

Returns

boolean

Definition at line 119 of file HTML.php.

    {
        //      Reading 2048 bytes should be enough to validate that the format is HTML
        $data = fread($this->_fileHandle, 2048);
        if ((strpos($data, '<') !== FALSE) &&
                (strlen($data) !== strlen(strip_tags($data)))) {
            return TRUE;
        }
 
        return FALSE;
    }

References $data.

Referenced by loadIntoExisting().

Here is the caller graph for this function:

_processDomElement()

PHPExcel_Reader_HTML::_processDomElement ( DOMNode  $element,   $sheet, &  $row, &  $column, &  $cellContent,   $format = null  )

protected

Definition at line 216 of file HTML.php.

    {
        foreach ($element->childNodes as $child) {
            if ($child instanceof DOMText) {
                $domText = preg_replace('/\s+/u', ' ', trim($child->nodeValue));
                if (is_string($cellContent)) {
                    //  simply append the text if the cell content is a plain text string
                    $cellContent .= $domText;
                } else {
                    //  but if we have a rich text run instead, we need to append it correctly
                    //  TODO
                }
            } elseif ($child instanceof DOMElement) {
//                              echo '<b>DOM ELEMENT: </b>' , strtoupper($child->nodeName) , '<br />';
 
                $attributeArray = array();
                foreach ($child->attributes as $attribute) {
//                                      echo '<b>ATTRIBUTE: </b>' , $attribute->name , ' => ' , $attribute->value , '<br />';
                    $attributeArray[$attribute->name] = $attribute->value;
                }
 
                switch ($child->nodeName) {
                    case 'meta' :
                        foreach ($attributeArray as $attributeName => $attributeValue) {
                            switch ($attributeName) {
                                case 'content':
                                    //  TODO
                                    //  Extract character set, so we can convert to UTF-8 if required
                                    break;
                            }
                        }
                        $this->_processDomElement($child, $sheet, $row, $column, $cellContent);
                        break;
                    case 'title' :
                        $this->_processDomElement($child, $sheet, $row, $column, $cellContent);
                        $sheet->setTitle($cellContent);
                        $cellContent = '';
                        break;
                    case 'span' :
                    case 'div' :
                    case 'font' :
                    case 'i' :
                    case 'em' :
                    case 'strong':
                    case 'b' :
//                                              echo 'STYLING, SPAN OR DIV<br />';
                        if ($cellContent > '')
                            $cellContent .= ' ';
                        $this->_processDomElement($child, $sheet, $row, $column, $cellContent);
                        if ($cellContent > '')
                            $cellContent .= ' ';
//                                              echo 'END OF STYLING, SPAN OR DIV<br />';
                        break;
                    case 'hr' :
                        $this->_flushCell($sheet, $column, $row, $cellContent);
                        ++$row;
                        if (isset($this->_formats[$child->nodeName])) {
                            $sheet->getStyle($column . $row)->applyFromArray($this->_formats[$child->nodeName]);
                        } else {
                            $cellContent = '----------';
                            $this->_flushCell($sheet, $column, $row, $cellContent);
                        }
                        ++$row;
                    case 'br' :
                        if ($this->_tableLevel > 0) {
                            //  If we're inside a table, replace with a \n
                            $cellContent .= "\n";
                        } else {
                            //  Otherwise flush our existing content and move the row cursor on
                            $this->_flushCell($sheet, $column, $row, $cellContent);
                            ++$row;
                        }
//                                              echo 'HARD LINE BREAK: ' , '<br />';
                        break;
                    case 'a' :
//                                              echo 'START OF HYPERLINK: ' , '<br />';
                        foreach ($attributeArray as $attributeName => $attributeValue) {
                            switch ($attributeName) {
                                case 'href':
//                                                                      echo 'Link to ' , $attributeValue , '<br />';
                                    $sheet->getCell($column . $row)->getHyperlink()->setUrl($attributeValue);
                                    if (isset($this->_formats[$child->nodeName])) {
                                        $sheet->getStyle($column . $row)->applyFromArray($this->_formats[$child->nodeName]);
                                    }
                                    break;
                            }
                        }
                        $cellContent .= ' ';
                        $this->_processDomElement($child, $sheet, $row, $column, $cellContent);
//                                              echo 'END OF HYPERLINK:' , '<br />';
                        break;
                    case 'h1' :
                    case 'h2' :
                    case 'h3' :
                    case 'h4' :
                    case 'h5' :
                    case 'h6' :
                    case 'ol' :
                    case 'ul' :
                    case 'p' :
                        if ($this->_tableLevel > 0) {
                            //  If we're inside a table, replace with a \n
                            $cellContent .= "\n";
//                                                      echo 'LIST ENTRY: ' , '<br />';
                            $this->_processDomElement($child, $sheet, $row, $column, $cellContent);
//                                                      echo 'END OF LIST ENTRY:' , '<br />';
                        } else {
                            if ($cellContent > '') {
                                $this->_flushCell($sheet, $column, $row, $cellContent);
                                $row++;
                            }
//                                                      echo 'START OF PARAGRAPH: ' , '<br />';
                            $this->_processDomElement($child, $sheet, $row, $column, $cellContent);
//                                                      echo 'END OF PARAGRAPH:' , '<br />';
                            $this->_flushCell($sheet, $column, $row, $cellContent);
 
                            if (isset($this->_formats[$child->nodeName])) {
                                $sheet->getStyle($column . $row)->applyFromArray($this->_formats[$child->nodeName]);
                            }
 
                            $row++;
                            $column = 'A';
                        }
                        break;
                    case 'li' :
                        if ($this->_tableLevel > 0) {
                            //  If we're inside a table, replace with a \n
                            $cellContent .= "\n";
//                                                      echo 'LIST ENTRY: ' , '<br />';
                            $this->_processDomElement($child, $sheet, $row, $column, $cellContent);
//                                                      echo 'END OF LIST ENTRY:' , '<br />';
                        } else {
                            if ($cellContent > '') {
                                $this->_flushCell($sheet, $column, $row, $cellContent);
                            }
                            ++$row;
//                                                      echo 'LIST ENTRY: ' , '<br />';
                            $this->_processDomElement($child, $sheet, $row, $column, $cellContent);
//                                                      echo 'END OF LIST ENTRY:' , '<br />';
                            $this->_flushCell($sheet, $column, $row, $cellContent);
                            $column = 'A';
                        }
                        break;
                    case 'table' :
                        $this->_flushCell($sheet, $column, $row, $cellContent);
                        $column = $this->_setTableStartColumn($column);
//                                              echo 'START OF TABLE LEVEL ' , $this->_tableLevel , '<br />';
                        if ($this->_tableLevel > 1)
                            --$row;
                        $this->_processDomElement($child, $sheet, $row, $column, $cellContent);
//                                              echo 'END OF TABLE LEVEL ' , $this->_tableLevel , '<br />';
                        $column = $this->_releaseTableStartColumn();
                        if ($this->_tableLevel > 1) {
                            ++$column;
                        } else {
                            ++$row;
                        }
                        break;
                    case 'thead' :
                    case 'tbody' :
                        $this->_processDomElement($child, $sheet, $row, $column, $cellContent);
                        break;
                    case 'tr' :
                        $column = $this->_getTableStartColumn();
                        $cellContent = '';
//                                              echo 'START OF TABLE ' , $this->_tableLevel , ' ROW<br />';
                        $this->_processDomElement($child, $sheet, $row, $column, $cellContent);
                        ++$row;
//                                              echo 'END OF TABLE ' , $this->_tableLevel , ' ROW<br />';
                        break;
                    case 'th' :
                    case 'td' :
//                                              echo 'START OF TABLE ' , $this->_tableLevel , ' CELL<br />';
                        $this->_processDomElement($child, $sheet, $row, $column, $cellContent);
//                                              echo 'END OF TABLE ' , $this->_tableLevel , ' CELL<br />';
 
                        while (isset($this->rowspan[$column . $row])) {
                            ++$column;
                        }
 
                        $this->_flushCell($sheet, $column, $row, $cellContent);
 
//                        if (isset($attributeArray['style']) && !empty($attributeArray['style'])) {
//                            $styleAry = $this->getPhpExcelStyleArray($attributeArray['style']);
//
//                            if (!empty($styleAry)) {
//                                $sheet->getStyle($column . $row)->applyFromArray($styleAry);
//                            }
//                        }
 
                        if (isset($attributeArray['rowspan']) && isset($attributeArray['colspan'])) {
                            //create merging rowspan and colspan
                            $columnTo = $column;
                            for ($i = 0; $i < $attributeArray['colspan'] - 1; $i++) {
                                ++$columnTo;
                            }
                            $range = $column . $row . ':' . $columnTo . ($row + $attributeArray['rowspan'] - 1);
                            foreach (\PHPExcel_Cell::extractAllCellReferencesInRange($range) as $value) {
                                $this->rowspan[$value] = true;
                            }
                            $sheet->mergeCells($range);
                            $column = $columnTo;
                        } elseif (isset($attributeArray['rowspan'])) {
                            //create merging rowspan
                            $range = $column . $row . ':' . $column . ($row + $attributeArray['rowspan'] - 1);
                            foreach (\PHPExcel_Cell::extractAllCellReferencesInRange($range) as $value) {
                                $this->rowspan[$value] = true;
                            }
                            $sheet->mergeCells($range);
                        } elseif (isset($attributeArray['colspan'])) {
                            //create merging colspan
                            $columnTo = $column;
                            for ($i = 0; $i < $attributeArray['colspan'] - 1; $i++) {
                                ++$columnTo;
                            }
                            $sheet->mergeCells($column . $row . ':' . $columnTo . $row);
                            $column = $columnTo;
                        }
                        ++$column;
                        break;
                    case 'body' :
                        $row = 1;
                        $column = 'A';
                        $content = '';
                        $this->_tableLevel = 0;
                        $this->_processDomElement($child, $sheet, $row, $column, $cellContent);
                        break;
                    default:
                        $this->_processDomElement($child, $sheet, $row, $column, $cellContent);
                }
            }
        }
    }

References $column, $row, _flushCell(), _getTableStartColumn(), _processDomElement(), _releaseTableStartColumn(), _setTableStartColumn(), and PHPExcel_Cell\extractAllCellReferencesInRange().

Referenced by _processDomElement(), and loadIntoExisting().

Here is the call graph for this function:

Here is the caller graph for this function:

_releaseTableStartColumn()

PHPExcel_Reader_HTML::_releaseTableStartColumn ( )

protected

Definition at line 189 of file HTML.php.

    {
        --$this->_tableLevel;
 
        return array_pop($this->_nestedColumn);
    }

References $_tableLevel.

Referenced by _processDomElement().

Here is the caller graph for this function:

_setTableStartColumn()

PHPExcel_Reader_HTML::_setTableStartColumn (   $column )

protected

Definition at line 174 of file HTML.php.

    {
        if ($this->_tableLevel == 0)
            $column = 'A';
        ++$this->_tableLevel;
        $this->_nestedColumn[$this->_tableLevel] = $column;
 
        return $this->_nestedColumn[$this->_tableLevel];
    }

References $_tableLevel, and $column.

Referenced by _processDomElement().

Here is the caller graph for this function:

getInputEncoding()

PHPExcel_Reader_HTML::getInputEncoding

(

)

Get input encoding.

Returns

string

Definition at line 164 of file HTML.php.

    {
        return $this->_inputEncoding;
    }

References $_inputEncoding.

getSheetIndex()

PHPExcel_Reader_HTML::getSheetIndex

(

)

Get sheet index.

Returns

int

Definition at line 500 of file HTML.php.

    {
        return $this->_sheetIndex;
    }

References $_sheetIndex.

load()

PHPExcel_Reader_HTML::load

(

$pFilename

)

Loads PHPExcel from file.

Parameters

string

$pFilename

Returns

PHPExcel

Exceptions

PHPExcel_Reader_Exception

Implements PHPExcel_Reader_IReader.

Definition at line 138 of file HTML.php.

    {
        // Create new PHPExcel
        $objPHPExcel = new PHPExcel();
 
        // Load into this instance
        return $this->loadIntoExisting($pFilename, $objPHPExcel);
    }

References $objPHPExcel, and loadIntoExisting().

Here is the call graph for this function:

loadIntoExisting()

PHPExcel_Reader_HTML::loadIntoExisting	(		$pFilename,
		PHPExcel	$objPHPExcel
	)

Loads PHPExcel from file into PHPExcel instance.

Parameters

string	$pFilename
PHPExcel	$objPHPExcel

Returns

PHPExcel

Exceptions

PHPExcel_Reader_Exception

Definition at line 458 of file HTML.php.

    {
        // Open file to validate
        $this->_openFile($pFilename);
        if (!$this->_isValidFormat()) {
            fclose($this->_fileHandle);
            throw new PHPExcel_Reader_Exception($pFilename . " is an Invalid HTML file.");
        }
        //      Close after validating
        fclose($this->_fileHandle);
 
        // Create new PHPExcel
        while ($objPHPExcel->getSheetCount() <= $this->_sheetIndex) {
            $objPHPExcel->createSheet();
        }
        $objPHPExcel->setActiveSheetIndex($this->_sheetIndex);
 
        //      Create a new DOM object
        $dom = new domDocument;
        //      Reload the HTML file into the DOM object
        $loaded = $dom->loadHTML($this->securityScanFile($pFilename));
        if ($loaded === FALSE) {
            throw new PHPExcel_Reader_Exception('Failed to load ', $pFilename, ' as a DOM Document');
        }
 
        //      Discard white space
        $dom->preserveWhiteSpace = false;
 
        $row = 0;
        $column = 'A';
        $content = '';
        $this->_processDomElement($dom, $objPHPExcel->getActiveSheet(), $row, $column, $content);
 
                // Return
        return $objPHPExcel;
    }

References $column, $objPHPExcel, $row, _isValidFormat(), PHPExcel_Reader_Abstract\_openFile(), _processDomElement(), and PHPExcel_Reader_Abstract\securityScanFile().

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

securityScan()

PHPExcel_Reader_HTML::securityScan

(

$xml

)

Scan theXML for use of <!ENTITY to prevent XXE/XEE attacks.

Parameters

string

$xml

Exceptions

PHPExcel_Reader_Exception

Reimplemented from PHPExcel_Reader_Abstract.

Definition at line 524 of file HTML.php.

        {
        $pattern = '/\\0?' . implode('\\0?', str_split('<!ENTITY')) . '\\0?/';
        if (preg_match($pattern, $xml)) { 
            throw new PHPExcel_Reader_Exception('Detected use of ENTITY in XML, spreadsheet file load() aborted to prevent XXE/XEE attacks');
        }
        return $xml;
    }

setInputEncoding()

PHPExcel_Reader_HTML::setInputEncoding

(

$pValue = 'ANSI'

)

Set input encoding.

Parameters

string

$pValue

Input encoding

Definition at line 152 of file HTML.php.

    {
        $this->_inputEncoding = $pValue;
 
        return $this;
    }

setSheetIndex()

PHPExcel_Reader_HTML::setSheetIndex

(

$pValue = 0

)

Set sheet index.

Parameters

int

$pValue

Sheet index

Returns

PHPExcel_Reader_HTML

Definition at line 511 of file HTML.php.

    {
        $this->_sheetIndex = $pValue;
 
        return $this;
    }

Field Documentation

$_dataArray

PHPExcel_Reader_HTML::$_dataArray = array()

protected

Definition at line 170 of file HTML.php.

$_formats

PHPExcel_Reader_HTML::$_formats

protected

Definition at line 66 of file HTML.php.

$_inputEncoding

PHPExcel_Reader_HTML::$_inputEncoding = 'ANSI'

protected

Definition at line 52 of file HTML.php.

Referenced by getInputEncoding().

$_nestedColumn

PHPExcel_Reader_HTML::$_nestedColumn = array('A')

protected

Definition at line 172 of file HTML.php.

$_sheetIndex

PHPExcel_Reader_HTML::$_sheetIndex = 0

protected

Definition at line 59 of file HTML.php.

Referenced by getSheetIndex().

$_tableLevel

PHPExcel_Reader_HTML::$_tableLevel = 0

protected

Definition at line 171 of file HTML.php.

Referenced by _getTableStartColumn(), _releaseTableStartColumn(), and _setTableStartColumn().

$rowspan

PHPExcel_Reader_HTML::$rowspan = array()

protected

Definition at line 104 of file HTML.php.

---

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

• libs/composer/vendor/phpoffice/phpexcel/Classes/PHPExcel/Reader/HTML.php