683ec52a9d
To prepare the migration to 3.0, we need to change the location where the documentation is generated from. Having a gh-pages branch makes it hard to synchronize the code and the docs. Having a "docs" folder in the repo itself simplifies this.
97 lines
2.7 KiB
Markdown
Executable File
97 lines
2.7 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 5.4.0 or higher
|
|
* PHP extension `php_zip` enabled
|
|
* PHP extension `php_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?start_inline=1
|
|
// 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?start_inline=1
|
|
use Box\Spout\Reader\ReaderFactory;
|
|
use Box\Spout\Common\Type;
|
|
|
|
$reader = ReaderFactory::create(Type::XLSX); // for XLSX files
|
|
//$reader = ReaderFactory::create(Type::CSV); // for CSV files
|
|
//$reader = ReaderFactory::create(Type::ODS); // for ODS files
|
|
|
|
$reader->open($filePath);
|
|
|
|
foreach ($reader->getSheetIterator() as $sheet) {
|
|
foreach ($sheet->getRowIterator() as $row) {
|
|
// do stuff with the row
|
|
}
|
|
}
|
|
|
|
$reader->close();
|
|
```
|
|
|
|
If there are multiple sheets in the file, the reader will read all of them sequentially.
|
|
|
|
### Writer
|
|
|
|
As with the reader, there is one common interface to write data to a file:
|
|
|
|
```php?start_inline=1
|
|
use Box\Spout\Writer\WriterFactory;
|
|
use Box\Spout\Common\Type;
|
|
|
|
$writer = WriterFactory::create(Type::XLSX); // for XLSX files
|
|
//$writer = WriterFactory::create(Type::CSV); // for CSV files
|
|
//$writer = WriterFactory::create(Type::ODS); // for ODS files
|
|
|
|
$writer->openToFile($filePath); // write data to a file or to a PHP stream
|
|
//$writer->openToBrowser($fileName); // stream data directly to the browser
|
|
|
|
$writer->addRow($singleRow); // add a row at a time
|
|
$writer->addRows($multipleRows); // add multiple rows at a time
|
|
|
|
$writer->close();
|
|
```
|
|
|
|
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.
|