alex
/
PhpSpreadsheet
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
PhpSpreadsheet/docs/index.md

103 lines
3.0 KiB
Markdown
Raw Normal View History

Wrap lines to 80 We wrapped lines to make easier the source easier to read, and to have more manageable diffs. This was done with something like: ```sh pandoc --wrap=auto --atx-headers -f markdown -t markdown-fenced_code_attributes+pipe_tables+raw_html+intraword_underscores` ```
2016-12-03 15:00:54 +00:00
# Welcome to PhpSpreadsheet's documentation
Add documentation welcome page
2016-11-27 10:34:17 +00:00
![Logo](./assets/logo.svg)
Wrap lines to 80 We wrapped lines to make easier the source easier to read, and to have more manageable diffs. This was done with something like: ```sh pandoc --wrap=auto --atx-headers -f markdown -t markdown-fenced_code_attributes+pipe_tables+raw_html+intraword_underscores` ```
2016-12-03 15:00:54 +00:00
PhpSpreadsheet is a library written in pure PHP and providing a set of
classes that allow you to read from and to write to different
spreadsheet file formats, like Excel and LibreOffice Calc.
Add documentation welcome page
2016-11-27 10:34:17 +00:00
Keep documentation in a single place and link to it Fixes #191 Closes #192
2017-07-30 14:22:28 +00:00
## File formats supported
|Format |Reading|Writing|
|--------------------------------------------|:-----:|:-----:|
|Open Document Format/OASIS (.ods) | ✓ | ✓ |
|Office Open XML (.xlsx) Excel 2007 and above| ✓ | ✓ |
|BIFF 8 (.xls) Excel 97 and above | ✓ | ✓ |
|BIFF 5 (.xls) Excel 95 | ✓ | |
|SpreadsheetML (.xml) Excel 2003 | ✓ | |
|Gnumeric | ✓ | |
|HTML | ✓ | ✓ |
|SYLK | ✓ | |
|CSV | ✓ | ✓ |
Simplify IOFactory to rely on autoloading
2017-10-21 16:54:14 +00:00
|PDF (using either the TCPDF, Dompdf or mPDF libraries, which need to be installed separately)| | ✓ |
Keep documentation in a single place and link to it Fixes #191 Closes #192
2017-07-30 14:22:28 +00:00
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
# Getting started
## Software requirements
The following software is required to develop using PhpSpreadsheet:
Drop PHP 5.5 support According to our policy to support PHP version 6 months after their end of life, it is time to drop PHP 5.5.
2017-01-23 02:44:16 +00:00
- PHP version 5.6 or newer
Drop support for PclZip Over the years PclZip became a maintenance problem. It's code base is old and the official project seems to have died out. ZipArchive is now more commonly available and offer an easier and more complete API. So PclZip was dropped in order to focus our efforts on what matters. Closes #18
2017-03-11 02:48:46 +00:00
- PHP extension php\_zip enabled
Wrap lines to 80 We wrapped lines to make easier the source easier to read, and to have more manageable diffs. This was done with something like: ```sh pandoc --wrap=auto --atx-headers -f markdown -t markdown-fenced_code_attributes+pipe_tables+raw_html+intraword_underscores` ```
2016-12-03 15:00:54 +00:00
- PHP extension php\_xml enabled
- PHP extension php\_gd2 enabled (if not compiled in)
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
Keep documentation in a single place and link to it Fixes #191 Closes #192
2017-07-30 14:22:28 +00:00
### PHP version support
Support for PHP versions will only be maintained for a period of six months beyond the end-of-life of that PHP version
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
## Installation
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
Use [composer](https://getcomposer.org/) to install PhpSpreadsheet into your project:
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
```sh
composer require phpoffice/phpspreadsheet
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
```
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
**Note:** If you want the unreleased, unstable development version use
`phpoffice/phpspreadsheet:dev-develop` instead.
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
## Hello World
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
This would be the simplest way to write a spreadsheet:
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
```php
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
<?php
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
require 'vendor/autoload.php';
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Writer\Xlsx;
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
$spreadsheet = new Spreadsheet();
$sheet = $spreadsheet->getActiveSheet();
$sheet->setCellValue('A1', 'Hello World !');
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
$writer = new Xlsx($spreadsheet);
$writer->save('hello world.xlsx');
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
```
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
## Learn by example
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
Typo
2017-03-13 03:33:24 +00:00
A good way to get started is to run some of the samples. Serve the samples via
PHP built-in webserver:
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
```sh
php -S localhost:8000 -t vendor/phpoffice/phpspreadsheet/samples
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
```
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
Then point your browser to:
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
> http://localhost:8000/
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
The samples may also be run directly from the command line, for example:
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
```sh
php vendor/phpoffice/phpspreadsheet/samples/01_Simple.php
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
```
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
## Learn by documentation
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
For more in-depth documentation, you may read about an [overview of the
architecture](./topics/architecture.md),
[creating a spreadsheet](./topics/creating-spreadsheet.md),
[worksheets](./topics/worksheets.md),
[accessing cells](./topics/accessing-cells.md) and
[reading and writing to files](./topics/reading-and-writing-to-file.md).
Reorganise documentation We aim for long pages instead of several small one, to make `CTRL+F`ing easier and URL less prone to changes in the future. There is still way to improve it though...
2016-12-03 13:16:45 +00:00
# Credits
Update documentation with composer instructions And split first page into several topics to improve sidebar navigation Closes #114
2017-03-13 02:33:02 +00:00
Please refer to the [contributor
Wrap lines to 80 We wrapped lines to make easier the source easier to read, and to have more manageable diffs. This was done with something like: ```sh pandoc --wrap=auto --atx-headers -f markdown -t markdown-fenced_code_attributes+pipe_tables+raw_html+intraword_underscores` ```
2016-12-03 15:00:54 +00:00
list](https://github.com/PHPOffice/PhpSpreadsheet/graphs/contributors)
for up-to-date credits.