The yii2-export extension allows you to export data from your database, server, or other source in various formats (e.g. excel, html, pdf, csv etc.) using the popular PHP Spreadsheet library. The extension simplifies this by rendering an export menu (via ExportMenu widget) that generates
a export link for each format and can accept input data from a yii\data\DataProvider.
The ExportMenu widget has a configuration very similar to the kartik\grid\GridView widget. It extends the kartik\grid\GridView widget and can thus be configured with a dataProvider and columns property just like any GridView.
However, the difference is that widget will be used for exporting the complete data and hence WOULD NOT render the grid by default. It thus does not involve any overhead of publishing GridView related assets OR run validations for filters or sorts directly. Instead, it displays the menu / list of export actions in form of a bootstrap styled ButtonDropdown menu or a simple HTML list which one can style as needed.
This menu
can be easily embedded and within the \kartik\grid\GridView toolbar and complements the client export functionality of \kartik\grid\GridView.
It can alternatively be used with the default kartik\grid\GridView as well, OR it can also be implemented as a separate component in isolation in your view.
View a complete demo.
Not seeing the updated content on this page! Hard refresh your browser to clean cache for this page (e.g. SHIFT-F5 on Windows Chrome)
ExportMenu supports configuration of the bootstrap library version so that you can use this either with any Bootstrap version 3.x and above. For setting up the bootstrap version for your extension, you can configure the ExportMenu::bsVersion property to one of the following.
To use with bootstrap 3 library - you can set ExportMenu::bsVersion property to any string starting with 3 (e.g. 3 or 3.3.7 or 3.x)
To use with bootstrap 4 library - you can set ExportMenu::bsVersion property to any string starting with 4 (e.g. 4 or 4.6.0 or 4.x)
To use with bootstrap 5 library - you can set ExportMenu::bsVersion property to any string starting with 5 (e.g. 5 or 5.1.0 or 5.x)
Generally, you may also want to set a default version globally for all Krajee Extensions (instead of setting it for each widget or extension separately). In order to do this, you can setup the bsVersion property within Yii 2 application params (i.e. Yii::$app->params['bsVersion']). To set this up, add this section of code to your application params configuration file (e.g. config/params.php):
'params' => [
'bsVersion' => '5.x', // this will set globally `bsVersion` to Bootstrap 5.x for all Krajee Extensions
// other settings
// 'adminEmail' => 'admin@example.com'
]
If ExportMenu::bsVersion property is set, in addition to Yii::$app->params['bsVersion'], the extension level setting (ExportMenu::bsVersion property) will override the Yii::$app->params['bsVersion']. If ExportMenu::bsVersion property is not set, and Yii::$app->params['bsVersion'] is also not set, ExportMenu::bsVersion property will default to 3.x (i.e. Bootstrap 3.x version will be assumed as default).
You need to install one of yiisoft/yii2-bootstrap or yiisoft/yii2-bootstrap4 or yiisoft/yii2-bootstrap5 extensions manually in your application to enable Bootstrap 3.x or 4.x or 5.x functionality respectively. This dependency has not been pre-built into the composer configuration for Krajee extensions, to allow better control to the developers in configuring their bootstrap library version. If bsVersion is set to 5.x and yiisoft/yii2-bootstrap5 is not installed, then an exception message will be thrown mentioning you to install the yiisoft/yii2-bootstrap5 extension. If bsVersion is set to 4.x and yiisoft/yii2-bootstrap4 is not installed, then an exception message will be thrown mentioning you to install the yiisoft/yii2-bootstrap4 extension. Similarly, if bsVersion is set to 3.x and yiisoft/yii2-bootstrap is not installed, an exception message will be thrown mentioning you to install the yiisoft/yii2-bootstrap extension.
To install yiisoft/yii2-bootstrap5, add the repo to the require section of your application's composer.json.
"yiisoft/yii2-bootstrap5": "@dev"
To install yiisoft/yii2-bootstrap4, add the repo to the require section of your application's composer.json.
"yiisoft/yii2-bootstrap4": "@dev"
To install yiisoft/yii2-bootstrap, add the repo to the require section of your application's composer.json.
"yiisoft/yii2-bootstrap": "@dev"
The Krajee extension asset bundle(s) by default depend on one of the following asset bundles to load the Bootstrap CSS and JS:
yii\bootstrap\BootstrapAsset and/or yii\bootstrap\BootstrapPluginAsset for bootstrap 3.x (bsVersion = 3 setting)
yii\bootstrap4\BootstrapAsset and/or yii\bootstrap4\BootstrapPluginAsset for bootstrap 4.x ( bsVersion = 4 setting)
yii\bootstrap5\BootstrapAsset and/or yii\bootstrap5\BootstrapPluginAsset for bootstrap 5.x (bsVersion = 5 setting)
This is controlled by the property bsDependencyEnabled within the asset bundle (which defaults to true). One can override this and prevent the default yii2 bootstrap assets (CSS & JS) from loading by doing one or all of the following:
Global Override: Set Yii::$app->params['bsDependencyEnabled'] to false in your Yii 2 application config params.php. This setting will be applied for all Krajee Extension Asset Bundles that depend on Bootstrap assets.
'params' => [
'bsDependencyEnabled' => false, // this will not load Bootstrap CSS and JS for all Krajee extensions
// you need to ensure you load the Bootstrap CSS/JS manually in your view layout before Krajee CSS/JS assets
//
// other params settings below
// 'bsVersion' => '5.x',
// 'adminEmail' => 'admin@example.com'
]
Asset Bundle Specific Override: Set bsDependencyEnabled to false for the specific asset bundle within Yii2 Asset Manager component in your Yii 2 application config file.
// ...
'components' => [
'assetManager' => [
'bundles' => [
'kartik\form\ActiveFormAsset' => [
'bsDependencyEnabled' => false // do not load bootstrap assets for a specific asset bundle
],
],
],
],
When setting bsDependencyEnabled to false, you need to ensure that your app code/view layout loads the Bootstrap CSS and JS on your view before the Krajee CSS/JS are loaded to ensure that the Krajee extension JS plugins and CSS styles do not get broken.
Bootstrap 5.x / 4.x does not include glyphicons or any other icons framework bundled with the library. Krajee extensions therefore will use Font Awesome 5.x icons instead of glyphicons when working with Bootstrap 5.x / 4.x. You can download Font Awesome 5.x icons from the icons website. Alternatively, you can load the free version of Font Awesome from their CDN.
For Krajee extensions and demos, the Font Awesome Free version is used and loaded as the Icons Display Package on all the Yii2 demo layouts. To include font awesome assets on your page, include the following markup on the HEAD section of your view layout file, when bsVersion is set to 4.x or 5.x.
Option 1: Font CSS version of Font Awesome:
<!-- on your view layout file HEAD section --> <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.3.1/css/all.css">
Option 2: SVG / JS version of Font Awesome (recommended for cleaner scaling vector icons and features like icon layers):
<!-- on your view layout file HEAD section --> <script defer src="https://use.fontawesome.com/releases/v5.3.1/js/all.js" crossorigin="anonymous"></script>
Alternatively, you can use the FontAwesomeAsset from the kartik-v/yii2-icons package to load the SVG/JS version.
// on your view layout file use kartik\icons\FontAwesomeAsset; FontAwesomeAsset::register($this);
The yii2-export extension can be installed automatically or manually using one of these options:
Installation via Composer is the recommended and most easy option to install Krajee Yii2 extensions. You can install yii2-export via composer package manager. Either run:
$ php composer.phar require kartik-v/yii2-export "dev-master"
or add:
"kartik-v/yii2-export": "dev-master"
to your application's composer.json file.
You may also manually install the extension to your project (in case your composer install does not work). Just download the source ZIP or TAR ball and extract the extension asset files and folders into your project. You may need to install dependencies manually and also set the namespaces to the extensions in your Yii2 extensions configurations manually.
The Export Menu extends the \kartik\grid\GridView widget, and thus allows you to setup your export menu just like a GridView using most of the GridView properties.
The following GridView properties are mandatory and important:
yii\data\DataProviderInterface, is the data provider for the Export Menu. See yii\grid\GridView::dataProvider for more details.
array, is the Grid column data configuration to be displayed in the Exported data output. See yii\grid\GridView::columns for more details.
string, the HTML content to be displayed when dataProvider does not have any data OR if no columns are selected for export. See yii\grid\GridView::emptyText for more details.
In addition to the above, the following additional properties are specially recognized for ExportMenu:
string, the target for submitting the export form, which will trigger
the download of the exported file. Defaults to ExportMenu::TARGET_POPUP. Must be one of the following:
ExportMenu::TARGET_POPUP or _popup: whereby a popup window with download progress message is displayed.
ExportMenu::TARGET_BLANK or _blank: whereby a new blank window is displayed and closed after download is finished.
ExportMenu::TARGET_SELF or _self: no window is popped up in this case, but download is submitted on same page.
NOTE: Note if you set stream to false, then this will be overridden to ExportMenu::TARGET_SELF.
array, configuration settings for the Krajee dialog widget (yii2-dialog) that will be used to render alerts and confirmation dialog prompts. Note that the yii2-dialog extension must be installed and available.
boolean, whether to show a confirmation alert dialog before download. This confirmation dialog will notify user about the type of exported file for download and to disable popup blockers. Defaults to true.
boolean, whether to enable the yii gridview formatter component for formatting columns. Defaults to true. If set to false, this will render content as raw format.
string, the HTML content to be displayed when dataProvider does not have any data OR if no columns are selected for export.
array, is the HTML attributes for the export button menu. Applicable only
if asDropdown is set to true. Defaults to ['class' => 'btn btn-secondary btn-default'].
The following special options are available:
icon: string, label for the dropdown defaults to <i class="fas fa-export"></i>
label: string, label for the dropdown defaults to empty string.
title: string, title to display on hover of the export menu dropdown button. Defaults to Export data in selected format.
itemsBefore: array, any additional items that will be merged/prepended before with the export dropdown list. This should be similar to the items property as supported by \yii\bootstrap\ButtonDropdown widget.
itemsAfter: array, any additional items that will be merged/appended after with the export dropdown list. This should be similar to the items property as supported by \yii\bootstrap\ButtonDropdown widget.
menuOptions: array, is the HTML attributes for the dropdown menu.
string, the pjax container identifier inside which this menu is being rendered. If set the jQuery export menu plugin will get auto initialized on pjax request completion.
boolean, whether to initialize data provider and clear models before rendering. Defaults to false.
boolean, whether to show a column selector to select columns for export. Defaults to true. Note that in addition to this the asDropdown must be set to true, for the column selector to be displayed.
array, the configuration of the column names in the column selector. Note: column names will be auto-generated anyway. Any setting in this property will override the auto-generated column names. This list should be setup as $key => $value where:
key: int, is the zero based index for the column as set in columns.
value: string, is the column name/label you wish to display in the column selector.
array, is the HTML attributes for the column selector dropdown button. Applicable only
if asDropdown and showColumnSelector is set to true. Defaults to ['class' => 'btn btn-secondary btn-default'].
The following special options are available:
icon: string, label for the dropdown defaults to <i class="fas fa-list"></i>
label: string, label for the dropdown defaults to empty string.
title: string, title to display on hover of the export menu dropdown button. Defaults to Select columns for export.
array, is the HTML attributes for the column selector menu list (UL tag). Applicable only
if asDropdown and showColumnSelector is set to true.
array,the settings for the toggle all checkbox to check/uncheck the columns as a batch. Should be setup as an associative array which can have the following keys:
show: boolean, whether the batch toggle checkbox is to be shown. Defaults to true.
label: string, the label to be displayed for toggle all checkbox. Defaults to Toggle All.
options: array, the HTML attributes for the toggle label text. Defaults to ['class'=>'kv-toggle-all'].
array, HTML attributes for the container to wrap the widget. Defaults to ['class'=>'btn-group', 'role'=>'group']].
string, the template for rendering the content in the container. This will
be parsed only if asDropdown is true. Defaults to {columns}\n{menu}. The following tags
will automatically be parsed and replaced:
{columns}: will be replaced with columns selector dropdown
{menu}: will be replaced with export menu dropdown
integer, timeout for the export function (in seconds), if timeout is < 0, the default PHP timeout will be used.
array, the list of column indexes that will be pre-selected in the column selector. If this is not set, all columns in column selector will be pre-selected.
array, the list of column indexes that will be disabled in the column selector. The disabled column will be pre-selected and displayed for export based on selectedColumns setting.
array, the list of column indexes that will be hidden in the column selector. The hidden column will be pre-selected and displayed for export based on selectedColumns setting.
array, the list of column indexes that will be hidden in the column selector as well as the export (this will not validate any column setting from selectedColumns).
string, the view file for rendering the export form. Defaults to _form in the widget views directory.
string, the view file for rendering the export columns selector. Defaults to _columns in the widget views directory.
array, is the configuration for each export format above. This must be setup as an associative array as
$key => $setting pairs. The array keys ($key) must be the one of the format constants:
ExportMenu::FORMAT_HTML or 'Html'
ExportMenu::FORMAT_CSV or 'Csv'
ExportMenu::FORMAT_TEXT or 'Txt'
ExportMenu::FORMAT_PDF or 'Pdf'
ExportMenu::FORMAT_EXCEL or 'Xls'
ExportMenu::FORMAT_EXCEL_X or 'Xlsx'
The array values ($setting) for each of the keys above can be a boolean false value OR a configuration array containing the following options:
icon string, is the glyphicon or font-awesome name suffix to be displayed before the export menu item label. The font awesome icons will be used, if you have setup fontAwesome propery to true. to be displayed before the export menu item label. If set to an empty string, this will not be displayed. For glyphicons, it defaults to one of the 'floppy-' glyphicons available in bootstrap.
true, so that icons would be properly rendered.
iconOptions: array, HTML attributes for export menu icon.
linkOptions: array, HTML attributes for each export item link.
label string, is the label for the export format menu item displayed.
extension string, is the extension for the above file name.
alertMsg string, is the message prompt to show before saving. If this is empty or not set it will not be displayed.
mime string, is the mime type (for the file format) to be set before downloading.
writer string, is the PHPSpreadsheet writer type.
options: array, HTML attributes for export menu item.
$settings as false or an empty array. For example to disable TEXT and PDF:
exportConfig => [
ExportMenu::FORMAT_TEXT => false,
ExportMenu::FORMAT_PDF => false
]
The exportConfig if not set will default to the following:
[
ExportMenu::FORMAT_HTML => [
'label' => Yii::t('kvexport', 'HTML'),
'icon' => $isFa ? 'file-text' : 'floppy-saved',
'iconOptions' => ['class' => 'text-info'],
'linkOptions' => [],
'options' => ['title' => Yii::t('kvexport', 'Hyper Text Markup Language')],
'alertMsg' => Yii::t('kvexport', 'The HTML export file will be generated for download.'),
'mime' => 'text/html',
'extension' => 'html',
'writer' => ExportMenu::FORMAT_HTML
],
ExportMenu::FORMAT_CSV => [
'label' => Yii::t('kvexport', 'CSV'),
'icon' => $isFa ? 'file-code-o' : 'floppy-open',
'iconOptions' => ['class' => 'text-primary'],
'linkOptions' => [],
'options' => ['title' => Yii::t('kvexport', 'Comma Separated Values')],
'alertMsg' => Yii::t('kvexport', 'The CSV export file will be generated for download.'),
'mime' => 'application/csv',
'extension' => 'csv',
'writer' => ExportMenu::FORMAT_CSV
],
ExportMenu::FORMAT_TEXT => [
'label' => Yii::t('kvexport', 'Text'),
'icon' => $isFa ? 'file-text-o' : 'floppy-save',
'iconOptions' => ['class' => 'text-muted'],
'linkOptions' => [],
'options' => ['title' => Yii::t('kvexport', 'Tab Delimited Text')],
'alertMsg' => Yii::t('kvexport', 'The TEXT export file will be generated for download.'),
'mime' => 'text/plain',
'extension' => 'csv',
'writer' => ExportMenu::FORMAT_TEXT
],
ExportMenu::FORMAT_PDF => [
'label' => Yii::t('kvexport', 'PDF'),
'icon' => $isFa ? 'file-pdf-o' : 'floppy-disk',
'iconOptions' => ['class' => 'text-danger'],
'linkOptions' => [],
'options' => ['title' => Yii::t('kvexport', 'Portable Document Format')],
'alertMsg' => Yii::t('kvexport', 'The PDF export file will be generated for download.'),
'mime' => 'application/pdf',
'extension' => 'pdf',
'writer' => ExportMenu::FORMAT_PDF
],
ExportMenu::FORMAT_EXCEL => [
'label' => Yii::t('kvexport', 'Excel 95 +'),
'icon' => $isFa ? 'file-excel-o' : 'floppy-remove',
'iconOptions' => ['class' => 'text-success'],
'linkOptions' => [],
'options' => ['title' => Yii::t('kvexport', 'Microsoft Excel 95+ (xls)')],
'alertMsg' => Yii::t('kvexport', 'The EXCEL 95+ (xls) export file will be generated for download.'),
'mime' => 'application/vnd.ms-excel',
'extension' => 'xls',
'writer' => ExportMenu::FORMAT_EXCEL
],
ExportMenu::FORMAT_EXCEL_X => [
'label' => Yii::t('kvexport', 'Excel 2007+'),
'icon' => $isFa ? 'file-excel-o' : 'floppy-remove',
'iconOptions' => ['class' => 'text-success'],
'linkOptions' => [],
'options' => ['title' => Yii::t('kvexport', 'Microsoft Excel 2007+ (xlsx)')],
'alertMsg' => Yii::t('kvexport', 'The EXCEL 2007+ (xlsx) export file will be generated for download.'),
'mime' => 'application/application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
'extension' => 'xlsx',
'writer' => ExportMenu::FORMAT_EXCEL_X
],
]
string, is the request parameter (received via $_GET or $_POST response) that will be submitted during export. This should be unique for each export menu widget (for multiple export menu widgets on same page). If not set this will be auto generated.
boolean, whether to use font awesome icons for rendering the icons as defined in exportConfig. If set to true, you must load the FontAwesome CSS separately in your application.
boolean, whether to strip HTML tags from formatted content in each data cell before rendering the PhpSpreadsheet Cell. Defaults to true.
array, is the output style configuration options for each data cell setup as an associative array: $key => $setting. The $key must be one of ExportMenu::FORMAT_ constants. Note that one can also set the exportMenuStyle property for each grid column to format one's style specific to the column (note that the column class must be kartik\grid\DataColumn or kartik\grid\SerialColumn). The $setting must be the style configuration
array as required by PHPSpreadsheet. This defaults to an empty array.
array, is the the output style configuration options for the header row setup as an associative array: $key => $setting. The $key must be one of ExportMenu::FORMAT_ constants. The $setting must be the style configuration
array as required by PHPSpreadsheet. Note that one can also set the exportHeaderMenuStyle property for each grid column to format one's header style specific to the column (note that the column class must be kartik\grid\DataColumn or kartik\grid\SerialColumn). The following configuration is defaulted for headerStyleOptions:
[
ExportMenu::FORMAT_HTML => $defaultStyle,
ExportMenu::FORMAT_PDF => $defaultStyle,
ExportMenu::FORMAT_EXCEL => $defaultStyle,
ExportMenu::FORMAT_EXCEL_X => $defaultStyle,
]
// where $defaultStyle is set as below
$defaultStyle = [
'font' => ['bold' => true],
'fill' => [
'fillType' => Fill::FILL_SOLID,
'color' => [
'argb' => 'FFE5E5E5',
],
],
'borders' => [
'outline' => [
'borderStyle' => Border::BORDER_MEDIUM,
'color' => ['argb' => Color::COLOR_BLACK],
],
'inside' => [
'borderStyle' => Border::BORDER_THIN,
'color' => ['argb' => Color::COLOR_BLACK],
]
],
];
array, is the the output style configuration options for the entire spreadsheet data range box as an associative array: $key => $setting. The $key must be one of ExportMenu::FORMAT_ constants. The headerStyleOptions will be parsed and applied
again after boxStyleOptions to ensure the header row box formatting is correct. The $setting must be the style configuration array as required by PHPSpreadsheet. The following configuration is defaulted for boxStyleOptions:
[
ExportMenu::FORMAT_HTML => $defaultStyle,
ExportMenu::FORMAT_PDF => $defaultStyle,
ExportMenu::FORMAT_EXCEL => $defaultStyle,
ExportMenu::FORMAT_EXCEL_X => $defaultStyle,
]
// where $defaultStyle is set as below
$defaultStyle = [
'borders' => [
'outline' => [
'borderStyle' => Border::BORDER_MEDIUM,
'color' => ['argb' => Color::COLOR_BLACK],
],
'inside' => [
'borderStyle' => Border::BORDER_DOTTED,
'color' => ['argb' => Color::COLOR_BLACK],
]
],
];
array, an array of rows to prepend in front of the exported grid. This can be used to add content like a table caption/title. The array can be configured with the following keys:
value: string, the value of the merged row
styleOptions: array, array of configuration options to set the style. See styleOptions on the various settings to configure.
array, an array of rows to append in end of the exported grid. This can be used to extend content in table footer. The array can be configured with the following keys:
value: string, the value of the merged row
styleOptions: array, array of configuration options to set the style. See styleOptions on the various settings to configure.
string, the folder to save the exported file. Defaults to @app/runtime/export/. If
the specified folder does not exist, the extension will attempt to create it - else an exception will be thrown.
string|boolean, the view file to show details of exported file link. This property will be validated only when stream is false. You can set this to false to not display any file link details for view. Else it defaults to _view, which will use the extension inbuilt view.
string, the web accessible path for the saved file location. This property will be parsed only if
stream is set to false. Note that the
afterSaveView property will render the displayed file link. Check the configure files link demo for details on setting this.
string, the name of the file to be appended to linkPath to generate the complete link. If not set, this will default to the filename. Check the configure files link demo for details on setting this.
integer, fetch models from the dataprovider using batches (pages) of this size. Set this to 0 (the default) to disable. If $dataProvider does not have a pagination object, this parameter is ignored. Setting this property helps reduce memory overflow issues by allowing parsing of models in batches, rather than fetching all models in one go.
array, is the configuration of various messages that will be displayed at runtime:
allowPopups: string, is the message to be shown to disable browser popups for download. Defaults to Disable any popup blockers in your browser to ensure proper download..
confirmDownload: string, is the message to be shown for confirming to proceed with the download. Defaults to Ok to proceed?.
downloadProgress: string, is the message to be shown in a popup dialog when download request is executed. Defaults to Generating file. Please wait....
downloadProgress: string, is the message to be shown in a popup dialog when download request is completed. Defaults to All done! Click anywhere here to close this window, once you have downloaded the file..
Closure, is the callback function on initializing the PhpSpreadsheet library. The anonymous function should have the following signature:
function ($sheet, $widget)
where:
sheet: \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet, is the PHPSpreadsheet work sheet object instance
widget: ExportMenu, is the current ExportMenu object instance
Closure, is the callback function that is executed on initializing the work sheet. The anonymous function should have the following signature:
function ($sheet, $widget)
where:
sheet: \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet, is the PHPSpreadsheet work sheet object instance
widget: ExportMenu, is the current ExportMenu object instance
Closure, is the callback function that is executed on initializing the writer. The anonymous function should have the following signature:
function ($writer, $widget)
where:
writer: \PhpOffice\PhpSpreadsheet\Writer\BaseWriter, is the PHPSpreadsheet writer object instance
widget: ExportMenu, is the current ExportMenu object instance
Closure, is the callback function that is executed on rendering the header cell output content. The anonymous function should have the following signature:
function ($cell, $content, $widget)
where:
cell: \PhpOffice\PhpSpreadsheet\Cell\Cell, is the PHPSpreadsheet cell object instance
content: string, is the header cell content being rendered
widget: ExportMenu, is the current ExportMenu object instance
Refer the On Render Methods section for more details on the usage of these event based callbacks.
Closure, is the callback function that is executed on rendering each body data cell output content. The anonymous function should have the following signature:
function ($cell, $content, $model, $key, $index, $widget)
where:
cell: \PhpOffice\PhpSpreadsheet\Cell\Cell, is the PHPSpreadsheet work sheet object instance
content: string, is the header cell content being rendered
model mixed, is the data model
key mixed, is the key associated with the data model
index integer, is the zero-based index of the data model among the models array returned by GridView::dataProvider
widget: ExportMenu, is the current ExportMenu object instance
Refer the On Render Methods section for more details on the usage of these event based callbacks.
Closure, is the callback function that is executed on rendering the footer cell output content. The anonymous function should have the following signature:
function ($cell, $content, $widget)
where:
cell: \PhpOffice\PhpSpreadsheet\Cell\Cell, is the PHPSpreadsheet work sheet object instance
content: string, is the footer cell content being rendered
widget: ExportMenu, is the current ExportMenu object instance
Refer the On Render Methods section for more details on the usage of these event based callbacks.
Closure, is the callback function that is executed on rendering the work sheet. The anonymous function should have the following signature:
function ($sheet, $widget)
where:
sheet: \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet, is the PHPSpreadsheet work sheet object instance
widget: ExportMenu, is the current ExportMenu object instance
Refer the On Render Methods section for more details on the usage of these event based callbacks.
Closure, is the callback function that is executed after file is generated. The anonymous function should have the following signature:
function ($extension, $widget)
where:
extension: string, is the currently exported file extension
widget: ExportMenu, is the current ExportMenu object instance
Refer the On Render Methods section for more details on the usage of these event based callbacks. Check the configure files link demo for details on setting this.
array, is the internalization configuration for this module. Defaults to:
[
'class' => 'yii\i18n\PhpMessageSource',
'basePath' => '@kvexport/messages',
'forceTranslation' => true
];
boolean, enable dynagrid widget functionality (yii2-dynagrid) for column selection. If set to true the inbuilt export menu column selector
functionality will be disabled and not rendered and columns set as part of kartik\dynagrid\Dynagrid widget as per settings in dynagridOptions will be used. Defaults to false.
array, configuration options for the yii2-dynagrid widget (applicable when dynagrid is set to true). Defaults to:
[
'options' => ['id' => 'dynagrid-export-menu']
]
The widget offers an event based approach to manipulate PHPSpreadsheet output. This is made possible via the onRender callbacks available as properties to this widget. The following properties can be setup as an anonymous Closure callbacks, as mentioned in the widget settings section
Each of the methods above allows accesses to the current export menu grid object instance. This is available as a parameter $widget within each of the callbacks above. The following list of getters, setters, and methods could be accessible via the $widget object instance. Note that this list below is not comprehensive. All public properties and methods of ExportMenu should be accessible via the $widget object instance.
// getters $widget->getPHPSpreadsheet(); // returns PHPSpreadsheet object instance $widget->getPHPSpreadsheetWriter(); // returns PHPSpreadsheet Writer object instance $widget->getPHPSpreadsheetSheet(); // returns PHPSpreadsheet Sheet object instance $widget->getExportType(); // returns the currently selected export type // setters $widget->setPHPSpreadsheet($obj); // sets/overwrites the PHPSpreadsheet object $widget->setPHPSpreadsheetWriter($obj); // sets/overwrites the PHPSpreadsheet Writer object $widget->setPHPSpreadsheetSheet($obj); // sets/overwrites the PHPSpreadsheet Sheet object // other methods - check the ExportMenu source for public methods and properties $widget->destroyPHPSpreadsheet(); // destroys the current PHPSpreadsheet object
An example of configuring the onRenderSheet method could be:
'onRenderSheet' => function($sheet, $widget) {
$exportType = $widget->getExportType(); // currently selected export type
if ($exportType == ExportMenu::FORMAT_EXCEL_X) {
$sheet->setCellValue("A5", "=SUM(A1:A4)"); // setting a formula in cell A5
}
}
yii2-export is released under the BSD-3-Clause License. See the bundled LICENSE.md for details.
Comments & Discussion
Note
You can now visit the Krajee Webtips Q & A forum for searching OR asking questions OR helping programmers with answers on these extensions and plugins. For asking a question click here. Select the appropriate question category (i.e. Krajee Plugins) and choose this current page plugin in the question related to field.
The comments and discussion section below are intended for generic discussions or feedback for this plugin. Developers may not be able to search or lookup here specific questions or tips on usage for this plugin.