-
Notifications
You must be signed in to change notification settings - Fork 611
/
FieldLayout.php
909 lines (819 loc) · 28.5 KB
/
FieldLayout.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
<?php
/**
* @link https://craftcms.com/
* @copyright Copyright (c) Pixel & Tonic, Inc.
* @license https://craftcms.github.io/license/
*/
namespace craft\models;
use Craft;
use craft\base\ElementInterface;
use craft\base\FieldInterface;
use craft\base\FieldLayoutElement;
use craft\base\FieldLayoutProviderInterface;
use craft\base\Model;
use craft\events\CreateFieldLayoutFormEvent;
use craft\events\DefineFieldLayoutCustomFieldsEvent;
use craft\events\DefineFieldLayoutElementsEvent;
use craft\events\DefineFieldLayoutFieldsEvent;
use craft\fieldlayoutelements\BaseField;
use craft\fieldlayoutelements\CustomField;
use craft\fieldlayoutelements\Heading;
use craft\fieldlayoutelements\HorizontalRule;
use craft\fieldlayoutelements\LineBreak;
use craft\fieldlayoutelements\Template;
use craft\fieldlayoutelements\Tip;
use craft\helpers\ArrayHelper;
use craft\helpers\Html;
use craft\helpers\StringHelper;
use Generator;
use yii\base\InvalidArgumentException;
use yii\base\InvalidConfigException;
/**
* FieldLayout model class.
*
* @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
* @since 3.0.0
*/
class FieldLayout extends Model
{
/**
* @event DefineFieldLayoutFieldsEvent The event that is triggered when defining the native (not custom) fields for the layout.
*
* ```php
* use craft\models\FieldLayout;
* use craft\events\DefineFieldLayoutFieldsEvent;
* use yii\base\Event;
*
* Event::on(
* FieldLayout::class,
* FieldLayout::EVENT_DEFINE_NATIVE_FIELDS,
* function(DefineFieldLayoutFieldsEvent $event) {
* // @var FieldLayout $layout
* $layout = $event->sender;
*
* if ($layout->type === MyElementType::class) {
* $event->fields[] = MyNativeField::class;
* }
* }
* );
* ```
*
* @see getAvailableNativeFields()
* @since 4.0.0
*/
public const EVENT_DEFINE_NATIVE_FIELDS = 'defineNativeFields';
/**
* @event DefineFieldLayoutCustomFieldsEvent The event that is triggered when defining the custom fields for the layout.
*
* Note that fields set on [[DefineFieldLayoutCustomFieldsEvent::$fields]] will be grouped by field group, indexed by the group names.
*
* ```php
* use craft\models\FieldLayout;
* use craft\events\DefineFieldLayoutFieldsEvent;
* use craft\fields\PlainText;
* use yii\base\Event;
*
* Event::on(
* FieldLayout::class,
* FieldLayout::EVENT_DEFINE_CUSTOM_FIELDS,
* function(DefineFieldLayoutFieldsEvent $event) {
* // @var FieldLayout $layout
* $layout = $event->sender;
*
* if ($layout->type === MyElementType::class) {
* // Only allow Plain Text fields
* foreach ($event->fields as $groupName => &$fields) {
* $fields = array_filter($fields, fn($field) => $field instanceof PlainText);
* }
* }
* }
* );
* ```
*
* @see getAvailableCustomFields()
* @since 4.2.0
*/
public const EVENT_DEFINE_CUSTOM_FIELDS = 'defineCustomFields';
/**
* @event DefineFieldLayoutElementsEvent The event that is triggered when defining UI elements for the layout.
*
* ```php
* use craft\models\FieldLayout;
* use craft\events\DefineFieldLayoutElementsEvent;
* use yii\base\Event;
*
* Event::on(
* FieldLayout::class,
* FieldLayout::EVENT_DEFINE_UI_ELEMENTS,
* function(DefineFieldLayoutElementsEvent $event) {
* $event->elements[] = MyUiElement::class;
* }
* );
* ```
*
* @see getAvailableUiElements()
* @since 3.5.0
*/
public const EVENT_DEFINE_UI_ELEMENTS = 'defineUiElements';
/**
* @event CreateFieldLayoutFormEvent The event that is triggered when creating a new field layout form.
*
* ```php
* use craft\elements\Entry;
* use craft\events\CreateFieldLayoutFormEvent;
* use craft\fieldlayoutelements\HorizontalRule;
* use craft\fieldlayoutelements\StandardTextField;
* use craft\fieldlayoutelements\Template;
* use craft\models\FieldLayout;
* use craft\models\FieldLayoutTab;
* use yii\base\Event;
*
* Event::on(
* FieldLayout::class,
* FieldLayout::EVENT_CREATE_FORM,
* function(CreateFieldLayoutFormEvent $event) {
* if ($event->element instanceof Entry) {
* $event->tabs[] = new FieldLayoutTab([
* 'name' => 'My Tab',
* 'elements' => [
* new StandardTextField([
* 'attribute' => 'myTextField',
* 'label' => 'My Text Field',
* ]),
* new HorizontalRule(),
* new Template([
* 'template' => '_layout-elements/info'
* ]),
* ],
* ]);
* }
* }
* );
* ```
*
* @see createForm()
* @since 3.6.0
*/
public const EVENT_CREATE_FORM = 'createForm';
/**
* Creates a new field layout from the given config.
*
* @param array $config
* @return self
* @since 3.1.0
*/
public static function createFromConfig(array $config): self
{
$tabConfigs = ArrayHelper::remove($config, 'tabs');
$layout = new self($config);
if (is_array($tabConfigs)) {
$layout->setTabs(array_values(array_map(
fn(array $tabConfig) => FieldLayoutTab::createFromConfig(['layout' => $layout] + $tabConfig),
$tabConfigs,
)));
} else {
$layout->setTabs([]);
}
return $layout;
}
/**
* @var int|null ID
*/
public ?int $id = null;
/**
* @var string|null The element type
* @phpstan-var class-string<ElementInterface>|null
*/
public ?string $type = null;
/**
* @var string UID
*/
public string $uid;
/**
* @var FieldLayoutProviderInterface|null The field layout’s provider.
* @since 4.5.0
*/
public ?FieldLayoutProviderInterface $provider = null;
/**
* @var string[]|null Reserved custom field handles
* @since 3.7.0
*/
public ?array $reservedFieldHandles = null;
/**
* @var BaseField[][]
* @see getAvailableCustomFields()
*/
private array $_availableCustomFields;
/**
* @var BaseField[]
* @see getAvailableNativeFields()
*/
private array $_availableNativeFields;
/**
* @var FieldLayoutTab[]
*/
private array $_tabs;
/**
* @inheritdoc
*/
public function init(): void
{
parent::init();
if (!isset($this->uid)) {
$this->uid = StringHelper::UUID();
}
if (!isset($this->_tabs)) {
// go through setTabs() so any mandatory fields get added
$this->setTabs([]);
}
}
/**
* @inheritdoc
*/
protected function defineRules(): array
{
$rules = parent::defineRules();
$rules[] = [['id'], 'number', 'integerOnly' => true];
$rules[] = [['customFields'], 'validateFields'];
return $rules;
}
/**
* Validates the field selections.
*
* @since 3.7.0
*/
public function validateFields(): void
{
if (!$this->reservedFieldHandles) {
return;
}
// Make sure no field handles are duplicated or using one of our reserved attribute names
$handles = [];
foreach ($this->getCustomFields() as $field) {
if (in_array($field->handle, $this->reservedFieldHandles, true)) {
$this->addError('fields', Craft::t('app', '“{handle}” is a reserved word.', [
'handle' => $field->handle,
]));
return;
}
if (isset($handles[$field->handle])) {
$this->addError('fields', Craft::t('yii', '{attribute} "{value}" has already been taken.', [
'attribute' => Craft::t('app', 'Handle'),
'value' => $field->handle,
]));
return;
}
$handles[$field->handle] = true;
}
}
/**
* Returns the layout’s tabs.
*
* @return FieldLayoutTab[] The layout’s tabs.
*/
public function getTabs(): array
{
if (!isset($this->_tabs)) {
// go through setTabs() so any mandatory fields get added
$this->setTabs([]);
}
return $this->_tabs;
}
/**
* Sets the layout’s tabs.
*
* @param array $tabs An array of the layout’s tabs, which can either be FieldLayoutTab objects or arrays defining the tab’s attributes.
* @phpstan-param array<array|FieldLayoutTab> $tabs
*/
public function setTabs(array $tabs): void
{
$this->_tabs = [];
$index = 0;
foreach ($tabs as $tab) {
if (is_array($tab)) {
// Set the layout before anything else
$tab = ['layout' => $this] + $tab;
$tab = new FieldLayoutTab($tab);
} else {
$tab->setLayout($this);
}
$tab->sortOrder = ++$index;
$this->_tabs[] = $tab;
}
// Make sure that we aren't missing any mandatory fields
$includedFields = [];
$missingFields = [];
foreach ($this->getElementsByType(BaseField::class) as $field) {
/** @var BaseField $field */
$includedFields[$field->attribute()] = true;
}
foreach ($this->getAvailableNativeFields() as $field) {
if ($field->mandatory()) {
$attribute = $field->attribute();
if (!isset($includedFields[$attribute])) {
$missingFields[] = $field;
$includedFields[$attribute] = true;
}
}
}
if (!empty($missingFields)) {
// Make sure there's at least one tab
$tab = reset($this->_tabs);
if (!$tab) {
$this->_tabs[] = $tab = new FieldLayoutTab([
'layout' => $this,
'layoutId' => $this->id,
'name' => Craft::t('app', 'Content'),
'sortOrder' => 1,
'elements' => [],
]);
}
$layoutElements = $tab->getElements();
array_unshift($layoutElements, ...array_values($missingFields));
$tab->setElements($layoutElements);
}
}
/**
* Returns the available fields, grouped by field group name.
*
* @return BaseField[][]
* @since 3.5.0
*/
public function getAvailableCustomFields(): array
{
if (!isset($this->_availableCustomFields)) {
$customFields = [];
foreach (Craft::$app->getFields()->getAllFields() as $field) {
$customFields[] = Craft::createObject([
'class' => CustomField::class,
'layout' => $this,
], [$field]);
}
// Allow changes
$event = new DefineFieldLayoutCustomFieldsEvent([
'fields' => [
Craft::t('app', 'Custom Fields') => $customFields,
],
]);
$this->trigger(self::EVENT_DEFINE_CUSTOM_FIELDS, $event);
$this->_availableCustomFields = $event->fields;
}
return $this->_availableCustomFields;
}
/**
* Returns the available native fields.
*
* @return BaseField[]
* @since 3.5.0
*/
public function getAvailableNativeFields(): array
{
if (!isset($this->_availableNativeFields)) {
$this->_availableNativeFields = [];
$event = new DefineFieldLayoutFieldsEvent();
$this->trigger(self::EVENT_DEFINE_NATIVE_FIELDS, $event);
// Instantiate them
foreach ($event->fields as $field) {
if (is_string($field) || is_array($field)) {
$field = Craft::createObject($field);
}
if (!$field instanceof BaseField) {
throw new InvalidConfigException('Invalid standard field config');
}
$field->setLayout($this);
$this->_availableNativeFields[] = $field;
}
}
return $this->_availableNativeFields;
}
/**
* Returns the layout elements that are available to the field layout, grouped by the type name and (optionally) group name.
*
* @return FieldLayoutElement[]
* @since 3.5.0
*/
public function getAvailableUiElements(): array
{
$event = new DefineFieldLayoutElementsEvent([
'elements' => [
new Heading(),
new Tip([
'style' => Tip::STYLE_TIP,
]),
new Tip([
'style' => Tip::STYLE_WARNING,
]),
new Template(),
],
]);
$this->trigger(self::EVENT_DEFINE_UI_ELEMENTS, $event);
// HR and Line Break should always be last
$event->elements[] = new HorizontalRule();
$event->elements[] = new LineBreak();
// Instantiate them
foreach ($event->elements as &$element) {
if (is_string($element) || is_array($element)) {
$element = Craft::createObject($element);
}
if (!$element instanceof FieldLayoutElement) {
throw new InvalidConfigException('Invalid UI element config');
}
}
return $event->elements;
}
/**
* Returns whether a field is included in the layout by a callback or its attribute
*
* @param callable|string $filter
* @return bool
* @since 3.5.0
*/
public function isFieldIncluded(callable|string $filter): bool
{
try {
$this->getField($filter);
return true;
} catch (InvalidArgumentException) {
return false;
}
}
/**
* Returns a field that’s included in the layout by a callback or its attribute name.
*
* @param callable|string $filter
* @return BaseField
* @throws InvalidArgumentException if the field isn’t included
* @since 3.5.0
*/
public function getField(callable|string $filter): BaseField
{
if (is_string($filter)) {
$attribute = $filter;
$filter = fn(BaseField $field) => $field->attribute() === $attribute;
}
/** @var BaseField|null $field */
$field = $this->_element(fn(FieldLayoutElement $layoutElement) => (
$layoutElement instanceof BaseField &&
$filter($layoutElement)
));
if (!$field) {
throw new InvalidArgumentException(isset($attribute) ? "Invalid field: $attribute" : 'Invalid field');
}
return $field;
}
/**
* Returns the field layout’s config.
*
* @return array|null
* @since 3.1.0
*/
public function getConfig(): ?array
{
$tabConfigs = array_values(array_map(
fn(FieldLayoutTab $tab) => $tab->getConfig(),
$this->getTabs(),
));
if (empty($tabConfigs)) {
return null;
}
return [
'tabs' => $tabConfigs,
];
}
/**
* Returns a layout element by its UID.
*
* @param string $uid
* @return FieldLayoutElement|null
* @since 5.0.0
*/
public function getElementByUid(string $uid): ?FieldLayoutElement
{
$filter = fn(FieldLayoutElement $layoutElement) => $layoutElement->uid === $uid;
return $this->_element($filter);
}
/**
* Returns the layout elements of a given type.
*
* @template T
* @param string $class
* @phpstan-param class-string<T> $class
* @return T[]
* @since 4.0.0
*/
public function getElementsByType(string $class): array
{
$filter = fn(FieldLayoutElement $layoutElement) => $layoutElement instanceof $class;
return iterator_to_array($this->_elements($filter));
}
/**
* Returns the visible layout elements of a given type, taking conditions into account.
*
* @template T
* @param string $class
* @phpstan-param class-string<T> $class
* @param ElementInterface $element
* @return T[]
* @since 4.0.0
*/
public function getVisibleElementsByType(string $class, ElementInterface $element): array
{
$filter = fn(FieldLayoutElement $layoutElement) => $layoutElement instanceof $class;
return iterator_to_array($this->_elements($filter, $element));
}
/**
* Returns the first layout element of a given type.
*
* @template T of FieldLayoutElement
* @param string $class
* @phpstan-param class-string<T> $class
* @return T|null The layout element, or `null` if none were found
* @since 4.0.0
*/
public function getFirstElementByType(string $class): ?FieldLayoutElement
{
$filter = fn(FieldLayoutElement $layoutElement) => $layoutElement instanceof $class;
return $this->_element($filter);
}
/**
* Returns the first visible layout element of a given type, taking conditions into account.
*
* @template T of FieldLayoutElement
* @param string $class
* @phpstan-param class-string<T> $class
* @param ElementInterface $element
* @return T|null The layout element, or `null` if none were found
* @since 4.0.0
*/
public function getFirstVisibleElementByType(string $class, ElementInterface $element): ?FieldLayoutElement
{
$filter = fn(FieldLayoutElement $layoutElement) => $layoutElement instanceof $class;
return $this->_element($filter, $element);
}
/**
* Returns the layout elements representing custom fields.
*
* @return CustomField[]
* @since 3.7.27
*/
public function getCustomFieldElements(): array
{
return $this->getElementsByType(CustomField::class);
}
/**
* Returns the visible layout elements representing custom fields, taking conditions into account.
*
* @param ElementInterface $element
* @return CustomField[]
* @since 4.1.4
*/
public function getVisibleCustomFieldElements(ElementInterface $element): array
{
$filter = fn(FieldLayoutElement $layoutElement) => $layoutElement instanceof CustomField;
return iterator_to_array($this->_elements($filter, $element));
}
/**
* Returns the custom fields included in the layout.
*
* @return FieldInterface[]
* @since 4.0.0
*/
public function getCustomFields(): array
{
return $this->_customFields();
}
/**
* Returns the visible custom fields included in the layout, taking conditions into account.
*
* @param ElementInterface $element
* @return FieldInterface[]
* @since 4.0.0
*/
public function getVisibleCustomFields(ElementInterface $element): array
{
return $this->_customFields($element);
}
/**
* Returns the field layout’s designated thumbnail field.
*
* @return BaseField|null
* @since 5.0.0
*/
public function getThumbField(): ?BaseField
{
/** @var BaseField|null */
return $this->_element(fn(FieldLayoutElement $layoutElement) => (
$layoutElement instanceof BaseField &&
$layoutElement->thumbable() &&
$layoutElement->providesThumbs
));
}
/**
* Returns the custom fields that should be used in element card bodies.
*
* @param ElementInterface|null $element
* @return BaseField[]
* @since 5.0.0
*/
public function getCardBodyFields(?ElementInterface $element): array
{
/** @var BaseField[] */
return iterator_to_array($this->_elements(fn(FieldLayoutElement $layoutElement) => (
$layoutElement instanceof BaseField &&
$layoutElement->previewable() &&
$layoutElement->includeInCards
), $element));
}
/**
* @param ElementInterface|null $element
* @return FieldInterface[]
*/
private function _customFields(?ElementInterface $element = null): array
{
return array_map(
fn(CustomField $layoutElement) => $layoutElement->getField(),
iterator_to_array($this->_elements(
fn(FieldLayoutElement $layoutElement) => $layoutElement instanceof CustomField,
$element,
)),
);
}
/**
* Returns a custom field by its ID.
*
* @param int $id The field ID.
* @return FieldInterface|null
* @since 5.0.0
*/
public function getFieldById(int $id): ?FieldInterface
{
foreach ($this->getCustomFields() as $field) {
if ($field->id === $id) {
return $field;
}
}
return null;
}
/**
* Returns a custom field by its UUID.
*
* @param string $uid The field UUID.
* @return FieldInterface|null
* @since 5.0.0
*/
public function getFieldByUid(string $uid): ?FieldInterface
{
foreach ($this->getCustomFields() as $field) {
if ($field->uid === $uid) {
return $field;
}
}
return null;
}
/**
* Returns a custom field by its handle.
*
* @param string $handle The field handle.
* @return FieldInterface|null
*/
public function getFieldByHandle(string $handle): ?FieldInterface
{
foreach ($this->getCustomFields() as $field) {
if ($field->handle === $handle) {
return $field;
}
}
return null;
}
/**
* Creates a new [[FieldLayoutForm]] object for the given element.
*
* The `$config` array can contain the following keys:
*
* - `tabIdPrefix` – prefix that should be applied to the tab content containers’ `id` attributes
* - `namespace` – Namespace that should be applied to the tab contents
* - `registerDeltas` – Whether delta name registration should be enabled/disabled for the form (by default its state will be left alone)
* - `visibleElements` – Lists of already-visible layout elements from [[FieldLayoutForm::getVisibleElements()]]
*
* @param ElementInterface|null $element The element the form is being rendered for
* @param bool $static Whether the form should be static (non-interactive)
* @param array $config The [[FieldLayoutForm]] config
* @return FieldLayoutForm
* @since 3.5.0
*/
public function createForm(?ElementInterface $element = null, bool $static = false, array $config = []): FieldLayoutForm
{
$view = Craft::$app->getView();
// Calling this with an existing namespace isn’t fully supported,
// since the tab anchors’ `href` attributes won’t end up getting set properly
$namespace = ArrayHelper::remove($config, 'namespace');
// Register delta names?
$registerDeltas = ArrayHelper::remove($config, 'registerDeltas');
$changeDeltaRegistration = $registerDeltas !== null;
if ($changeDeltaRegistration) {
$view = Craft::$app->getView();
$isDeltaRegistrationActive = $view->getIsDeltaRegistrationActive();
$view->setIsDeltaRegistrationActive($registerDeltas);
}
// Any already-included layout elements?
$visibleElements = ArrayHelper::remove($config, 'visibleElements');
$form = new FieldLayoutForm($config);
$tabs = $this->getTabs();
// Fine a 'createForm' event
if ($this->hasEventHandlers(self::EVENT_CREATE_FORM)) {
$event = new CreateFieldLayoutFormEvent([
'form' => $form,
'element' => $element,
'static' => $static,
'tabs' => $tabs,
]);
$this->trigger(self::EVENT_CREATE_FORM, $event);
$tabs = $event->tabs;
}
foreach ($tabs as $tab) {
$layoutElements = [];
$showTab = !isset($tab->uid) || $tab->showInForm($element);
$hasVisibleFields = false;
foreach ($tab->getElements() as $layoutElement) {
// Only tabs + elements that were saved with UUIDs can be conditional
$isConditional = isset($tab->uid, $layoutElement->uid);
if ($showTab && (!$isConditional || $layoutElement->showInForm($element))) {
// If it was already included and we just need the missing elements, only keep track that it’s still included
if (
$visibleElements !== null &&
(!$isConditional || (isset($visibleElements[$tab->uid]) && in_array($layoutElement->uid, $visibleElements[$tab->uid])))
) {
$layoutElements[] = [$layoutElement, $isConditional, true];
$hasVisibleFields = true;
} else {
$html = $view->namespaceInputs(function() use ($layoutElement, $element, $static) {
return $layoutElement->formHtml($element, $static) ?? '';
}, $namespace);
if ($html) {
$errorKey = null;
// if error key prefix was set on the FieldLayoutForm - use it
if ($form->errorKeyPrefix) {
$tagAttributes = Html::parseTagAttributes($html);
// if we already have an error-key for this field, prefix it
if (isset($tagAttributes['data']['error-key'])) {
$errorKey = $form->errorKeyPrefix . '.' . $tagAttributes['data']['error-key'];
} elseif ($layoutElement instanceof BaseField) {
// otherwise let's construct it
$errorKey = $form->errorKeyPrefix . '.' . ($layoutElement->name ?? $layoutElement->attribute());
}
}
$html = Html::modifyTagAttributes($html, [
'data' => [
'layout-element' => $isConditional ? $layoutElement->uid : true,
] + ($errorKey ? ['error-key' => $errorKey] : []),
]);
$layoutElements[] = [$layoutElement, $isConditional, $html];
$hasVisibleFields = true;
} else {
$layoutElements[] = [$layoutElement, $isConditional, false];
}
}
} else {
$layoutElements[] = [$layoutElement, $isConditional, false];
}
}
if ($hasVisibleFields) {
$form->tabs[] = new FieldLayoutFormTab([
'layoutTab' => $tab,
'hasErrors' => $element && $tab->elementHasErrors($element),
'elements' => $layoutElements,
]);
}
}
if ($changeDeltaRegistration) {
$view->setIsDeltaRegistrationActive($isDeltaRegistrationActive);
}
return $form;
}
/**
* @param callable $filter
* @param ElementInterface|null $element
* @return FieldLayoutElement|null
*/
private function _element(callable $filter, ?ElementInterface $element = null): ?FieldLayoutElement
{
return $this->_elements($filter, $element)->current();
}
/**
* @param callable $filter
* @param ElementInterface|null $element
* @return Generator
*/
private function _elements(callable $filter, ?ElementInterface $element = null): Generator
{
foreach ($this->getTabs() as $tab) {
if (!$element || !isset($tab->uid) || $tab->showInForm($element)) {
foreach ($tab->getElements() as $layoutElement) {
if ($filter($layoutElement) && (!$element || !isset($layoutElement->uid) || $layoutElement->showInForm($element))) {
yield $layoutElement;
}
}
}
}
}
}