A pure PHP library for reading and writing spreadsheet files
MIT License
11553
315
2788

PhpSpreadsheet

Build Status Code Quality Code Coverage Total Downloads Latest Stable Version License Join the chat at https://gitter.im/PHPOffice/PhpSpreadsheet

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.

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.

Currently the required PHP minimum version is PHP 7.3.

See the composer.json for other requirements.

Installation

Use composer to install PhpSpreadsheet into your project:

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:

{
    "require": {
        "phpoffice/phpspreadsheet": "^1.23"
    },
    "config": {
        "platform": {
            "php": "7.3"
        }
    }
}

and then run

composer install

to ensure that the correct dependencies are retrieved to match your deployment environment.

See CLI vs Application run-time for more details.

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:

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

and configure PhpSpreadsheet using:

// 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.

Chart Export

For Chart export, we support following packages, which you will also need to install yourself using composer require

and then configure PhpSpreadsheet using:

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

One or the other of these libraries is necessary if you want to generate HTML or PDF files that include charts.

Documentation

Read more about it, including install instructions, in the official documentation. Or check out the API documentation.

Please ask your support questions on StackOverflow, or have a quick chat on Gitter.

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.).

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.

Do you need to migrate? There is an automated tool for that.

License

PhpSpreadsheet is licensed under MIT.

Contributors

MarkBaker
PowerKiKi
oleibman
Progi1984
dependabot[bot]
maartenba
agopaul
dbonsch
aswinkumar863
AkiraPenguin
Slamdunk
ndench
Jean85
carusogabriel
mjan4175
frantzmiccoli
frost-nzcr4
xandros15
dgeppo
tiagof
brainfoolong
lucasnetau
tolbon
SailorMax
kamazee
MasterOfDeath
Synchro
Quix0r
billblume
darenas31415
diegosouza
yasar-luo
nohn
basbl
titanrat
amironov
arnested
CQD
Enyby
gmsantos
Gemorroj
jdufresne
u01jmg3
reijnnn
nicoder
paulkned
odbc
SenseException
CrazyBite
blunket
carlos-montiers
cwild
Collie-IT
hazybluedot
DavisDevasia
deekthesqueak
xklid101
guillaume-ro-fr
JackStoneDev
Josh-G
KacerCZ
vipmaa
Martin0123456
martinssipenko
MewesK
nickypn
patrickbrouwers
PhilETaylor
rolandsusans
sarciszewski
simPod
tiagomalheiro
TomasVotruba
UziTech
VincentLanglet
kalessil
alexgann
ankitm123
ayacoo
Golodnyi
jarrettj
neclimdul
karak
rtek
tsmsogn
AlexPravdin
Arthur-min
DennisBirkholz
azine
tezrik
jasverix
gnat42
rvanvelzen
rdarcy1
n-longcape
lmeraki
AegirLeet
arraintxo
albanduval
Bird87ZA