vrtc/yii2-export

Yii2 It saves data in xls, csv, word, html, pdf files.

2.0 2019-12-16 10:01 UTC

Requires

• php: >=7.2
• dompdf/dompdf: *
• phpoffice/phpspreadsheet: *
• phpoffice/phpword: *
• yiisoft/yii2: *

MIT

• phpNT
• Kindeev Dmitriy

• excel
• xls
• csv
• word
• pdf
• html
• extension
• export
• dompdf
• widget
• PHPExcel
• yii2
• PhpWord

README

Описание:

Сохраняет данные в xls, csv, word, html, pdf файлы. Если, в представлении, модель Search использовалась вместе с DataProvider для вывода GridView и применялся фильтр, то к сохраняемым данным будет также применен этот фильтр.

Для CSV файлов предусмотрен выбор кодировок 'UTF-8' (по умолчанию) и 'Windows-1251'.

Инструкция для русификации PDF файлов находится в файле README, в папке /dompdf_ru.

Установка:

php composer.phar require "vrtc/yii2-export" "*"

или

composer require vrtc/yii2-export

или добавить в composer.json файл

"vrtc/yii2-export": "*"

Использование:

Подключение:

// в файле настройки приложения (main.php - Advanced или web.php - Basic) добавляется класс в controllerMap
...
'controllerMap' => [
    'export' => 'vrtc\exportFile\controllers\ExportController'
],
'components' => [
    ...
],

В любой модели Search:

...
class GeoCitySearch extends GeoCity
{
...
    // указываются свойства, которые нужно выводить в файлы
    public function exportFields()
    {
        return [
            'id' => function ($model) {
                /* @var $model User */
                return $model->id;
            },
            'name_ru',
            'region_id' => function ($model) {
                /* @var $model GeoCity */
                if (isset($model->region->name_ru)) {
                    return $model->region->name_ru;
                }
                return false;
            },
            'lat',
            'lon'
        ];
    }
...
}

Контроллер:

...
    // cоздается стандартное действие для вывода данных
    public function actionExportFile()
    {
        $searchModel = new GeoCitySearch();
        $dataProvider = $searchModel->search(\Yii::$app->request->queryParams);

        return $this->render('export-file', [
            'searchModel' => $searchModel,
            'dataProvider' => $dataProvider,
        ]);
    }
...

Представление 1:

use vrtc\exportFile\ExportFile;
use yii\grid\GridView;
/* @var $searchModel \common\models\GeoCitySearch */
/* @var $dataProvider yii\data\ActiveDataProvider */

// минимальные настройки
echo ExportFile::widget([
        'model'             => 'common\models\GeoCitySearch',   // путь к модели
        'searchAttributes'  => $searchModel,                    // фильтр
]) ?>
<?= GridView::widget([
    'dataProvider'  => $dataProvider,
    'filterModel'   => $searchModel,
    'columns' => [
        ...
    ]
]);
?>

Представление 2:

use vrtc\exportFile\ExportFile;
use yii\grid\GridView;
/* @var $searchModel \common\models\GeoCitySearch */
/* @var $dataProvider yii\data\ActiveDataProvider */

// максимальные настройки
echo \vrtc\exportFile\ExportFile::widget([
        'model' => WebProxyFrontendSearch::class,   // путь к модели
        'queryParams' => Yii::$app->request->queryParams,
        'getAll' => true,
        'xls' => [
            'buttonOption' => [
                'class' => 'btn btn--blue btn-proxy'
            ],
            'tagOption' => [
              'class' => 'export-form',
            ],
            'tag' => 'div'
        ],
        'txt' => [
            'buttonOption' => [
                'class' => 'btn btn--blue btn-proxy'
            ],
            'tagOption' => [
                'class' => 'export-form'
            ],
            'tag' => 'div',
            'includeFields' => 'proxy',
            'txtDelimiter' => ' ',
            'txtQuoteItem' => '',
        ],
        'csv' => false,
        'word' => false,
        'html' => false,
        'pdf' => false,
    ]);  ?>
<?= GridView::widget([
    'dataProvider'  => $dataProvider,
    'filterModel'   => $searchModel,
    'columns' => [
        ...
    ]
]);
?>

Документация (примеры):

PHPExcel

PHPWord

dompdf

Версия:

1.0

Лицензия:

MIT