后台导入和导出

• 介绍
• 配置行为
  • 导入页面
  • 导出页面
• 导入和导出视图
  • 导入视图
  • 导出视图
• 定义导入模型
• 定义导出模型
• 自定义选项
• 与列表行为集成

介绍

导入导出行为 是一个控制器修饰符，提供导入和导出数据的功能。 该行为提供了两个名为Import和Export的页面。 “导入”页面允许用户上传CSV文件并将列与数据库匹配。 “导出”页面相反，允许用户将数据库中的列作为CSV文件下载。 该行为提供了控制器动作import()和export()。

行为配置分为两部分，每部分依赖于特殊的模型类以及列表和表单字段定义文件。 要使用导入和导出行为，应将其添加到控制器类的$implement属性中。 此外，应定义$importExportConfig类属性，其值应引用用于配置行为选项的YAML文件。

namespace Acme\Shop\Controllers;
class Products extends Controller
{
    public $implement = [
        'Backend.Behaviors.ImportExportController',
    ];
    public $importExportConfig = 'config_import_export.yaml';
    // [...]
}

配置行为

$importExportConfig属性中引用的配置文件以YAML格式定义。 该文件应放入控制器的views目录。 以下是配置文件的示例：

# ===================================
#  Import/Export Behavior Config
# ===================================
import:
    title: Import subscribers
    modelClass: Acme\Campaign\Models\SubscriberImport
    list: $/acme/campaign/models/subscriber/columns.yaml
export:
    title: Export subscribers
    modelClass: Acme\Campaign\Models\SubscriberExport
    list: $/acme/campaign/models/subscriber/columns.yaml

下面列出的配置选项是可选的。 如果您希望行为支持 Import或Export或两者，请定义它们。

导入页面

要支持“导入”页面，请将以下配置添加到YAML文件中：

import:
    title: Import subscribers
    modelClass: Acme\Campaign\Models\SubscriberImport
    list: $/acme/campaign/models/subscriberimport/columns.yaml
    redirect: acme/campaign/subscribers

“导入”页面支持以下配置选项：

导出页面

要支持“导出”页面，请将以下配置添加到YAML文件中：

export:
    title: Export subscribers
    modelClass: Acme\Campaign\Models\SubscriberExport
    list: $/acme/campaign/models/subscriberexport/columns.yaml
    redirect: acme/campaign/subscribers

“导出”页面支持以下配置选项：

导入和导出视图

对于每个页面功能导入和导出，您应该提供一个视图文件和相应的名称 - import.htm和export.htm。

导入/导出行为向控制器类添加了两个方法：importRender和exportRender。 这些方法根据上述YAML配置文件呈现导入和导出部分。

导入视图

import.htm视图表示允许用户导入数据的导入页面。 典型的导入页面包含面包屑，导入部分本身和提交按钮。 data-request属性应该引用行为提供的onImport AJAX处理程序。 以下是典型的import.htm视图文件的内容。

<?= Form::open(['class' => 'layout']) ?>
    <div class="layout-row">
        <?= $this->importRender() ?>
    </div>
    <div class="form-buttons">
        <button
            type="submit"
            data-control="popup"
            data-handler="onImportLoadForm"
            data-keyboard="false"
            class="btn btn-primary">
            Import records
        </button>
    </div>
<?= Form::close() ?>

导出视图

export.htm视图表示允许用户从数据库导出文件的“导出”页面。 典型的“导出”页面包含面包屑，导出部分本身和提交按钮。 data-request属性应该引用行为提供的onExport AJAX处理程序。 以下是典型的export.htm表单的内容。

<?= Form::open(['class' => 'layout']) ?>
    <div class="layout-row">
        <?= $this->exportRender() ?>
    </div>
    <div class="form-buttons">
        <button
            type="submit"
            data-control="popup"
            data-handler="onExportLoadForm"
            data-keyboard="false"
            class="btn btn-primary">
            Export records
        </button>
    </div>
<?= Form::close() ?>

定义导入模型

对于导入数据，您应该为此过程创建一个专用模型，该模型扩展了Backend\Models\ImportModel类。 这是一个示例类定义：

class SubscriberImport extends \Backend\Models\ImportModel
{
    /**
     * @var array 要应用于数据的规则。
     */
    public $rules = [];
    public function importData($results, $sessionKey = null)
    {
        foreach ($results as $row => $data) {
            try {
                $subscriber = new Subscriber;
                $subscriber->fill($data);
                $subscriber->save();
                $this->logCreated();
            }
            catch (\Exception $ex) {
                $this->logError($row, $ex->getMessage());
            }
        }
    }
}

该类必须定义一个名为importData的方法，用于处理导入的数据。 第一个参数$results将包含一个包含要导入的数据的数组。 第二个参数$sessionKey将包含用于请求的会话密钥。

定义导出模型

要导出数据，您应该创建一个扩展Backend\Models\ExportModel类的专用模型。 这是一个例子：

class SubscriberExport extends \Backend\Models\ExportModel
{
    public function exportData($columns, $sessionKey = null)
    {
        $subscribers = Subscriber::all();
        $subscribers->each(function($subscriber) use ($columns) {
            $subscriber->addVisible($columns);
        });
        return $subscribers->toArray();
    }
}

该类必须定义一个名为exportData的方法，用于返回导出数据。 第一个参数$columns是要导出的列名数组。 第二个参数$sessionKey将包含用于请求的会话密钥。

自定义选项

导入和导出表单都支持可以使用表单字段引入的自定义选项，这些表单字段分别在导入或导出配置中的表单选项中定义。 然后将这些值传递给导入/导出模型，并在处理期间可用。

import:
    [...]
    form: $/acme/campaign/models/subscriberimport/fields.yaml
export:
    [...]
    form: $/acme/campaign/models/subscriberexport/fields.yaml

指定的表单字段将显示在导入/导出页面上。 这是一个示例fields.yaml文件内容：

# ===================================
#  Form Field Definitions
# ===================================
fields:
    auto_create_lists:
        label: Automatically create lists
        type: checkbox
        default: true

可以使用导入模型的importData方法中的$this-> auto_create_lists访问上面名为auto_create_lists的表单字段的值。 如果这是导出模型，则该值将在exportData方法中可用。

class SubscriberImport extends \Backend\Models\ImportModel
{
    public function importData($results, $sessionKey = null)
    {
        if ($this->auto_create_lists) {
            // Do something
        }
        [...]
    }
}

与列表行为集成

有一种替代方法可以导出使用list行为 来提供导出数据的数据。 要使用此功能，您应该将Backend.Behaviors.ListController定义到控制器类的$implement字段。 您不需要使用导出视图，所有设置都将从列表中提取。 这是唯一需要的配置：

export:
    useList: true

如果您使用多个列表定义，那么您可以提供列表定义：

export:
    useList: orders
    fileName: orders.csv

useList选项还支持扩展配置选项。

export:
    useList:
        definition: orders
        raw: true

支持以下配置选项：