Class kartik\export\ExportMenu

The table beginning row

Whether the column selector is enabled

The default export configuration

The current table end column

The current table end row

Columns to be grouped

Grouped row values

The header beginning row

Object instance

Object instance

Object instance

The modified data provider for usage with export.

The visble columns for export

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. This defaults to the _view PHP file in the views folder of the extension.

Whether to render the export menu as bootstrap button dropdown widget. Defaults to true. If set to false, this will generate a simple HTML list of links.

Whether to auto-size the excel output column widths. Defaults to true.

Fetch models from the dataprovider using batches 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.

The output style configuration options for the entire spreadsheet box range. It must be the style configuration array as required by \PhpOffice\PhpSpreadsheet\Spreadsheet.

Whether to clear all previous / parent buffers. Defaults to false.

The column selector flag parameter for export form

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. Defaults to Select Columns.
• options: array, the HTML attributes for the toggle label text. Defaults to ['class'=>'kv-toggle-all']

The configuration of the column names in the column selector. Note: column names will be generated automatically by default. Any setting in this property will override the auto-generated column names. This list should be setup as $key => $value where:

• $key: integer, is the zero based index of the column as set in $columns.
• $value: string, is the column name/label you wish to display in the column selector.

The HTML attributes for the column selector menu list.

The HTML attributes for the column selector dropdown button. The following special options are recognized:

• label: string, defaults to empty string.
• icon: string, defaults to <i class="glyphicon glyphicon-list"></i> for BS3 and <i class="fas fa-list"></i> for BS4
• title: string, defaults to Select columns for export.

HTML attributes for the container to wrap the widget. Defaults to: ['class'=>'btn-group', 'role'=>'group']

An array of rows to append after the footer row. Each array should be set with the following settings:

• value: string, the value of the merged row
• cellFormat: string|null, the explicit cell format to apply (should be one of the PhpOffice\PhpSpreadsheet\Cell\DataType::TYPE_ constants)
• styleOptions: array, array of configuration options to set the style. See $styleOptions on how to configure.

An array of rows to prepend in front of the grid used to create things like a title. Each array should be set with the following settings:

• value: string, the value of the merged row
• cellFormat: string|null, the explicit cell format to apply (should be one of the PhpOffice\PhpSpreadsheet\Cell\DataType::TYPE_ constants)
• styleOptions: array, array of configuration options to set the style. See $styleOptions on how to configure.

Data for creating excel data validation. An example setting: 'dataValidation' => ['sheetName1' => ['cellPosition' => count($array)], 'sheetName2' => []], If set to empty or null will be ignored.

Whether to delete file after saving file to $folder and when $stream is false. This property will be validated only when $stream is false.

The column indexes for export that will be disabled for selection in the column selector.

The \PhpOffice\PhpSpreadsheet\Spreadsheet document properties

The HTML attributes for the export button menu. Applicable only if $asDropdown is set to true. The following special options are available:

• label: string, defaults to empty string
• icon: string, defaults to <i class="glyphicon glyphicon-export"></i> for BS3 and <i class="fas fa-external-link-alt"></i> for BS4
• title: string, defaults to Export data in selected format.
• menuOptions: array, the HTML attributes for the dropdown menu.
• 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 ButtonDropdown widget. Note the page export items will be automatically generated based on settings in the $exportConfig property.
• 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 ButtonDropdown widget. Note the page export items will be automatically generated based on settings in the exportConfig property.

Enable dynagrid for column selection. If set to true the inbuilt export menu column selector functionality will be disabled and not rendered and column settings for dynagrid will be used as per settings configured in $dynagridOptions.

Dynagrid widget options. Applicable only if $dynagrid is set to true.

Enable or disable cell formatting by auto detecting the grid column alignment and format. If set to false the format will not be applied but improve performance configured in $dynagridOptions.

Whether to enable the yii gridview formatter component. Defaults to true. If set to false, this will render content as raw format.

Encoding for the downloaded file header. Defaults to ENCODING_UTF8.

The export columns input parameter for export form

The view file for rendering the columns selection

The export configuration. The array keys must be the one of the format constants (CSV, HTML, TEXT, EXCEL, PDF) and the array value is a configuration array consisting of these settings:

• label: string, the label for the export format menu item displayed
• icon: string, the glyphicon or font-awesome name suffix to be displayed before the export menu item label. If set to an empty string_, this will not be displayed.
• iconOptions: array, HTML attributes for export menu icon.
• linkOptions: array, HTML attributes for each export item link.
• filename: string, the base file name for the generated file. Defaults to 'grid-export'. This will be used to generate a default file name for downloading.
• extension: string, the extension for the file name
• alertMsg: string, the message prompt to show before saving. If this is empty or not set it will not be displayed.
• mime: string, the mime type (for the file format) to be set before downloading.
• writer: string, the PhpSpreadsheet writer type
• options: array, HTML attributes for the export menu item.

The configuration of additional hidden inputs that will be rendered with the export form. This will be set as an array of hidden input $name => $setting pairs where:

• $name: string, is the hidden input name attribute.
• $setting: array, containing the following settings:
  • value: string, the value of the hidden input. Defaults to NULL.
  • options: array, the HTML attributes for the hidden input. Defaults to an empty array [].

An example of how you can configure this property is shown below:

[
   'inputName1' => ['value' => 'inputValue1'],
   'inputName2' => ['value' => 'inputValue2', 'options' => ['id' => 'inputId2']],
]

The HTML attributes for the export form.

The view file for rendering the export form. DEPRECATED since v1.3.5 (not parsed or used anymore).

The request parameter ($_GET or $_POST) that will be submitted during export. If not set this will be auto generated. This should be unique for each export menu widget (for multiple export menu widgets on same page).

The data output format type. Defaults to ExportMenu::FORMAT_EXCEL_X.

The export type input parameter for export form

The exported output file name. Defaults to 'grid-export';

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.

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.

The PhpSpreadsheet style configuration for a grouped grid row

The output style configuration options for the header row. It must be the style configuration array as required by \PhpOffice\PhpSpreadsheet\Spreadsheet.

The column indexes for export that will be hidden for selection in the column selector, but will still be displayed in export output.

Whether to initialize data provider and clear models before rendering. Defaults to false.

Configuration settings for the Krajee dialog widget that will be used to render alerts and confirmation dialog prompts

See also http://demos.krajee.com/dialog.

The name of the file to be appended to $linkPath to generate the complete link. If not set, this will default to the $filename.

The web accessible path for the saved file location. This property will be parsed only if $stream is false. Note the $afterSaveView property that will render the displayed file link.

The configuration of various messages that will be displayed at runtime:

• allowPopups: string, 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, the message to be shown for confirming to proceed with the download. Defaults to Ok to proceed?.
• downloadProgress: string, the message to be shown in a popup dialog when download request is executed. Defaults to Generating file. Please wait....
• downloadComplete: string, 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..

The column indexes for export that will not be exported at all nor will they be shown in the column selector

The callback function to be executed after the output file is generated. This function must return a boolean status of true or false. A false status will abort the post file generation activities. The anonymous function should have the following signature: `php function ($fileExt, $widget) ` where:

• $fileExt: string, is the generated file extension.
• $widget: ExportMenu, the current ExportMenu object instance

The callback function on initializing the PhpSpreadsheet library. The anonymous function should have the following signature: `php function ($spreadsheet, $widget) ` where:

• $spreadsheet: \PhpOffice\PhpSpreadsheet\Spreadsheet, the Spreadsheet object instance
• $widget: ExportMenu, the current ExportMenu object instance

The callback function to be executed on initializing the active sheet. The anonymous function should have the following signature: `php function ($sheet, $widget) ` where:

• $sheet: \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet, the Worksheet object instance
• $widget: ExportMenu, the current ExportMenu object instance

The callback function on initializing the writer. The anonymous function should have the following signature: `php function ($writer, $widget) ` where:

• $writer: \PhpOffice\PhpSpreadsheet\Writer\BaseWriter, the BaseWriter object instance
• $widget: ExportMenu, the current ExportMenu object instance

The callback function to be executed on rendering each body data cell content. The anonymous function should have the following signature: `php function ($cell, $content, $model, $key, $index, $widget) ` where:

• $cell: \PhpOffice\PhpSpreadsheet\Cell\Cell, the current Spreadsheet cell being rendered
• $content: string, the data cell content being rendered
• $model: Model, the data model to be rendered
• $key: mixed, the key associated with the data model
• $index: integer, the zero-based index of the data model among the model array returned by $dataProvider.
• $widget: ExportMenu, the current ExportMenu object instance

The callback function to be executed on rendering the footer cell output content. The anonymous function should have the following signature: `php function ($cell, $content, $widget) ` where:

• $sheet: \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet, the Worksheet object instance
• $content: string, the footer cell content being rendered
• $widget: ExportMenu, the current ExportMenu object instance

The callback function to be executed on rendering the header cell output content. The anonymous function should have the following signature: `php function ($cell, $content, $widget) ` where:

• $cell: \PhpOffice\PhpSpreadsheet\Cell\Cell, is the current Spreadsheet cell being rendered
• $content: string, is the header cell content being rendered
• $widget: ExportMenu, the current ExportMenu object instance

The callback function to be executed on rendering the sheet. The anonymous function should have the following signature: `php function ($sheet, $widget) ` where:

• $sheet: \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet, the Worksheet object instance
• $widget: ExportMenu, the current ExportMenu object instance

The current \PhpOffice\PhpSpreadsheet\Spreadsheet object instance

The current \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet object instance

The current \PhpOffice\PhpSpreadsheet\Writer\BaseWriter object instance

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.

The selected column indexes for export. If not set this will default to all columns.

The sheet name. Defaults to 'Worksheet'.

Whether to show a column selector to select columns for export. Defaults to true. This is applicable only if $asDropdown is set to true. Else this property is ignored.

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.

Whether to stream output to the browser.

Whether to strip HTML tags from each of the source column data before rendering the PHP Spreadsheet Cell.

The output style configuration options for each data cell. It must be the style configuration array as required by \PhpOffice\PhpSpreadsheet\Spreadsheet.

New supplement sheets to be created. Required for data validation in excel. An example setting: 'supplementSheets' => ['city' => $citiesKeyValueArray, 'state' => $stateKeyValueArray], If set to empty or null will be ignored.

The target for submitting the export form, which will trigger the download of the exported file. Must be one of the TARGET_ constants. Defaults to TARGET_SELF. Note if you set $stream to false, then this will be always overridden to TARGET_SELF.

The template for rendering the content in the container. This will be parsed only if asDropdown is true. The following tokens will be replaced:

• {columns}: will be replaced with the column selector dropdown
• {menu}: will be replaced with export menu dropdown

Timeout for the export function (in seconds), if timeout is < 0, the default PHP timeout will be used.

Flag to identify if download is triggered

The columns configuration