-
Notifications
You must be signed in to change notification settings - Fork 639
/
BaseRelationField.php
1620 lines (1413 loc) · 53.9 KB
/
BaseRelationField.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
/**
* @link https://craftcms.com/
* @copyright Copyright (c) Pixel & Tonic, Inc.
* @license https://craftcms.github.io/license/
*/
namespace craft\fields;
use Craft;
use craft\base\conditions\ConditionInterface;
use craft\base\EagerLoadingFieldInterface;
use craft\base\Element;
use craft\base\ElementInterface;
use craft\base\Field;
use craft\base\InlineEditableFieldInterface;
use craft\base\MergeableFieldInterface;
use craft\base\NestedElementInterface;
use craft\base\RelationalFieldInterface;
use craft\base\ThumbableFieldInterface;
use craft\behaviors\EventBehavior;
use craft\db\FixedOrderExpression;
use craft\db\Query;
use craft\db\Table as DbTable;
use craft\elements\conditions\ElementCondition;
use craft\elements\conditions\ElementConditionInterface;
use craft\elements\db\ElementQuery;
use craft\elements\db\ElementQueryInterface;
use craft\elements\db\ElementRelationParamParser;
use craft\elements\db\OrderByPlaceholderExpression;
use craft\elements\ElementCollection;
use craft\errors\SiteNotFoundException;
use craft\events\CancelableEvent;
use craft\events\ElementCriteriaEvent;
use craft\fieldlayoutelements\CustomField;
use craft\fields\conditions\RelationalFieldConditionRule;
use craft\helpers\ArrayHelper;
use craft\helpers\Cp;
use craft\helpers\Db;
use craft\helpers\ElementHelper;
use craft\helpers\Queue;
use craft\helpers\StringHelper;
use craft\queue\jobs\LocalizeRelations;
use craft\services\Elements;
use craft\services\ElementSources;
use DateTime;
use GraphQL\Type\Definition\Type;
use Illuminate\Support\Collection;
use yii\base\Event;
use yii\base\InvalidConfigException;
use yii\db\Expression;
use yii\db\Schema;
use yii\validators\NumberValidator;
/**
* BaseRelationField is the base class for classes representing a relational field.
*
* @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
* @since 3.0.0
*/
abstract class BaseRelationField extends Field implements
InlineEditableFieldInterface,
EagerLoadingFieldInterface,
RelationalFieldInterface,
ThumbableFieldInterface,
MergeableFieldInterface
{
/**
* @event ElementCriteriaEvent The event that is triggered when defining the selection criteria for this field.
* @since 3.4.16
*/
public const EVENT_DEFINE_SELECTION_CRITERIA = 'defineSelectionCriteria';
private static bool $validatingRelatedElements = false;
/**
* Returns the element class associated with this field type.
*
* @return class-string<ElementInterface> The Element class name
*/
abstract public static function elementType(): string;
/**
* Returns the default [[selectionLabel]] value.
*
* @return string The default selection label
*/
public static function defaultSelectionLabel(): string
{
return Craft::t('app', 'Choose');
}
/**
* @inheritdoc
*/
public static function phpType(): string
{
return sprintf('\\%s|\\%s<\\%s>', ElementQueryInterface::class, ElementCollection::class, ElementInterface::class);
}
/**
* @inheritdoc
*/
public static function dbType(): array|string|null
{
return Schema::TYPE_JSON;
}
/**
* @inheritdoc
*/
public static function queryCondition(array $instances, mixed $value, array &$params): array|false
{
/** @var self $field */
$field = reset($instances);
if (!is_array($value)) {
$value = [$value];
}
$conditions = [];
if (isset($value[0]) && in_array($value[0], [':notempty:', ':empty:', 'not :empty:'])) {
$emptyCondition = array_shift($value);
if (in_array($emptyCondition, [':notempty:', 'not :empty:'])) {
$conditions[] = static::existsQueryCondition($field);
} else {
$conditions[] = ['not', static::existsQueryCondition($field)];
}
}
if (!empty($value)) {
$parser = new ElementRelationParamParser([
'fields' => [
$field->handle => $field,
],
]);
$condition = $parser->parse([
'targetElement' => $value,
'field' => $field->handle,
]);
if ($condition !== false) {
$conditions[] = $condition;
}
}
if (empty($conditions)) {
return false;
}
array_unshift($conditions, 'or');
return $conditions;
}
/**
* Returns a query builder-compatible condition for an element query,
* limiting the results to only elements where the given relation field has a value.
*
* @param self $field The relation field
* @param bool $enabledOnly Whether to only
* @param bool $inTargetSiteOnly
* @return array
* @since 5.2.0
*/
public static function existsQueryCondition(self $field, bool $enabledOnly = true, bool $inTargetSiteOnly = true): array
{
$ns = sprintf('%s_%s', $field->handle, StringHelper::randomString(5));
$query = (new Query())
->from(["relations_$ns" => DbTable::RELATIONS])
->innerJoin(["elements_$ns" => DbTable::ELEMENTS], "[[elements_$ns.id]] = [[relations_$ns.targetId]]")
->leftJoin(["elements_sites_$ns" => DbTable::ELEMENTS_SITES], "[[elements_sites_$ns.elementId]] = [[elements_$ns.id]]")
->where([
'and',
"[[relations_$ns.sourceId]] = [[elements.id]]",
[
"relations_$ns.fieldId" => $field->id,
"elements_$ns.dateDeleted" => null,
],
[
'or',
["relations_$ns.sourceSiteId" => null],
["relations_$ns.sourceSiteId" => new Expression('[[elements_sites.siteId]]')],
],
]);
if ($enabledOnly) {
$query->andWhere([
"elements_$ns.enabled" => true,
"elements_sites_$ns.enabled" => true,
]);
}
if ($inTargetSiteOnly) {
$query->andWhere([
"elements_sites_$ns.siteId" => $field->_targetSiteId() ?? new Expression('[[elements_sites.siteId]]'),
]);
}
return ['exists', $query];
}
/**
* @var string|string[]|null The source keys that this field can relate elements from (used if [[allowMultipleSources]] is set to true)
*/
public string|array|null $sources = '*';
/**
* @var string|null The source key that this field can relate elements from (used if [[allowMultipleSources]] is set to false)
*/
public ?string $source = null;
/**
* @var string|null The UID of the site that this field should relate elements from
*/
public ?string $targetSiteId = null;
/**
* @var bool Whether the site menu should be shown in element selector modals.
* @since 3.5.0
*/
public bool $showSiteMenu = false;
/**
* @var bool Whether to automatically relate structural ancestors.
* @since 4.4.0
*/
public bool $maintainHierarchy = false;
/**
* @var int|null Branch limit
*
* @since 4.4.0
*/
public ?int $branchLimit = null;
/**
* @var string|null The view mode
*/
public ?string $viewMode = null;
/**
* @var bool Whether cards should be shown in a multi-column grid
* @since 5.0.0
*/
public bool $showCardsInGrid = false;
/**
* @var int|null The maximum number of relations this field can have (used if [[allowLimit]] is set to true).
* @since 4.0.0
*/
public ?int $minRelations = null;
/**
* @var int|null The maximum number of relations this field can have (used if [[allowLimit]] is set to true).
* @since 4.0.0
*/
public ?int $maxRelations = null;
/**
* @var string|null The label that should be used on the selection input
*/
public ?string $selectionLabel = null;
/**
* @var bool Whether related elements should be validated when the source element is saved.
*/
public bool $validateRelatedElements = false;
/**
* @var bool Whether each site should get its own unique set of relations
* @deprecated in 5.3.0
*/
public bool $localizeRelations = false;
/**
* @var bool Whether to allow multiple source selection in the settings
*/
public bool $allowMultipleSources = true;
/**
* @var bool Whether to show the Min Relations and Max Relations settings.
*/
public bool $allowLimit = true;
/**
* @var bool Whether elements should be allowed to relate themselves.
* @since 3.4.21
*/
public bool $allowSelfRelations = false;
/**
* @var bool Whether to allow the “Large Thumbnails” view mode
*/
protected bool $allowLargeThumbsView = false;
/**
* @var string Template to use for settings rendering
*/
protected string $settingsTemplate = '_components/fieldtypes/elementfieldsettings.twig';
/**
* @var string Template to use for field rendering
*/
protected string $inputTemplate = '_includes/forms/elementSelect.twig';
/**
* @var string|null The JS class that should be initialized for the input
*/
protected ?string $inputJsClass = null;
/**
* @var bool Whether the elements have a custom sort order
*/
protected bool $sortable = true;
/**
* @var ElementConditionInterface|array|null
* @phpstan-var ElementConditionInterface|array{class:class-string<ElementConditionInterface>}|null
* @see getSelectionCondition()
* @see setSelectionCondition()
*/
private array|null|ElementConditionInterface $_selectionCondition = null;
/**
* @inheritdoc
*/
public function __construct(array $config = [])
{
// limit => maxRelations
if (array_key_exists('limit', $config)) {
$config['maxRelations'] = ArrayHelper::remove($config, 'limit');
}
// Config normalization
if (($config['source'] ?? null) === '') {
unset($config['source']);
}
if (array_key_exists('sources', $config) && empty($config['sources'])) {
// Not possible to have no sources selected, so go with the default
unset($config['sources']);
}
// If useTargetSite is in here, but empty, then disregard targetSiteId
if (array_key_exists('useTargetSite', $config)) {
if (empty($config['useTargetSite'])) {
unset($config['targetSiteId']);
}
unset($config['useTargetSite']);
}
// Default showSiteMenu to true for existing fields
if (isset($config['id']) && !isset($config['showSiteMenu'])) {
$config['showSiteMenu'] = true;
}
// if relating ancestors, then clear min/max limits, otherwise clear branch limit
if ($config['maintainHierarchy'] ?? false) {
$config['maxRelations'] = null;
$config['minRelations'] = null;
} else {
$config['branchLimit'] = null;
}
// remove settings that shouldn't be here
unset($config['allowMultipleSources'], $config['allowLimit'], $config['allowLargeThumbsView'], $config['sortable']);
if ($this->allowMultipleSources) {
unset($config['source']);
} else {
unset($config['sources']);
}
if (isset($config['localizeRelations'])) {
$config['translationMethod'] = $config['localizeRelations'] ? self::TRANSLATION_METHOD_SITE : self::TRANSLATION_METHOD_NONE;
} else {
$config['localizeRelations'] = ($config['translationMethod'] ?? self::TRANSLATION_METHOD_NONE) !== self::TRANSLATION_METHOD_NONE;
}
parent::__construct($config);
}
/**
* @inheritdoc
* @since 3.4.9
*/
protected function defineRules(): array
{
$rules = parent::defineRules();
$rules[] = [['minRelations', 'maxRelations', 'branchLimit'], 'number', 'integerOnly' => true];
$rules[] = [['source', 'sources'], 'validateSources'];
return $rules;
}
/**
* Ensure only one structured source is selected when maintainHierarchy is true.
*
* @param string $attribute
* @since 4.4.0
*/
public function validateSources(string $attribute): void
{
if (!$this->maintainHierarchy) {
return;
}
$inputSources = $this->getInputSources();
if ($inputSources === null) {
$this->maintainHierarchy = false;
return;
}
if (is_string($inputSources)) {
$inputSources = [$inputSources];
}
$elementSources = ArrayHelper::whereIn(
Craft::$app->elementSources->getSources(static::elementType()),
'key',
$inputSources
);
if (count($elementSources) > 1) {
$this->maintainHierarchy = false;
return;
}
foreach ($elementSources as $elementSource) {
if (!isset($elementSource['structureId'])) {
$this->maintainHierarchy = false;
return;
}
}
}
/**
* @inheritdoc
*/
public function settingsAttributes(): array
{
$attributes = parent::settingsAttributes();
$attributes[] = 'allowSelfRelations';
$attributes[] = 'maxRelations';
$attributes[] = 'minRelations';
$attributes[] = 'selectionLabel';
$attributes[] = 'showSiteMenu';
$attributes[] = 'source';
$attributes[] = 'sources';
$attributes[] = 'targetSiteId';
$attributes[] = 'validateRelatedElements';
$attributes[] = 'viewMode';
$attributes[] = 'showCardsInGrid';
$attributes[] = 'allowSelfRelations';
$attributes[] = 'maintainHierarchy';
$attributes[] = 'branchLimit';
return $attributes;
}
/**
* @inheritdoc
*/
public function getSettings(): array
{
$settings = parent::getSettings();
// cleanup
unset($settings['allowMultipleSources'], $settings['allowLimit'], $settings['allowLargeThumbsView'], $settings['sortable']);
if ($this->allowMultipleSources) {
unset($settings['source']);
} else {
unset($settings['sources']);
}
if ($selectionCondition = $this->getSelectionCondition()) {
$settings['selectionCondition'] = $selectionCondition->getConfig();
}
return $settings;
}
/**
* @inheritdoc
*/
public function getSettingsHtml(): ?string
{
$variables = $this->settingsTemplateVariables();
$view = Craft::$app->getView();
$view->registerJsWithVars(fn($args) => <<<JS
new Craft.ElementFieldSettings(...$args);
JS, [
[
$this->allowMultipleSources,
$view->namespaceInputId('maintain-hierarchy-field'),
$view->namespaceInputId($this->allowMultipleSources ? 'sources-field' : 'source-field'),
$view->namespaceInputId('branch-limit-field'),
$view->namespaceInputId('min-relations-field'),
$view->namespaceInputId('max-relations-field'),
$view->namespaceInputId('viewMode-field'),
],
]);
return $view->renderTemplate($this->settingsTemplate, $variables);
}
/**
* @inheritdoc
*/
public function getElementValidationRules(): array
{
$rules = [
['validateRelationCount', 'on' => [Element::SCENARIO_LIVE], 'skipOnEmpty' => false],
];
if ($this->validateRelatedElements) {
$rules[] = ['validateRelatedElements', 'on' => [Element::SCENARIO_LIVE]];
}
return $rules;
}
/**
* Validates that the number of related elements are within the min/max relation bounds.
*
* @param ElementInterface $element
*/
public function validateRelationCount(ElementInterface $element): void
{
if ($this->allowLimit && ($this->minRelations || $this->maxRelations)) {
/** @var ElementQueryInterface|ElementCollection $value */
$value = $element->getFieldValue($this->handle);
if ($value instanceof ElementQueryInterface) {
$value = $this->_all($value, $element);
}
$arrayValidator = new NumberValidator([
'min' => $this->minRelations,
'max' => $this->maxRelations,
'tooSmall' => $this->minRelations ? Craft::t('app', '{attribute} should contain at least {min, number} {min, plural, one{selection} other{selections}}.', [
'attribute' => Craft::t('site', $this->name),
'min' => $this->minRelations, // Need to pass this in now
]) : null,
'tooBig' => $this->maxRelations ? Craft::t('app', '{attribute} should contain at most {max, number} {max, plural, one{selection} other{selections}}.', [
'attribute' => Craft::t('site', $this->name),
'max' => $this->maxRelations, // Need to pass this in now
]) : null,
'skipOnEmpty' => false,
]);
if (!$arrayValidator->validate($value->count(), $error)) {
$element->addError($this->handle, $error);
}
}
}
/**
* Validates the related elements.
*
* @param ElementInterface $element
*/
public function validateRelatedElements(ElementInterface $element): void
{
// No recursive related element validation
if (self::$validatingRelatedElements) {
return;
}
/** @var ElementQueryInterface|ElementCollection $value */
$value = $element->getFieldValue($this->handle);
if ($value instanceof ElementQueryInterface) {
$value
->site('*')
->unique()
->preferSites([$this->targetSiteId($element)]);
}
$errorCount = 0;
foreach ($value->all() as $i => $target) {
if (!self::_validateRelatedElement($element, $target)) {
/** @phpstan-ignore-next-line */
$element->addModelErrors($target, "$this->handle[$i]");
$errorCount++;
}
}
if ($errorCount) {
$elementType = static::elementType();
$element->addError($this->handle, Craft::t('app', 'Validation errors found in {attribute} {type}; please fix them.', [
'type' => $errorCount === 1 ? $elementType::lowerDisplayName() : $elementType::pluralLowerDisplayName(),
'attribute' => Craft::t('site', $this->name),
]));
}
}
/**
* Returns whether a related element validates.
*
* @param ElementInterface $source
* @param ElementInterface $target
* @return bool
*/
private static function _validateRelatedElement(ElementInterface $source, ElementInterface $target): bool
{
if (
self::$validatingRelatedElements ||
!$target->enabled ||
!$target->getEnabledForSite() ||
$target->getCanonicalId() === $source->getCanonicalId()
) {
return true;
}
// Prevent relational fields on this element from enforcing related element validation
self::$validatingRelatedElements = true;
$target->setScenario(Element::SCENARIO_LIVE);
$validates = $target->validate();
self::$validatingRelatedElements = false;
return $validates;
}
/**
* @inheritdoc
*/
public function isValueEmpty(mixed $value, ElementInterface $element): bool
{
/** @var ElementQueryInterface|ElementCollection $value */
if ($value instanceof ElementQueryInterface) {
return !$this->_all($value, $element)->exists();
}
return $value->isEmpty();
}
/**
* @inheritdoc
*/
public function normalizeValue(mixed $value, ?ElementInterface $element): mixed
{
// If we're propagating a value, and we don't show the site menu,
// only save relations to elements in the current site.
// (see https://github.com/craftcms/cms/issues/15459)
if (
$value instanceof ElementQueryInterface &&
$element?->propagating &&
$element->isNewForSite &&
!$this->targetSiteId &&
!$this->showSiteMenu
) {
$value = $this->_all($value, $element)
->siteId($this->targetSiteId($element))
->ids();
}
if ($value instanceof ElementQueryInterface || $value instanceof ElementCollection) {
return $value;
}
$class = static::elementType();
/** @var ElementQuery $query */
$query = $class::find()
->siteId($this->targetSiteId($element));
if (is_array($value)) {
$value = array_values(array_filter($value));
if (!empty($value)) {
$query
->andWhere(['elements.id' => $value])
->orderBy([new FixedOrderExpression('elements.id', $value, Craft::$app->getDb())]);
} else {
$query->andWhere('0 = 1');
}
} elseif ($value === null && $element?->id && $this->isFirstInstance($element)) {
// If $value is null, the element + field haven’t been saved since updating to Craft 5.3+,
// or since the field was added to the field layout. So only actually look at the `relations` table
// if this is the first instance of the field that was ever added to the field layout.
if (!$this->allowMultipleSources && $this->source) {
$source = ElementHelper::findSource($class, $this->source, ElementSources::CONTEXT_FIELD);
// Does the source specify any criteria attributes?
if (isset($source['criteria'])) {
Craft::configure($query, $source['criteria']);
}
}
// Make our query customizations via EVENT_BEFORE_PREPARE/EVENT_AFTER_PREPARE,
// so they get applied for cloned queries as well
$query->attachBehavior(sprintf('%s-once', self::class), new EventBehavior([
ElementQuery::EVENT_BEFORE_PREPARE => function(CancelableEvent $event, ElementQuery $query) {
if ($this->maintainHierarchy && $query->id === null) {
$structuresService = Craft::$app->getStructures();
$structureElements = (clone($query))
->select(['**' => '**'])
->status(null)
->all();
// Fill in any gaps
$structuresService->fillGapsInElements($structureElements);
// Enforce the branch limit
if ($this->branchLimit) {
$structuresService->applyBranchLimitToElements($structureElements, $this->branchLimit);
}
$query->id(array_map(fn(ElementInterface $element) => $element->id, $structureElements));
}
},
], true));
$relationsAlias = sprintf('relations_%s', StringHelper::randomString(10));
$query->attachBehavior(self::class, new EventBehavior([
ElementQuery::EVENT_AFTER_PREPARE => function(
CancelableEvent $event,
ElementQuery $query,
) use ($element, $relationsAlias) {
// Make these changes directly on the prepared queries, so `sortOrder` doesn't ever make it into
// the criteria. Otherwise, if the query ends up A) getting executed normally, then B) getting
// eager-loaded with eagerly(), the `orderBy` value referencing the join table will get applied
// to the eager-loading query and cause a SQL error.
foreach ([$query->query, $query->subQuery] as $q) {
$q->innerJoin(
[$relationsAlias => DbTable::RELATIONS],
[
'and',
"[[$relationsAlias.targetId]] = [[elements.id]]",
[
"$relationsAlias.sourceId" => $element->id,
"$relationsAlias.fieldId" => $this->id,
],
[
'or',
["$relationsAlias.sourceSiteId" => null],
["$relationsAlias.sourceSiteId" => $element->siteId],
],
]
);
if (
$this->sortable &&
!$this->maintainHierarchy &&
count($query->orderBy ?? []) === 1 &&
($query->orderBy[0] ?? null) instanceof OrderByPlaceholderExpression
) {
$q->orderBy(["$relationsAlias.sortOrder" => SORT_ASC]);
}
}
},
]));
} else {
$query->id(false);
}
// Prepare the query for lazy eager loading
$query->prepForEagerLoading($this->handle, $element);
if ($this->allowLimit && $this->maxRelations) {
$query->limit($this->maxRelations);
}
return $query;
}
private function isFirstInstance(?Elementinterface $element): bool
{
if ($this->layoutElement?->uid === null) {
return false;
}
/** @var CustomField|null $first */
$first = Collection::make($element?->getFieldLayout()?->getCustomFieldElements())
->filter(fn(CustomField $layoutElement) => $layoutElement->getField()->id === $this->id)
->sortBy(fn(CustomField $layoutElement) => $layoutElement->dateAdded)
->first();
// Compare handles here rather than UUIDs, since the UUID will change
//if we're hot-swapping field layouts (e.g. changing an entry's type).
return $this->handle === $first?->getField()->handle;
}
/**
* @inheritdoc
*/
public function serializeValue(mixed $value, ?ElementInterface $element): mixed
{
/** @var ElementQueryInterface|ElementCollection $value */
if ($value instanceof ElementCollection) {
return $value->ids()->all();
}
return $this->_all($value, $element)->ids();
}
/**
* @inheritdoc
*/
public function getElementConditionRuleType(): array|string|null
{
return RelationalFieldConditionRule::class;
}
/**
* @inheritdoc
*/
public function modifyElementIndexQuery(ElementQueryInterface $query): void
{
$criteria = [
'drafts' => null,
'status' => null,
];
if (!$this->targetSiteId) {
$criteria['siteId'] = '*';
$criteria['unique'] = true;
// Just to be safe...
if (is_numeric($query->siteId)) {
$criteria['preferSites'] = [$query->siteId];
}
}
$query->andWith([$this->handle, $criteria]);
}
/**
* @inheritdoc
*/
public function getIsTranslatable(?ElementInterface $element): bool
{
return $this->localizeRelations;
}
/**
* @inheritdoc
*/
protected function inputHtml(mixed $value, ?ElementInterface $element, bool $inline): string
{
if ($element !== null && $element->hasEagerLoadedElements($this->handle)) {
$value = $element->getEagerLoadedElements($this->handle)->all();
} else {
/** @var ElementQueryInterface $value */
$value = $this->_all($value, $element);
}
/** @var ElementQuery|array $value */
$variables = $this->inputTemplateVariables($value, $element);
$variables['inline'] = $inline || $variables['viewMode'] === 'large';
if ($inline) {
$variables['viewMode'] = 'list';
}
return Craft::$app->getView()->renderTemplate($this->inputTemplate, $variables);
}
/**
* @inheritdoc
*/
protected function searchKeywords(mixed $value, ElementInterface $element): string
{
/** @var ElementQuery|ElementCollection $value */
$titles = [];
if ($value instanceof ElementCollection) {
$value = $value->all();
} else {
$value = $this->_all($value, $element)->all();
}
foreach ($value as $relatedElement) {
$titles[] = (string)$relatedElement;
}
return parent::searchKeywords($titles, $element);
}
/**
* @inheritdoc
*/
public function getStaticHtml(mixed $value, ElementInterface $element): string
{
/** @var ElementQueryInterface|ElementCollection $value */
if ($value instanceof ElementCollection) {
$value = $value->all();
} else {
$value = $this->_all($value, $element)->all();
}
if (empty($value)) {
return '<p class="light">' . Craft::t('app', 'Nothing selected.') . '</p>';
}
$size = Cp::CHIP_SIZE_SMALL;
$viewMode = $this->viewMode();
if ($viewMode == 'large') {
$size = Cp::CHIP_SIZE_LARGE;
}
$id = $this->getInputId();
$html = "<div id='$id' class='elementselect noteditable'>" .
"<div class='elements chips" . ($size === Cp::CHIP_SIZE_LARGE ? ' inline-chips' : '') . "'>";
foreach ($value as $relatedElement) {
$html .= Cp::elementChipHtml($relatedElement, [
'size' => $size,
]);
}
$html .= '</div></div>';
return $html;
}
/**
* @inheritdoc
*/
public function getPreviewHtml(mixed $value, ElementInterface $element): string
{
/** @var ElementQueryInterface|ElementCollection $value */
if ($value instanceof ElementQueryInterface) {
$value = $this->_all($value, $element)->collect();
} else {
// todo: come up with a way to get the normalized field value ignoring the eager-loaded value
$rawValue = $element->getBehavior('customFields')->{$this->handle} ?? null;
if (is_array($rawValue)) {
$ids = array_flip($rawValue);
$value = $value->filter(fn(ElementInterface $element) => isset($ids[$element->id]));
}
}
return $this->previewHtml($value);
}
/**
* @inheritdoc
*/
public function previewPlaceholderHtml(mixed $value, ?ElementInterface $element): string
{
$mockup = new (static::elementType());
$mockup->title = Craft::t('app', 'Related {type} Title', ['type' => $mockup->displayName()]);
return Cp::chipHtml($mockup);
}
/**
* Returns the HTML that should be shown for this field in table and card views.
*
* @param ElementCollection $elements
* @return string
* @since 5.0.0
*/
protected function previewHtml(ElementCollection $elements): string
{
return Cp::elementPreviewHtml($elements->all());
}
/**
* @inheritdoc
*/
public function getThumbHtml(mixed $value, ElementInterface $element, int $size): ?string
{
/** @var ElementQueryInterface|ElementCollection $value */
if ($value instanceof ElementQueryInterface) {
$handle = sprintf('%s-%s-%s', preg_replace('/:+/', '-', __METHOD__), $this->id, $size);
$value = (clone $value)->eagerly($handle);
}
return $value->one()?->getThumbHtml($size);
}
/**
* @inheritdoc
*/
public function getEagerLoadingMap(array $sourceElements): array|null|false
{
$sourceSiteId = $sourceElements[0]->siteId;
$map = [];
$missingSourceElementIds = [];
foreach ($sourceElements as $sourceElement) {
$rawValue = $sourceElement->getBehavior('customFields')->{$this->handle} ?? null;
if ($rawValue instanceof ElementQueryInterface) {
$rawValue = $rawValue->where['elements.id'] ?? null;
}
if (is_array($rawValue)) {
foreach ($rawValue as $targetElementId) {
$map[] = ['source' => $sourceElement->id, 'target' => $targetElementId];
}
} elseif ($this->isFirstInstance($sourceElement)) {
// The relation IDs aren't hardcoded yet and this is the first
// instance of this field in the field layout, so fetch the relations
// via the DB table
$missingSourceElementIds[] = $sourceElement->id;