-
Notifications
You must be signed in to change notification settings - Fork 821
/
TableListField.php
executable file
·1442 lines (1220 loc) · 40.3 KB
/
TableListField.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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* @package forms
* @subpackage fields-relational
*/
/**
* Form field that embeds a list into a form, such as a member list or a file list.
*
* All get variables are namespaced in the format ctf[MyFieldName][MyParameter] to avoid collisions
* when multiple TableListFields are present in a form.
*
* @param $name string The fieldname
* @param $sourceClass string The source class of this field
* @param $fieldList array An array of field headings of Fieldname => Heading Text (eg. heading1)
* @param $sourceFilter string The filter field you wish to limit the objects by (eg. parentID)
* @param $sourceSort string
* @param $sourceJoin string
* @package forms
* @subpackage fields-relational
*/
class TableListField extends FormField {
/**
* @var $cachedSourceItems DataObjectSet Prevent {@sourceItems()} from being called multiple times.
*/
protected $cachedSourceItems;
protected $sourceClass;
protected $sourceFilter = "";
protected $sourceSort = "";
protected $sourceJoin = array();
protected $fieldList;
/**
* @var $fieldListCsv array
*/
protected $fieldListCsv;
/**
* @var $clickAction
*/
protected $clickAction;
/**
* @var bool
*/
public $IsReadOnly;
/**
* Called method (needs to be retained for AddMode())
*/
protected $methodName;
/**
* @var $summaryFieldList array Shows a row which summarizes the contents of a column by a predefined
* Javascript-function
*/
protected $summaryFieldList;
/**
* @var $summaryTitle string The title which will be shown in the first column of the summary-row.
* Accordingly, the first column can't be used for summarizing.
*/
protected $summaryTitle;
/**
* @var $template string Template-Overrides
*/
protected $template = "TableListField";
/**
* @var bool Do we use checkboxes to mark records, or delete them one by one?
*/
public $Markable;
public $MarkableTitle = null;
/**
* @var $readOnly boolean Deprecated, please use $permssions instead
*/
protected $readOnly;
/**
* @var $permissions array Influence output without having to subclass the template.
* See $actions for adding your custom actions/permissions.
*/
protected $permissions = array(
//"print",
//"export",
"delete"
);
/**
* @var $actions array Action that can be performed on a single row-entry.
* Has to correspond to a method in a TableListField-class (or subclass).
* Actions can be disabled through $permissions.
* Format (key is used for the methodname and CSS-class):
* array(
* 'delete' => array('label' => 'Delete', 'icon' => 'cms/images/delete.gif')
* )
*/
public $actions = array(
'delete' => array(
'label' => 'Delete',
'icon' => 'cms/images/delete.gif',
'class' => 'deletelink'
)
);
/**
* @var $defaultAction String Action being executed when clicking on table-row (defaults to "show").
* Mostly needed in ComplexTableField-subclass.
*/
public $defaultAction = '';
/**
* @var $customQuery Specify custom query, e.g. for complicated having/groupby-constructs.
* Caution: TableListField automatically selects the ID from the {@sourceClass}, because it relies
* on this information e.g. in saving a TableField. Please use a custom select if you want to filter
* for other IDs in joined tables: $query->select[] = "MyJoinedTable.ID AS MyJoinedTableID"
*/
protected $customQuery;
/**
* @var $customCsvQuery Query for CSV-export (might need different fields or further filtering)
*/
protected $customCsvQuery;
/**
* @var $customSourceItems DataObjectSet Use the manual setting of a result-set only as a last-resort
* for sets which can't be resolved in a single query.
*
* @todo: Add pagination support for customSourceItems.
*/
protected $customSourceItems;
/**
* Character to seperate exported columns in the CSV file
*/
protected $csvSeparator = ",";
/*
* Boolean deciding whether to include a header row in the CSV file
*/
protected $csvHasHeader = true;
/**
* @var array Specify custom escape for the fields.
*
* <code>
* array("\""=>"\"\"","\r"=>"", "\r\n"=>"", "\n"=>"")
* </code>
*/
public $csvFieldEscape = array(
"\""=>"\"\"",
"\r\n"=>"",
"\r"=>"",
"\n"=>"",
);
/**
* @var int Shows total count regardless or pagination
*/
protected $totalCount;
/**
* @var boolean Trigger pagination
*/
protected $showPagination = false;
/**
* @var int Number of items to show on a single page (needed for pagination)
*/
protected $pageSize = 10;
/**
* @var array Definitions for highlighting table-rows with a specific class. You can use all column-names
* in the result of a query. Use in combination with {@setCustomQuery} to select custom properties and joined objects.
*
* Example:
* array(
* array(
* "rule" => '$Flag == "red"',
* "class" => "red"
* ),
* array(
* "rule" => '$Flag == "orange"',
* "class" => "orange"
* )
* )
*/
public $highlightConditions = array();
/**
* @var array Specify castings with fieldname as the key, and the desired casting as value.
* Example: array("MyCustomDate"=>"Date","MyShortText"=>"Text->FirstSentence")
*/
public $fieldCasting = array();
/**
* @var array Specify custom formatting for fields, e.g. to render a link instead of pure text.
* Caution: Make sure to escape special php-characters like in a normal php-statement.
* Example: "myFieldName" => '<a href=\"custom-admin/$ID\">$ID</a>'
*/
public $fieldFormatting = array();
public $csvFieldFormatting = array();
/**
* @var string
*/
public $exportButtonLabel = 'Export as CSV';
/**
* @var string $groupByField Used to group by a specific column in the DataObject
* and create partial summaries.
*/
public $groupByField = null;
/**
* @var array
*/
protected $extraLinkParams;
protected $__cachedQuery;
function __construct($name, $sourceClass, $fieldList = null, $sourceFilter = null,
$sourceSort = null, $sourceJoin = null) {
$this->fieldList = ($fieldList) ? $fieldList : singleton($sourceClass)->summaryFields();
$this->sourceClass = $sourceClass;
$this->sourceFilter = $sourceFilter;
$this->sourceSort = $sourceSort;
$this->sourceJoin = $sourceJoin;
$this->readOnly = false;
parent::__construct($name);
}
/**
* Get the filter
*/
function sourceFilter() {
return $this->sourceFilter;
}
function index() {
return $this->FieldHolder();
}
static $url_handlers = array(
'item/$ID' => 'handleItem',
'$Action' => '$Action',
);
function sourceClass() {
return $this->sourceClass;
}
function handleItem($request) {
return new TableListField_ItemRequest($this, $request->param('ID'));
}
function FieldHolder() {
Requirements::javascript(THIRDPARTY_DIR . '/prototype.js');
Requirements::javascript(THIRDPARTY_DIR . '/behaviour.js');
Requirements::javascript(THIRDPARTY_DIR . '/prototype_improvements.js');
Requirements::javascript(THIRDPARTY_DIR . '/scriptaculous/effects.js');
Requirements::add_i18n_javascript(SAPPHIRE_DIR . '/javascript/lang');
Requirements::javascript(SAPPHIRE_DIR . '/javascript/TableListField.js');
Requirements::css(SAPPHIRE_DIR . '/css/TableListField.css');
if($this->clickAction) {
$id = $this->id();
Requirements::customScript(<<<JS
Behaviour.register({
'#$id tr' : {
onclick : function() {
$this->clickAction
return false;
}
}
});
JS
);}
return $this->renderWith($this->template);
}
function Headings() {
$headings = array();
foreach($this->fieldList as $fieldName => $fieldTitle) {
$isSorted = (isset($_REQUEST['ctf'][$this->Name()]['sort']) && $fieldName == $_REQUEST['ctf'][$this->Name()]['sort']);
// we can't allow sorting with partial summaries (groupByField)
$isSortable = ($this->form && $this->isFieldSortable($fieldName) && !$this->groupByField);
// sorting links (only if we have a form to refresh with)
if($this->form) {
$sortLink = $this->Link();
$sortLink = HTTP::setGetVar("ctf[{$this->Name()}][sort]", $fieldName, $sortLink);
if(isset($_REQUEST['ctf'][$this->Name()]['dir'])) {
$XML_sort = (isset($_REQUEST['ctf'][$this->Name()]['dir'])) ? Convert::raw2xml($_REQUEST['ctf'][$this->Name()]['dir']) : null;
$sortLink = HTTP::setGetVar("ctf[{$this->Name()}][dir]", $XML_sort, $sortLink);
}
if(isset($_REQUEST['ctf'][$this->Name()]['search']) && is_array($_REQUEST['ctf'][$this->Name()]['search'])) {
foreach($_REQUEST['ctf'][$this->Name()]['search'] as $parameter => $value) {
$XML_search = Convert::raw2xml($value);
$sortLink = HTTP::setGetVar("ctf[{$this->Name()}][search][$parameter]", $XML_search, $sortLink);
}
}
} else {
$sortLink = '#';
}
$headings[] = new ArrayData(array(
"Name" => $fieldName,
"Title" => ($this->sourceClass) ? singleton($this->sourceClass)->fieldLabel($fieldTitle) : $fieldTitle,
"IsSortable" => $isSortable,
"SortLink" => $sortLink,
"SortBy" => $isSorted,
"SortDirection" => (isset($_REQUEST['ctf'][$this->Name()]['dir'])) ? $_REQUEST['ctf'][$this->Name()]['dir'] : null
));
}
return new DataObjectSet($headings);
}
/**
* Determines if a field is "sortable".
* If the field is generated by a custom getter, we can't sort on it
* without generating all objects first (which would be a huge performance impact).
*
* @param string $fieldName
* @return bool
*/
function isFieldSortable($fieldName) {
if($this->customSourceItems) {
return false;
}
if($this->__cachedQuery) {
$query = $this->__cachedQuery;
} else {
$query = $this->__cachedQuery = $this->getQuery();
}
$sql = $query->sql();
$SQL_fieldName = Convert::raw2sql($fieldName);
return (in_array($SQL_fieldName,$query->select) || stripos($sql,"AS {$SQL_fieldName}"));
}
/**
* Dummy function to get number of actions originally generated in
* TableListField_Item.
*
* @return DataObjectSet
*/
function Actions() {
$allowedActions = new DataObjectSet();
foreach($this->actions as $actionName => $actionSettings) {
if($this->Can($actionName)) {
$allowedActions->push(new ViewableData());
}
}
return $allowedActions;
}
/**
* Provide a custom query to compute sourceItems. This is the preferred way to using
* {@setSourceItems}, because we can still paginate.
* Caution: Other parameters such as {@sourceFilter} will be ignored.
* Please use this only as a fallback for really complex queries (e.g. involving HAVING and GROUPBY).
*
* @param $query Query
*/
function setCustomQuery($query) {
$this->customQuery = $query;
}
function setCustomCsvQuery($query) {
$this->customCsvQuery = $query;
}
function setCustomSourceItems($items) {
$this->customSourceItems = $items;
}
function sourceItems() {
$SQL_limit = ($this->showPagination && $this->pageSize) ? "{$this->pageSize}" : null;
if(isset($_REQUEST['ctf'][$this->Name()]['start']) && is_numeric($_REQUEST['ctf'][$this->Name()]['start'])) {
$SQL_start = (isset($_REQUEST['ctf'][$this->Name()]['start'])) ? intval($_REQUEST['ctf'][$this->Name()]['start']) : "0";
} else {
$SQL_start = 0;
}
if(isset($this->customSourceItems)) {
if($this->showPagination && $this->pageSize) {
$items = $this->customSourceItems->getRange($SQL_start, $SQL_limit);
} else {
$items = $this->customSourceItems;
}
} elseif(isset($this->cachedSourceItems)) {
$items = $this->cachedSourceItems;
} else {
// get query
$dataQuery = $this->getQuery();
// we don't limit when doing certain actions T
if(!isset($_REQUEST['methodName']) || !in_array($_REQUEST['methodName'],array('printall','export'))) {
$dataQuery->limit(array(
'limit' => $SQL_limit,
'start' => (isset($SQL_start)) ? $SQL_start : null
));
}
// get data
$records = $dataQuery->execute();
$sourceClass = $this->sourceClass;
$dataobject = new $sourceClass();
$items = $dataobject->buildDataObjectSet($records, 'DataObjectSet');
$this->cachedSourceItems = $items;
}
return $items;
}
function Items() {
$fieldItems = new DataObjectSet();
if($items = $this->sourceItems()) foreach($items as $item) {
$fieldItem = new TableListField_Item($item, $this);
if($item) $fieldItems->push(new TableListField_Item($item, $this));
}
return $fieldItems;
}
/**
* Generates the query for sourceitems (without pagination/limit-clause)
*
* @return string
*/
function getQuery() {
if($this->customQuery) {
$query = clone $this->customQuery;
$baseClass = ClassInfo::baseDataClass($this->sourceClass);
$query->select[] = "{$baseClass}.ID AS ID";
$query->select[] = "{$baseClass}.ClassName AS ClassName";
$query->select[] = "{$baseClass}.ClassName AS RecordClassName";
} else {
$query = singleton($this->sourceClass)->extendedSQL($this->sourceFilter(), $this->sourceSort, null, $this->sourceJoin);
// Add more selected fields if they are from joined table.
$SNG = singleton($this->sourceClass);
foreach($this->FieldList() as $k=>$title){
if(!$SNG->hasField($k) && !$SNG->hasMethod('get' . $k) && !$SNG->hasMethod($k) && !strpos($k, "."))
$query->select[] = "`$k`";
}
}
if(isset($_REQUEST['ctf'][$this->Name()]['sort'])) {
$SQL_sort = Convert::raw2sql($_REQUEST['ctf'][$this->Name()]['sort']);
$sql = $query->sql();
// see {isFieldSortable}
if(in_array($SQL_sort,$query->select) || stripos($sql,"AS {$SQL_sort}")) {
$query->orderby = $SQL_sort;
}
}
return $query;
}
function getCsvQuery() {
$baseClass = ClassInfo::baseDataClass($this->sourceClass);
if($this->customCsvQuery) {
$query = $this->customCsvQuery;
$query->select[] = "{$baseClass}.ID AS ID";
$query->select[] = "{$baseClass}.ClassName AS ClassName";
$query->select[] = "{$baseClass}.ClassName AS RecordClassName";
} else if($this->customQuery) {
$query = $this->customQuery;
$query->select[] = "{$baseClass}.ID AS ID";
$query->select[] = "{$baseClass}.ClassName AS ClassName";
$query->select[] = "{$baseClass}.ClassName AS RecordClassName";
} else {
$query = singleton($this->sourceClass)->extendedSQL($this->sourceFilter(), $this->sourceSort, null, $this->sourceJoin);
// Add more selected fields if they are from joined table.
foreach($this->FieldList() as $k=>$title){
if(singleton($this->sourceClass)->hasDatabaseField($k))
$query->select[] = "`$k`";
}
}
return clone $query;
}
function FieldList() {
return $this->fieldList;
}
/**
* Configure this table to load content into a subform via ajax
*/
function setClick_AjaxLoad($urlBase, $formID) {
$this->clickAction = "this.ajaxRequest('" . addslashes($urlBase) . "', '" . addslashes($formID) . "')";
}
/**
* Configure this table to open a popup window
*/
function setClick_PopupLoad($urlBase) {
$this->clickAction = "var w = window.open(baseHref() + '$urlBase' + this.id.replace(/.*-(\d*)$/,'$1'), 'popup'); w.focus();";
}
function performReadonlyTransformation() {
$clone = clone $this;
$clone->setShowPagination(false);
$clone->setPermissions(array('show'));
$clone->addExtraClass( 'readonly' );
$clone->setReadonly(true);
return $clone;
}
/**
* #################################
* CRUD
* #################################
*/
/**
* @return String
*/
function delete() {
if($this->Can('delete') !== true) {
return false;
}
$this->methodName = "delete";
$childId = Convert::raw2sql($_REQUEST['ctf']['childID']);
if (is_numeric($childId)) {
$childObject = DataObject::get_by_id($this->sourceClass, $childId);
if($childObject) $childObject->delete();
}
// TODO return status in JSON etc.
//return $this->renderWith($this->template);
}
/**
* #################################
* Summary-Row
* #################################
*/
/**
* Can utilize some built-in summary-functions, with optional casting.
* Currently supported:
* - sum
* - avg
*
* @param $summaryTitle string
* @param $summaryFields array
* Simple Format: array("MyFieldName"=>"sum")
* With Casting: array("MyFieldname"=>array("sum","Currency->Nice"))
*/
function addSummary($summaryTitle, $summaryFieldList) {
$this->summaryTitle = $summaryTitle;
$this->summaryFieldList = $summaryFieldList;
}
function removeSummary() {
$this->summaryTitle = null;
$this->summaryFields = null;
}
function HasSummary() {
return (isset($this->summaryFieldList));
}
function SummaryTitle() {
return $this->summaryTitle;
}
/**
* @param DataObjectSet $items Only used to pass grouped sourceItems for creating
* partial summaries.
*/
function SummaryFields($items = null) {
if(!isset($this->summaryFieldList)) {
return false;
}
$summaryFields = array();
$fieldListWithoutFirst = $this->fieldList;
if(!empty($this->summaryTitle)) {
array_shift($fieldListWithoutFirst);
}
foreach($fieldListWithoutFirst as $fieldName => $fieldTitle) {
if(in_array($fieldName, array_keys($this->summaryFieldList))) {
if(is_array($this->summaryFieldList[$fieldName])) {
$summaryFunction = "colFunction_{$this->summaryFieldList[$fieldName][0]}";
$casting = $this->summaryFieldList[$fieldName][1];
} else {
$summaryFunction = "colFunction_{$this->summaryFieldList[$fieldName]}";
$casting = null;
}
// fall back to integrated sourceitems if not passed
if(!$items) $items = $this->sourceItems();
$summaryValue = ($items) ? $this->$summaryFunction($items->column($fieldName)) : null;
// Optional casting, Format: array('MyFieldName'=>array('sum','Currency->Nice'))
if(isset($casting)) {
$summaryValue = $this->getCastedValue($summaryValue, $casting);
}
} else {
$summaryValue = null;
$function = null;
}
$summaryFields[] = new ArrayData(array(
'Function' => $function,
'SummaryValue' => $summaryValue,
'Name' => DBField::create('Varchar', $fieldName),
'Title' => DBField::create('Varchar', $fieldTitle),
));
}
return new DataObjectSet($summaryFields);
}
function HasGroupedItems() {
return ($this->groupByField);
}
function GroupedItems() {
if(!$this->groupByField) {
return false;
}
$items = $this->sourceItems();
if(!$items || !$items->Count()) {
return false;
}
$groupedItems = $items->groupBy($this->groupByField);
$groupedArrItems = new DataObjectSet();
foreach($groupedItems as $key => $group) {
$fieldItems = new DataObjectSet();
foreach($group as $item) {
if($item) $fieldItems->push(new TableListField_Item($item, $this));
}
$groupedArrItems->push(new ArrayData(array(
'Items' => $fieldItems,
'SummaryFields' => $this->SummaryFields($group)
)));
}
return $groupedArrItems;
}
function colFunction_sum($values) {
return array_sum($values);
}
function colFunction_avg($values) {
return array_sum($values)/count($values);
}
/**
* #################################
* Permissions
* #################################
*/
/**
* Template accessor for Permissions
*/
function Can($mode) {
if($mode == 'add' && $this->isReadonly()) {
return false;
} else if($mode == 'delete' && $this->isReadonly()) {
return false;
} else if($mode == 'edit' && $this->isReadonly()) {
return false;
} else {
return (in_array($mode, $this->permissions));
}
}
function setPermissions($arr) {
$this->permissions = $arr;
}
/**
* @return array
*/
function getPermissions() {
return $this->permissions;
}
/**
* #################################
* Pagination
* #################################
*/
function setShowPagination($bool) {
$this->showPagination = (bool)$bool;
}
/**
* @return boolean
*/
function ShowPagination() {
if($this->showPagination && !empty($this->summaryFieldList)) {
user_error("You can't combine pagination and summaries - please disable one of them.", E_USER_ERROR);
}
return $this->showPagination;
}
function setPageSize($pageSize) {
$this->pageSize = $pageSize;
}
function PageSize() {
return $this->pageSize;
}
function ListStart() {
return $_REQUEST['ctf'][$this->Name()]['start'];
}
/**
* @param array
* @deprecated Put the query string onto your form's link instead :-)
*/
function setExtraLinkParams($params){
user_error("TableListField::setExtraLinkParams() deprecated - put the query string onto your form's FormAction instead; it will be handed down to all field with special handlers", E_USER_NOTICE);
$this->extraLinkParams = $params;
}
/**
* @return array
*/
function getExtraLinkParams(){
return $this->extraLinkParams;
}
function FirstLink() {
$start = 0;
if(!isset($_REQUEST['ctf'][$this->Name()]['start']) || !is_numeric($_REQUEST['ctf'][$this->Name()]['start']) || $_REQUEST['ctf'][$this->Name()]['start'] == 0) {
return null;
}
$link = Controller::join_links($this->Link(), "?ctf[{$this->Name()}][start]={$start}");
if($this->extraLinkParams) $link .= "&" . http_build_query($this->extraLinkParams);
return $link;
}
function PrevLink() {
$currentStart = isset($_REQUEST['ctf'][$this->Name()]['start']) ? $_REQUEST['ctf'][$this->Name()]['start'] : 0;
if($currentStart == 0) {
return null;
}
$start = ($_REQUEST['ctf'][$this->Name()]['start'] - $this->pageSize < 0) ? 0 : $_REQUEST['ctf'][$this->Name()]['start'] - $this->pageSize;
$link = Controller::join_links($this->Link(), "?ctf[{$this->Name()}][start]={$start}");
if($this->extraLinkParams) $link .= "&" . http_build_query($this->extraLinkParams);
return $link;
}
function NextLink() {
$currentStart = isset($_REQUEST['ctf'][$this->Name()]['start']) ? $_REQUEST['ctf'][$this->Name()]['start'] : 0;
$start = ($currentStart + $this->pageSize < $this->TotalCount()) ? $currentStart + $this->pageSize : $this->TotalCount() % $this->pageSize > 0;
if($currentStart >= $start-1) {
return null;
}
$link = Controller::join_links($this->Link(), "?ctf[{$this->Name()}][start]={$start}");
if($this->extraLinkParams) $link .= "&" . http_build_query($this->extraLinkParams);
return $link;
}
function LastLink() {
$pageSize = ($this->TotalCount() % $this->pageSize > 0) ? $this->TotalCount() % $this->pageSize : $this->pageSize;
$start = $this->TotalCount() - $pageSize;
// Check if there is only one page, or if we are on last page
if($this->TotalCount() <= $pageSize || (isset($_REQUEST['ctf'][$this->Name()]['start']) && $_REQUEST['ctf'][$this->Name()]['start'] >= $start)) {
return null;
}
$link = Controller::join_links($this->Link(), "?ctf[{$this->Name()}][start]={$start}");
if($this->extraLinkParams) $link .= "&" . http_build_query($this->extraLinkParams);
return $link;
}
function FirstItem() {
if ($this->TotalCount() < 1) return 0;
return isset($_REQUEST['ctf'][$this->Name()]['start']) ? $_REQUEST['ctf'][$this->Name()]['start'] + 1 : 1;
}
function LastItem() {
if(isset($_REQUEST['ctf'][$this->Name()]['start'])) {
return $_REQUEST['ctf'][$this->Name()]['start'] + min($this->pageSize, $this->TotalCount() - $_REQUEST['ctf'][$this->Name()]['start']);
} else {
return min($this->pageSize, $this->TotalCount());
}
}
function TotalCount() {
if($this->totalCount) {
return $this->totalCount;
}
if($this->customSourceItems) {
return $this->customSourceItems->Count();
}
$countQuery = $this->getQuery();
$countQuery->orderby = array();
$baseClass = ClassInfo::baseDataClass($this->sourceClass);
// we can't clear the select if we're relying on its output by a HAVING clause
if(count($countQuery->having) || count($countQuery->groupby)) {
$records = $countQuery->execute();
// TODO figure out how to use COUNT and GROUBY together to produce a single rowcount
$this->totalCount = $records->numRecords();
} else {
$countQuery->select = array();
$countQuery->groupby = array();
$countQuery->select[] = "COUNT(DISTINCT {$baseClass}.ID) AS TotalCount";
$records = $countQuery->execute();
$record = $records->nextRecord();
$this->totalCount = $record['TotalCount'];
}
return $this->totalCount;
}
/**
* #################################
* Search
* #################################
*
* @todo Not fully implemented at the moment
*/
/**
* Compile all request-parameters for search and pagination
* (except the actual list-positions) as a query-string.
*
* @return String URL-parameters
*/
function filterString() {
}
/**
* #################################
* CSV Export
* #################################
*/
function setFieldListCsv($fields) {
$this->fieldListCsv = $fields;
}
/**
* Set the CSV separator character. Defaults to ,
*/
function setCsvSeparator($csvSeparator) {
$this->csvSeparator = $csvSeparator;
}
/**
* Get the CSV separator character. Defaults to ,
*/
function getCsvSeparator() {
return $this->csvSeparator;
}
/**
* Remove the header row from the CSV export
*/
function removeCsvHeader() {
$this->csvHasHeader = false;
}
/**
* Exports a given set of comma-separated IDs (from a previous search-query, stored in a HiddenField).
* Uses {$csv_columns} if present, and falls back to {$result_columns}.
* We move the most filedata generation code to the function {@link generateExportFileData()} so that a child class
* could reuse the filedata generation code while overwrite export function.
*
* @todo Make relation-syntax available (at the moment you'll have to use custom sql)
*/
function export() {
$now = Date("d-m-Y-H-i");
$fileName = "export-$now.csv";
if($fileData = $this->generateExportFileData($numColumns, $numRows)){
return HTTPRequest::send_file($fileData, $fileName);
}else{
user_error("No records found", E_USER_ERROR);
}
}
function generateExportFileData(&$numColumns, &$numRows) {
$separator = $this->csvSeparator;
$csvColumns = ($this->fieldListCsv) ? $this->fieldListCsv : $this->fieldList;
$fileData = '';
$columnData = array();
$fieldItems = new DataObjectSet();
if($this->csvHasHeader) {
$fileData .= "\"" . implode("\"{$separator}\"", array_values($csvColumns)) . "\"";
$fileData .= "\n";
}
if(isset($this->customSourceItems)) {
$items = $this->customSourceItems;
} else {
$dataQuery = $this->getCsvQuery();
$items = $dataQuery->execute();
}
// temporary override to adjust TableListField_Item behaviour
$this->setFieldFormatting(array());
$this->fieldList = $csvColumns;
if($items) {
foreach($items as $item) {
if(is_array($item)) {
$className = isset($item['RecordClassName']) ? $item['RecordClassName'] : $item['ClassName'];
$item = new $className($item);
}
$fieldItem = new TableListField_Item($item, $this);
$fields = $fieldItem->Fields();
$columnData = array();
if($fields) foreach($fields as $field) {
$value = $field->Value;
// TODO This should be replaced with casting
if(array_key_exists($field->Name, $this->csvFieldFormatting)) {
$format = str_replace('$value', "__VAL__", $this->csvFieldFormatting[$field->Name]);
$format = preg_replace('/\$([A-Za-z0-9-_]+)/','$item->$1', $format);
$format = str_replace('__VAL__', '$value', $format);
eval('$value = "' . $format . '";');
}
$value = str_replace(array("\r", "\n"), "\n", $value);
$tmpColumnData = "\"" . str_replace("\"", "\"\"", $value) . "\"";
$columnData[] = $tmpColumnData;
}
$fileData .= implode($separator, $columnData);
$fileData .= "\n";
$item->destroy();
unset($item);
unset($fieldItem);
}
$numColumns = count($columnData);
$numRows = $fieldItems->count();
return $fileData;
} else {
return null;
}
}
/**
* We need to instanciate this button manually as a normal button has no means of adding inline onclick-behaviour.
*/
function ExportLink() {
$exportLink = Controller::join_links($this->Link(), 'export');
if($this->extraLinkParams) $exportLink .= "?" . http_build_query($this->extraLinkParams);
return $exportLink;
}
function printall() {
Requirements::clear();
Requirements::css(CMS_DIR . '/css/typography.css');
Requirements::css(CMS_DIR . '/css/cms_right.css');
Requirements::css(SAPPHIRE_DIR . '/css/TableListField_print.css');
unset($this->cachedSourceItems);
$oldShowPagination = $this->showPagination;