/
Form.class.php
executable file
·1835 lines (1537 loc) · 47.7 KB
/
Form.class.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
/**
* Form Class, ou comment créer et utiliser facilement un formulaire
*
* \todo optimiser !
*
* Vous êtes libre d'utiliser et de distribuer ce script comme vous
* l'entendez, en gardant à l'esprit que ce script est, à l'origine, fait
* par des développeurs bénévoles : en conséquence, veillez à laisser le
* Copyright, par respect de ceux qui ont consacré du temps à la création
* du script.
*
* @package Form Class
* @author Kévin Gomez <geek63@gmail.com>
* @copyright © Kévin Gomez, La Geek Attitude 2007, 2010
* @link http://blog.kevingomez.fr/ La Geek Attitude
* @license http://www.gnu.org/licenses/gpl.html (COPYING) GNU Public License
* @begin 10/01/2009, Kévin Gomez
* @last 18/05/2010, Kévin Gomez
*/
/**
*
* Class de création de formulaires
*
**/
class Form {
protected $attrs;
protected $label_suffix = ' : ';
protected $values = array();
protected $fields = array();
protected $errors_msg = array();
public function __construct($method='post', $action='')
{
$this->attrs = new AttributeList(array(
'method' => $method,
'action' => $action,
)
);
}
/**
* Ajouter un champ
*
* @param $type type de champ à ajouter (correspond au nom de l'objet réprésentant le champ)
* @param $name nom du champ (doit être unique)
* @param $value valeur par défaut
*
* @return obj (retourne l'objet représentant le champ créé)
*/
public function add($type, $name='', $value='', $label='')
{
if(is_object($type))
{
if(isset($this->fields[$type->getName()]))
trigger_error('Un champ nommé « '.$type->getName().' » existe déjà.', E_USER_ERROR);
$this->fields[$type->getName()] = $type;
}
else
{
if(empty($name))
trigger_error('L\'argument name est nécessaire pour la création du champ.', E_USER_ERROR);
if(isset($this->fields[$name]))
trigger_error('Un champ nommé « '.$name.' » existe déjà.', E_USER_ERROR);
else
{
$field = 'Field_'.$type;
if($field == 'Field_SubmitButton')
$o_Field = new $field($name);
else
$o_Field = new $field($name, $value, $label);
$o_Field->setForm($this);
$this->fields[$name] = $o_Field;
return $o_Field;
}
}
}
/**
* Remplis les champs avec l'array fourni
*
* \todo Refaire : parcourir $data plutôt que $this->fields
*
* @param $data ('clef' => 'valeur') où clef == nom du champ
*
* @return void
*/
public function bound(array &$data)
{
foreach($this->fields as $name => $field)
{
if($field->getType() == 'submit')
continue;
$field->setValue((isset($data[$name])) ? $data[$name] : Null);
}
}
/**
* Indique si les champs du formulaire ont été correctement remplis
* (méthode à appeler si on veut générer les erreurs)
*
* @return bool
*/
public function isValid()
{
$valid = True;
foreach($this->fields as $name => $field)
{
if($field->isDisabled())
continue;
if(!$field->isValid())
{
$valid = False;
foreach($field->getErrors() as $error)
$this->triggerError($field, $error);
}
$this->values[$field->getName()] = $field->getValue();
}
return ($valid AND count($this->errors_msg) == 0);
}
/**
* Ajoute un message d'erreur à la liste des erreurs
*
* @param $field nom du champ ou objet représentant le champ lié à l'erreur
* @param $error_text message d'erreur à afficher
*
* @return void
*/
public function triggerError($field, $error_text)
{
if(!is_string($field))
$oField = $field;
else
{
if(!isset($this->fields[$field]))
trigger_error('Aucun champ nommé « '.$field.' » n\'a été déclaré.', E_USER_ERROR);
$oField = $this->fields[$field];
}
if(isset($oField))
$this->errors_msg[] = array(
'ERROR_TEXT' => $error_text,
'FIELD_LABEL' => $oField->getLabel()
);
}
/**
* Récupère l'objet représentant le champ ayant pour code $field_name
*
* @param $field_name nom du champ
*
* @return obj
*/
public function field($field_name)
{
if(isset($this->fields[$field_name]))
return $this->fields[$field_name];
else
trigger_error('Aucun champ nommé « '.$field_name.' » n\'a été créé.', E_USER_ERROR);
}
/**
* Retourne une valeur du formulaire (ou toute si pas de clef fournie)
* si la clef ne correspond pas à un champ et qu'une valeur par défaut
* est donnée, on la renvoie
*
* \warning Ne fonctionne qu'après un appel à la méthode isValid() !
*
* @param $var nom d'un item du formulaire dont on veut la valeur
* @param $default valeur à renvoyer si pas de correspondance avec un champ
*
* @return mixed
*/
public function get($val='', $default='|NoDefaultValue|')
{
if(empty($val))
return $this->values;
elseif(isset($this->values[$val]))
return $this->values[$val];
elseif($default != '|NoDefaultValue|')
return $default;
else
trigger_error('Aucun champ nommé « '.$val.' » n\'a été créé, il est donc impossible de récupérer sa valeur.', E_USER_ERROR);
}
/**
* Retourne un array contenant les messages d'erreur
* array de la forme ::
* array(
* 'ERROR_TEXT' => "message d'erreur",
* 'FIELD_LABEL' => "label du champ"
* )
*
* @return array
*/
public function getErrors()
{
return $this->errors_msg;
}
/**
* Change l'enctype du formulaire
*
* @param $enctype multipart/form-data ou application/x-www-form-urlencoded
*
* @return obj (le formulaire en question)
*/
public function setEnctype($enctype)
{
$enctype = strtolower($enctype);
if (in_array($enctype, array('multipart/form-data', 'application/x-www-form-urlencoded')))
$this->attrs['enctype'] = $enctype;
return $this;
}
/**
* Change l'attribut "name" du formulaire
*
* @param $name La nouvelle valeur de l'attribut
*
* @return $this
*/
public function setName($name)
{
$this->attrs['name'] = $name;
return $this;
}
/**
* Change l'ID du formulaire
*
* @param $text nouvelle valeur
*
* @return obj (le champ en question)
*/
public function setID($id)
{
$this->attrs['id'] = $id;
return $this;
}
/**
* Retourne l'ID du champ
*
* @return string
*/
public function getID()
{
return $this->attrs['id'];
}
/**
* Texte à afficher après le label du champ
*
* @param $string nouvelle valeur
*
* @return obj (le champ en question)
*/
public function setLabelSuffix($string)
{
$this->label_suffix = $string;
return $this;
}
/**
* Retourne le texte à afficher après le label du champ
*
* @return string
*/
public function getLabelSuffix()
{
return $this->label_suffix;
}
/**
* Retourne le form préparé pour que le moteur de TPL puisse l'exploiter
*
* @return array('nom_du_champ' => array('code_html', 'label', array('mess erreur 1', 'mess erreur 2')))
*/
public function toArray()
{
$output = array();
foreach($this->fields as $name => $field)
{
$output[$name] = array(
'HTML' => (string) $field, //on caste en string pour récupérer le code html
'LABEL' => $field->getLabel(),
'ERRORS' => $field->getErrors(),
);
}
return $output;
}
/**
* Retourne le form au format HTML, prêt à être utilisé
* les champs sont encadrés par des <p>
*
* @param $display_errors dés/active l'affichage auto des erreurs
*
* @return string
*/
public function asP($display_errors=False)
{
$output = sprintf('<form %s>', $this->attrs);
$errors = '<h3>Erreur</h3><ul class="form_error">';
foreach($this->fields as $field)
{
if($field->getType() != 'hidden')
{
if($field->getErrors())
$errors .= '<li>'.$field->getLabel().$this->label_suffix.' '.implode(', ', $field->getErrors()).'</li>';
$output .= "\n\t".'<p>';
if($field->getLabel() != '')
$output .= "\n\t\t".'<label for="'.$field->getID().'">'.$field->getLabel().$this->label_suffix.'</label>';
$output .= "\n\t\t".$field->toHTML();
$output .= "\n\t".'</p>';
}
else
{
$output .= "\n\t".$field->toHTML();
}
}
$errors .= '</ul>';
$output .= "\n\r".'</form>';
return ($display_errors) ? $errors.$output : $output;
}
public function __toString()
{
return $this->asP();
}
}
/**
*
* Class de base aux divers champs
*
**/
abstract class FormField {
protected $class = array();
protected $attrs;
protected $form_ref = Null;
protected $label = '';
protected $required = True;
protected $auto_bound = True;
protected $error_messages = array();
protected $user_validation_rules = array();
protected $errors_list = array(
'required' => 'Ce champ est obligatoire.',
);
public function __construct($name, $label='')
{
$this->attrs = new AttributeList(array('name' => $name));
$this->attrs['id'] = $this->getName();
$this->attrs['value'] = '';
$this->setLabel($label);
}
/**
* Donne au champ une référence vers le formulaire
*
* @param &$form Référence à l'instance du formulaire qui a créé le champ
*
* @return void
*/
public function setForm(Form &$form)
{
if($this->form_ref != Null)
return;
$this->form_ref = $form;
}
/**
* Dit si le contenu du champ est valide et crée les erreurs si besoin
* (pourra et devra être surchargée)
*
* @return bool
*/
public function isValid()
{
// empty considérant les valeurs telles que 0 comme vides
if($this->required AND (isset($this->attrs['value']) AND $this->attrs['value'] == ''))
{
$this->_error('required');
return False;
}
return True;
}
/**
* Ajoute une règle de validation
*
* @param $callback fonction/méthode de validation.
* doit accepter un paramètre, et retourner le
* texte de l'erreur (si erreur), ou une chaine
* vide si tout est OK
* @param $args Paramètres à passer au callback (en plus de ceux par défaut)
*
* @return obj (le champ en question)
*/
public function addValidationRule($callback, array $args=array())
{
$this->user_validation_rules[] = array($callback, $args);
return $this;
}
/**
* Indique si le formulaire passe les règles de validation personnalisées
*
* @return bool
*/
protected function passUserValidationRules()
{
foreach($this->user_validation_rules as $key => $rule)
{
$args = array($this->getValue(), $this->form_ref);
$pass = call_user_func_array($rule[0], array_merge($args, $rule[1]));
if(!empty($pass))
{
$this->_userError($pass);
return False;
}
}
return True;
}
/**
* Rend obligatoire le champ ou pas
*
* @param $bool status du champ
*
* @return obj (le champ en question)
*/
public function required($bool=True)
{
$this->required = (bool) $bool;
return $this;
}
/**
* Dés/active un champ
*
* @param $bool état d'activation
*
* @return obj (le champ en question)
*/
public function disabled($bool=True)
{
if((bool) $bool)
$this->attrs['disabled'] = 'disabled';
else
unset($this->attrs['disabled']);
return $this;
}
/**
* Indique si le champ est désactivé
*
* @return bool
*/
public function isDisabled() {
return isset($this->attrs['disabled']) && $this->attrs['disabled'] == 'disabled';
}
/**
* Dés/active la lecture seule
*
* @param $bool état d'activation
*
* @return obj (le champ en question)
*/
public function readOnly($bool=True)
{
if((bool) $bool)
$this->attrs['readonly'] = 'readonly';
else
unset($this->attrs['readonly']);
return $this;
}
/**
* Dés/Active la remplissage auto lors de l'appel à la méthode bound()
* Empêche simplement la valeur de s'afficher, mais elle reste présente et récupérable via getValue() par ex
*
* @param $bool état (True == activé)
*
* @return obj (le champ en question)
*/
public function autoBound($bool=True)
{
$this->auto_bound = (bool) $bool;
return $this;
}
/**
* Donne l'état du remplissage auto
*
* @return bool
*/
public function canBound()
{
return $this->auto_bound;
}
/**
* Retourne le nom du champ
*
* \note Si le champ est un tableau, son attribut name se termine par
* [] dans le code HTML. Cette méthode supprime les crochets.
*
* @return string
*/
public function getName()
{
return substr($this->attrs['name'], -2) == '[]' ? substr($this->attrs['name'], 0, -2) : $this->attrs['name'];
}
/**
* Retourne l'ID du champ
*
* @return string
*/
public function getID()
{
return $this->attrs['id'];
}
/**
* Retourne le type du champ
*
* @return string
*/
public function getType()
{
return (!empty($this->attrs['type'])) ? $this->attrs['type'] : '';
}
/**
* Retourne le contenu du label
*
* @return string
*/
public function getLabel()
{
return $this->label;
}
/**
* Retourne les messages d'erreurs
*
* @return array
*/
public function getErrors()
{
return array_values($this->error_messages);
}
/**
* Retourne la valeur du champ
*
* @return string
*/
public function getValue()
{
return isset($this->attrs['value']) ? $this->attrs['value'] : '';
}
/**
* Retourne la valeur du champ (nettoyée) (à surcharger dans une class-fille)
*
* @return string
*/
/*
public function getCleanedValue($value='')
{
return (empty($value)) ? $this->attrs['value'] : $value;
}
*/
/**
* Ajoute une _class CSS au champ
*
* @param $class nom de la class
*
* @return obj (le champ en question)
*/
public function addClass($class)
{
if(is_array($class))
{
foreach($class as $item)
$this->addClass($item);
}
else
{
if(!in_array($class, $this->class))
$this->class[] = $class;
}
return $this;
}
/**
* Génère le contenu de l'attribut _class_ avec tous les éléments données
*
* \note Méthode à appeler en début de __toString()
*
* return void
*/
protected function _makeClass()
{
if(!empty($this->class))
$this->attrs['class'] = implode(' ', $this->class);
}
/**
* Change la valeur d'un champ du formulaire
*
* @param $text nouvelle valeur
*
* @return obj (le champ en question)
*/
public function setValue($text)
{
$this->attrs['value'] = $text;
return $this;
}
/**
* Change la valeur du label
*
* @param $text nouvelle valeur
*
* @return obj (le champ en question)
*/
public function setLabel($text)
{
$this->label = $text;
return $this;
}
/**
* Change la valeur de l'ID du champ
*
* @param $text nouvelle valeur
*
* @return obj (le champ en question)
*/
public function setID($text)
{
$this->attrs['id'] = $text;
return $this;
}
/**
* Permet de changer le message affiché lors d'une erreur
*
* @param $error_id id du message d'erreur
* @param $text nouveau message
*
* @return obj (le champ en question)
*/
public function setErrorText($error_id, $text)
{
$this->errors_list[$error_id] = $text;
return $this;
}
/**
* Ajoute le message d'erreur correspondant à $id dans la liste d'erreurs
*
* @param $id identifiant de l'erreur
*
* @return void
*/
protected function _error()
{
$args = func_get_args();
$id = array_shift($args);
$this->error_messages[$id] = vsprintf($this->errors_list[$id], $args);
}
/**
* Ajoute le message d'erreur dans la liste d'erreurs
* méthode utilisée pour les erreurs provoquées par des règles de validation
* provenants de l'utilisateur
*
* @param $error erreur
*
* @return void
*/
protected function _userError($error)
{
$this->error_messages[time()] = $error;
}
public abstract function toHTML();
public function __toString() {
return $this->toHTML();
}
}
abstract class FormInput extends FormField {
protected $min_lenght = 0;
public function __construct($name, $label='')
{
parent::__construct($name, $label);
$this->attrs['type'] = 'text';
$this->setErrorText('minlength', 'Le texte est trop court (au moins %d caractères).');
$this->setErrorText('maxlength', 'Le texte est trop long (pas plus de %d caractères).');
}
/**
* Permet de définir la taille du champ
*
* @param $size La nouvelle taille (0 pour supprimer cet attribut)
*
* @return $this
*/
public function setSize($size)
{
if(is_numeric($size))
{
if((int) $size > 0)
$this->attrs['size'] = (int) $size;
elseif((int) $size == 0)
unset($this->attrs['size']);
}
return $this;
}
/**
* Change la longueur minimale du contenu du champ
*
* @param $len nouvelle valeur (0 pour désactiver la limitation)
*
* @return obj (le champ en question)
*/
public function setMinLength($len)
{
$this->min_lenght = (is_numeric($len) AND (int) $len > 0) ? (int) $len : 0;
return $this;
}
/**
* Change la longueur maximale du contenu du champ
*
* @param $len nouvelle valeur (0 pour désactiver la limitation)
*
* @return obj (le champ en question)
*/
public function setMaxLength($len)
{
if(is_numeric($len))
{
if((int) $len > 0)
$this->attrs['maxlength'] = (int) $len;
elseif((int) $len == 0)
unset($this->attrs['maxlength']);
}
return $this;
}
public function isValid()
{
if(parent::isValid())
{
if(strlen($this->getValue()) < $this->min_lenght)
{
$this->_error('minlength', $this->min_lenght);
return False;
}
if(!empty($this->attrs['maxlength']) AND strlen($this->getValue()) > $this->attrs['maxlength'])
{
$this->_error('maxlength', $this->attrs['maxlength']);
return False;
}
return True;
}
return False;
}
public function toHTML()
{
$this->_makeClass();
$attrs = $this->attrs;
$attrs['value'] = htmlspecialchars(($this->canBound()) ? $attrs['value'] : '');
$html = sprintf('<input %s/>', $attrs);
return $html;
}
}
//Champ de texte simple
class Field_Text extends FormInput {
public function __construct($name, $value='', $label='')
{
parent::__construct($name, $label);
$this->setValue($value);
}
public function isValid()
{
if(parent::isValid())
{
$value = $this->getValue();
return empty($value) ? True : $this->passUserValidationRules();
}
return False;
}
}
//Champ de soumission du formulaire
class Field_SubmitButton extends FormInput {
public function __construct($name)
{
parent::__construct($name);
$this->setValue($name);
$this->required(False);
$this->attrs['type'] = 'submit';
}
}
//Champ de texte pour URL
class Field_URL extends FormInput {
protected $verify_exists = False;
public function __construct($name, $value='', $label='')
{
parent::__construct($name, $label);
$this->setValue($value);
$this->setErrorText('invalid_url', 'L\'URL n\'est pas valide.');
}
/**
* Si tourné à True, vérifiera la présence d'une page à l'url donnée
* (on attendra une réponse 200 OK via le protocole HTTP)
*
* @param $bool vérification ou non
*
* @return obj (le champ en question)
*/
public function verifyExists($bool)
{
$this->verify_exists = (bool) $bool;
return $this;
}
public function isValid()
{
if(parent::isValid())
{
if(parse_url($this->getValue(), PHP_URL_SCHEME) === False)
{
$this->_error('invalid_url');
return False;
}
if($this->verify_exists)
{
$headers = @get_headers($this->getValue());
if(!$headers)
{
$this->_error('invalid_url');
return False;
}
elseif(!in_array('HTTP/1.1 200 OK', $headers) AND !in_array('HTTP/1.0 200 OK', $headers))
{
$this->_error('invalid_url');
return False;
}
}
$value = $this->getValue();
return empty($value) ? True : $this->passUserValidationRules();
}
return False;
}
}
//Champ décimal :: on attend un nombre (entier ou flottant)
class Field_Decimal extends FormInput {
protected $min = Null;
protected $max = Null;
public function __construct($name, $value='', $label='')
{
parent::__construct($name, $label);
$this->setValue($value);
$this->setErrorText('decimal_required', 'Doit être un nombre.');
$this->setErrorText('lower_than_min_decimal', 'Ce nombre est trop petit (au moins %d).');
$this->setErrorText('higher_than_max_decimal', 'Ce nombre est trop grand (au maximum %d).');
}
/**
* Définit un minimum pour le champ
*
* @param $int valeur du minimum
*
* @return obj (le champ en question)
*/
public function min($int)
{
$this->min = (is_numeric($int)) ? (int) $int : NULL;
return $this;
}
/**
* Définit un maximum pour le champ
*
* @param $int valeur du maximum
*
* @return obj (le champ en question)
*/
public function max($int)
{
$this->max = (is_numeric($int)) ? (int) $int : NULL;
return $this;
}
public function isValid()
{
if(parent::isValid())
{