2015-07-15 09:35:31 +00:00
|
|
|
<?php namespace Backend\Behaviors;
|
|
|
|
|
|
|
|
|
|
use Backend\Classes\ControllerBehavior;
|
|
|
|
|
use League\Csv\Writer;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Import/Export Controller Behavior
|
|
|
|
|
* Adds features for importing and exporting data.
|
|
|
|
|
*
|
|
|
|
|
* @package october\backend
|
|
|
|
|
* @author Alexey Bobkov, Samuel Georges
|
|
|
|
|
*/
|
|
|
|
|
class ImportExportController extends ControllerBehavior
|
|
|
|
|
{
|
|
|
|
|
|
2015-07-16 12:15:30 +00:00
|
|
|
/**
|
|
|
|
|
* {@inheritDoc}
|
|
|
|
|
*/
|
|
|
|
|
protected $requiredProperties = ['importExportConfig'];
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @var array Configuration values that must exist when applying the primary config file.
|
|
|
|
|
*/
|
|
|
|
|
protected $requiredConfig = [];
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @var Model Import model
|
|
|
|
|
*/
|
|
|
|
|
public $importModel;
|
|
|
|
|
|
2015-07-17 22:51:26 +00:00
|
|
|
/**
|
|
|
|
|
* @var array Import column configuration.
|
|
|
|
|
*/
|
|
|
|
|
public $importColumns;
|
|
|
|
|
|
2015-07-16 12:15:30 +00:00
|
|
|
/**
|
|
|
|
|
* @var Backend\Classes\WidgetBase Reference to the widget used for uploading import file.
|
|
|
|
|
*/
|
|
|
|
|
protected $importUploadFormWidget;
|
|
|
|
|
|
2015-07-15 09:35:31 +00:00
|
|
|
/**
|
|
|
|
|
* Behavior constructor
|
|
|
|
|
* @param Backend\Classes\Controller $controller
|
|
|
|
|
*/
|
|
|
|
|
public function __construct($controller)
|
|
|
|
|
{
|
|
|
|
|
parent::__construct($controller);
|
|
|
|
|
|
|
|
|
|
$this->addJs('js/october.importexport.js', 'core');
|
|
|
|
|
$this->addCss('css/importexport.css', 'core');
|
2015-07-16 12:15:30 +00:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Build configuration
|
|
|
|
|
*/
|
|
|
|
|
$this->config = $this->makeConfig($controller->importExportConfig, $this->requiredConfig);
|
|
|
|
|
|
|
|
|
|
/*
|
2015-07-18 00:27:54 +00:00
|
|
|
* Import form widget
|
2015-07-16 12:15:30 +00:00
|
|
|
*/
|
2015-07-18 00:27:54 +00:00
|
|
|
if ($this->importUploadFormWidget = $this->makeImportUploadFormWidget()) {
|
|
|
|
|
$this->importUploadFormWidget->bindToController();
|
|
|
|
|
}
|
|
|
|
|
}
|
2015-07-16 12:15:30 +00:00
|
|
|
|
2015-07-18 00:27:54 +00:00
|
|
|
//
|
|
|
|
|
// Controller actions
|
|
|
|
|
//
|
2015-07-17 22:51:26 +00:00
|
|
|
|
2015-07-18 00:27:54 +00:00
|
|
|
public function import()
|
|
|
|
|
{
|
|
|
|
|
$this->prepareVars();
|
2015-07-15 09:35:31 +00:00
|
|
|
}
|
|
|
|
|
|
2015-07-18 00:27:54 +00:00
|
|
|
public function export()
|
|
|
|
|
{
|
|
|
|
|
// TBA
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
//
|
|
|
|
|
// Importing
|
|
|
|
|
//
|
|
|
|
|
|
2015-07-16 12:15:30 +00:00
|
|
|
/**
|
|
|
|
|
* Prepares the view data.
|
|
|
|
|
* @return void
|
|
|
|
|
*/
|
|
|
|
|
public function prepareVars()
|
2015-07-15 09:35:31 +00:00
|
|
|
{
|
2015-07-16 12:15:30 +00:00
|
|
|
$this->vars['importUploadFormWidget'] = $this->importUploadFormWidget;
|
2015-07-18 00:27:54 +00:00
|
|
|
$this->vars['importColumns'] = $this->getImportDbColumns();
|
2015-07-15 09:35:31 +00:00
|
|
|
|
2015-07-18 00:27:54 +00:00
|
|
|
// Make these variables to widgets
|
|
|
|
|
$this->controller->vars += $this->vars;
|
2015-07-15 09:35:31 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public function importRender()
|
|
|
|
|
{
|
2015-07-17 22:51:26 +00:00
|
|
|
return $this->importExportMakePartial('import');
|
2015-07-15 09:35:31 +00:00
|
|
|
}
|
|
|
|
|
|
2015-07-18 00:27:54 +00:00
|
|
|
public function importGetModel()
|
|
|
|
|
{
|
|
|
|
|
if ($this->importModel !== null) {
|
|
|
|
|
return $this->importModel;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
$modelClass = $this->getConfig('import[modelClass]');
|
|
|
|
|
return $this->importModel = new $modelClass;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
protected function getImportDbColumns()
|
|
|
|
|
{
|
|
|
|
|
if ($this->importColumns !== null) {
|
|
|
|
|
return $this->importColumns;
|
|
|
|
|
}
|
|
|
|
|
$columnConfig = $this->getConfig('import[list]');
|
|
|
|
|
return $this->importColumns = $this->makeListColumns($columnConfig);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
protected function getImportFileColumns()
|
|
|
|
|
{
|
|
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
protected function makeImportUploadFormWidget()
|
|
|
|
|
{
|
|
|
|
|
// first_row_titles FALSE is generic columns (1,2,3,4,5..)
|
|
|
|
|
|
|
|
|
|
$widgetConfig = $this->makeConfig('~/modules/backend/behaviors/importexportcontroller/partials/fields_import.yaml');
|
|
|
|
|
$widgetConfig->model = $this->importGetModel();
|
|
|
|
|
$widgetConfig->alias = 'importUploadForm';
|
|
|
|
|
|
|
|
|
|
$widget = $this->makeWidget('Backend\Widgets\Form', $widgetConfig);
|
|
|
|
|
|
|
|
|
|
$widget->bindEvent('form.beforeRefresh', function($holder) {
|
|
|
|
|
$holder->data = [];
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
return $widget;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
//
|
|
|
|
|
// Exporting
|
|
|
|
|
//
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
//
|
|
|
|
|
// Helpers
|
|
|
|
|
//
|
|
|
|
|
|
2015-07-15 09:35:31 +00:00
|
|
|
/**
|
|
|
|
|
* Controller accessor for making partials within this behavior.
|
|
|
|
|
* @param string $partial
|
|
|
|
|
* @param array $params
|
|
|
|
|
* @return string Partial contents
|
|
|
|
|
*/
|
|
|
|
|
public function importExportMakePartial($partial, $params = [])
|
|
|
|
|
{
|
|
|
|
|
$contents = $this->controller->makePartial('import_export_'.$partial, $params + $this->vars, false);
|
|
|
|
|
if (!$contents) {
|
|
|
|
|
$contents = $this->makePartial($partial, $params);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return $contents;
|
|
|
|
|
}
|
|
|
|
|
|
2015-07-17 22:51:26 +00:00
|
|
|
protected function makeListColumns($config)
|
|
|
|
|
{
|
|
|
|
|
$config = $this->makeConfig($config);
|
|
|
|
|
|
|
|
|
|
if (!isset($config->columns) || !is_array($config->columns)) {
|
|
|
|
|
return null;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
$result = [];
|
|
|
|
|
foreach ($config->columns as $attribute => $column) {
|
|
|
|
|
$result[$attribute] = array_get($column, 'label', $attribute);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return $result;
|
|
|
|
|
}
|
2015-07-15 09:35:31 +00:00
|
|
|
}
|