138 lines
3.9 KiB
Markdown
Executable File
138 lines
3.9 KiB
Markdown
Executable File
---
|
|
layout: doc
|
|
title: Getting Started
|
|
permalink: /getting-started/
|
|
---
|
|
|
|
This guide will help you install {{ site.spout_html }} and teach you how to use it.
|
|
|
|
## Requirements
|
|
|
|
* PHP version 7.1 or higher
|
|
* PHP extension `ext-zip` enabled
|
|
* PHP extension `ext-xmlreader` enabled
|
|
|
|
|
|
## Installation
|
|
|
|
### Composer (recommended)
|
|
|
|
{{ site.spout_html }} can be installed directly from [Composer](https://getcomposer.org/).
|
|
|
|
Run the following command:
|
|
```powershell
|
|
$ composer require box/spout
|
|
```
|
|
|
|
### Manual installation
|
|
|
|
If you can't use Composer, no worries! You can still install {{ site.spout_html }} manually.
|
|
|
|
> Before starting, make sure your system meets the [requirements](#requirements).
|
|
|
|
1. Download the source code from the [Releases page](https://github.com/box/spout/releases)
|
|
2. Extract the downloaded content into your project.
|
|
3. Add this code to the top controller (e.g. index.php) or wherever it may be more appropriate:
|
|
|
|
```php
|
|
// don't forget to change the path!
|
|
require_once '[PATH/TO]/src/Spout/Autoloader/autoload.php';
|
|
```
|
|
|
|
|
|
## Basic usage
|
|
|
|
### Reader
|
|
|
|
Regardless of the file type, the interface to read a file is always the same:
|
|
|
|
```php
|
|
|
|
use Box\Spout\Reader\Common\Creator\ReaderEntityFactory;
|
|
|
|
$reader = ReaderEntityFactory::createReaderFromFile('/path/to/file.ext');
|
|
|
|
$reader->open($filePath);
|
|
|
|
foreach ($reader->getSheetIterator() as $sheet) {
|
|
foreach ($sheet->getRowIterator() as $row) {
|
|
// do stuff with the row
|
|
$cells = $row->getCells();
|
|
...
|
|
}
|
|
}
|
|
|
|
$reader->close();
|
|
```
|
|
|
|
If there are multiple sheets in the file, the reader will read all of them sequentially.
|
|
|
|
|
|
Note that {{ site.spout_html }} guesses the reader type based on the file extension. If the extension is not standard (`.csv`, `.ods`, `.xlsx` _- lower/uppercase_), a specific reader can be created directly:
|
|
|
|
```php
|
|
use Box\Spout\Reader\Common\Creator\ReaderEntityFactory;
|
|
|
|
$reader = ReaderEntityFactory::createXLSXReader();
|
|
// $reader = ReaderEntityFactory::createODSReader();
|
|
// $reader = ReaderEntityFactory::createCSVReader();
|
|
```
|
|
|
|
### Writer
|
|
|
|
As with the reader, there is one common interface to write data to a file:
|
|
|
|
```php
|
|
use Box\Spout\Writer\Common\Creator\WriterEntityFactory;
|
|
use Box\Spout\Common\Entity\Row;
|
|
|
|
$writer = WriterEntityFactory::createXLSXWriter();
|
|
// $writer = WriterEntityFactory::createODSWriter();
|
|
// $writer = WriterEntityFactory::createCSVWriter();
|
|
|
|
$writer->openToFile($filePath); // write data to a file or to a PHP stream
|
|
//$writer->openToBrowser($fileName); // stream data directly to the browser
|
|
|
|
$cells = [
|
|
WriterEntityFactory::createCell('Carl'),
|
|
WriterEntityFactory::createCell('is'),
|
|
WriterEntityFactory::createCell('great!'),
|
|
];
|
|
|
|
/** add a row at a time */
|
|
$singleRow = WriterEntityFactory::createRow($cells);
|
|
$writer->addRow($singleRow);
|
|
|
|
/** add multiple rows at a time */
|
|
$multipleRows = [
|
|
WriterEntityFactory::createRow($cells),
|
|
WriterEntityFactory::createRow($cells),
|
|
];
|
|
$writer->addRows($multipleRows);
|
|
|
|
/** Shortcut: add a row from an array of values */
|
|
$values = ['Carl', 'is', 'great!'];
|
|
$rowFromValues = WriterEntityFactory::createRowFromArray($values);
|
|
$writer->addRow($rowFromValues);
|
|
|
|
$writer->close();
|
|
```
|
|
|
|
Similar to the reader, if the file extension of the file to be written is not standard, specific writers can be created this way:
|
|
|
|
```php
|
|
use Box\Spout\Writer\Common\Creator\WriterEntityFactory;
|
|
use Box\Spout\Common\Entity\Row;
|
|
|
|
$writer = WriterEntityFactory::createXLSXWriter();
|
|
// $writer = WriterEntityFactory::createODSWriter();
|
|
// $writer = WriterEntityFactory::createCSVWriter();
|
|
```
|
|
|
|
For XLSX and ODS files, the number of rows per sheet is limited to *1,048,576*. By default, once this limit is reached, the writer will automatically create a new sheet and continue writing data into it.
|
|
|
|
|
|
## Advanced usage
|
|
|
|
You can do a lot more with {{ site.spout_html }}! Check out the [full documentation]({{ site.github.url }}/docs/) to learn about all the features.
|