-
Notifications
You must be signed in to change notification settings - Fork 2
/
FormGroupTrait.php
275 lines (238 loc) · 6.08 KB
/
FormGroupTrait.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
<?php
namespace Charcoal\Ui\FormGroup;
use \InvalidArgumentException;
// Intra-module (`charcoal-ui`) dependencies
use \Charcoal\Ui\Form\FormInterface;
use \Charcoal\Ui\FormInput\FormInputBuilder;
use \Charcoal\Ui\FormInput\FormInputInterface;
/**
* Provides an implementation of {@see \Charcoal\Ui\FormGroup\FormGroupInterface}.
*/
trait FormGroupTrait
{
/**
* Store a reference to the parent form widget.
*
* @var FormInterface
*/
protected $form;
/**
* The group's collection of fields.
*
* @var FormInputInterface[]
*/
private $inputs;
/**
* The input callback; called on every input.
*
* Callable signature: `function(FormInputInterface $input)`
*
* @var callable
*/
private $inputCallback;
/**
* Store the builder instance for the current class.
*
* @var FormInputBuilder
*/
protected $formInputBuilder;
/**
* The L10N display mode.
*
* @var string
*/
private $l10nMode;
/**
* The group's identifier.
*
* @var string
*/
private $ident;
/**
* The group's priority.
*
* @var integer
*/
private $priority;
/**
* The required Acl permissions fetch from form group.
*
* @var string[] $requiredAclPermissions
*/
private $requiredAclPermissions = [];
/**
* @param FormInputBuilder $builder The builder, to create customized form input objects.
* @return FormGroupInterface Chainable
*/
protected function setFormInputBuilder(FormInputBuilder $builder)
{
$this->formInputBuilder = $builder;
return $this;
}
/**
* @param callable $cb The input callback.
* @return FormGroupInterface Chainable
*/
public function setInputCallback(callable $cb)
{
$this->inputCallback = $cb;
return $this;
}
/**
* @param FormInterface $form The parent form object.
* @return FormGroupInterface Chainable
*/
public function setForm(FormInterface $form)
{
$this->form = $form;
return $this;
}
/**
* @return FormInterface
*/
public function form()
{
return $this->form;
}
/**
* @param string $mode The l10n mode.
* @return FormGroupInterface Chainable
*/
public function setL10nMode($mode)
{
$this->l10nMode = $mode;
return $this;
}
/**
* @return string
*/
public function l10nMode()
{
return $this->l10nMode;
}
/**
* @param array $inputs The group inputs.
* @return FormGroupInterface Chainable
*/
public function setInputs(array $inputs)
{
$this->inputs = [];
foreach ($inputs as $inputIdent => $input) {
$this->addInput($inputIdent, $input);
}
return $this;
}
/**
* @param string $inputIdent The input identifier.
* @param array|FormInputInterface $input The input object or structure.
* @throws InvalidArgumentException If the ident argument is not a string or if the input is not valid.
* @return FormGroupInterface Chainable
*/
public function addInput($inputIdent, $input)
{
if (!is_string($inputIdent)) {
throw new InvalidArgumentException(
'Group ident must be a string'
);
}
if (($input instanceof FormInputInterface)) {
$input->setForm($this->form);
$input->setFormGroup($this);
$this->inputs[$inputIdent] = $input;
} elseif (is_array($input)) {
$g = $this->formInputBuilder->build($input);
$this->inputs[$inputIdent] = $g;
} else {
throw new InvalidArgumentException(
'Group must be a Form Group object or an array of form group options'
);
}
return $this;
}
/**
* Form Input generator.
*
* @param callable $inputCallback Optional. Input callback.
* @return FormGroupInterface[]|Generator
*/
public function inputs(callable $inputCallback = null)
{
$groups = $this->groups;
uasort($groups, ['self', 'sortInputsByPriority']);
$inputCallback = isset($inputCallback) ? $inputCallback : $this->inputCallback;
foreach ($inputs as $input) {
if (!$input->l10nMode()) {
$input->setL10nMode($this->l10nMode());
}
if ($inputCallback) {
$inputCallback($input);
}
$GLOBALS['widget_template'] = $input->template();
yield $input->ident() => $input;
}
}
/**
* Wether this group contains any inputs.
*
* @return boolean
*/
public function hasInputs()
{
return (count($this->inputs) > 0);
}
/**
* Get the number of inputs in this group.
*
* @return integer
*/
public function numInputs()
{
return count($this->inputs);
}
/**
* Set the identifier of the group.
*
* @param string $ident The group identifier.
* @return self
*/
public function setIdent($ident)
{
$this->ident = $ident;
return $this;
}
/**
* Retrieve the idenfitier of the group.
*
* @return string
*/
public function ident()
{
return $this->ident;
}
/**
* Set the group's priority or sorting index.
*
* @param integer $priority An index, for sorting.
* @throws InvalidArgumentException If the priority is not an integer.
* @return self
*/
public function setPriority($priority)
{
if (!is_numeric($priority)) {
throw new InvalidArgumentException(
'Priority must be an integer'
);
}
$this->priority = intval($priority);
return $this;
}
/**
* Retrieve the group's priority or sorting index.
*
* @return integer
*/
public function priority()
{
return $this->priority;
}
}