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
|
<?php
/**
* UF Form Generator
*
* @link https://github.com/lcharette/UF_FormGenerator
* @copyright Copyright (c) 2017 Louis Charette
* @license https://github.com/lcharette/UF_FormGenerator/blob/master/LICENSE (MIT License)
*/
namespace UserFrosting\Sprinkle\FormGenerator;
use Illuminate\Contracts\Config\Repository;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Collection;
use Illuminate\Support\Str;
use UserFrosting\Fortress\RequestSchema\RequestSchemaInterface;
/**
* Form Class
*
* The FormGenerator class, which is used to return the `form` part from a Fortress
* schema for html form generator in Twig.
*/
class Form {
/**
* @var RequestSchemaInterface The form fields definition
*/
protected $schema;
/**
* @var array|object The form values
*/
protected $data = [];
/**
* @var string Use this to wrap form fields in top-level array
*/
protected $formNamespace = "";
/**
* Constructor
*
* @param RequestSchemaInterface $schema
* @param array|object $data (default: [])
* @return void
*/
public function __construct(RequestSchemaInterface $schema, $data = [])
{
$this->setSchema($schema);
$this->setData($data);
}
/**
* Set the form current values
*
* @param array|object $data The form values
*/
public function setData($data)
{
if ($data instanceof Collection || $data instanceof Model) {
$this->data = $data->toArray();
} else if (is_array($data) || $data instanceof Repository) {
$this->data = $data;
} else {
throw new \InvalidArgumentException("Data must be an array, a Collection, a Model or a Repository");
}
}
/**
* Set the schema for this validator.
*
* @param RequestSchemaInterface $schema A RequestSchemaInterface object, containing the form definition.
*/
public function setSchema(RequestSchemaInterface $schema)
{
$this->schema = $schema;
}
/**
* Use to define the value of a form input when `setData` is already set
*
* @param mixed $inputName
* @param mixed $value
* @return void
*/
public function setValue($inputName, $value)
{
$this->data[$inputName] = $value;
}
/**
* Function used to overwrite the input argument from a schema file
* Can also be used to overwrite an argument hardcoded in the Twig file.
* Use `setCustomFormData` to set any other tag.
*
* @param string $inputName The input name where the argument will be added
* @param string $property The argument name. Example "data-color"
* @param string $data The value of the argument
* @return void
*/
public function setInputArgument($inputName, $property, $data)
{
if ($this->schema->has($inputName)) {
// Get the element and force set the property
$element = $this->schema->get($inputName);
$element['form'][$property] = $data;
// Push back the modifyed element in the schema
$this->schema->set($inputName, $element);
}
}
/**
* Function used to set options of a select element. Shortcut for using
* `setInputArgument` and `setValue`.
*
* @param string $inputName The select name to add options to
* @param array $data An array of `value => label` options
* @param string $selected The selected key
* @return void
*/
public function setOptions($inputName, $data = [], $selected = null)
{
// Set opdations
$this->setInputArgument($inputName, 'options', $data);
// Set the value
if (!is_null($selected)) {
$this->setValue($inputName, $selected);
}
}
/**
* Function to set the form namespace.
* Use the form namespace to wrap the fields name in a top level array.
* Useful when using multiple schemas at once or if the names are using dot syntaxt.
* See : http://stackoverflow.com/a/20365198/445757
*
* @param string $namespace
* @return void
*/
public function setFormNamespace($namespace)
{
$this->formNamespace = $namespace;
}
/**
* Generate an array contining all nececerry value to generate a form
* with Twig.
*
* @return array The form fields data
*/
public function generate()
{
$form = collect([]);
// Loop all the the fields in the schema
foreach ($this->schema->all() as $name => $input) {
// Skip the one that don't have a `form` definition
if (isset($input['form'])) {
// Get the value from the data
$value = isset($this->data[$name]) ? $this->data[$name] : null;
// Add the namespace to the name if it's defined
$name = ($this->formNamespace != "") ? $this->formNamespace."[".$name."]" : $name;
// Get the element class and make sure it exist
$type = (isset($input['form']['type'])) ? $input['form']['type'] : "text";
$type = "UserFrosting\\Sprinkle\\FormGenerator\\Element\\" . Str::studly($type);
// If class doesn't esist, default to Text element
if (!class_exists($type)) {
$type = "UserFrosting\\Sprinkle\\FormGenerator\\Element\\Text";
}
// Create a new instance
$element = new $type($name, $input['form'], $value);
// Push data to `$form`
$form->put($name, $element->parse());
}
}
return $form->toArray();
}
}
|
