File: README.md

Recommend this page to a friend!
  Classes of Sergey Shuchkin  >  SimpleXLSX  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: SimpleXLSX
Parse and retrieve data from Excel XLS files
Author: By
Last change: 0.8.15
0.8.15
0.8.14
0.8.13
0.8.12
0.8.11
0.8.11
0.8.10
more datetime examples
clickable badges
+ badges
Added example "Rows with header values as keys"
Added example "Rows with header values as keys"
fixed release version
close tag <table>
close tag <table>
Date: 4 months ago
Size: 10,869 bytes
 

Contents

Class file image Download

SimpleXLSX class 0.8.15 (Official)

<img src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Fshuchkin" /> <img src="https://img.shields.io/github/license/shuchkin/simplexlsx" /> <img src="https://img.shields.io/github/stars/shuchkin/simplexlsx" /> <img src="https://img.shields.io/github/forks/shuchkin/simplexlsx" /> <img src="https://img.shields.io/github/issues/shuchkin/simplexlsx" />

Parse and retrieve data from Excel XLSx files. MS Excel 2007 workbooks PHP reader. No addiditional extensions need (internal unzip + standart SimpleXML parser) (!) XLSX only, see MS Excel 97 php reader here.

Sergey Shuchkin <sergey.shuchkin@gmail.com> 2010-2020<br/>

Hey, bro, please ? the package for my motivation :)

Basic Usage

if ( $xlsx = SimpleXLSX::parse('book.xlsx') ) {
	print_r( $xlsx->rows() );
} else {
	echo SimpleXLSX::parseError();
}
Array
(
    [0] => Array
        (
            [0] => ISBN
            [1] => title
            [2] => author
            [3] => publisher
            [4] => ctry
        )

    [1] => Array
        (
            [0] => 618260307
            [1] => The Hobbit
            [2] => J. R. R. Tolkien
            [3] => Houghton Mifflin
            [4] => USA
        )

)
// SimpleXLSX::parse( $filename, $is_data = false, $debug = false ): SimpleXLSX (or false)
// SimpleXLSX::parseFile( $filename, $debug = false ): SimpleXLSX (or false)
// SimpleXLSX::parseData( $data, $debug = false ): SimpleXLSX (or false)

Installation

The recommended way to install this library is through Composer. New to Composer?

This will install the latest supported version:

$ composer require shuchkin/simplexlsx

or download class here

Examples

XLSX to html table

if ( $xlsx = SimpleXLSX::parse('book.xlsx') ) {
	echo '<table border="1" cellpadding="3" style="border-collapse: collapse">';
	foreach( $xlsx->rows() as $r ) {
		echo '<tr><td>'.implode('</td><td>', $r ).'</td></tr>';
	}
	echo '</table>';
	// or $xlsx->toHTML();	
} else {
	echo SimpleXLSX::parseError();
}

XLSX read cells, out commas and bold headers

echo '<pre>';
if ( $xlsx = SimpleXLSX::parse( 'xlsx/books.xlsx' ) ) {
	foreach ( $xlsx->rows() as $r => $row ) {
		foreach ( $row as $c => $cell ) {
			echo ($c > 0) ? ', ' : '';
			echo ( $r === 0 ) ? '<b>'.$cell.'</b>' : $cell;
		}
		echo '<br/>';
	}
} else {
	echo SimpleXLSX::parseError();
}
echo '</pre>';

XLSX get sheet names and sheet indexes

if ( $xlsx = SimpleXLSX::parse( 'xlsx/books.xlsx' ) ) {
	print_r( $xlsx->sheetNames() );
}
// Sheet numeration started 0
Array
(
    [0] => Sheet1
    [1] => Sheet2
    [2] => Sheet3
)

Gets extend cell info by ->rowsEx()

print_r( SimpleXLSX::parse('book.xlsx')->rowsEx() );
Array
(
    [0] => Array
        (
            [0] => Array
                (
                    [type] => s
                    [name] => A1
                    [value] => ISBN
                    [href] => 
                    [f] => 
                    [format] => 
                    [r] => 1
                )

            [1] => Array
                (
                    [type] => 
                    [name] => B1
                    [value] => 2016-04-12 13:41:00
                    [href] => 
                    [f] => 
                    [format] => m/d/yy h:mm
                    [r] => 2
                )

Select Sheet

$xlsx = SimpleXLSX::parse('book.xlsx');
print_r( $xlsx->rows(1) ); // Sheet numeration started 0, we select second worksheet

Get sheet by index

$xlsx = SimpleXLSX::parse('book.xlsx');	
echo 'Sheet Name 2 = '.$xlsx->sheetName(1);

XLSX::parse remote data

if ( $xlsx = SimpleXLSX::parse('http://www.example.com/example.xlsx' ) ) {
	$dim = $xlsx->dimension(1); // don't trust dimension extracted from xml
	$num_cols = $dim[0];
	$num_rows = $dim[1];
	echo $xlsx->sheetName(1).':'.$num_cols.'x'.$num_rows;
} else {
	echo SimpleXLSX::parseError();
}

XLSX::parse memory data

// For instance $data is a data from database or cache    
if ( $xlsx = SimpleXLSX::parseData( $data ) ) {
	print_r( $xlsx->rows() );
} else {
	echo SimpleXLSX::parseError();
}

Get Cell (slow)

echo $xlsx->getCell(0, 'B2'); // The Hobbit

DateTime helpers

// default SimpleXLSX datetime format YYYY-MM-DD HH:MM:SS (MySQL)
echo $xlsx->getCell(0,'C2'); // 2016-04-12 13:41:00

// custom datetime format
$xlsx->setDateTimeFormat('d.m.Y H:i');
echo $xlsx->getCell(0,'C2'); // 12.04.2016 13:41

// unixstamp
$xlsx->setDateTimeFormat('U');
$ts = $xlsx->getCell(0,'C2'); // 1460468460
echo gmdate('Y-m-d', $ts); // 2016-04-12
echo gmdate('H:i:s', $ts); // 13:41:00

// raw excel value
$xlsx->setDateTimeFormat( NULL ); // returns as excel datetime
$xd = $xlsx->getCell(0,'C2'); // 42472.570138889
echo gmdate('m/d/Y', $xlsx->unixstamp( $xd )); // 04/12/2016
echo gmdate('H:i:s', $xlsx->unixstamp( $xd )); // 13:41:00 

Rows with header values as keys

if ( $xlsx = SimpleXLSX::parse('books.xlsx')) {
	// Produce array keys from the array values of 1st array element
	$header_values = $rows = [];
	foreach ( $xlsx->rows() as $k => $r ) {
		if ( $k === 0 ) {
			$header_values = $r;
			continue;
		}
		$rows[] = array_combine( $header_values, $r );
	}
	print_r( $rows );
}
Array
(
    [0] => Array
        (
            [ISBN] => 618260307
            [title] => The Hobbit
            [author] => J. R. R. Tolkien
            [publisher] => Houghton Mifflin
            [ctry] => USA
        )
    [1] => Array
        (
            [ISBN] => 908606664
            [title] => Slinky Malinki
            [author] => Lynley Dodd
            [publisher] => Mallinson Rendel
            [ctry] => NZ
        )
)

Debug

ini_set('error_reporting', E_ALL );
ini_set('display_errors', 1 );

if ( $xlsx = SimpleXLSX::parseFile('books.xlsx', true ) ) {
	echo $xlsx->toHTML();
} else {
	echo SimpleXLSX::parseError();
}

Classic OOP style

$xlsx = new SimpleXLSX('books.xlsx'); // try...catch
if ( $xlsx->success() ) {
	print_r( $xlsx->rows() );
} else {
	echo 'xlsx error: '.$xlsx->error();
}

More examples here

Error Codes

SimpleXLSX::ParseErrno(), $xlsx->errno()<br/> <table> <tr><th>code</th><th>message</th><th>comment</th></tr> <tr><td>1</td><td>File not found</td><td>Where file? UFO?</td></tr> <tr><td>2</td><td>Unknown archive format</td><td>ZIP?</td></tr> <tr><td>3</td><td>XML-entry parser error</td><td>bad XML</td></tr> <tr><td>4</td><td>XML-entry not found</td><td>bad ZIP archive</td></tr> <tr><td>5</td><td>Entry not found</td><td>File not found in ZIP archive</td></tr> <tr><td>6</td><td>Worksheet not found</td><td>Not exists</td></tr> </table>

History

v0.8.15 (2020-04-28) fixed LibreOffice xml specificity, thx stephengmatthews <br/> v0.8.14 (2020-04-03) fixed Office for Mac relations<br/> v0.8.13 (2020-02-19) removed skipEmptyRows property (xml optimization always), added static parseFile & parseData<br/> v0.8.12 (2020-01-22) remove empty rows (opencalc)<br/> v0.8.11 (2020-01-20) changed formats source priority<br/> v0.8.10 (2019-11-07) skipEmptyRows improved<br/> v0.8.9 (2019-08-15) fixed release version<br/> v0.8.8 (2019-06-19) removed list( $x, $y ), added bool $xlsx->skipEmptyRows, $xlsx->parseFile( $filename ), $xlsx->parseData( $data ), release 0.8.8<br/> v0.8.7 (2019-04-18) empty rows fixed, release 0.8.7<br/> v0.8.6 (2019-04-16) 1900/1904 bug fixed<br/> v0.8.5 (2019-03-07) SimpleXLSX::ParseErrno(), $xlsx->errno() returns error code<br/> v0.8.4 (2019-02-14) detect datetime values, mb_string.func_overload=2 support .!. Bitrix<br/> v0.8.3 (2018-11-14) getCell - fixed empty cells and rows, safe now, but very slow<br/> v0.8.2 (2018-11-09) fix empty cells and rows in rows() and rowsEx(), added setDateTimeFormat( $see_php_date_func )<br/> v0.8.1 rename simplexlsx.php to SimpleXLSX.php, rename parse_error to parseError fix _columnIndex, add ->toHTML(), GNU to MIT license<br/> v0.7.13 (2018-06-18) get sheet indexes bug fix<br/> v0.7.12 (2018-06-17) $worksheet_id to $worksheet_index, sheet numeration started 0<br/> v0.7.11 (2018-04-25) rowsEx(), added row index "r" to cell info<br/> v0.7.10 (2018-04-21) fixed getCell, returns NULL if not exits<br/> v0.7.9 (2018-03-17) fixed sheetNames() (namespaced or not namespaced attr)<br/> v0.7.8 (2018-01-15) remove namespace prefixes (hardcoded)<br/> v0.7.7 (2017-10-02) XML External Entity (XXE) Prevention (<!ENTITY xxe SYSTEM "file: ///etc/passwd" >]>)<br/> v0.7.6 (2017-09-26) if worksheet_id === 0 (default) then detect first sheet (for LibreOffice capabilities)<br/> v0.7.5 (2017-09-10) ->getCell() - fixed<br/> v0.7.4 (2017-08-22) ::parse_error() - to get last error in "static style"<br/> v0.7.3 (2017-08-14) ->_parse fixed relations reader, added ->getCell( sheet_id, address, format ) for direct cell reading<br/> v0.7.2 (2017-05-13) ::parse( $filename ) helper method<br/> v0.7.1 (2017-03-29) License added<br/> v0.6.11 (2016-07-27) fixed timestamp()<br/> v0.6.10 (2016-06-10) fixed search entries (UPPERCASE)<br/> v0.6.9 (2015-04-12) $xlsx->datetime_format to force dates out<br/> v0.6.8 (2013-10-13) fixed dimension() where 1 row only, fixed rowsEx() empty cells indexes (Daniel Stastka)<br/> v0.6.7 (2013-08-10) fixed unzip (mac), added $debug param to _constructor to display errors<br/> v0.6.6 (2013-06-03) +entryExists()<br/> v0.6.5 (2013-03-18) fixed sheetName()<br/> v0.6.4 (2013-03-13) rowsEx(), _parse(): fixed date column type & format detection<br/> v0.6.3 (2013-03-13) rowsEx(): fixed formulas, added date type 'd', added format 'format'<br/>

				dimension(): fixed empty sheet dimension<br/>
                + sheetNames() - returns array( sheet_id => sheet_name, sheet_id2 => sheet_name2 ...)<br/>

v0.6.2 (2012-10-04) fixed empty cells, rowsEx() returns type and formulas now<br/> v0.6.1 (2012-09-14) removed "raise exception" and fixed _unzip<br/> v0.6 (2012-09-13) success(), error(), __constructor( $filename, $is_data = false )<br/> v0.5.1 (2012-09-13) sheetName() fixed<br/> v0.5 (2012-09-12) sheetName()<br/> v0.4 sheets(), sheetsCount(), unixstamp( $excelDateTime )<br/> v0.3 - fixed empty cells (Gonzo patch)<br/>


For more information send a message to info at phpclasses dot org.