-
Notifications
You must be signed in to change notification settings - Fork 23
/
FormValidationScriptGenerator.php
415 lines (371 loc) · 18.4 KB
/
FormValidationScriptGenerator.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
<?php
/**
* This file is part of the JsFormValidationBundle.
*
* (c) Abhoryo <abhoryo@free.fr>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace APY\JsFormValidationBundle\Generator;
use Doctrine\ORM\EntityManager;
use APY\JsFormValidationBundle\Generator\GettersLibraries;
use APY\JsFormValidationBundle\Generator\PreProcessEvent;
use APY\JsFormValidationBundle\Generator\FieldsConstraints;
use APY\JsFormValidationBundle\Generator\PostProcessEvent;
use APY\JsFormValidationBundle\JsfvEvents;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Form\FormView;
use Doctrine\Common\Annotations\AnnotationReader;
use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Mapping\Loader\AnnotationLoader;
use Assetic\Filter\Yui\JsCompressorFilter;
use Assetic\Asset\AssetCollection;
class FormValidationScriptGenerator
{
/**
* @var ClassMetadata
*/
protected $metadata;
/**
* @var ContainerInterface
*/
protected $container;
/**
* @var EntityManager
*/
protected $em;
/**
* Constructor
*
* @param ContainerInterface $container
*/
public function __construct(ContainerInterface $container)
{
$this->container = $container;
$this->em = $container->get('doctrine')->getEntityManager();
}
/**
* Gets Entity Manager
*
* @return \Doctrine\ORM\EntityManager Returns Entity Manager
*/
public function getEntityManager()
{
return $this->em;
}
/**
* Retrieves validation bundle name.
*
* Validation Bundle can be overridden in app/config/config.yml
* apy_js_form_validation:
* validation_bundle: YourValidationBundle
*
* @return string Returns validation bundle name from config
* @author Vitaliy Demidov <zend@i.ua>
* @since 31 July 2012
*/
public function getValidationBundle()
{
return $this->getParameter('validation_bundle');
}
/**
* Gets parameter value from apy_js_form_validation namespace
*
* @param string $parameter Parameter name
* @return mixed|null Returns parameter value, or NULL if it does not exist
*/
public function getParameter($parameter)
{
return $this->container->hasParameter('apy_js_form_validation.' . $parameter) ?
$this->container->getParameter('apy_js_form_validation.' . $parameter) : null;
}
/**
* Gets ClassMetadata of desired entity with annotations info
*
* @param string $entityName
* @return ClassMetadata Returns ClassMetadata object of desired entity with annotations info
*/
public function getClassMetadata ($entityName)
{
// Load metadata
$metadata = new ClassMetadata($entityName);
// from annotations
$annotationloader = new AnnotationLoader(new AnnotationReader());
$annotationloader->loadClassMetadata($metadata);
// from php
// $entity = new $entityName();
// $entity->loadValidatorMetadata($metadata);
// from yml
// from xml
return $metadata;
}
/**
* Checks, whether the entity has UiqueEntity Constraint
*
* @param string $entityName Entity Name
* @return boolean Returns TRUE if desired entity has UniqueEntity constraint
*/
public function hasUniqueEntityConstraint ($entityName)
{
$ret = false;
$metadata = $this->getClassMetadata($entityName);
if (!empty($metadata->constraints)) {
foreach ($metadata->constraints as $constraint) {
if (preg_match("/\\\\UniqueEntity$/", get_class($constraint))) {
$ret = true;
break;
}
}
}
return $ret;
}
/**
* Gets entity identifier value.
*
* When entity is updated UniqueEntity constraint should ignore
* entity with the same primary key id
*
* @param object $entity Entity object which is applied to the form
* @return array|null Returns array that contains values of the fields that form
* primary key of entity
* @throws \RuntimeException
*/
public function getEntityIdentifierValue ($entity)
{
if (empty($entity) || !is_object($entity)) {
throw new \RuntimeException("Invalid parameter. Entity should be provided.");
}
$entityMetadata = $this->getEntityManager()->getClassMetadata(get_class($entity));
$identifier = $entityMetadata->getIdentifier();
$ignore = array();
if (!empty($identifier)) {
foreach ($identifier as $prop) {
$propGetter = 'get' . ucfirst($prop);
if (method_exists($entity, $propGetter)) {
$ignore[] = $entity->$propGetter();
} elseif (isset($entity->$prop)) {
$ignore[] = $entity->$prop;
} else {
throw new \RuntimeException('Could not access value for the field: ' . $prop);
}
}
}
if (empty($ignore)) $ignore = null;
return $ignore;
}
/**
* Generates client-side javascript that validates form
*
* @param FormView $formView
* @param boolean $overwrite
* @throws \RuntimeException
*/
public function generate(FormView $formView, $overwrite = false)
{
// Prepare output file
$scriptPath = $this->container->getParameter('apy_js_form_validation.script_directory');
$scriptRealPath = $this->container->getParameter('assetic.write_to').'/'.$scriptPath;
$formName = $formView->getName() ?: 'form';
$scriptFile = strtolower($this->container->get('request')->get('_route')) . "_" . strtolower($formName) . ".js";
if ($overwrite || false === file_exists($scriptRealPath . $scriptFile)) {
// Initializes variables
$fieldsConstraints = new FieldsConstraints();
$gettersLibraries = new GettersLibraries($this->container, $formView);
$aConstraints = array();
$aGetters = array();
$dispatcher = $this->container->get('event_dispatcher');
// Retrieves entity name from the form view
$formViewValue = $formView->get('value');
if (is_object($formViewValue)) {
$entityName = get_class($formViewValue);
} elseif ($formView->get('data_class') && class_exists($formView->get('data_class'))) {
$entityName = $formView->get('data_class');
}
if (isset($entityName)) {
// Form is built on Entity
$metadata = $this->getClassMetadata($entityName);
$formValidationGroups = $formView->get('validation_groups', array('Default'));
// Dispatch JsfvEvents::preProcess event
$preProcessEvent = new PreProcessEvent($formView, $metadata);
$dispatcher->dispatch(JsfvEvents::preProcess, $preProcessEvent);
if (!empty($metadata->constraints)) {
foreach ($metadata->constraints as $constraint) {
$constraintName = end((explode(chr(92), get_class($constraint))));
if ($constraintName == 'UniqueEntity') {
if (is_array($constraint->fields)) {
//It has not been implemented yet
} else if (is_string($constraint->fields)) {
if (!isset($aConstraints[$constraint->fields])) {
$aConstraints[$constraint->fields] = array();
}
$aConstraints[$constraint->fields][] = $constraint;
}
}
}
}
$errorMapping = $formView->get('error_mapping');
if (!empty($metadata->getters)) {
foreach ($metadata->getters as $getterMetadata) {
/* @var \Symfony\Component\Validator\Mapping\GetterMetadata $getterMetadata */
if (!empty($getterMetadata->constraints)) {
if ($gettersLibraries->findLibrary($getterMetadata) === null) {
// You have to provide getter templates in the following location
// {EntityBundle}/Resources/views/Getters/{EntityName}.{GetterMethod}.js.twig
// or all templates in one place:
// app/Resources/APYJsFormValidationBundle/views/Getters/{EntityName}.{GetterMethod}.js.twig
continue;
}
foreach ($getterMetadata->constraints as $constraint) {
/* @var \Symfony\Component\Validator $constraint */
$getterName = $getterMetadata->getName();
$jsHandlerCallback = $gettersLibraries->getKey($getterMetadata, '_');
$constraintName = end((explode(chr(92), get_class($constraint))));
$constraintProperties = get_object_vars($constraint);
$exist = array_intersect($formValidationGroups, $constraintProperties['groups']);
if (!empty($exist)) {
if (!$gettersLibraries->has($getterMetadata)) {
$gettersLibraries->add($getterMetadata);
}
if (!$fieldsConstraints->hasLibrary($constraintName)) {
$librairy = "APYJsFormValidationBundle:Constraints:{$constraintName}Validator.js.twig";
$fieldsConstraints->addLibrary($constraintName, $librairy);
}
if (!empty($errorMapping[$getterName]) && is_string($errorMapping[$getterName])) {
$fieldName = $errorMapping[$getterName];
//'type' property is set in RepeatedTypeExtension class
if (!empty($formView->children[$fieldName]) &&
$formView->children[$fieldName]->get('type') == 'repeated') {
$repeatedNames = array_keys($formView->children[$fieldName]->get('value'));
//Listen first repeated element
$fieldId = $formView->children[$fieldName]->get('id') . "_" . $repeatedNames[0];
} else {
$fieldId = $formView->children[$fieldName]->get('id');
}
} else {
$fieldId = '.';
}
if (!isset($aGetters[$fieldId][$jsHandlerCallback])) {
$aGetters[$fieldId][$jsHandlerCallback] = array();
}
unset($constraintProperties['groups']);
$aGetters[$fieldId][$jsHandlerCallback][] = array(
'name' => $constraintName,
'parameters' => json_encode($constraintProperties),
);
}
}
}
}
}
}
if (isset($entityName)) {
$constraintsTarget = $metadata->properties;
} else {
// Simple form that is built manually
$constraintsTarget = $formView->get('constraints');
if (isset($constraintsTarget[0]) && !empty($constraintsTarget[0]->fields)) {
//Get Default group ?
$constraintsTarget = $constraintsTarget[0]->fields;
}
}
if (!empty($constraintsTarget)) {
// we look through each field of the form
foreach ($formView->children as $formField) {
// Fields with property_path=false must be excluded from validation
if ($formField->get('property_path') === false) continue;
// we look for constraints for the field
if (isset($constraintsTarget[$formField->get('name')])) {
$constraintList = isset($entityName) ?
$constraintsTarget[$formField->get('name')]->getConstraints() :
$constraintsTarget[$formField->get('name')]->constraints;
//Adds entity level constraints that have been provided for this field
if (!empty($aConstraints[$formField->get('name')])) {
$constraintList = array_merge($constraintList, $aConstraints[$formField->get('name')]);
}
// we look through each field constraint
foreach ($constraintList as $constraint) {
$constraintName = end((explode(chr(92), get_class($constraint))));
$constraintProperties = get_object_vars($constraint);
// Groups are no longer needed
unset($constraintProperties['groups']);
if (!$fieldsConstraints->hasLibrary($constraintName)) {
$librairy = "APYJsFormValidationBundle:Constraints:{$constraintName}Validator.js.twig";
$fieldsConstraints->addLibrary($constraintName, $librairy);
}
$constraintParameters = array();
//We need to know entity class for the field which is applied by UniqueEntity constraint
if ($constraintName == 'UniqueEntity' && !empty($formField->parent)) {
$entity = $formField->parent->get('value');
$constraintParameters += array(
'entity:' . json_encode(get_class($entity)),
'identifier_field_id:'.
json_encode($formView->children[$this->getParameter('identifier_field')]->get('id')),
);
}
foreach ($constraintProperties as $variable => $value) {
if (is_array($value)) {
$value = json_encode($value);
} else {
// regex
if (stristr('pattern', $variable) === false) {
$value = json_encode($value);
}
}
$constraintParameters[] = "$variable:$value";
}
$fieldsConstraints->addFieldConstraint($formField->get('id'), array(
'name' => $constraintName,
'parameters' => '{' . join(', ', $constraintParameters) . '}'
));
}
}
}
}
// Dispatch JsfvEvents::postProcess event
$postProcessEvent = new PostProcessEvent($formView, $fieldsConstraints);
$dispatcher->dispatch(JsfvEvents::postProcess, $postProcessEvent);
// Retrieve validation mode from configuration
$check_modes = array('submit' => false, 'blur' => false);
switch ($this->container->getParameter('apy_js_form_validation.check_mode')) {
default:
case 'submit':
$check_modes['submit'] = true;
break;
case 'blur':
$check_modes['blur'] = true;
break;
case 'both':
$check_modes = array('submit' => true, 'blur' => true);
break;
}
// Render the validation script
$validation_bundle = $this->getValidationBundle();
$javascript_framework = strtolower($this->container->getParameter('apy_js_form_validation.javascript_framework'));
$template = $this->container->get('templating')->render(
"{$validation_bundle}:Frameworks:JsFormValidation.js.{$javascript_framework}.twig",
array(
'formName' => $formView->get('name'),
'fieldConstraints' => $fieldsConstraints->getFieldsConstraints(),
'librairyCalls' => $fieldsConstraints->getLibraries(),
'check_modes' => $check_modes,
'getterHandlers' => $gettersLibraries->all(),
'gettersConstraints' => $aGetters,
));
// Create asset and compress it
$asset = new AssetCollection();
$asset->setContent($template);
$asset->setTargetPath($scriptRealPath.$scriptFile);
// Js compression
if ($this->container->getParameter('apy_js_form_validation.yui_js')) {
$yui = new JsCompressorFilter($this->container->getParameter('assetic.filter.yui_js.jar'), $this->container->getParameter('assetic.java.bin'));
$yui->filterDump($asset);
}
$this->container->get('filesystem')->mkdir($scriptRealPath);
if (false === @file_put_contents($asset->getTargetPath(), $asset->getContent())) {
throw new \RuntimeException('Unable to write file '.$asset->getTargetPath());
}
}
return $this->container->get('templating.helper.assets')->getUrl($scriptPath.$scriptFile);
}
}