README

Why use xlswriter

The chart below compares xlswriter with PhpSpreadsheet (the maintained successor to PHPExcel) when exporting an XLSX file, scaled all the way to Excel's row limit. Writing 1,048,576 rows × 10 columns, xlswriter is about 20× faster, and its fixed-memory mode keeps peak memory flat at ~30 MB no matter how many rows you write — whereas a pure-PHP library's memory grows with the data (≈7 GB for the same file).

The two xlswriter modes track within ~10% of each other on time. Fixed-memory mode is marginally faster because it streams each row straight to disk and frees it immediately — a single pass, with no full in-memory model to build up and then serialize a second time at the end. The trade-off is that, unlike normal mode, it can no longer revisit a cell once it has been written (and its strings are stored inline rather than de-duplicated, so the file can be slightly larger). Normal mode keeps the whole workbook in memory, which is what lets you write cells in any order and re-style them before saving.

xlswriter is a PHP C Extension for Excel 2007+ XLSX files. It writes text, numbers, formulas, dates, charts, images and hyperlinks to new workbooks, opens existing files to edit them and save the result, reads their contents back, and evaluates formulas to a computed value. It supports features such as:

Writer

• 100% compatible Excel XLSX files.
• Full Excel formatting.
• Merged cells.
• Defined names.
• Autofilters.
• Charts.
• Data validation and drop down lists.
• Conditional formatting.
• Rich text, comments and hyperlinks.
• Worksheet PNG/JPEG images.
• Edit existing workbooks — open a file, update cell values, styles, merged ranges and row/column sizes, add worksheets, images and charts, then save the result.
• Formula calculation — evaluate a formula and get its computed value, and write formulas with a pre-computed cached result.
• Memory optimization mode for writing large files.
• Works on Linux, FreeBSD, OpenBSD, OS X, Windows.
• Compiles for 32 and 64 bit.
• FreeBSD License.
• The only dependency is on zlib.

Reader

• Full read mode and cursor read mode.
• Read by data type.
• Read cell styles and number formats.
• Read merged cells.
• Read images, charts and comments.
• Read formulas together with their cached values.

Install

Unix

xlswriter requires the zlib development headers at build time. Install them first if they are missing (common on minimal images):

# Debian / Ubuntu
apt-get install -y zlib1g-dev
# Alpine
apk add zlib-dev
# RHEL / CentOS / Fedora
yum install -y zlib-devel

pecl install xlswriter

Windows

download dll

Benchmark

Test environment: Macbook Pro 13 inch, Intel Core i5, 16GB 2133MHz LPDDR3 Memory, 128GB SSD Storage.

Export

Two memory modes export 1 million rows of data (27 columns, data is string)

• Normal mode: only 29S is needed, and the memory only needs 2083MB;
• Fixed memory mode: only need 52S, memory only needs <1MB;

Import

1 million rows of data (1 columns, data is inter)

• Full mode: Just 3S, the memory is only 558MB;
• Cursor mode: Just 2.8S, memory is only <1MB;

Documents

Includes extensive and detailed instructions that make it easy to get started with xlswriter.

PECL Repository

IDE Helper

composer require viest/php-ext-xlswriter-ide-helper:dev-master

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

License

BSD License

Stargazers over time