-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathProcessChildrenCsvExport.module.php
281 lines (247 loc) · 13.3 KB
/
ProcessChildrenCsvExport.module.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
<?php
/**
* ProcessWire Table CSV Export Helper
* by Adrian Jones
*
* Helper process module for generating CSV from a Table field
*
* Copyright (C) 2024 by Adrian Jones
* Licensed under GNU/GPL v2, see LICENSE.TXT
*
*/
class ProcessChildrenCsvExport extends Process implements Module {
/**
* getModuleInfo is a module required by all modules to tell ProcessWire about them
*
* @return array
*
*/
public static function getModuleInfo() {
return array(
'title' => __('Process Children CSV Export'),
'version' => '1.8.31',
'summary' => __('Helper module for BatchChildEditor for creating CSV to export'),
'href' => 'http://modules.processwire.com/modules/batch-child-editor/',
'singular' => true,
'autoload' => false,
'permission' => 'batch-child-editor',
'requires' => 'BatchChildEditor',
'page' => array(
'name' => 'children-csv-export',
'parent' => 'setup',
'title' => 'Children CSV Export',
'status' => 'hidden'
)
);
}
/**
* Name used for the page created in the admin
*
*/
const adminPageName = 'children-csv-export';
/**
* Initialize the module
*
*/
public function init() {
parent::init();
$this->addHook('Page::exportCsv', $this, 'exportCsv'); /* not limited to table-csv-export permission because only relevant to front-end */
}
/**
* Executed when root url for module is accessed
*
*/
public function ___execute() {
$this->exportCsv();
}
public function outputCSV($data, $delimiter, $enclosure) {
$output = fopen("php://output", "w");
foreach ($data as $row) {
fputcsv($output, $row, $delimiter == "tab" ? chr(9) : $delimiter, $enclosure, '\\');
}
fclose($output);
}
public function exportCsv($event = NULL) {
$systemFields = wire('modules')->get("BatchChildEditor")->systemFields;
$configSettings = wire('modules')->getModuleConfigData("BatchChildEditor");
$pp = !is_null($event) ? $event->object : wire('pages')->get((int) wire('input')->get->pid);
$delimiter = !is_null($event) ? $event->arguments(0) : wire('input')->get->cs;
$enclosure = !is_null($event) ? $event->arguments(1) : wire('input')->get->ce;
$extension = !is_null($event) ? $event->arguments(2) : wire('input')->get->ext;
$namesFirstRow = !is_null($event) ? $event->arguments(3) : wire('input')->get->nfr;
$namesFirstRow = $namesFirstRow == 'checked' || $namesFirstRow == '1' ? true : false;
$exportMultipleValuesSeparator = !is_null($event) ? $event->arguments(4) : wire('input')->get->mvs;
$formatExport = !is_null($event) ? $event->arguments(5) : wire('input')->get->fe;
$formatExport = $formatExport == 'checked' || $formatExport == 1 ? true : false;
$pagesToInclude = !is_null($event) ? $event->arguments(6) : wire('input')->get->pti;
$fieldNames = !is_null($event) ? $event->arguments(7) : explode(',', wire('input')->get->fns);
//if settings not supplied, use defaults from page or module config settings
$currentData = isset($configSettings['configurablePages']) && in_array($pp->id, $configSettings['configurablePages']) && isset($configSettings['pageSettings'][$pp->id]) && $configSettings['pageSettings'][$pp->id] ? $configSettings['pageSettings'][$pp->id] : $configSettings;
if(isset($currentData['parentPage']) && $currentData['parentPage']) $pp = wire('pages')->get($currentData['parentPage']);
$delimiter = $delimiter ? $delimiter : $currentData['csvExportFieldSeparator'];
$enclosure = $enclosure ? $enclosure : $currentData['csvExportFieldEnclosure'];
$extension = $extension ? $extension : $currentData['csvExportExtension'];
$namesFirstRow = isset($namesFirstRow) ? $namesFirstRow : $currentData['columnsFirstRow'];
$exportMultipleValuesSeparator = $exportMultipleValuesSeparator ? $exportMultipleValuesSeparator : $currentData['exportMultipleValuesSeparator'];
if($exportMultipleValuesSeparator == '\r') $exportMultipleValuesSeparator = chr(13);
if($exportMultipleValuesSeparator == '\n') $exportMultipleValuesSeparator = chr(10);
$formatExport = isset($formatExport) ? $formatExport : $currentData['formatExport'];
if(!$pagesToInclude) {
$pagesToInclude = isset($currentData['pagesToInclude']) ? $currentData['pagesToInclude'] : '';
}
$fieldNames = $fieldNames ? $fieldNames : $currentData['exportFields'];
if($fieldNames[0] == 'undefined') {
$fieldNames = array();
// if fields not defined, then get list from first child
foreach ($pp->child()->fields as $f) $fieldNames[] = $f->name;
}
$csv = array();
$i=0;
$children = $pagesToInclude != '' && $pagesToInclude != 'undefined' ? $pp->children($pagesToInclude) : $pp->children();
foreach($children as $p) {
$p->of($formatExport); //needed to have fields formatted in the CSV
//Names in First Row
if($i==0 && $namesFirstRow == true) {
foreach($fieldNames as $fieldName) {
//exclude unsupported field types
if(wire('fields')->$fieldName && (wire('fields')->$fieldName->type == 'FieldtypeTable' ||
wire('fields')->$fieldName->type == 'FieldtypeRepeater' ||
wire('fields')->$fieldName->type == 'FieldtypePageTable' ||
wire('fields')->$fieldName->type == 'FieldsetOpen' ||
wire('fields')->$fieldName->type == 'FieldsetClose' ||
wire('fields')->$fieldName->type == 'FieldsetTabOpen' ||
wire('fields')->$fieldName->type == 'FieldsetTabClose'
)) continue;
//FieldtypeTextareas
if(wire('fields')->$fieldName && wire('fields')->$fieldName->type == 'FieldtypeTextareas') {
$field = wire('fields')->get($fieldName);
$subfields = $field->type->getBlankValue(new Page(), $field);
foreach($subfields as $subFieldName => $value) {
$csv[$i][] = $field->type->getLabel($field, $subFieldName) ? $field->type->getLabel($field, $subFieldName) : $subFieldName;
}
}
/*
//Repeaters
elseif(wire('fields')->$fieldName && wire('fields')->$fieldName->type == 'FieldtypeRepeater') {
$field = wire('fields')->get($fieldName);
$subfields = $field->repeaterFields;
foreach($subfields as $sf) {
$subField = wire('fields')->get($sf);
$csv[$i][] = $subField->label ? $subField->label : $subField->name;
}
}
*/
//All other fieldtypes
elseif(isset($fieldName) && $fieldName !== 'undefined') {
if(array_key_exists($fieldName, $systemFields)) {
$fieldLabel = $systemFields[$fieldName];
}
else {
$label = wire('fields')->get($fieldName)->label;
$fieldLabel = $label ? $label : $fieldName;
}
$csv[$i][] = $fieldLabel;
}
}
}
//All Data Rows
$i++;
foreach($fieldNames as $fieldName) {
$formattedValue = '';
if($fieldName == 'created_formatted' || $fieldName == 'modified_formatted' || $fieldName == 'published_formatted') {
$dateFieldName = str_replace('_formatted', '', $fieldName);
$formattedValue = date('Y-m-d H:i:s', $p->$dateFieldName);
}
//exclude unsupported field types
elseif(wire('fields')->$fieldName && (wire('fields')->$fieldName->type == 'FieldtypeTable' ||
wire('fields')->$fieldName->type == 'FieldtypeRepeater' ||
wire('fields')->$fieldName->type == 'FieldtypePageTable' ||
wire('fields')->$fieldName->type == 'FieldsetOpen' ||
wire('fields')->$fieldName->type == 'FieldsetClose' ||
wire('fields')->$fieldName->type == 'FieldsetTabOpen' ||
wire('fields')->$fieldName->type == 'FieldsetTabClose'
)) {
continue;
}
elseif(!$p->$fieldName) {
$formattedValue = '';
}
//FieldtypeTextareas
elseif(wire('fields')->$fieldName && wire('fields')->$fieldName->type == 'FieldtypeTextareas') {
$field = wire('fields')->get($fieldName);
$subfields = $field->type->getBlankValue(new Page(), $field);
foreach($subfields as $subFieldName => $value) {
$csv[$i][] = $p->$fieldName->$subFieldName;
}
}
/*
//FieldtypeRepeaters
elseif(wire('fields')->$fieldName && wire('fields')->$fieldName->type == 'FieldtypeRepeater') {
foreach($p->$fieldName as $item) {
foreach($item->fields as $subField) {
$csv[$i][] = $item->$subField;
}
}
}
*/
//Page fields
elseif(wire('fields')->$fieldName && wire('fields')->$fieldName->type instanceof FieldtypePage) {
if(method_exists($p->$fieldName,'implode')) {
if($p->$fieldName->implode($exportMultipleValuesSeparator, 'title')) { // title available
$formattedValue = $p->$fieldName->implode($exportMultipleValuesSeparator, 'title');
}
else { // no title so use name - eg a page field selecting from the user template
$formattedValue = $p->$fieldName->implode($exportMultipleValuesSeparator, 'name');
}
}
else {
$formattedValue = $p->$fieldName->title ? $p->$fieldName->title : $p->$fieldName->name;
}
}
//FieldtypeMultiplier and FieldtypeFile
elseif(wire('fields')->$fieldName && (wire('fields')->$fieldName->type == 'FieldtypeMultiplier' || wire('fields')->$fieldName->type == 'FieldtypeOptions' || wire('fields')->$fieldName->type instanceof FieldtypeFile)) {
if(wire('fields')->$fieldName->type instanceof FieldtypeFile) $p->of(false); //formatting off required if output format is "Rendered string of text"
if(count($p->$fieldName)>0) {
$values = array();
foreach($p->$fieldName as $value) {
if(wire('fields')->$fieldName->type instanceof FieldtypeFile) {
$values[] = $value->filename;
}
elseif($formatExport && wire('fields')->$fieldName->type == 'FieldtypeOptions') {
$values[] = $value->title;
}
else {
$values[] = $value;
}
}
$formattedValue = implode($exportMultipleValuesSeparator, $values);
}
$p->of($formatExport);
}
elseif(wire('fields')->$fieldName && wire('fields')->$fieldName->type == "FieldtypeMapMarker") {
foreach(array('address', 'lat', 'lng', 'zoom', 'status') as $subFieldName) {
$values[] = $p->$fieldName->$subFieldName;
}
$formattedValue = implode($exportMultipleValuesSeparator, $values);
}
elseif(wire('fields')->$fieldName && wire('fields')->$fieldName->type instanceof FieldtypeMulti && count($p->$fieldName) === 0) {
$formattedValue = '';
}
//All other fields
else {
$formattedValue = $p->$fieldName;
}
//Populate $csv array for all fields that don't have subfields and are therefore already populated, like FieldtypeTextareas
if(array_key_exists($fieldName, $systemFields) || (wire('fields')->$fieldName && wire('fields')->$fieldName->type != 'FieldtypeTextareas')) {
$csv[$i][] = $formattedValue;
}
}
}
header("Content-type: text/csv");
header("Content-Disposition: attachment; filename=".$pp->name .".".$extension);
header("Pragma: no-cache");
header("Expires: 0");
$this->outputCSV($csv, $delimiter, $enclosure);
exit;
}
}