Skip to content

Commit

Permalink
Add info about required ExcelBundle version
Browse files Browse the repository at this point in the history
  • Loading branch information
loostro committed Jun 16, 2014
1 parent df426ba commit 6ef1574
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
8 changes: 5 additions & 3 deletions Resources/doc/builders/excel-builder.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@

[back-to-index]: https://github.com/symfony2admingenerator/AdmingeneratorGeneratorBundle/blob/master/Resources/doc/documentation.md#4-generator

### Requirements

To use the Excel export make sure you have installed the recommended dependency `liuggio/excelbundle` (version `>= 2.0`) and enabled it in your AppKernel.php (`new Liuggio\ExcelBundle\LiuggioExcelBundle()`). Without this bundle enabled the ExcelAction will not work.

### 1. Usage
The Excel builder provides an Excel export of the list view. The export uses the data that is visible on the screen (and the next pages) and thus uses the filters and scopes selected.

To use the Excel export make sure you have installes the recommended dependency `liuggio/excelbundle` and enabled it in your AppKernel.php (`new Liuggio\ExcelBundle\LiuggioExcelBundle()`). Without this bundle enabled the ExcelAction will not work.

### 2. Options

* `display`: The same as in list/new/show/edit, selects the columns to export
* `filename`: Specify the export filename. When null 'admin_export_{list title}' is used
* `filetype`: Default Excel2007. See the [excelbundle documention](https://github.com/liuggio/excelbundle#not-only-excel5) for the possible options.
* `filetype`: Default Excel2007. See the [excelbundle documention](https://github.com/liuggio/excelbundle#not-only-excel5) for the possible options.
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
},
"suggest": {
"avocode/form-extensions-bundle": "Symfony2 form extensions for Admingenerator",
"liuggio/excelbundle": "Allows the usage of the Excel export",
"liuggio/excelbundle": "(version >= 2.0) Allows the usage of the Excel export.",
"cedriclombardot/admingenerator-user-bundle": "FOSUserBundle integration for Admingenerator",
"jms/security-extra-bundle": "Allows expressions in credential checks for generated actions"
},
Expand Down

0 comments on commit 6ef1574

Please sign in to comment.