\ No newline at end of file
diff --git a/modules/backend/behaviors/importexportcontroller/partials/_export_columns.htm b/modules/backend/behaviors/importexportcontroller/partials/_export_columns.htm
new file mode 100644
index 000000000..589679624
--- /dev/null
+++ b/modules/backend/behaviors/importexportcontroller/partials/_export_columns.htm
@@ -0,0 +1,27 @@
+
+
+
+ $column): ?>
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/backend/behaviors/importexportcontroller/partials/_export_form.htm b/modules/backend/behaviors/importexportcontroller/partials/_export_form.htm
new file mode 100644
index 000000000..2cd6aa806
--- /dev/null
+++ b/modules/backend/behaviors/importexportcontroller/partials/_export_form.htm
@@ -0,0 +1,51 @@
+
+ fatalError): ?>
+
+ 'exportForm']) ?>
+
+
Export progress
+
+
+
+
+
+
+
+
+
Processing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Export error
+
+
+
fatalError) ?>
+
+
+
+
+
\ No newline at end of file
diff --git a/modules/backend/behaviors/importexportcontroller/partials/_export_result_form.htm b/modules/backend/behaviors/importexportcontroller/partials/_export_result_form.htm
new file mode 100644
index 000000000..03ccfed82
--- /dev/null
+++ b/modules/backend/behaviors/importexportcontroller/partials/_export_result_form.htm
@@ -0,0 +1,34 @@
+fatalError): ?>
+
+
+
+ File export process has completed successfully!
+ The browser should now redirect automatically to the file download.
+
+
+
+
+
+
+
+
+
+
fatalError) ?>
+
+
+
+
\ No newline at end of file
diff --git a/modules/backend/behaviors/importexportcontroller/partials/_import.htm b/modules/backend/behaviors/importexportcontroller/partials/_import.htm
index 05adaa725..864c7097b 100644
--- a/modules/backend/behaviors/importexportcontroller/partials/_import.htm
+++ b/modules/backend/behaviors/importexportcontroller/partials/_import.htm
@@ -2,6 +2,8 @@
render() ?>
- render() ?>
+
+ render() ?>
+
\ No newline at end of file
diff --git a/modules/backend/behaviors/importexportcontroller/partials/fields_export.yaml b/modules/backend/behaviors/importexportcontroller/partials/fields_export.yaml
new file mode 100644
index 000000000..81dfba5ac
--- /dev/null
+++ b/modules/backend/behaviors/importexportcontroller/partials/fields_export.yaml
@@ -0,0 +1,58 @@
+# ===================================
+# Field Definitions
+# ===================================
+
+fields:
+ step1_section:
+ label: 1. Export output format
+ type: section
+
+ format_preset:
+ label: File format
+ type: dropdown
+ default: standard
+ options:
+ standard: Standard format
+ custom: Custom format
+ span: left
+
+ format_delimiter:
+ label: Delimiter character
+ default: ','
+ span: left
+ trigger:
+ action: show
+ condition: value[custom]
+ field: format_preset
+
+ format_enclosure:
+ label: Enclosure character
+ span: auto
+ default: '"'
+ trigger:
+ action: show
+ condition: value[custom]
+ field: format_preset
+
+ format_escape:
+ label: Escape character
+ span: auto
+ default: '\\'
+ trigger:
+ action: show
+ condition: value[custom]
+ field: format_preset
+
+ step2_section:
+ label: 2. Select columns to export
+ type: section
+
+ export_columns:
+ label: Columns
+ type: partial
+ path: ~/modules/backend/behaviors/importexportcontroller/partials/_export_columns.htm
+ span: left
+
+ step3_section:
+ label: 3. Set export options
+ type: section
\ No newline at end of file
diff --git a/modules/backend/models/ExportModel.php b/modules/backend/models/ExportModel.php
new file mode 100644
index 000000000..cd496dfaa
--- /dev/null
+++ b/modules/backend/models/ExportModel.php
@@ -0,0 +1,186 @@
+ 'Some attribute value',
+ * 'db_name2' => 'Another attribute value'
+ * ],
+ * [...]
+ *
+ */
+ abstract public function exportData($columns, $sessionKey = null);
+
+ /**
+ * Export data based on column names and labels.
+ * The $columns array should be in the format of:
+ *
+ * [
+ * 'db_name1' => 'Column label',
+ * 'db_name2' => 'Another label',
+ * ...
+ * ]
+ *
+ */
+ public function export($columns, $options)
+ {
+ $sessionKey = array_get($options, 'sessionKey');
+ $data = $this->exportData(array_keys($columns), $sessionKey);
+ return $this->processExportData($columns, $data, $options);
+ }
+
+ /**
+ * Download a previously compiled export file.
+ * @return void
+ */
+ public function download($name, $outputName = null)
+ {
+ if (!preg_match('/^oc[0-9a-z]*$/i', $name)) {
+ throw new ApplicationException('File not found');
+ }
+
+ $csvPath = temp_path() . '/' . $name;
+ if (!file_exists($csvPath)) {
+ throw new ApplicationException('File not found');
+ }
+
+ $headers = Response::download($csvPath, $outputName)->headers->all();
+ $result = Response::make(File::get($csvPath), 200, $headers);
+
+ @unlink($csvPath);
+
+ return $result;
+ }
+
+ /**
+ * Converts a data collection to a CSV file.
+ */
+ protected function processExportData($columns, $results, $options)
+ {
+ /*
+ * Validate
+ */
+ if (!$results) {
+ throw new ApplicationException('There was no data supplied to export');
+ }
+
+ /*
+ * Parse options
+ */
+ $defaultOptions = [
+ 'useOutput' => false,
+ 'fileName' => 'export.csv',
+ 'delimiter' => null,
+ 'enclosure' => null,
+ 'escape' => null
+ ];
+
+ $options = array_merge($defaultOptions, $options);
+ $columns = $this->exportExtendColumns($columns);
+
+ /*
+ * Prepare CSV
+ */
+ $csv = CsvWriter::createFromFileObject(new SplTempFileObject);
+
+ if ($options['delimiter'] !== null) {
+ $csv->setDelimiter($options['delimiter']);
+ }
+
+ if ($options['enclosure'] !== null) {
+ $csv->setEnclosure($options['enclosure']);
+ }
+
+ if ($options['escape'] !== null) {
+ $csv->setEscape($options['escape']);
+ }
+
+ /*
+ * Add headers
+ */
+ $headers = $this->getColumnHeaders($columns);
+ $csv->insertOne($headers);
+
+ /*
+ * Add records
+ */
+ foreach ($results as $result) {
+ $data = $this->matchDataToColumns($result, $columns);
+ $csv->insertOne($data);
+ }
+
+ /*
+ * Output
+ */
+ if ($options['useOutput']) {
+ $csv->output($options['fileName']);
+ }
+
+ /*
+ * Save for download
+ */
+ $csvName = uniqid('oc');
+ $csvPath = temp_path().'/'.$csvName;
+ $output = $csv->__toString();
+
+ File::put($csvPath, $output);
+
+ return $csvName;
+ }
+
+ /**
+ * Used to override column definitions at export time.
+ */
+ protected function exportExtendColumns($columns)
+ {
+ return $columns;
+ }
+
+ /**
+ * Extracts the headers from the column definitions.
+ */
+ protected function getColumnHeaders($columns)
+ {
+ $headers = [];
+
+ foreach ($columns as $column => $label) {
+ $headers[] = Lang::get($label);
+ }
+
+ return $headers;
+ }
+
+ /**
+ * Ensures the correct order of the column data.
+ */
+ protected function matchDataToColumns($data, $columns)
+ {
+ $results = [];
+
+ foreach ($columns as $column => $label) {
+ $results[] = array_get($data, $column);
+ }
+
+ return $results;
+ }
+
+}
\ No newline at end of file
diff --git a/modules/backend/models/ImportModel.php b/modules/backend/models/ImportModel.php
index 3d45f1ffb..9047b9b7b 100644
--- a/modules/backend/models/ImportModel.php
+++ b/modules/backend/models/ImportModel.php
@@ -26,6 +26,9 @@ abstract class ImportModel extends Model
'import_file' => ['System\Models\File']
];
+ /**
+ * @var array Import statistics store.
+ */
protected $resultStats = [
'updated' => 0,
'created' => 0,
@@ -36,11 +39,33 @@ abstract class ImportModel extends Model
/**
* Called when data is being imported.
+ * The $results array should be in the format of:
+ *
+ * [
+ * 'db_name1' => 'Some value',
+ * 'db_name2' => 'Another value'
+ * ],
+ * [...]
+ *
*/
abstract public function importData($results, $sessionKey = null);
- public function importDataFromColumnMatch($matches, $sessionKey = null, $options = [])
+ /**
+ * Import data based on column names matching header indexes in the CSV.
+ * The $matches array should be in the format of:
+ *
+ * [
+ * 0 => [db_name1, db_name2],
+ * 1 => [db_name3],
+ * ...
+ * ]
+ *
+ * The key (0, 1) is the column index in the CSV and the value
+ * is another array of target database column names.
+ */
+ public function import($matches, $options = [])
{
+ $sessionKey = array_get($options, 'sessionKey');
$path = $this->getImportFilePath($sessionKey);
$data = $this->processImportData($path, $matches, $options);
return $this->importData($data, $sessionKey);
@@ -48,11 +73,12 @@ abstract class ImportModel extends Model
/**
* Converts column index to database column map to an array containing
- * database column names and values pulled from the CSV file.
- * Eg:
+ * database column names and values pulled from the CSV file. Eg:
+ *
* [0 => [first_name], 1 => [last_name]]
*
* Will return:
+ *
* [first_name => Joe, last_name => Blogs],
* [first_name => Harry, last_name => Potter],
* [...]