phpoffice/phpspreadsheet

PHPSpreadsheet - Read, Create and Write Spreadsheet documents in PHP - Spreadsheet engine

PhpSpreadsheet

, _(*1)

PhpSpreadsheet is a library written in pure PHP and offers a set of classes that allow you to read and write various spreadsheet file formats such as Excel and LibreOffice Calc., _(*2)

PHP Version Support

LTS: Support for PHP versions will only be maintained for a period of six months beyond the end of life of that PHP version., _(*3)

Currently the required PHP minimum version is PHP 8.0, and we will support that version until May 2024., _(*4)

See the composer.json for other requirements., _(*5)

Installation

Use composer to install PhpSpreadsheet into your project:, _(*6)

composer require phpoffice/phpspreadsheet

If you are building your installation on a development machine that is on a different PHP version to the server where it will be deployed, or if your PHP CLI version is not the same as your run-time such as php-fpm or Apache's mod_php, then you might want to add the following to your composer.json before installing:, _(*7)

{
    "config": {
        "platform": {
            "php": "8.0"
        }
    }
}

and then run, _(*8)

composer install

to ensure that the correct dependencies are retrieved to match your deployment environment., _(*9)

See CLI vs Application run-time for more details., _(*10)

Additional Installation Options

If you want to write to PDF, or to include Charts when you write to HTML or PDF, then you will need to install additional libraries:, _(*11)

PDF

For PDF Generation, you can install any of the following, and then configure PhpSpreadsheet to indicate which library you are going to use: - mpdf/mpdf - dompdf/dompdf - tecnickcom/tcpdf, _(*12)

and configure PhpSpreadsheet using:, _(*13)

// Dompdf, Mpdf or Tcpdf (as appropriate)
$className = \PhpOffice\PhpSpreadsheet\Writer\Pdf\Dompdf::class;
IOFactory::registerWriter('Pdf', $className);

or the appropriate PDF Writer wrapper for the library that you have chosen to install., _(*14)

Chart Export

For Chart export, we support following packages, which you will also need to install yourself using composer require - jpgraph/jpgraph (this package was abandoned at version 4.0. You can manually download the latest version that supports PHP 8 and above from jpgraph.net) - mitoteam/jpgraph - up to date fork with modern PHP versions support and some bugs fixed., _(*15)

and then configure PhpSpreadsheet using:, _(*16)

// to use jpgraph/jpgraph
Settings::setChartRenderer(\PhpOffice\PhpSpreadsheet\Chart\Renderer\JpGraph::class);
//or
// to use mitoteam/jpgraph
Settings::setChartRenderer(\PhpOffice\PhpSpreadsheet\Chart\Renderer\MtJpGraphRenderer::class);

One or the other of these libraries is necessary if you want to generate HTML or PDF files that include charts; or to render a Chart to an Image format from within your code. They are not necessary to define charts for writing to Xlsx files. Other file formats don't support writing Charts., _(*17)

Documentation

Read more about it, including install instructions, in the official documentation. Or check out the API documentation., _(*18)

Please ask your support questions on StackOverflow, or have a quick chat on Gitter., _(*19)

Patreon

I am now running a Patreon to support the work that I do on PhpSpreadsheet., _(*20)

Supporters will receive access to articles about working with PhpSpreadsheet, and how to use some of its more advanced features., _(*21)

Posts already available to Patreon supporters: - The Dating Game - A look at how MS Excel (and PhpSpreadsheet) handle date and time values. - Looping the Loop - Advice on Iterating through the rows and cells in a worksheet., _(*22)

And for Patrons at levels actively using PhpSpreadsheet: - Behind the Mask - A look at Number Format Masks., _(*23)

The Next Article (currently Work in Progress): - Formula for Success - How to debug formulae that don't produce the expected result., _(*24)

My aim is to post at least one article each month, taking a detailed look at some feature of MS Excel and how to use that feature in PhpSpreadsheet, or on how to perform different activities in PhpSpreadsheet., _(*25)

Planned posts for the future include topics like: - Tables - Structured References - AutoFiltering - Array Formulae - Conditional Formatting - Data Validation - Value Binders - Images - Charts, _(*26)

After a period of six months exclusive to Patreon supporters, articles will be incorporated into the public documentation for the library., _(*27)

PHPExcel vs PhpSpreadsheet ?

PhpSpreadsheet is the next version of PHPExcel. It breaks compatibility to dramatically improve the code base quality (namespaces, PSR compliance, use of latest PHP language features, etc.)., _(*28)

Because all efforts have shifted to PhpSpreadsheet, PHPExcel will no longer be maintained. All contributions for PHPExcel, patches and new features, should target PhpSpreadsheet master branch., _(*29)

Do you need to migrate? There is an automated tool for that., _(*30)

License

PhpSpreadsheet is licensed under MIT., _(*31)