README

yii2-export

使用 PhpSpreadsheet 库将服务器/数据库数据导出为各种格式（例如 excel、html、pdf、csv 等）的库。小部件允许您像配置 yii\grid\GridView 一样配置数据提供者和列。然而，它只以按钮下拉菜单的形式显示导出操作，以便嵌入到您的 GridView 或其他组件中。

此外，从版本 v1.2.0 开始，该扩展还显示一个实用的网格列选择器，用于控制导出列。列选择器可用的功能包括：

显示一个列选择器下拉列表，允许选择要导出的列。
新的 container 属性允许您将导出菜单和列选择器下拉菜单分组。
新的 template 属性用于操作菜单、列选择器或按钮组中额外按钮的显示。
通过 columnSelectorOptions 配置列选择器下拉按钮。
自动在列选择器中生成列标签。但您可以通过 columnSelector 属性设置覆盖每个列键的显示列标签。
通过 selectedColumns 预选列（您必须设置所选列键）。
通过 disabledColumns 在列选择器中禁用列（您必须设置禁用列键）。
通过 hiddenColumns 在列选择器中隐藏列（您必须设置隐藏列键）。
通过 noExportColumns 在导出和列选择器中隐藏列（您必须设置不导出列键）。
通过 showColumnSelector 属性切换列选择器的显示。
只有当 asDropdown 设置为 true 时，列选择器才会显示。

该扩展通过视图模板提供可配置的用户界面，用于高级情况。

exportColumnsView 允许您设置自己的自定义视图文件以渲染列选择器下拉菜单。
afterSaveView 允许您设置自己的保存视图文件，如果您配置将导出文件保存在服务器上。

演示

您可以在文档和演示中查看扩展的详细信息和用法。

版本更改

注意：有关各个版本更改的详细信息，请参阅变更日志。

安装

安装此扩展的首选方法是通过 composer。

注意：请参阅此网络提示/wiki 了解如何为您的应用程序的 composer.json 设置 minimum-stability 设置。

先决条件

根据您的Bootstrap版本安装必要的先决条件（Krajee Dropdown扩展）

对于Bootstrap v5.x，请安装扩展 kartik-v/yii2-bootstrap5-dropdown
对于Bootstrap v4.x，请安装扩展 kartik-v/yii2-bootstrap4-dropdown
对于Bootstrap v3.x，请安装扩展 kartik-v/yii2-dropdown-x

例如，如果您使用的是Bootstrap v5.x，请将以下内容添加到您的 composer.json 文件的 require 部分

"kartik-v/yii2-bootstrap5-dropdown": "@dev"

安装

运行以下命令之一：

$ php composer.phar require kartik-v/yii2-export "@dev"

或将其添加到您的 composer.json 文件的 require 部分。

"kartik-v/yii2-export": "@dev"

注意：您必须运行 composer update 以获取最新稳定依赖项，如 kartik-v/yii2-krajee-base

注意：您必须运行 composer update 以获取最新稳定依赖项，如 kartik-v/yii2-krajee-base

先决条件

yii2-export 扩展依赖于 yii2-grid 扩展模块。为了开始使用 yii2-export，您需要确保在应用程序模块配置文件中设置 gridview 模块。例如

'modules' => [
    'gridview' => [
        'class' => 'kartik\grid\Module',
        // other module settings
    ]
]

使用方法

ExportMenu

use kartik\export\ExportMenu;
$gridColumns = [
    ['class' => 'yii\grid\SerialColumn'],
    'id',
    'name',
    'color',
    'publish_date',
    'status',
    ['class' => 'yii\grid\ActionColumn'],
];

// Renders a export dropdown menu
echo ExportMenu::widget([
    'dataProvider' => $dataProvider,
    'columns' => $gridColumns,
    'clearBuffers' => true, //optional
]);

// You can choose to render your own GridView separately
echo \kartik\grid\GridView::widget([
    'dataProvider' => $dataProvider,
    'filterModel' => $searchModel,
    'columns' => $gridColumns
]);