-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathFieldtypeSelectExtOption.module
executable file
·1273 lines (1154 loc) · 48.4 KB
/
FieldtypeSelectExtOption.module
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 namespace ProcessWire;
/**
* ProcessWire Module Fieldtype Select External Option
* extend all Selectfieldtypes
* provide all Inputfields
*
* pulls options (value/ label pairs) from other datatable (also other fields)
* access to selected datatable row via Api
*
*
* made by kixe (Christoph Thelen) 2015-03-09
* Licensed under GNU/GPL v3
* @version 2.1.9 2024-05-28
*
* ProcessWire 2.x, 3.x
* Copyright (C) 2013 by Ryan Cramer
* Licensed under GNU/GPL v2, see LICENSE.TXT
*
* http://processwire.com
*
* @since 1.2.3 - added config field for initial selection (default value) - 2017-02-12
* @since 1.2.4 - added config field for other language labels - 2017-02-20
* @since 1.2.5 - fixed bug added filter to function getTableRow(), allow 0 as value (data) - 2017-03-01
* @since 1.2.6 - allow no pre-selection if value 0 is selectable - 2017-03-02
* @since 1.2.7 - modified field render and added error message in case of an empty options array - 2017-03-03
* @since 1.2.8 - fixed multilanguage bug, fixed issues related to allowance of 0 values as selectable option - 2017-03-03
* @since 1.2.9 - added hookable function label() - 2017-03-03
* @since 1.3.0 - modified arguments of function label() - 2017-03-06
* @since 1.3.1 - added hook to remove InputfieldSelect::defaultValue doubled by init_value - 2017-04-19
* @since 1.3.2 - fixed issue: quick exit of getTableRow() if external database connection fails - 2017-07-25
* @since 1.3.3 - fixed issues: setting default port to external db, return value of of getDatabaseColumns - 2017-07-25
* @since 1.3.4 - better error handling - external databases - 2017-07-25
* @since 1.3.5 - modified arguments of function label() - 2017-08-28
* @since 1.3.6 - fixed bug: in function options() - 2017-10-15
* @since 1.3.7 - fixed bug: attribute value not provided if page instance of NullPage - 2018-03-27
* @since 1.3.8 - fixed bug: return language sensitive label getSingleValue() - 2018-03-30
* @since 1.3.9 - switched return of SelectExtOption::__toString() from value (int) to label - 2018-05-31
* @since 1.4.0 - fixed bug: render select, apply selected attribute - removed changes from version 1.3.9 - 2018-06-13
* @since 1.4.1 - added config field to define return of SelectExtOption::__toString() - 2019-06-20
* @since 1.4.2 - fixed bug: #12 thanks @tiefenb - 2019-10-03
* @since 1.4.3 - fixed bug: after some changes in InputfieldSelect::renderOptions() since PW 3.0.140 - 2019-12-10
* @since 1.4.4 - fixed bug: hook of last update affected config inputfields - 2019-12-11
* @since 1.4.5 - allow InputfieldToggle - 2019-12-21
* @since 1.4.6 - fixed render and processInput bugs with InputfieldToggle - 2019-12-21
* @since 1.4.7 - fixed bug: typo in InputfieldSelect::render hook - 2019-12-24
* @since 1.4.8 - added language argument to function options() and language sensitive output for toString() - 2019-12-25
* @since 1.4.9 - fixed multi value bug, fixed for single values in 1.4.3 - 2019-12-25
* @since 2.0.0 - major update, switched to ProcessWire namespace, added functions for better import and export, cleanup - 2019-12-28
* @since 2.0.1 - extended filter, use pipes to create OR groups - 2020-01-11
* @since 2.0.2 - added function getDefaultValue() - 2020-04-04
* @since 2.0.3 - removed hook, updated requirement PW version - 2020-04-04
* @since 2.0.4 - changed a lot of code for better handling default value and zero vs. null - 2020-04-04
* @since 2.0.5 - fixed bug #13 - https://github.com/kixe/FieldtypeSelectExtOption/issues/13 - 2020-04-05
* @since 2.0.6 - fixed bug: filter didn't allow zero as value - 2020-04-09
* @since 2.0.7 - added constant to limit number of selectable options show error if exceeded - 2020-04-09
* @since 2.0.8 - added function getSelectorInfo() to distinguish between single and multiple values for selector fields (remove subfield 'count' if single), added function getMatchQuery() to allow searching via label - 2020-12-11
* @since 2.0.9 - force to sort by final label - 2021-02-13
* @since 2.1.0 - fixed bug: removed line 841 @see https://processwire.com/talk/topic/9320-fieldtype-select-external-option/?do=findComment&comment=212453 - 2021-02-13
* @since 2.1.1 - fixed bug: surround custom filter with brackets - 2022-01-27
* @since 2.1.2 - extended function row() to retrieve any row by int value independend from a page value - 2022-08-30
* @since 2.1.3 - fixed bug: Option list does not take into account 'Order by' and 'Order direction'. - 2024-02-12
* @since 2.1.4 - added function getEqualValue() as workaround to prevent Page::trackChange() triggered by PageComparison::isEqual() resulting in a message even if nothing has changed due to strict object comparison (Bug in ProcessWire) - 2024-03-27
* @since 2.1.5 - fixed bug: function getEqualValue() receive current page value (SelectExtOption or WireArray) from page data array instead of direct access via __get()resulting in error - 2024-03-29
* @since 2.1.6 - update setDatabase() prevents the instantiation of duplicates of database connections that can lead to a database exception by exceeding 'max_user_connections' - 2024-04-20
* @since 2.1.7 - fixed bug: getSaveableValue() should always return array - 2024-04-25
* @since 2.1.8 - made function getDefaultValue() consistent to fieldtype,
* moved Inputfield hooks to init,
* optimized output formatting by adding function formatValue()
* and adding of() functions to the value classes similar to FieldtypeOptions,
* made compatible with FieldtypeFile custom fields
* fixed getEqualValue() bug if multiple options selected - 2024-05-10
* @since 2.1.9 - fixed formatValue() bug if value is not of type SelectExtOption or SelectExtOptionArray - 2024-05-28
*
*/
class FieldtypeSelectExtOption extends FieldtypeMulti {
public static function getModuleInfo() {
return array(
'title' => 'Select External Option',
'version' => 219,
'summary' => __('Fieldtype which generates the options for a Select Inputfield from *any* table in *any* database hosted *anywhere*. Define database, source table, columns (to pull value & label) and the preferred Inputfieldtype in field settings.'),
'author' => 'kixe',
'href' => 'http://modules.processwire.com/modules/fieldtype-select-ext-option/',
'license' => 'GNU-GPLv3',
'hreflicense' => 'http://www.gnu.org/licenses/gpl-3.0.html',
'icon' => 'database',
'requires' => 'ProcessWire>=3.0.148'
);
}
protected $database = null;
protected $databases = [];
/**
* Max allowed number of options
*
*/
const OPTIONSLIMIT = 500;
/**
* Setup Inputfield hooks
*
*/
public function init() {
// remove Inputfield setup field 'defaultValue' because it's provided by this class
$this->addHookAfter('InputfieldSelect::getConfigInputfields', function($e) {
if ($e->object->hasFieldtype instanceof FieldtypeSelectExtOption == false) return;
$inputfields = $e->return;
$e->return = $inputfields->remove('defaultValue');
});
// set default value
$this->addHookBefore("Inputfield::render", function ($e) {
$page = $e->object->hasPage;
$field = $e->object->hasField;
$fieldtype = $e->object->hasFieldtype;
// quick exit
if ($fieldtype instanceof FieldtypeSelectExtOption == false) return;
if ($field->init_value !== null) {
$field->defaultValue = is_array($field->init_value)? implode("\n", $field->init_value) : "$field->init_value";
}
});
/**
* hook for special case:
* - field required
* - InputfieldSelect
* - value 0 is a selectable option
* - 0 is selected
* in this case InputfieldSelect::renderOptions() does not make a difference between 0 and null and provides the 'deselect' option tag. We remove it here
*
*/
$this->addHookAfter("InputfieldSelect::render", function ($e) {
$page = $e->object->hasPage;
$field = $e->object->hasField;
$fieldtype = $e->object->hasFieldtype;
// quick exit
if ($fieldtype instanceof FieldtypeSelectExtOption == false) return;
// if ($field->type != $this) return;
if ($field->required && $e->object->intValue === array(0)) {
$string = $e->return;
$e->return = str_replace("<option value=''> </option>", '', $string);
}
});
}
/**
* Create a new PDO instance from field settings. set database property
*
*
* @param Field $field
* @return bool if WireDatabasePDO could be set
*
*/
protected function setDatabase(Field $field) {
if ($this->lastAccessField == $field && $this->database) return true;
if (array_key_exists($field->id, $this->databases)) {
if (!($this->databases[$field->id] instanceof WireDatabasePDO)) {
$type = gettype($this->databases[$field->id]);
if ($type == 'object') {
$class = get_class($this->databases[$field->id]);
$type = "instanceof $class";
}
unset($this->databases[$field->id]);
throw new WireException("Expected instance of WireDatabasePDO for FieldtypeSelectExtOption::databases[$field->id] $type given");
} else {
$this->database = $this->databases[$field->id];
$this->setLastAccessField($field);
return true;
}
}
if (!strlen($field->db_user.$field->db_pass.$field->db_name)) {
$this->setLastAccessField($field);
$this->database = $this->wire('database');
$this->databases[$field->id] = $this->database;
return true;
}
else if (strlen($field->db_user) == 0 || strlen($field->db_pass) == 0 || strlen($field->db_name) == 0) {
$this->database = $this->wire('database');
unset($this->databases[$field->id]);
if (!count($_POST)) $this->error('Setting an external database failed: Missing value/s');
return false;
}
else {
try {
$host = $field->db_host;
$username = $field->db_user;
$password = $field->db_pass;
$name = $field->db_name;
$socket = $field->db_socket;
$charset = $this->wire('config')->dbCharset; // charset set in config, don't change here!
$port = $field->db_port; // default port set in config
if ($socket) {
// if socket is provided ignore $host and $port and use $socket instead:
$dsn = "mysql:unix_socket=$socket;dbname=$name;";
} else {
$dsn = "mysql:dbname=$name;host=$host";
if($port) $dsn .= ";port=$port";
}
if (!$this->checkAccess($host, $port)) {
$field->db_host = 'localhost'; // we reset to localhost
$field->save('db_host');
return false;
}
$driver_options = array(
\PDO::MYSQL_ATTR_INIT_COMMAND => "SET NAMES '$charset'",
\PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION,
\PDO::ATTR_TIMEOUT => 5,
\PDO::ATTR_PERSISTENT => true // test to get better performance ...
);
$database = new WireDatabasePDO($dsn, $username, $password, $driver_options);
$database->setDebugMode($this->wire('config')->debug);
$this->database = $database;
$this->databases[$field->id] = $database;
$this->setLastAccessField($field);
return true;
} catch (\PDOException $e) {
if (!count($_POST)) {
$this->error('Setting an external database failed: '.$e->getMessage());
return false;
}
}
}
throw new WireException("Unepected error");
}
/**
* Check accessibility of external host:port before trying to create a database connection
*
* @param string $host
* @param string/int $port
* @return bool
*
*/
protected function checkAccess($host, $port) {
if (!function_exists('socket_create')) return true;
// make all errors, warnings, notices exception
// set_error_handler(function($errno, $errstr) {throw new Exception($errstr, $errno);});
if (!filter_var($host, FILTER_VALIDATE_IP)) {
$_host = gethostbyname($host);
if (empty($_POST) && $_host == $host) $this->error("Unable to translate '$host' to valid IP Adress (IPv4)");
else if (empty($_POST) && !filter_var($_host, FILTER_VALIDATE_IP)) $this->error('Invalid IPv4 syntax for host');
else $host = $_host;
}
if (!empty($this->errors(array('array')))) return false;
$socket = socket_create(AF_INET, SOCK_STREAM, 0);
$message = '';
try {
if (socket_connect($socket, $host, $port)) {
socket_close($socket);
return true;
}
}
catch (Exception $e) {
$message = "Error: ".$e->getMessage();
}
if (empty($_POST)) $this->error("No response from [$host:$port]. $message");
restore_error_handler();
return false;
}
/**
* prevent database queries before database is set
*
*/
public function getLoadQueryAutojoin(Field $field, DatabaseQuerySelect $query) {
if (!$this->database) return null;
return parent::getLoadQueryAutojoin($field, $query);
}
/**
* Get an associative array of all values of the row depending to the selected single value.
*
* @param object $field
* @param int $value
* @return array / empty if column holding the values is not defined
*
*/
protected function getTableRow(Field $field, $value) {
if ($value === null) return array();
if (!$this->setDatabase($field)) return array();
$table = $field->option_table;
if (!$table) return array();
$columns = $this->getDatabaseColumns($table);
$valuecolumn = $field->option_value;
if (!in_array($valuecolumn,$columns)) return array();
$table = $this->database->escapeTable($table);
$value = (int)$value;
$filter = $this->filter($field);
$filter = ($filter)?" AND $filter":'';
$sql = "SELECT * FROM `$table` WHERE $valuecolumn = '$value'$filter";
$query = $this->database->query($sql);
if (!$query->rowCount()) return array();
return $query->fetch(\PDO::FETCH_ASSOC); // single return, unique value
}
/**
* Access to all column values of the selected row/rows.
*
* @param string fieldname, default: first field in page of type SelectExtOption
* @param selector null|string|bool to get a page, default: current page
* @param value int|array to get a specific row, selector must be set to false
* @return assoc array
*
*/
public function row($name = null, $selector = null, $value = null) {
$return = array();
$n = $name;
if ($name) $name = ',name='.$name;
// get a page value
if ($value === null && $selector !== false) {
$page = ($selector)? $this->wire('pages')->get($selector) : $this->wire('page');
if ($page instanceof NullPage) throw new WireException("Page not found. Selector string '$selector' doesn't match.");
$field = $page->fields->get('type=FieldtypeSelectExtOption'.$name);
//field does not belong to pages fieldgroup
if (!$name && !$field) throw new WireException("Page '$page->name' doesn't contain any field of type 'SelectExtOption'!");
if (!$field) throw new WireException("Field '$n' doesn't belong to page '$page->name'.");
$name = $field->name;
$value = $page->$name;
} else {
$field = wire('fields')->get($n);
if (is_numeric($value)) $value = (int) $value;
else if (!is_array($value)) throw new WireException("3d argument 'value' must be of type numeric (int) or array.");
}
if (is_int($value)) {
$return = $this->getTableRow($field, $value);
}
else if (is_array()) {
foreach ($value as $key => $val) {
$row = $this->getTableRow($field, $value);
$return[$key] = $row;
}
}
else if ($value instanceof SelectExtOptionArray) {
foreach ($value as $key => $val) {
$row = $this->getTableRow($field, $val->value);
$return[$key] = $row;
}
} else if ($value instanceof SelectExtOption) {
$return = $this->getTableRow($field, $value->value);
} else {
// ...
}
return $return;
}
public function getInputfield(Page $page, Field $field) {
// get (set default) name of Inputfieldtype
$class = ($field->input_type)? $field->input_type : 'InputfieldSelect';
// set Inputfield
$inputfield = $this->modules->get($class);
// get the options array
$options = $this->options($field);
// any selectable options provided?
if (empty($options)) {
$inputfield = $this->modules->get('InputfieldMarkup');
$inputfield->textformatters = array('TextformatterMarkdownExtra');
$inputfield->markupText = "Field: *$field->name* doesn't provide selectable options. Check field settings!";
return $inputfield;
}
foreach($options as $optval => &$label) $label = $this->label($label, $optval, $page, $field);
if (!$field->option_order) {
if ($field->option_asc) arsort($options, SORT_LOCALE_STRING); // sort descending by final label
else asort($options, SORT_LOCALE_STRING); // sort ascending by final label
}
// else ksort($options); // DO NOT SORT, because already sorted by database query "order by"
$inputfield->addOptions($options, true);
/**
* attributes needed?
*
foreach ($options as $optval => $label) {
$inputfield->addOption($optval, $label, array());
}
*/
// InputfieldToggle requires a value, the property 'useDeselect' is not provided here
// value must be a valid selectable option
if ($class == 'InputfieldToggle') {
if ($page->{$field->name} instanceof WireArray && $page->{$field->name}->value === null) {
reset($options);
$value = $field->init_value? $field->init_value : key($options);
$page->setAndSave($field->name, $value);
}
}
return $inputfield;
}
/**
* Get an array of all columns in a given table of the database.
*
* @param string name of the table
* @return array
*
*/
protected function getDatabaseColumns($table) {
if (!$this->database || !in_array($table, $this->database->getTables())) return array();
$columns = array();
$table = $this->database->escapeTable($table);
$sql = "SHOW COLUMNS FROM $table";
$query = $this->database->query($sql);
if (!$query->rowCount()) return array();
$rows = $query->fetchAll();
foreach ($rows as $row) $columns[] = $row['Field'];
return $columns;
}
/**
* Return true if column in a given table of the database is of type (int).
*
* @param string datatable and column
* @return null (if table and/or column doesn't exist)
* @return bool (true if int)
*
*/
protected function isIntColumn($table,$column) {
$result = array();
$columns = $this->getDatabaseColumns($table);
if (!$columns) return null;
if (!in_array($column,$columns)) return null;
$table = $this->database->escapeTable($table);
$column = $this->database->escapeCol($column);
$sql = "SELECT DATA_TYPE FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = '$table' AND COLUMN_NAME = '$column'";
$query = $this->database->query($sql);
if (!$query->rowCount()) return null;
foreach ($query->fetchAll() as $type) if(strpos($type[0],'int') !== false) return true;
return false;
}
/**
* Return array of all selectable options, key ≈ (int)optionvalue, value ≈ optionlabel
*
* @param string/int/object $field - Field, field->id, field->name
* @param object $language - Language - default: user language
* @return array
*
*/
public function options($field = null, Language $language = null) {
if (!$field instanceof Field) {
$selector = '';
if (is_int($field)) $selector = ",id=$field";
elseif (is_string($field)) $selector = ",name=$field";
$_field = $field;
$field = $this->wire('fields')->get('type=FieldtypeSelectExtOption'.$selector);
if (!$field) throw new WireException("Field '$_field' doesn't exist or is not of type FieldtypeSelectExtOption.");
}
elseif ($field->type != 'FieldtypeSelectExtOption') throw new WireException("Expecting FieldtypeSelectExtOption.");
$this->setDatabase($field);
// set language
$langID = null;
if (!$language &&
$this->wire('modules')->isInstalled("LanguageSupport") &&
!$this->wire('user')->get('language')->isDefault()) {
$language = $this->wire('user')->get('language');
}
if ($language && !empty($field->{"option_label_$language->id"})) $langID = "_$language->id";
// create options array
$options = $this->getExtOptions($field->option_table,$field->option_value,$field->{"option_label$langID"},$this->filter($field),$field->option_order,$field->option_asc,$field->option_label);
return $options;
}
/**
* Get options array from external field or datatable
*
* @return bool false if table and/or column doesn't exist
* @return null if table doesn't contain any data
* @return array(value => label)
*
*/
protected function getExtOptions($table, $value = false, $label = false, $filter = false, $order = false, $dir = false, $defaultLabel = null) {
// quick exit
if (!$this->database) return false;
// check if table exist
$table = $this->database->escapeTable($table);
if (!in_array($table,$this->database->getTables())) return false;
// get columns array
$columns = $this->getDatabaseColumns($table);
// we need minimum one inttype column
foreach ($columns as $column) {
if ($this->isIntColumn($table,$column)) $intcolumn = $column; break;
}
if (!isset($intcolumn)) return false;
// check if column isset and exist, default 1st column
if ($label === false) $label = $columns[0];
else if (!in_array($label,$columns)) return false;
// check if column isset and exist, default 1st column
if($defaultLabel === null) $defaultLabel = $label;
else if (!in_array($defaultLabel,$columns)) return false;
// check if column isset and exist, default 1st column of type int
if($value === false) $value = $intcolumn;
else if (!in_array($value,$columns)) return false;
$options = array();
// @see getConfigInputfields()
if ($dir !== 'LIMIT 1') {
$dir = ((bool)$dir === true)? 'DESC':'ASC';
}
$order = ($order)?$order:$label;
$order = $this->database->escapeCol($order);
// validate/sanitize filterstring
$filter = $filter? "WHERE $filter" : '';
// $statement = "SELECT * FROM `$table` $filter ORDER BY `$order` $dir LIMIT " . self::OPTIONSLIMIT;
$statement = "SELECT * FROM `$table` $filter ORDER BY `$order` $dir";
$query = $this->database->prepare($statement);
$query->execute();
if (!$query->rowCount()) return null;
if ($query->rowCount() > self::OPTIONSLIMIT) {
$this->error($this->className() . sprintf(': Maximum number (%1$d < %2$d) of selectable options exceeded. Use filter function in field settings to limit.', self::OPTIONSLIMIT, $query->rowCount()));
return false;
}
$this->errors('clear all');
while ($row = $query->fetch(\PDO::FETCH_ASSOC)) $options[$row[$value]] = strlen((string) $row[$label])? $row[$label] : $row[$defaultLabel];
return $options;
}
/**
* Hookable function called from Inputield provides option to edit option labels
*
* @param string $label (option label)
* @param int $value (option value)
* @param object $page
* @param object $field
* @return string
*
*/
protected function ___label($label, $value, Page $page, Field $field) {
return $label;
}
/**
* Hookable function provides option to filter options array
*
* @param object $field
* @return string SQL command filter part. example: "column = 'value'"
*
*/
protected function ___filter(Field $field) {
// all parts set?
if (!$field->filter_column||!$field->filter_selector||$field->filter_value === null) return false;
// valid operator?
$operators = array(' LIKE ',' NOT LIKE ');
// we use pipe to allow OR
if (strpos($field->filter_value, '|')) {
$values = explode('|', $field->filter_value);
foreach ($values as &$v) {
$v = $this->database->quote($v);
}
unset($v);
} else $values = array($this->database->quote($field->filter_value));
if (!$this->database->isOperator($field->filter_selector) && !in_array($field->filter_selector,$operators)) return false;
// escape column, compose filter string
$return = '';
foreach ($values as $value) {
$return .= '`'.$this->database->escapeCol($field->filter_column).'`'.$field->filter_selector.$value. ' OR ';
}
return '(' . rtrim($return, ' OR ') . ')';
}
/**
* Return an existing page (data) value if identical with runtime value
* workaround to prevent Page::trackChange() triggered by PageComparison::isEqual() resulting in a message that page value has been changed even if nothing has changed due to strict object comparison (instance must be identical)
*
* @param object $page
* @param object $field
* @param int|array|object $value
* @return int|array|object SelectExtOption|SelectExtOptionArray
*
* @see self::sanitizeValue(), PageComparison::isEqual(), WireData::set()
*
*/
protected function getEqualValue(Page $page, Field $field, $value) {
// receive current page value (SelectExtOption or SelectExtOptionArray) from data array
$_value = isset($page->data[$field->name]) ? $page->data[$field->name] : null;
if (!$_value) return $value;
// $this->error('changed');
$int1 = null;
$int2 = null;
$array1 = [];
$array2 = [];
// $this->error('changed');
if ($value instanceof SelectExtOption) $int1 = $value->value;
if ($value instanceof SelectExtOptionArray) $array1 = array_values($value->each('value'));
if ($_value instanceof SelectExtOption) $int2 = $_value->value;
if ($_value instanceof SelectExtOptionArray) $array2 = array_values($_value->each('value'));
if (is_numeric($value)) $int1 = (int) $value;
if (is_array($value)) {
foreach ($value as $key => $item) {
if ($item instanceof SelectExtOption) $array1[] = $item->value;
else if (is_numeric($item)) $array1[] = (int) $item;
}
}
$array1 = array_unique($array1);
$array2 = array_unique($array2);
// sortable?
$module = $this->modules->get($field->input_type);
$sortable = ($module instanceof InputfieldHasArrayValue && $module instanceof InputfieldHasSortableValue)? true : false;
if (!$sortable) {
sort($array1);
sort($array2);
}
if ($array1 === $array2 && $int1 === $int2) return $_value;
return $value;
}
public function getBlankValue(Page $page, Field $field) {
$module = $this->modules->get($field->input_type);
return ($module instanceof InputfieldHasArrayValue)? new SelectExtOptionArray() : new SelectExtOption();
}
/**
* Return the defaultValue property for this field (if set), or blank otherwise.
*
* Under no circumstances should this return NULL, because that is used by Page to determine if a field has been loaded.
*
* @param object $page
* @param object $field
* @return mixed
*
* @see Fieldtype::getDefaultValue(), Field::getDefaultValue(), InputfieldSelect::checkDefaultValue()
*
*/
public function getDefaultValue(Page $page, Field $field) {
if ($field->init_value !== null) {
return $this->sanitizeValue($page, $field, $field->init_value);
}
return $this->getBlankValue($page, $field);
}
public function getSingleValue(Field $field, $value) {
// if ($value instanceof SelectExtOption) return $value;
if ($value === null) return new SelectExtOption();
$new = new SelectExtOption();
$new->value = (int) $value;
$row = $this->getTableRow($field, $new->value);
if (empty($row)) return new SelectExtOption();
foreach ($row as $key => $value) {
// skip reserved words
if (in_array($key, array('of','value','label','row','data','options','toString'))) continue;
$new->set($key, $value);
}
if ($field->option_output) $new->toString = $field->option_output;
$new->row = $row;
$new->options = $this->options($field);
$new->label = $new->options[$new->value];
return $new;
}
public function sanitizeValue(Page $page, Field $field, $value) {
$value = $this->getEqualValue($page, $field, $value);
if ($value instanceof SelectExtOption) return $value;
if ($value instanceof SelectExtOptionArray) return $value;
if (is_array($value)) {
$return = new SelectExtOptionArray();
foreach ($value as $key => $val) {
if (is_numeric($val)) $key = $val;
if ($val instanceof SelectExtOption) $key = $val->value;
$return->set((int) $key, $this->getSingleValue($field, $val));
}
$return->data('options',$this->options($field));
return $return;
}
if (empty($value) || !is_numeric($value)) return $this->getBlankValue($page, $field);
return $this->getSingleValue($field, $value);
}
public function wakeupValue(Page $page, Field $field, $value) {
if (empty($value)) return $this->getBlankValue($page, $field);
if (!is_array($value)) $value = array($value);
// if input type has changed ...
$module = $this->modules->get($field->input_type);
if (!$module instanceof InputfieldHasArrayValue) return $this->getSingleValue($field, array_pop($value));
$return = new SelectExtOptionArray();
foreach ($value as $val) $return->set((int) $val, $this->getSingleValue($field, $val));
$return->data('options',$this->options($field));
return $return;
}
public function sleepValue(Page $page, Field $field, $value) {
if ($value instanceof SelectExtOption) return ($value->value !== null)? array($value->value) : null;
$return = array();
if ($value instanceof SelectExtOptionArray) {
foreach ($value as $object) {
if (!$object instanceof SelectExtOption) throw new WireException("Expecting an instance of SelectExtOption");
if ($object->value === null) continue;
$return[] = $object->value;
}
}
return $return;
}
/**
* Prep a value for front-end output
*
* This returns a cloned copy of $value with output formatting enabled.
*
* @param Page $page
* @param Field $field
* @param SelectExtOption|SelectExtOptionArray $value
* @return SelectExtOption|SelectExtOptionArray
*
*/
public function ___formatValue(Page $page, Field $field, $value) {
$value = $this->sanitizeValue($page, $field, $value);
if ($value instanceof SelectExtOption) {
$_value = clone $value;
} else {
$_value = new SelectExtOptionArray();
foreach($value as $option) {
$_option = clone $option;
$_value->add($_option);
}
}
$_value->of(true);
return $_value;
}
/**
* Given a value, return an portable version of it
*
* @param Page $page
* @param Field $field
* @param string|int|float|array|object|null $value
* @param array $options Optional settings to shape the exported value, if needed:
* - `human` (boolean): When true, Fieldtype may optionally emphasize human readability over importability
* - `language` (null|int|object): Language or language id
* @return int|string|array
*
*/
public function ___exportValue(Page $page, Field $field, $value, array $options = array()) {
$defaultOptions = array(
'human' => false,
'language' => null
);
$options = array_merge($defaultOptions, $options);
// default return int (single) or array of int (multiple)
if (!$options['human'] || $value->toString == 'value') return $this->sleepValue($page, $field, $value);
// get language
$language = null;
if ($this->wire('modules')->isInstalled("LanguageSupport") && $options['language']) {
if (!$options['language'] instanceof Language) $language = $this->wire('languages')->get($options['language']);
else $language = $options['language'];
}
// return label or array of labels (language sensitive)
if ($language->id && $value->toString == 'label') {
if ($value instanceof SelectExtOption) return $this->options($field, $language)[$value->value];
else {
$return = [];
foreach ($value as $v) $return[] = $this->options($field, $language)[$v->value];
return $return;
}
}
// return human readable string or array of strings
$value = $this->sanitizeValue($page, $field, $value);
$value->of(true);
if ($value instanceof SelectExtOption) return "$value";
else {
$return = [];
foreach ($value as $v) $return[] = "$v";
return $return;
}
}
/**
* get a saveable value (array of selectable option values [int]), by searching for matches of $search in label columns or any column
* $page->set('myfield', $return) or $page->setAndSave('myfield', $return)
*
* @param Field $field
* @param string|int|float|array $search
* @param int $full
* - 0: searching in label columns only (multilanguage if set)
* - 1: full search in all columns
* @return array
*
*/
public function getSaveableValue(Field $field, $search, $full = 0) {
$this->setDatabase($field);
// search for labels
if (!$full) {
$columns = [$field->option_label];
$otherLanguagePageIDs = $this->modules->isInstalled("LanguageSupport")? $this->modules->get("LanguageSupport")->otherLanguagePageIDs: null;
if (!empty($otherLanguagePageIDs)) {
foreach ($otherLanguagePageIDs as $lid) {
if (empty($field->{"option_label_$lid"})) continue;
$columns[] = $field->{"option_label_$lid"};
}
}
}
// full search
else $columns = $this->getDatabaseColumns($field->option_table);
// compose statement
$columnsString = '`' . implode('`,`', $columns) . '`';
$filter = $this->filter($field);
$filter = ($filter)? "WHERE $filter AND ":'WHERE ';
if (is_array($search)) $search = implode("' IN ($columnsString) OR '" , $search);
$filter .= "'$search' IN ($columnsString)";
$statement = "SELECT * FROM `$field->option_table` $filter";
// execute statement
$query = $this->database->prepare($statement);
$query->execute();
if (!$query->rowCount()) return [];
$result = [];
while($row = $query->fetch(\PDO::FETCH_ASSOC)) {
$result[] = (int) $row[$field->option_value];
}
if (empty($result)) return [];
return $result;
}
/**
* Get the database query that matches a Fieldtype table’s data
* translate label to related value (always integer)
*
*/
public function getMatchQuery($query, $table, $subfield, $operator, $value) {
if (!is_numeric($value)) $value = $this->getSaveableValue($query->field, $value, 0);
if (empty($value)) $value = '';
return parent::getMatchQuery($query, $table, $subfield, $operator, $value);
}
/**
* Return array with information about what properties and operators can be used with this field
* corresponding to the selected Inputfieldtype (single, multiple)
*
*/
public function ___getSelectorInfo(Field $field, array $data = array()) {
$class = $field->input_type;
$module = $this->modules->get($class);
if($module instanceof InputfieldHasArrayValue) return parent::___getSelectorInfo($field, $data);
else return Fieldtype::___getSelectorInfo($field, $data);
}
public function ___getConfigInputfields(Field $field) {
$inputfields = parent::___getConfigInputfields($field);
$this->setDatabase($field);
// usage
$markup = file_exists(dirname(__FILE__) . '/README.md')?file_get_contents(dirname(__FILE__) . '/README.md'):null;
if ($markup) {
$f = $this->modules->get("InputfieldMarkup");
$f->label = $this->_('Usage');
// call textformatter before wrapping
$this->modules->get('TextformatterMarkdownExtra')->format($markup);
$f->markupText = "<div style=\"padding:0 16px; border-left: 16px solid #29c4bc;\"><strong>README.md</strong><hr/>$markup</div>";
$f->collapsed = Inputfield::collapsedYes;
$inputfields->append($f);
}
// choose inputfieldtype
$f = $this->modules->get('InputfieldSelect');
$f->label = $this->_('Inputfieldtype');
$f->attr('name', 'input_type');
$f->attr('value', $field->input_type);
$f->required = true;
$f->description = $this->_('Select the type of Inputfield.');
$f->notes = '* ' . $this->_('Types indicated with an asterisk are for multiple selection. Maybe 3rd party Inputfields will not work as expected. Please test carefully.');
$f->addOption('InputfieldSelect', 'Select');
foreach($this->modules->get("InputfieldPage")->inputfieldClasses as $class) {
$module = $this->modules->get($class);
if (!$module instanceof InputfieldSelect && !$module instanceof InputfieldToggle) continue;
$label = str_replace("Inputfield", '', $class);
if ($module instanceof InputfieldHasArrayValue) $label .= "*";
$f->addOption($class, $label);
}
$inputfields->append($f);
// external Database
$fieldset = $this->modules->get("InputfieldFieldset");
$fieldset->label = $this->_('External MySQL Database/ Host');
$fieldset->description = $this->_("Optionally specify an external MySQL 5.x database. If the database is not accessible for any reason default database will be selected.");
$fieldset->notes = $this->_('Incorrect entries in the field \'DB Host\' produce unsightly error messages! Be aware of this.');
$fieldset->collapsed = strlen($field->db_name.$field->db_user.$field->db_pass)? Inputfield::collapsedNo : Inputfield::collapsedYes;
$inputfields->add($fieldset);
// DB Name
$f = $this->modules->get("InputfieldText");
$f->label = $this->_("DB Name");
$f->attr('name', 'db_name');
$f->attr('value', $field->db_name);
$f->columnWidth = 20;
$fieldset->append($f);
// DB User
$f = $this->modules->get("InputfieldText");
$f->label = $this->_("DB User");
$f->attr('name', 'db_user');
$f->attr('value', $field->db_user);
$f->columnWidth = 20;
$fieldset->append($f);
// DB Pass
$f = $this->modules->get("InputfieldText");
$f->label = $this->_("DB Pass");
$f->attr('name', 'db_pass');
$f->attr('value', $field->db_pass);
$f->columnWidth = 20;
$fieldset->append($f);
// DB Host
$f = $this->modules->get("InputfieldText");
$f->label = $this->_("DB Host");
$f->attr('name', 'db_host');
$host = (isset($field->db_host))?$field->db_host:'localhost';
$f->attr('value', $host);
$f->columnWidth = 20;
$fieldset->append($f);
/*
// DB Socket
$f = $this->modules->get("InputfieldText");
$f->label = $this->_("Socket");
$f->attr('name', 'db_socket');
$f->attr('value', $field->db_socket);
$f->columnWidth = 16.666;
$fieldset->append($f);
*/
// DB Port
$f = $this->modules->get("InputfieldText");
$f->label = $this->_("DB Port");
$f->attr('name', 'db_port');
$field->db_port? $f->attr('value', $field->db_port) : $f->attr('value', $this->wire('config')->dbPort);
$f->columnWidth = 20;
$fieldset->append($f);
// create options
$fieldset = $this->modules->get("InputfieldFieldset");
$fieldset->label = $this->_('Create options from any database table');
$fieldset->notes = $this->_("Save after selecting 'Source Table' to populate the appropriate select for 'Option Label' and 'Option Value'. Make a selection and save again.");
$inputfields->add($fieldset);
// source table
$f = $this->modules->get("InputfieldSelect");
$f->label = $this->_("Source Table");
$f->attr('name', 'option_table');
$f->required = true;
$f->attr('value', $field->option_table);
if (!$field->option_table) $f->addOption(null, 'no table selected!',array('selected'=>'selected'));
// we use $dir for limit to check if one single row exists
if ($this->getExtOptions($field->option_table,false,false,false,false,'LIMIT 1') === null && !count($_POST)) $f->error('Table doesn\'t contain any data!');
if ($this->database) foreach ($this->database->getTables() as $table) $f->addOption($table, $table);
$f->description = $this->_("Choose a table in your database.");
$f->columnWidth = 33;
$fieldset->append($f);
$columns = $this->getDatabaseColumns($field->option_table);
// option value column
$f = $this->modules->get("InputfieldSelect");
$f->label = $this->_("Option Value");
$f->attr('name', 'option_value');
$f->attr('value', $field->option_value);
$f->description = $this->_("Choose an integer type column.");
if ($columns) foreach ($columns as $value) {
if ($this->isIntColumn($field->option_table,$value)) $f->addOption($value, $value);