PHPackages                             vartruexuan/yii-excel - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [PDF & Document Generation](/categories/documents)
4. /
5. vartruexuan/yii-excel

ActiveLibrary[PDF & Document Generation](/categories/documents)

vartruexuan/yii-excel
=====================

excel导入导出组件

v1.2.1(1y ago)3136MITPHPPHP >=8.2

Since Jul 12Pushed 1y agoCompare

[ Source](https://github.com/vartruexuan/yii-excel)[ Packagist](https://packagist.org/packages/vartruexuan/yii-excel)[ Docs](https://github.com/vartruexuan/yii-excel)[ RSS](/packages/vartruexuan-yii-excel/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)Dependencies (9)Versions (6)Used By (0)

yii-excel
=========

[](#yii-excel)

[![php](https://camo.githubusercontent.com/af3c14fed4241be47ccc899f006a8cddf0bd4f0ee21ac9b1ed280a351df75c08/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d2533453d382e322d627269676874677265656e2e7376673f6d61784167653d32353932303030)](https://github.com/php/php-src)[![Latest Stable Version](https://camo.githubusercontent.com/cd3ebafbbd499bd3fa31cacbac32d7ca89e3e465967aa42966672b1c7320a18e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f766172747275657875616e2f7969692d657863656c)](https://packagist.org/packages/vartruexuan/yii-excel)[![Total Downloads](https://camo.githubusercontent.com/b5c094a781c3054b30ce965b16ef712861a7d1f739e0a99e8cfdf26bcb0aea82/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f766172747275657875616e2f7969692d657863656c)](https://packagist.org/packages/vartruexuan/yii-excel)[![License](https://camo.githubusercontent.com/85cce26440fad3c7050f3633d1afac94a0437308e46dfc401254307e0e7dd7cc/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f766172747275657875616e2f7969692d657863656c)](https://github.com/vartruexuan/yii-excel)

概述
==

[](#概述)

excel 导入导出,支持异步、进度构建。

组件能力
----

[](#组件能力)

- 导入、导出excel
- 支持异步操作,进度构建,进度消息输出
- 格式 `xlsx`
- ...

安装
==

[](#安装)

- 安装依赖拓展 [xlswriter](https://xlswriter-docs.viest.me/zh-cn/an-zhuang)

```
pecl install xlswriter
```

- 安装组件

```
composer require vartruexuan/yii-excel
```

使用
--

[](#使用)

### 配置

[](#配置)

- 配置组件 `components`

```
[
    'components' => [
        // excel组件
        'excel' => [
            'class' => \vartruexuan\excel\drivers\xlswriter\Excel::class,
            'fileSystem' => 'filesystem', // 文件管理组件(默认:filesystem)
            'redis' => 'redis',// redis组件(默认:redis)
            'queue' => 'queue', // 队列组件(默认:queue)
            // 进度组件
            'progress'=>[
                'class' => \vartruexuan\excel\ExcelProgress::class,
                'expireTime' => 3600, // 进度信息失效时长(秒)
                'prefix' => 'excel',// key前缀
                'redis' => 'redis',// redis组件(默认:redis)
                'queue' => 'queue', // 队列组件(默认:queue)
            ],
            // 进度行为
            'as progress' => \vartruexuan\excel\behaviors\ExcelProgressBehavior::class,
            // 日志行为
            'as log' => \vartruexuan\excel\behaviors\ExcelLogBehavior::class
        ]
    ]
]
```

- api

```
// 导出
\Yii::$app->excel->export(\vartruexuan\excel\data\export\ExportConfig $config);
// 导入
\Yii::$app->excel->import(\vartruexuan\excel\data\export\ImportConfig $config);
// 进度查询
\Yii::$app->excel->progress->getProgressRecord($token,true);
// 进度消息输出查询
\Yii::$app->excel->progress->getProgressMessage($token);
```

### 导出

[](#导出)

```
/**
 * 导出配置
 *
 * @var \vartruexuan\excel\data\export\ExportConfig $config
 */
$config = new DemoExportConfig([
    // 额外参数,比如导出需要筛选时
    'param' => [
         'name' => '先生',
     ]
]);
/**
 *  导出数据
 *
 * @var  \vartruexuan\excel\data\export\ExportData $exportData
 */
$exportData = \Yii::$app->excel->export($config);
$token = $exportData->token; // 导出唯一标识
```

- 配置

```