-
Notifications
You must be signed in to change notification settings - Fork 24
/
ManyToOneRelation.php
2431 lines (2077 loc) · 86.4 KB
/
ManyToOneRelation.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
namespace Sintattica\Atk\Relations;
use Exception;
use Sintattica\Atk\Attributes\Attribute;
use Sintattica\Atk\Attributes\ListAttribute;
use Sintattica\Atk\Core\Config;
use Sintattica\Atk\Core\Node;
use Sintattica\Atk\Core\Tools;
use Sintattica\Atk\DataGrid\DataGrid;
use Sintattica\Atk\Db\Db;
use Sintattica\Atk\Db\Query;
use Sintattica\Atk\RecordList\ColumnConfig;
use Sintattica\Atk\Session\SessionManager;
use Sintattica\Atk\Ui\Page;
use Sintattica\Atk\Utils\StringParser;
/**
* A N:1 relation between two classes.
*
* For example, projects all have one coordinator, but one
* coordinator can have multiple projects. So in the project
* class, there's a ManyToOneRelation to a coordinator.
*
* This relation essentially creates a dropdown box, from which
* you can select from a set of records.
*
* @author Ivo Jansch <ivo@achievo.org>
*/
class ManyToOneRelation extends Relation
{
/**
* Create edit/view links for the items in a manytoonerelation dropdown.
*/
const AF_RELATION_AUTOLINK = 33554432;
/**
* Create edit/view links for the items in a manytoonerelation dropdown.
*/
const AF_MANYTOONE_AUTOLINK = 33554432;
/**
* Do not add null option under any circumstance.
*/
const AF_RELATION_NO_NULL_ITEM = 67108864;
/**
* Do not add null option ever.
*/
const AF_MANYTOONE_NO_NULL_ITEM = 67108864;
/**
* Use auto-completition instead of drop-down / selection page.
*/
const AF_RELATION_AUTOCOMPLETE = 134217728;
/**
* Use auto-completition instead of drop-down / selection page.
*/
const AF_MANYTOONE_AUTOCOMPLETE = 134217728;
/**
* Lazy load.
*/
const AF_MANYTOONE_LAZY = 268435456;
/**
* Add a default null option to obligatory relations.
*/
const AF_MANYTOONE_OBLIGATORY_NULL_ITEM = 536870912;
const SEARCH_MODE_EXACT = 'exact';
const SEARCH_MODE_STARTSWITH = 'startswith';
const SEARCH_MODE_CONTAINS = 'contains';
/*
* By default, we do a left join. this means that records that don't have
* a record in this relation, will be displayed anyway. NOTE: set this to
* false only if you know what you're doing. When in doubt, 'true' is
* usually the best option.
* @var boolean
*/
public $m_leftjoin = true;
/*
* The array of referential key fields.
* @access private
* @var array
*/
public $m_refKey = [];
/*
* SQL statement with extra filter for the join that retrieves the
* selected record.
* @var String
*/
public $m_joinFilter = '';
/*
* Hide the relation when there are no records to select.
* @access private
* @var boolean
*/
public $m_hidewhenempty = false;
/*
* List columns.
* @access private
* @var array
*/
public $m_listColumns = [];
/*
* Always show list columns?
* @access private
* @var boolean
*/
public $m_alwaysShowListColumns = false;
/*
* Label to use for the 'none' option.
*
* @access private
* @var String
*/
public $m_noneLabel = null;
/*
* Minimum number of character a user needs to enter before auto-completion kicks in.
*
* @access private
* @var int
*/
public $m_autocomplete_minchars;
/*
* An array with the fieldnames of the destination node in which the autocompletion must search
* for results.
*
* @access private
* @var array
*/
public $m_autocomplete_searchfields = '';
/*
* The search mode of the autocomplete fields. Can be 'startswith', 'exact' or 'contains'.
*
* @access private
* @var String
*/
public $m_autocomplete_searchmode;
/*
* Value determines wether the search of the autocompletion is case-sensitive.
*
* @var boolean
*/
public $m_autocomplete_search_case_sensitive;
/*
* Value determines if select link for autocomplete should use atkSubmit or not (for use in admin screen for example)
*
* @var boolean
*/
public $m_autocomplete_saveform = true;
/*
* Set the minimal number of records for showing the automcomplete. If there are less records the normal dropdown is shown
* @var integer
*/
public $m_autocomplete_minrecords;
/**
* Set the size attribute of the autocompletion input element.
*
* @var int
*/
protected $m_autocomplete_size;
/**
* Destination node for auto links (edit, new).
*
* @var string
*/
protected $m_autolink_destination = '';
/*
* Use destination filter for autolink add link?
*
* @access private
* @var boolean
*/
public $m_useFilterForAddLink = true;
/*
* Set a function to use for determining the descriptor in the getConcatFilter function
*
* @access private
* @var string
*/
public $m_concatDescriptorFunction = '';
/**
* When autosearch is set to true, this attribute will automatically submit
* the search form onchange. This will only happen in the admin action.
*
* @var bool
*/
protected $m_autoSearch = false;
/**
* Selectable records for edit mode.
*
* @see ManyToOneRelation::preAddToEditArray
*
* @var array
*/
protected $m_selectableRecords = null;
/**
* How many items for each ajax call
* @var int
*/
protected $m_autocomplete_pagination_limit;
public $m_onchangehandler_init = "var newvalue = el.value;\n";
public $m_search_by_pk = false;
protected $m_multipleSearch;
/**
* Constructor.
*
* @param string $name The name of the attribute. This is the name of the field that is the referential key to the destination.
* For relations with more than one field in the foreign key, you should pass an array of referential key fields.
* The order of the fields must match the order of the primary key attributes in the destination node.
* @param int $flags Flags for the relation
*
* @param string $destination The node we have a relationship with.
*
*/
public function __construct($name, $flags = 0, $destination)
{
if (Config::getGlobal('manytoone_autocomplete_default', false)) {
$flags |= self::AF_RELATION_AUTOCOMPLETE;
}
if (Config::getGlobal('manytoone_autocomplete_large', true) && Tools::hasFlag($flags, self::AF_LARGE)) {
$flags |= self::AF_RELATION_AUTOCOMPLETE;
}
$this->m_autocomplete_minchars = Config::getGlobal('manytoone_autocomplete_minchars', 2);
$this->m_autocomplete_searchmode = Config::getGlobal('manytoone_autocomplete_searchmode', 'contains');
$this->m_autocomplete_search_case_sensitive = Config::getGlobal('manytoone_autocomplete_search_case_sensitive', false);
$this->m_autocomplete_size = Config::getGlobal('manytoone_autocomplete_size', 50);
$this->m_autocomplete_minrecords = Config::getGlobal('manytoone_autocomplete_minrecords', -1);
$this->m_autocomplete_pagination_limit = Config::getGlobal('manytoone_autocomplete_pagination_limit', 25);
if (is_array($name)) {
$this->m_refKey = $name;
// ATK can't handle an array as name, so we initialize the
// underlying attribute with the first name of the referential
// keys.
// Languagefiles, overrides, etc should use this first name to
// override the relation.
parent::__construct($name[0], $flags, $destination);
} else {
$this->m_refKey[] = $name;
parent::__construct($name, $flags, $destination);
}
if ($this->hasFlag(self::AF_MANYTOONE_LAZY) && (count($this->m_refKey) > 1 || $this->m_refKey[0] != $this->fieldName())) {
Tools::atkerror('self::AF_MANYTOONE_LAZY flag is not supported for multi-column reference key or a reference key that uses another column.');
}
}
public function addFlag($flag)
{
parent::addFlag($flag);
if (Config::getGlobal('manytoone_autocomplete_large', true) && Tools::hasFlag($flag, self::AF_LARGE)) {
$this->m_flags |= self::AF_RELATION_AUTOCOMPLETE;
}
return $this;
}
/**
* When autosearch is set to true, this attribute will automatically submit
* the search form onchange. This will only happen in the admin action.
*
* @param bool $auto
*/
public function setAutoSearch($auto = false)
{
$this->m_autoSearch = $auto;
}
/**
* Set join filter.
*
* @param string $filter join filter
*/
public function setJoinFilter($filter)
{
$this->m_joinFilter = $filter;
}
/**
* Set the searchfields for the autocompletion.
*
* @param array $searchfields
*/
public function setAutoCompleteSearchFields($searchfields)
{
$this->m_autocomplete_searchfields = $searchfields;
}
/**
* Set the searchmode for the autocompletion:
* exact, startswith(default) or contains.
*
* @param array $mode
*/
public function setAutoCompleteSearchMode($mode)
{
$this->m_autocomplete_searchmode = $mode;
}
/**
* Sets the minimum number of characters before auto-completion kicks in.
*
* @param int $chars
*/
public function setAutoCompleteMinChars($chars)
{
$this->m_autocomplete_minchars = $chars;
}
/**
* Set if the select link should save form (atkSubmit) or not (for use in admin screen for example).
*
* @param bool $saveform
*/
public function setAutoCompleteSaveForm($saveform = true)
{
$this->m_autocomplete_saveform = $saveform;
}
/**
* Set the minimal number of records for the autocomplete to show
* If there are less records the normal dropdown is shown.
*
* @param int $minrecords
*/
public function setAutoCompleteMinRecords($minrecords)
{
$this->m_autocomplete_minrecords = $minrecords;
}
/**
* Set the size of the rendered autocompletion input element.
*
* @param int $size
*/
public function setAutoCompleteSize($size)
{
$this->m_autocomplete_size = $size;
}
/**
* Use destination filter for auto add link?
*
* @param bool $useFilter use destnation filter for add link?
*/
public function setUseFilterForAddLink($useFilter)
{
$this->m_useFilterForAddLink = $useFilter;
}
/**
* Set the function for determining the descriptor in the getConcatFilter function
* This function should be implemented in the destination node.
*
* @param string $function
*/
public function setConcatDescriptorFunction($function)
{
$this->m_concatDescriptorFunction = $function;
}
/**
* Return the function for determining the descriptor in the getConcatFilter function.
*
* @return string
*/
public function getConcatDescriptorFunction()
{
return $this->m_concatDescriptorFunction;
}
/**
* Add list column. An attribute of the destination node
* that (only) will be displayed in the recordlist.
*
* @param string $attr The attribute to add to the listcolumn
*
* @return ManyToOneRelation The instance of this ManyToOneRelation
*/
public function addListColumn($attr)
{
$this->m_listColumns[] = $attr;
return $this;
}
/**
* Add multiple list columns. Attributes of the destination node
* that (only) will be displayed in the recordlist.
*
* @return ManyToOneRelation The instance of this ManyToOneRelation
*/
public function addListColumns()
{
$attrs = func_get_args();
foreach ($attrs as $attr) {
$this->m_listColumns[] = $attr;
}
return $this;
}
public function getListColumns()
{
return $this->m_listColumns;
}
/**
* Reset the list columns and add multiple list columns. Attributes of the
* destination node that (only) will be displayed in the recordlist.
*
* @return ManyToOneRelation The instance of this ManyToOneRelation
*/
public function setListColumns()
{
$this->m_listColumns = [];
$attrs = func_get_args();
if (count($attrs) === 1 && is_array($attrs[0])) {
$columns = $attrs[0];
} else {
$columns = $attrs;
}
foreach ($columns as $column) {
$this->m_listColumns[] = $column;
}
return $this;
}
/**
* Always show list columns in list view,
* even if the attribute itself is hidden?
*
* @param bool $value always show list columns?
*
* @return ManyToOneRelation The instance of this ManyToOneRelation
*/
public function setAlwaysShowListColumns($value)
{
$this->m_alwaysShowListColumns = $value;
if ($this->m_alwaysShowListColumns) {
$this->addFlag(self::AF_FORCE_LOAD);
}
return $this;
}
/**
* Set the maximum rows of each ajax call
* @param int $limit
*/
public function setPaginationLimit($limit)
{
$this->m_autocomplete_pagination_limit = $limit;
}
public function value2db($rec)
{
if ($this->isEmpty($rec)) {
Tools::atkdebug($this->fieldName().' IS EMPTY!');
return;
} else {
if ($this->createDestination()) {
if (is_array($rec[$this->fieldName()])) {
$pkfield = $this->m_destInstance->m_primaryKey[0];
$pkattr = $this->m_destInstance->getAttribute($pkfield);
return $pkattr->value2db($rec[$this->fieldName()]);
} else {
return $rec[$this->fieldName()];
}
}
}
// This never happens, does it?
return '';
}
public function fetchValue($postvars)
{
if ($this->isPosted($postvars)) {
$result = [];
// support specifying the value as a single number if the
// destination's primary key consists of a single field
if (is_numeric($postvars[$this->fieldName()])) {
$result[$this->getDestination()->primaryKeyField()] = $postvars[$this->fieldName()];
} else {
// Split the primary key of the selected record into its
// referential key elements.
$keyelements = Tools::decodeKeyValueSet($postvars[$this->fieldName()]);
foreach ($keyelements as $key => $value) {
// Tablename must be stripped out because it is in the way..
if (strpos($key, '.') > 0) {
$field = substr($key, strrpos($key, '.') + 1);
} else {
$field = $key;
}
$result[$field] = $value;
}
}
if (count($result) == 0) {
return;
}
// add descriptor fields, this means they can be shown in the title
// bar etc. when updating failed for example
$record = array($this->fieldName() => $result);
$this->populate($record);
$result = $record[$this->fieldName()];
return $result;
}
return;
}
public function db2value($rec)
{
$this->createDestination();
if (isset($rec[$this->fieldName()]) && is_array($rec[$this->fieldName()]) && (!isset($rec[$this->fieldName()][$this->m_destInstance->primaryKeyField()]) || empty($rec[$this->fieldName()][$this->m_destInstance->primaryKeyField()]))) {
return;
}
if (isset($rec[$this->fieldName()])) {
$myrec = $rec[$this->fieldName()];
if (is_array($myrec)) {
$result = [];
if ($this->createDestination()) {
foreach (array_keys($this->m_destInstance->m_attribList) as $attrName) {
/** @var Attribute $attr */
$attr = &$this->m_destInstance->m_attribList[$attrName];
if ($attr) {
$result[$attrName] = $attr->db2value($myrec);
} else {
Tools::atkerror("m_attribList['{$attrName}'] not defined");
}
}
}
return $result;
} else {
// if the record is not an array, probably only the value of the primary key was loaded.
// This workaround only works for single-field primary keys.
if ($this->createDestination()) {
return array($this->m_destInstance->primaryKeyField() => $myrec);
}
}
}
}
/**
* Set none label.
*
* @param string $label The label to use for the "none" option
*/
public function setNoneLabel($label)
{
$this->m_noneLabel = $label;
}
/**
* Get none label.
* @param string $mode
* @return string The label for the "none" option
*/
public function getNoneLabel($mode = '')
{
if ($this->m_noneLabel !== null) {
return $this->m_noneLabel;
}
$text_key = 'select_none';
if (in_array($mode, array('add', 'edit')) && $this->hasFlag(self::AF_OBLIGATORY)) {
if ((($mode == 'add' && !$this->hasFlag(self::AF_READONLY_ADD)) || ($mode == 'edit' && !$this->hasFlag(self::AF_READONLY_EDIT)))) {
$text_key = 'select_none_obligatory';
}
} else {
if ($mode == 'search') {
$text_key = 'search_none';
}
}
$nodename = $modulename = $ownermodulename = '';
if ($this->createDestination()) {
$nodename = $this->m_destInstance->m_type;
$modulename = $this->m_destInstance->m_module;
$ownermodulename = $this->m_ownerInstance->m_module;
}
$label = Tools::atktext($this->fieldName().'_'.$text_key, $ownermodulename, $this->m_owner, '', '', true);
if ($label == '') {
$label = Tools::atktext($text_key, $modulename, $nodename);
}
return $label;
}
public function display($record, $mode)
{
if ($this->createDestination()) {
$cnt = isset($record[$this->fieldName()]) ? count($record[$this->fieldName()]) : null;
if ($cnt === count($this->m_refKey)) {
$this->populate($record);
}
if (!$this->isEmpty($record)) {
$result = $this->m_destInstance->descriptor($record[$this->fieldName()]);
if ($this->hasFlag(self::AF_RELATION_AUTOLINK) && (!in_array($mode, array('csv', 'plain')))) { // create link to edit/view screen
if (($this->m_destInstance->allowed('view')) && !$this->m_destInstance->hasFlag(Node::NF_NO_VIEW) && $result != '') {
$saveForm = $mode == 'add' || $mode == 'edit';
$url = Tools::dispatch_url($this->m_destination, 'view',
['atkfilter' => '', 'atkselector' => $this->m_destInstance->primaryKey($record[$this->fieldName()])]);
if ($mode != 'list') {
$result .= ' '.Tools::href($url, Tools::atktext('view'), SessionManager::SESSION_NESTED, $saveForm,
'class="atkmanytoonerelation-link"');
} else {
$result = Tools::href($url, $result, SessionManager::SESSION_NESTED, $saveForm);
}
}
}
} else {
$result = !in_array($mode, array('csv', 'plain', 'list')) ? $this->getNoneLabel($mode) : ''; // no record
}
return $result;
} else {
Tools::atkdebug("Can't create destination! ($this -> m_destination");
}
return '';
}
/**
* Populate the record with the destination record data.
*
* @param array $record record
* @param mixed $fullOrFields load all data, only the given fields or only the descriptor fields?
*/
public function populate(&$record, $fullOrFields = false)
{
if (!is_array($record) || $record[$this->fieldName()] == '') {
return;
}
Tools::atkdebug('Delayed loading of '.($fullOrFields || is_array($fullOrFields) ? '' : 'descriptor ').'fields for '.$this->m_name);
$this->createDestination();
$includes = '';
if (is_array($fullOrFields)) {
$includes = array_merge($this->m_destInstance->m_primaryKey, $fullOrFields);
} else {
if (!$fullOrFields) {
$includes = $this->m_destInstance->descriptorFields();
}
}
$result = $this->m_destInstance->select($this->m_destInstance->primaryKey($record[$this->fieldName()]))->orderBy($this->m_destInstance->getColumnConfig()->getOrderByStatement())->includes($includes)->getFirstRow();
if ($result != null) {
$record[$this->fieldName()] = $result;
}
}
/**
* Creates HTML for the selection and auto links.
*
* @param string $id attribute id
* @param array $record record
*
* @return string
*/
public function createSelectAndAutoLinks($id, $record)
{
$links = [];
$filter = $this->parseFilter($this->m_destinationFilter, $record);
$links[] = $this->_getSelectLink($id, $filter);
if ($this->hasFlag(self::AF_RELATION_AUTOLINK)) { // auto edit/view link
$sm = SessionManager::getInstance();
if ($this->m_destInstance->allowed('add') && !$this->m_destInstance->hasFlag(Node::NF_NO_ADD)) {
$links[] = Tools::href(Tools::dispatch_url($this->getAutoLinkDestination(), 'add', array(
'atkpkret' => $id,
'atkfilter' => ($filter != '' ? $filter : ''),
)), Tools::atktext('new'), SessionManager::SESSION_NESTED, true);
}
if ($this->m_destInstance->allowed('view') && !$this->m_destInstance->hasFlag(Node::NF_NO_VIEW) && $record[$this->fieldName()] != null) {
//we laten nu altijd de edit link zien, maar eigenlijk mag dat niet, want
//de app crasht als er geen waarde is ingevuld.
$viewUrl = $sm->sessionUrl(Tools::dispatch_url($this->getAutoLinkDestination(), 'view', array('atkselector' => 'REPLACEME', 'atkfilter' => '')),
SessionManager::SESSION_NESTED);
$links[] = '<span id="'.$id."_view\" style=\"\"><a href='javascript:ATK.FormSubmit.atkSubmit(ATK.ManyToOneRelation.parse(\"".Tools::atkurlencode($viewUrl).'", document.entryform.'.$id.".value), true)' class=\"atkmanytoonerelation atkmanytoonerelation-link\">".Tools::atktext('view').'</a></span>';
}
}
return implode(' ', $links);
}
/**
* Set destination node for the Autolink links (new/edit).
*
* @param string $node
*/
public function setAutoLinkDestination($node)
{
$this->m_autolink_destination = $node;
}
/**
* Get destination node for the Autolink links (new/edit).
*
* @return string
*/
public function getAutoLinkDestination()
{
if (!empty($this->m_autolink_destination)) {
return $this->m_autolink_destination;
}
return $this->m_destination;
}
public function preAddToEditArray(&$record, $fieldPrefix, $mode)
{
if ($mode == 'edit' && ($this->hasFlag(self::AF_READONLY_EDIT) || $this->hasFlag(self::AF_HIDE_EDIT))) {
// in this case we don't want that the destination filters are activated
return;
}
if ((!$this->hasFlag(self::AF_RELATION_AUTOCOMPLETE) && !$this->hasFlag(self::AF_LARGE)) || $this->m_autocomplete_minrecords > -1) {
$this->m_selectableRecords = $this->_getSelectableRecords($record, $mode);
if (count($this->m_selectableRecords) > 0 && !Config::getGlobal('list_obligatory_null_item') && (($this->hasFlag(self::AF_OBLIGATORY) && !$this->hasFlag(self::AF_MANYTOONE_OBLIGATORY_NULL_ITEM)) || (!$this->hasFlag(self::AF_OBLIGATORY) && $this->hasFlag(self::AF_RELATION_NO_NULL_ITEM)))) {
if (!isset($record[$this->fieldName()]) || !is_array($record[$this->fieldName()])) {
$record[$this->fieldName()] = $this->m_selectableRecords[0];
} else {
if (!$this->_isSelectableRecord($record, $mode)) {
$record[$this->fieldName()] = $this->m_selectableRecords[0];
} else {
$current = $this->getDestination()->primaryKey($record[$this->fieldName()]);
$record[$this->fieldName()] = null;
foreach ($this->m_selectableRecords as $selectable) {
if ($this->getDestination()->primaryKey($selectable) == $current) {
$record[$this->fieldName()] = $selectable;
break;
}
}
}
}
}
} else {
if (!isset($record[$this->fieldName()]) || (is_array($record[$this->fieldName()]) && !$this->_isSelectableRecord($record, $mode))) {
$record[$this->fieldName()] = null;
} else {
if (is_array($record[$this->fieldName()])) {
$this->populate($record);
}
}
}
}
public function edit($record, $fieldprefix, $mode)
{
$type = 'edit';
if (!$this->createDestination()) {
Tools::atkerror("Could not create destination for destination: $this -> m_destination!");
return;
}
$recordset = $this->m_selectableRecords;
if ($recordset === null && $this->hasFlag(self::AF_RELATION_AUTOCOMPLETE) && $this->m_autocomplete_minrecords > -1) {
$recordset = $this->_getSelectableRecords($record, $mode);
}
$isAutocomplete = (is_array($recordset) && count($recordset) > $this->m_autocomplete_minrecords) || $this->m_autocomplete_minrecords == -1;
if ($this->hasFlag(self::AF_RELATION_AUTOCOMPLETE) && is_object($this->m_ownerInstance) && $isAutocomplete) {
$result = $this->drawAutoCompleteBox($record, $fieldprefix, $mode);
return $result;
}
$result = '';
$options = [];
$id = $this->getHtmlId($fieldprefix);
$name = $this->getHtmlName($fieldprefix);
$htmlAttributes = [];
$linkview = false;
$style = '';
if($this->getCssStyle($type, 'width') === null && $this->getCssStyle($type, 'min-width') === null) {
$this->setCssStyle($type, 'min-width', '220px');
}
foreach($this->getCssStyles($type) as $k => $v) {
$style .= "$k:$v;";
}
if($style != ''){
$htmlAttributes['style'] = $style;
}
$value = isset($record[$this->fieldName()]) ? $record[$this->fieldName()] : null;
$currentPk = ($value != null) ? $this->getDestination()->primaryKey($value) : null;
$selValues = ($currentPk != null) ? [$currentPk] : [];
if ($this->hasFlag(self::AF_LARGE)) {
//no select list, but a link for select
$result = '';
$result .= '<span class="atkmanytoonerelation-large-container">';
$destrecord = $record[$this->fieldName()];
if (is_array($destrecord)) {
$result .= '<span id="'.$id.'_current">';
if ($this->hasFlag(self::AF_RELATION_AUTOLINK) && $this->m_destInstance->allowed('view') && !$this->m_destInstance->hasFlag(Node::NF_NO_VIEW)) {
$url = Tools::dispatch_url($this->m_destination, 'view', ['atkselector' => $this->m_destInstance->primaryKey($record[$this->fieldName()])]);
$descriptor = $this->m_destInstance->descriptor($destrecord);
$result .= $descriptor.' '.Tools::href($url, Tools::atktext('view'), SessionManager::SESSION_NESTED, true,
'class="atkmanytoonerelation-link"');
} else {
$result .= $this->m_destInstance->descriptor($destrecord);
}
$result .= ' ';
if (!$this->hasFlag(self::AF_OBLIGATORY)) {
$result .= '<a href="#" onClick="jQuery(\'#'.$id.'\').val(\'\');jQuery(\'#'.$id.'_current\').hide();" class="atkmanytoonerelation atkmanytoonerelation-link">'.Tools::atktext('unselect').'</a> ';
}
$result .= '</span>';
}
$result .= $this->hide($record, $fieldprefix, $mode);
$result .= $this->_getSelectLink($name, $this->parseFilter($this->m_destinationFilter, $record));
} else {
//normal dropdown
if ($recordset == null) {
$recordset = $this->_getSelectableRecords($record, $mode);
}
// autoselect if there is only one record (if obligatory is not set,
// we don't autoselect, since user may wist to select 'none' instead
// of the 1 record.
if (count($recordset) == 0) {
$result = $this->getNoneLabel();
} else {
// relation may be empty, so we must provide an empty selectable..
$hasNullOption = false;
$emptyValue = '';
$linkview = true;
if (!$this->hasFlag(self::AF_MANYTOONE_NO_NULL_ITEM)) {
if (!$this->hasFlag(self::AF_OBLIGATORY) || (
$this->hasFlag(self::AF_MANYTOONE_OBLIGATORY_NULL_ITEM) ||
(Config::getGlobal("list_obligatory_null_item") && !$this->hasFlag(ListAttribute::AF_LIST_NO_OBLIGATORY_NULL_ITEM))
)
) {
$hasNullOption = true;
$noneLabel = $this->getNoneLabel($mode);
$options[$emptyValue] = $noneLabel;
}
}
foreach ($recordset as $selectable) {
$pk = $this->getDestination()->primaryKey($selectable);
$options[$pk] = $this->m_destInstance->descriptor($selectable);
}
$selectOptions = [];
$selectOptions['enable-select2'] = true;
$selectOptions['minimum-results-for-search'] = 10;
$selectOptions['dropdown-auto-width'] = true;
if ($hasNullOption) {
$selectOptions['with-empty-value'] = $emptyValue;
}
$selectOptions = array_merge($selectOptions, $this->m_select2Options['edit']);
if (count($this->m_onchangecode)) {
$this->_renderChangeHandler($fieldprefix);
$htmlAttributes['onchange'] = $this->getHtmlId($fieldprefix).'_onChange(this)';
}
$result .= $this->drawSelect($id, $name, $options, $selValues, $selectOptions, $htmlAttributes);
}
}
$autolink = $this->getRelationAutolink($id, $name, $this->parseFilter($this->m_destinationFilter, $record));
$result .= $linkview && isset($autolink['view']) ? $autolink['view'] : '';
$result .= isset($autolink['add']) ? $autolink['add'] : '';
if ($this->hasFlag(self::AF_LARGE)) {
$result .= '</span>'; // atkmanytoonerelation-large-container
}
return $result;
}
/**
* Get the select link to select the value using a select action on the destination node.
*
* @param string $selname
* @param string $filter
*
* @return string HTML-code with the select link
*/
public function _getSelectLink($selname, $filter)
{
$result = '';
// we use the current level to automatically return to this page
// when we come from the select..
$sm = SessionManager::getInstance();
$atktarget = Tools::atkurlencode(Config::getGlobal('dispatcher').'?atklevel='.$sm->atkLevel().'&'.$selname.'=[atkprimkey]');
$linkname = Tools::atktext('link_select_'.Tools::getNodeType($this->m_destination), $this->getOwnerInstance()->getModule(),
$this->getOwnerInstance()->getType(), '', '', true);
if (!$linkname) {
$linkname = Tools::atktext('link_select_'.Tools::getNodeType($this->m_destination), Tools::getNodeModule($this->m_destination),
Tools::getNodeType($this->m_destination), '', '', true);
}
if (!$linkname) {
$linkname = Tools::atktext('select_a');
}
$result .= Tools::href(Tools::dispatch_url($this->m_destination, 'select', ['atkfilter' => $filter ?: 'true', 'atktarget' => $atktarget]),
$linkname, SessionManager::SESSION_NESTED, $this->m_autocomplete_saveform, 'class="atkmanytoonerelation atkmanytoonerelation-link"');
return $result;
}
/**
* Creates and returns the auto edit/view links.
*
* @param string $id The field html id
* @param string $name The field html name
* @param string $filter Filter that we want to apply on the destination node
*
* @return array The HTML code for the autolink links
*/
public function getRelationAutolink($id, $name, $filter)
{
$autolink = [];
if ($this->hasFlag(self::AF_RELATION_AUTOLINK)) { // auto edit/view link
$page = Page::getInstance();
$page->register_script(Config::getGlobal('assets_url').'javascript/manytoonerelation.js');
$sm = SessionManager::getInstance();
if (!$this->m_destInstance->hasFlag(Node::NF_NO_VIEW) && $this->m_destInstance->allowed('view')) {
$viewUrl = $sm->sessionUrl(Tools::dispatch_url($this->getAutoLinkDestination(), 'view', array('atkselector' => 'REPLACEME', 'atkfilter' => '')),
SessionManager::SESSION_NESTED);
$autolink['view'] = " <a href='javascript:ATK.FormSubmit.atkSubmit(ATK.ManyToOneRelation.parse(\"".Tools::atkurlencode($viewUrl).'", document.entryform.'.$id.".value),true)' class='atkmanytoonerelation atkmanytoonerelation-link'>".Tools::atktext('view').'</a>';
}
if (!$this->m_destInstance->hasFlag(Node::NF_NO_ADD) && $this->m_destInstance->allowed('add')) {
$autolink['add'] = ' '.Tools::href(Tools::dispatch_url($this->getAutoLinkDestination(), 'add', array(
'atkpkret' => $name,