Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eightyknots/phpspreadsheet-bundle
A Symfony bundle to integrate with PHPOffice's PhpSpreadsheet library
https://github.com/eightyknots/phpspreadsheet-bundle
excel office php-library symfony symfony-bundle
Last synced: 1 day ago
JSON representation
A Symfony bundle to integrate with PHPOffice's PhpSpreadsheet library
- Host: GitHub
- URL: https://github.com/eightyknots/phpspreadsheet-bundle
- Owner: eightyknots
- License: mit
- Created: 2018-02-14T22:52:49.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-18T15:42:15.000Z (11 months ago)
- Last Synced: 2025-01-12T22:06:02.227Z (9 days ago)
- Topics: excel, office, php-library, symfony, symfony-bundle
- Language: PHP
- Size: 39.1 KB
- Stars: 57
- Watchers: 4
- Forks: 24
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PhpSpreadsheetBundle
This bundle integrates your Symfony 4/5/6/7 app with the PHPOffice PhpSpreadsheet
productivity library.
## Requirements
This bundle requires, in addition to prerequisites of each PHPOffice library:
* PHP 7.2 or higher
* Symfony 4 or higher
Note: Tags older than v1.0.0 (e.g. v0.2.0) are no longer supported due to deprecated status for both PHP <= 7.1 and Symfony <= 4.4.
## Installation
Use composer to require the latest stable version.
````bash
composer require yectep/phpspreadsheet-bundle
````
If you're not using Flex, enable the bundle in your `AppKernel.php` or `bundles.php` file.
````php
$bundles = array(
[...]
new Yectep\PhpSpreadsheetBundle\PhpSpreadsheetBundle(),
);
````
## Usage
This bundle enables the `phpoffice.spreadsheet` service.
See also the official [PHPOffice PhpSpreadsheet documentation](http://phpspreadsheet.readthedocs.io/).
### createSpreadsheet()
Creates an empty `\PhpOffice\PhpSpreadsheet\Spreadsheet` object, or, if an optional
`$filename` is passed, instantiates the `\PhpOffice\PhpSpreadsheet\IOFactory` to
automatically detect and use the appropriate `IWriter` class to read the file.
````php
// In your controller
$newSpreadsheet = $this->get('phpoffice.spreadsheet')->createSpreadsheet();
$existingXlsx = $this->get('phpoffice.spreadsheet')->createSpreadsheet('/path/to/file.xlsx');
````
### createReader(`string` $type)
Returns an instance of the `\PhpOffice\PhpSpreadsheet\Reader` class of the given `$type`.
Types are case sensitive. Supported types are:
* `Xlsx`: Excel 2007
* `Xls`: Excel 5/BIFF (95)
* `Xml`: Excel 2003 XML
* `Slk`: Symbolic Link (SYLK)
* `Ods`: Open/Libre Office (ODS)
* `Csv`: CSV
* `Html`: HTML
````php
$readerXlsx = $this->get('phpoffice.spreadsheet')->createReader('Xlsx');
$spreadsheet = $readerXlsx->load('/path/to/file.xlsx');
````
### createWriter(`Spreadsheet` $spreadsheet, `string` $type)
Given a `\PhpOffice\PhpSpreadsheet\Spreadsheet` object and a writer `$type`, returns
an instance of a `\PhpOffice\PhpSpreadsheet\Writer` class for that type.
In addition the the read types above, these types are additionally supported for writing, if
the appropriate PHP libraries are installed.
* `Tcpdf`
* `Mpdf`
* `Dompdf`
````php
$spreadsheet = $this->get('phpoffice.spreadsheet')->createSpreadsheet();
$spreadsheet->getActiveSheet()->setCellValue('A1', 'Hello world');
$writerXlsx = $this->get('phpoffice.spreadsheet')->createWriter($spreadsheet, 'Xlsx');
$writerXlsx->save('/path/to/destination.xlsx');
````
## Roadmap and Contributions
Contributions are more than welcome. Fork the project, and submit a PR when you're done.
Remaining todos include:
* Tests and test coverage
* TravisCI
* Improved documentation
## Symfony serializer
If you are migrating from Symfony Serializer component + CSV encoder - you can use code like
```php
$spreadsheet = $this->get('phpoffice.spreadsheet')->createSpreadsheet();
$sheet = $spreadsheet->getActiveSheet();
$sheet->setTitle($this->filterVars['wareCategory']->getTitle());
$columnsMap = [];
$lineIndex = 2;
foreach ($data as $line) {
foreach ($line as $columnName=>$columnValue) {
if (is_int($columnIndex = array_search($columnName, $columnsMap))) {
$columnIndex++;
} else {
$columnsMap[] = $columnName;
$columnIndex = count($columnsMap);
}
$sheet->getCellByColumnAndRow($columnIndex, $lineIndex)->setValue($columnValue);
}
$lineIndex++;
}
foreach ($columnsMap as $columnMapId=>$columnTitle) {
$sheet->getCellByColumnAndRow($columnMapId+1, 1)->setValue($columnTitle);
}
$writer = $this->get('phpoffice.spreadsheet')->createWriter($spreadsheet, 'Xlsx');
ob_start();
$writer->save('php://output');
$excelOutput = ob_get_clean();
return new Response(
$excelOutput,
200,
[
'content-type' => 'text/x-csv; charset=windows-1251',
'Content-Disposition' => 'attachment; filename="price.xlsx"'
]
);
```