#463, move gh-pages to docs folder
This commit is contained in:
madflow authored and Adrien Loison committed
1 parent
5b1bcc1303
commit
cd0831ea8e
44 files changed
+1981
No files matched your search
Vendored
BIN
Binary file not shown.
@@ -0,0 +1,61 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Add data to an existing spreadsheet"
|
||||
category: guide
|
||||
permalink: /guides/add-data-to-existing-spreadsheet/
|
||||
---
|
||||
|
||||
A common use case when using spreadsheets is to add data to an existing spreadsheet. For instance, let's assume you built a spreadsheet containing the last orders on your favorite website and want to update it as you make a new order.
|
||||
|
||||
We'll start with a file called "orders.xlsx" and add a new row, containing the last order's info, at the end.
|
||||
|
||||
In order to avoid memory issues when dealing with large spreadsheets, {{ site.spout_html }} does not hold the whole representation of the spreadsheet in memory. So to alter an existing spreadsheet, we'll have to create a new one that is similar to the existing one and add the new data in the new one.
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
use Box\Spout\Reader\ReaderFactory;
|
||||
use Box\Spout\Writer\WriterFactory;
|
||||
use Box\Spout\Common\Type;
|
||||
|
||||
$existingFilePath = 'path/to/orders.xlsx';
|
||||
$newFilePath = 'path/to/new-orders.xlsx';
|
||||
|
||||
// we need a reader to read the existing file...
|
||||
$reader = ReaderFactory::create(Type::XLSX);
|
||||
$reader->open($existingFilePath);
|
||||
$reader->setShouldFormatDates(true); // this is to be able to copy dates
|
||||
|
||||
// ... and a writer to create the new file
|
||||
$writer = WriterFactory::create(Type::XLSX);
|
||||
$writer->openToFile($newFilePath);
|
||||
|
||||
// let's read the entire spreadsheet...
|
||||
foreach ($reader->getSheetIterator() as $sheetIndex => $sheet) {
|
||||
// Add sheets in the new file, as we read new sheets in the existing one
|
||||
if ($sheetIndex !== 1) {
|
||||
$writer->addNewSheetAndMakeItCurrent();
|
||||
}
|
||||
|
||||
foreach ($sheet->getRowIterator() as $row) {
|
||||
// ... and copy each row into the new spreadsheet
|
||||
$writer->addRow($row);
|
||||
}
|
||||
}
|
||||
|
||||
// At this point, the new spreadsheet contains the same data as the existing one.
|
||||
// So let's add the new data:
|
||||
$writer->addRow(['2015-12-25', 'Christmas gift', 29, 'USD']);
|
||||
|
||||
$reader->close();
|
||||
$writer->close();
|
||||
```
|
||||
|
||||
Optionally, if you rely on the file name or want to keep only one file, simple remove the old file and rename the new one:
|
||||
|
||||
```php?start_inline=1
|
||||
unlink($existingFilePath);
|
||||
rename($newFilePath, $existingFilePath);
|
||||
```
|
||||
|
||||
That's it! The created file now contains the updated data and is ready to be used.
|
||||
@@ -0,0 +1,88 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Edit an existing spreadsheet"
|
||||
category: guide
|
||||
permalink: /guides/edit-existing-spreadsheet/
|
||||
---
|
||||
|
||||
Editing an existing spreadsheet is a pretty common task that {{ site.spout_html }} is totally capable of doing.
|
||||
|
||||
With {{ site.spout_html }}, it is not possible to do things like `deleteRow(3)` or `insertRowAfter(5, $newRow)`. This is because {{ site.spout_html }} does not keep an in-memory representation of the entire spreadsheet, to avoid consuming all the memory available with large spreadsheets. This means, {{ site.spout_html }} does not know how to jump to the 3rd row directly and has especially no way of moving backwards (changing row 3 after having changed row 5). So let's see how this can be done, in a scalable way.
|
||||
|
||||
For this example, let's assume we have an existing ODS spreadsheet called "my-music.ods" that looks like this:
|
||||
|
||||
| Song title | Artist | Album | Year |
|
||||
| ---------------- | --------------- | --------------- | ---- |
|
||||
| Yesterday | The Beatles | The White Album | 1968 |
|
||||
| Yellow Submarine | The Beatles | Unknown | 1968 |
|
||||
| Space Oddity | David Bowie | David Bowie | 1969 |
|
||||
| Thriller | Michael Jackson | Thriller | 1982 |
|
||||
| No Woman No Cry | Bob Marley | Legend | 1984 |
|
||||
| Buffalo Soldier | Bob Marley | Legend | 1984 |
|
||||
|
||||
> Note that the album for "Yellow Submarine" is "Unknown" and that the songs are ordered by year (most recent last).
|
||||
|
||||
We'd like to update the missing album for "Yellow Submarine", remove the Bob Marley's songs and add a new song: "Hotel California" from "The Eagles", released in 1976. Here is how this can be done:
|
||||
|
||||
```php
|
||||
<?php
|
||||
|
||||
use Box\Spout\Reader\ReaderFactory;
|
||||
use Box\Spout\Writer\WriterFactory;
|
||||
use Box\Spout\Common\Type;
|
||||
|
||||
$existingFilePath = '/path/to/my-music.ods';
|
||||
$newFilePath = '/path/to/my-new-music.ods';
|
||||
|
||||
// we need a reader to read the existing file...
|
||||
$reader = ReaderFactory::create(Type::ODS);
|
||||
$reader->open($existingFilePath);
|
||||
$reader->setShouldFormatDates(true); // this is to be able to copy dates
|
||||
|
||||
// ... and a writer to create the new file
|
||||
$writer = WriterFactory::create(Type::ODS);
|
||||
$writer->openToFile($newFilePath);
|
||||
|
||||
// let's read the entire spreadsheet
|
||||
foreach ($reader->getSheetIterator() as $sheetIndex => $sheet) {
|
||||
// Add sheets in the new file, as you read new sheets in the existing one
|
||||
if ($sheetIndex !== 1) {
|
||||
$writer->addNewSheetAndMakeItCurrent();
|
||||
}
|
||||
|
||||
foreach ($sheet->getRowIterator() as $rowIndex => $row) {
|
||||
$songTitle = $row[0];
|
||||
$artist = $row[1];
|
||||
|
||||
// Change the album name for "Yellow Submarine"
|
||||
if ($songTitle === 'Yellow Submarine') {
|
||||
$row[2] = 'The White Album';
|
||||
}
|
||||
|
||||
// skip Bob Marley's songs
|
||||
if ($artist === 'Bob Marley') {
|
||||
continue;
|
||||
}
|
||||
|
||||
// write the edited row to the new file
|
||||
$writer->addRow($row);
|
||||
|
||||
// insert new song at the right position, between the 3rd and 4th rows
|
||||
if ($rowIndex === 3) {
|
||||
$writer->addRow(['Hotel California', 'The Eagles', 'Hotel California', 1976]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$reader->close();
|
||||
$writer->close();
|
||||
```
|
||||
|
||||
Optionally, if you rely on the file name or want to keep only one file, simple remove the old file and rename the new one:
|
||||
|
||||
```php?start_inline=1
|
||||
unlink($existingFilePath);
|
||||
rename($newFilePath, $existingFilePath);
|
||||
```
|
||||
|
||||
That's it! The created file now contains the updated data and is ready to be used.
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Read data from a specific sheet only"
|
||||
category: guide
|
||||
permalink: /guides/read-data-from-specific-sheet/
|
||||
---
|
||||
|
||||
Even though a spreadsheet contains multiple sheets, you may be interested in reading only one of them and skip the other ones. Here is how you can do it with Spout:
|
||||
|
||||
* If you know the name of the sheet
|
||||
|
||||
```php?start_inline=1
|
||||
$reader = ReaderFactory::create(Type:XLSX);
|
||||
$reader->open($filePath);
|
||||
|
||||
foreach ($reader->getSheetIterator() as $sheet) {
|
||||
// only read data from "summary" sheet
|
||||
if ($sheet->getName() === 'summary') {
|
||||
foreach ($sheet->getRowIterator() as $row) {
|
||||
// do something with the row
|
||||
}
|
||||
break; // no need to read more sheets
|
||||
}
|
||||
}
|
||||
|
||||
$reader->close();
|
||||
```
|
||||
|
||||
* If you know the position of the sheet
|
||||
|
||||
```php?start_inline=1
|
||||
$reader = ReaderFactory::create(Type:XLSX);
|
||||
$reader->open($filePath);
|
||||
|
||||
foreach ($reader->getSheetIterator() as $sheet) {
|
||||
// only read data from 3rd sheet
|
||||
if ($sheet->getIndex() === 2) { // index is 0-based
|
||||
foreach ($sheet->getRowIterator() as $row) {
|
||||
// do something with the row
|
||||
}
|
||||
break; // no need to read more sheets
|
||||
}
|
||||
}
|
||||
|
||||
$reader->close();
|
||||
```
|
||||
@@ -0,0 +1,110 @@
|
||||
---
|
||||
layout: page
|
||||
title: "[Symfony] Stream content of a large spreadsheet"
|
||||
category: guide
|
||||
permalink: /guides/symfony-stream-content-large-spreadsheet/
|
||||
---
|
||||
|
||||
> This tutorial is for the PHP framework [Symfony](http://symfony.com/).
|
||||
|
||||
The main benefit of streaming content is that this content can be rendered as soon as it is available. No matter how big the content is, the browser will be able to start rendering it as soon as the first byte is sent.
|
||||
|
||||
Reading a static spreadsheet to display its content to a user is a great use case for streaming. The spreadsheet can contain from a few rows to thousands of them and we don't want to wait until the whole file has been read (which can take a long time) before showing something to the user. Let's see how [Symfony's StreamedResponse](http://symfony.com/doc/current/components/http_foundation/introduction.html#streaming-a-response) let us easily stream the content of the spreadsheet.
|
||||
|
||||
A regular controller usually builds the content to be displayed and encapsulate it into a `Response` object. Everything happens synchronously. Such a controller may look like this:
|
||||
|
||||
```php?start_inline=1
|
||||
class MyRegularController extends Controller
|
||||
{
|
||||
/**
|
||||
* @Route("/spreadsheet/read")
|
||||
*/
|
||||
public function readAction()
|
||||
{
|
||||
$filePath = '/path/to/static/file.xlsx';
|
||||
|
||||
// The content to be displayed has to be built entirely
|
||||
// before it can be sent to the browser.
|
||||
$content = '';
|
||||
|
||||
$reader = ReaderFactory::create(Type::XLSX);
|
||||
$reader->open($filePath);
|
||||
|
||||
foreach ($reader->getSheetIterator() as $sheet) {
|
||||
$content .= '<table>';
|
||||
foreach ($sheet->getRowIterator() as $row) {
|
||||
$content .= '<tr>';
|
||||
$content .= implode(array_map(function($cell) {
|
||||
return '<td>' . $cell . '</td>';
|
||||
}, $row));
|
||||
$content .= '</tr>';
|
||||
}
|
||||
$content .= '</table><br>';
|
||||
}
|
||||
|
||||
$reader->close();
|
||||
|
||||
// The response is sent to the browser
|
||||
// once the entire file has been read.
|
||||
$response = new Response($content);
|
||||
$response->headers->set('Content-Type', 'text/html');
|
||||
|
||||
return $response;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Converting a regular controller to return a `StreamedResponse` is super easy! This is what it looks like after conversion:
|
||||
|
||||
```php?start_inline=1
|
||||
class MyStreamController extends Controller
|
||||
{
|
||||
// See below how it is used.
|
||||
const FLUSH_THRESHOLD = 100;
|
||||
|
||||
/**
|
||||
* @Route("/spreadsheet/stream")
|
||||
*/
|
||||
public function readAction()
|
||||
{
|
||||
$filePath = '/path/to/static/file.xlsx';
|
||||
|
||||
// We'll now return a StreamedResponse.
|
||||
$response = new StreamedResponse();
|
||||
$response->headers->set('Content-Type', 'text/html');
|
||||
|
||||
// Instead of a string, the streamed response will execute
|
||||
// a callback function to retrieve data chunks.
|
||||
$response->setCallback(function() use ($filePath) {
|
||||
// Same code goes inside the callback.
|
||||
$reader = ReaderFactory::create(Type::XLSX);
|
||||
$reader->open($filePath);
|
||||
|
||||
$i = 0;
|
||||
foreach ($reader->getSheetIterator() as $sheet) {
|
||||
// The main difference with the regular response is
|
||||
// that the content is now echo'ed, not appended.
|
||||
echo '<table>';
|
||||
foreach ($sheet->getRowIterator() as $row) {
|
||||
echo '<tr>';
|
||||
echo implode(array_map(function($cell) {
|
||||
return '<td>' . $cell . '</td>';
|
||||
}, $row));
|
||||
echo '</tr>';
|
||||
|
||||
$i++;
|
||||
// Flushing the buffer every N rows to stream echo'ed content.
|
||||
if ($i % FLUSH_THRESHOLD === 0) {
|
||||
flush();
|
||||
}
|
||||
}
|
||||
echo '</table><br>';
|
||||
}
|
||||
|
||||
$reader->close();
|
||||
});
|
||||
|
||||
return $response;
|
||||
}
|
||||
}
|
||||
```
|
||||
Reference in new issue
Block a user