-
Notifications
You must be signed in to change notification settings - Fork 0
/
SD_Form.php
1216 lines (1064 loc) · 35.5 KB
/
SD_Form.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 handling class
-------------------
@par Using the class
First, create the class:
$form = new SD_Forms();
During your display of the HTML:
<pre>
echo $form->start();
</pre>
Now you can build your forms using arrays as inputs.
<pre>
$input_text = array(
'name' => 'my_text_example',
'type' => 'text',
'size' => 60, // recommended that you have any size specified
'css_class' => 'text_area_orange', // optional
'css_style' => 'font-size: 500%;', // optional
'value' => 'This is the default text displayed', // optional
'description' => 'This is a short, optional description. Note that you'll need to put divs around the description in order to do interesting stuff with it.',
);
</pre>
<pre>
echo $form->make_label( $input_text ); // The accessible label
echo $form->make_input( $input_text ); // The input itself
echo $form->make_description( $input_text ); // displays only the description, including validation info.
</pre>
And to finish up the form after displaying:
<pre>
echo $form->stop();
</pre>
@par Input types
Most of the input types have the css_class, css_style, description, value fields in common.
checkbox
<pre>
$input_checkbox = array(
'name' => 'checkbox_example',
'type' => 'checkbox',
'label' => 'Label of checkbox',
'checked' => true,
);
</pre>
value, description is optional.
file
<pre>
$input_file = array(
'name' => 'file_example',
'type' => 'file',
'value' => 'Text on button',
);
</pre>
image
An image is used instead of a submit button.
<pre>
$input_image = array(
'name' => 'image_example',
'type' => 'image',
'label' => 'ALT value of image'
'src' => 'images/submit.png',
);
</pre>
password
Similar to text, except that the value isn't displayed.
<pre>
$input_password = array(
'name' => 'password_example',
'type' => 'password',
'label' => 'Displayed label',
);
</pre>
radio
<pre>
$input_radio = array(
'name' => 'radio_example',
'type' => 'radio
'label' => 'Label of radio box',
'options' => array(
'option001' => 'First radio option',
'option002' => 'Second radio option',
),
);
</pre>
select
<pre>
$input_select = array(
'name' => 'select_example',
'type' => 'select',
'label' => 'Label of select',
'multiple' => false, // Allow selection of multiple values
'size' => 5, // How many option rows to display.
'options' => array(
'option001' => 'First select option',
'option002' => 'Second select option',
),
);
</pre>
submit
<pre>
$input_submit = array(
'name' => 'submit_example',
'type' => 'submit',
'value' => 'Displayed on the button',
);
</pre>
text
<pre>
$input_text = array(
'name' => 'text_example',
'type' => 'text
'label' => 'Label of text box',
);
</pre>
textarea
<pre>
$input_textarea = array(
'name' => 'textarea_example',
'type' => 'textarea',
'label' => 'Label of text area',
'rows' => 80,
'cols' => 10,
);
</pre>
@par Validation
To add validation to your input, add a key called validation and make it an array with any of the following keys:
empty Field is allowed to be empty
valuemin Integer value: minimum
valuemax Integer value: maximum
datetime Date must be in this format. (Use format keywords from date(). "Y-m-d").
datemaximum Latest date/time allowed. Any date() format.
lengthmin Length: minimum
Validation example:
$input_text = array(
'name' => 'text_example',
'type' => 'text
'label' => 'Label of text box',
'validation' => array(
'empty' => true,
),
);
@par Changelog
- 2011-08-08 More documentation
- 2011-08-01 More documentation
@brief SD_Forms is a XHTML form class that handles: creation, display and validation of form elements and complete form layouts.
@author Edward Plainview edward.plainview@sverigedemokraterna.se
*/
class SD_Form
{
private $options;
private $default_options = array(
'class' => '',
'global_nameprefix' => '',
'nameprefix' => '',
'namesuffix' => '',
'title' => '',
'alt' => '',
'value' => '',
'multiple' => false,
'size' => 1,
'maxlength' => 255,
'disabled' => false,
'readonly' => false,
'display_two_rows' => false,
'style' => 'STYLE1',
'css_class' => '',
'css_style' => '',
'form_method' => 'post',
'form_action' => '',
'description' => '',
);
protected $language_data = array();
private $sections = array();
function __construct($options = array())
{
$this->options = array_merge($this->default_options, $options);
$this->language_data = SD_FormLanguage::$language_data;
}
/**
* Returns the _POST data of the calling class.
*/
public static function get_post_data($callingClass, $POST = null)
{
if ($POST === null)
$POST = $_POST;
if (isset( $POST[ get_class($callingClass) ] ))
return $POST[ get_class($callingClass) ];
}
/**
* Cleans up the name of an input, remove illegal characters.
*/
public static function fix_name($name)
{
return preg_replace('/\[|\]| |\'|\\\|\?/', '_', $name);
}
/**
* Returns a text ID of this input.
*/
public function make_id($options)
{
$options = array_merge($this->options, $options);
$options['name'] = self::fix_name($options['name']);
// Add the global prefix
$options['nameprefix'] = $this->options['global_nameprefix'] . $options['nameprefix'];
return $options['class'] . '_' . preg_replace('/\[|\]/', '_', $options['nameprefix']) . '_' . $options['name'] . $options['namesuffix'];
}
/**
* Returns the name of this input.
*/
public static function make_name($options)
{
$options['name'] = self::fix_name($options['name']);
if ($options['class']!='')
return $options['class'] . $options['global_nameprefix'] . $options['nameprefix'] . '[' . $options['name'] . ']';
else
{
$returnValue = $options['global_nameprefix'];
// Remove the first [ and first ]. Yeah, that's how lovely forms work: the first prefix doesn't have brackets. The rest do.
$returnValue .= ($returnValue == '' ?
preg_replace('/\[/', '',
preg_replace('/\]/', '', $options['nameprefix'], 1)
, 1) : $options['nameprefix']);
$returnValue .= ($returnValue == '' ? $options['name'] : '[' . $options['name'] . ']');
}
return $returnValue;
}
/**
* Returns a simple <form> tag (with action and method set).
*/
public function start()
{
return '<form enctype="multipart/form-data" action="'.$this->options['form_action'].'" method="'.$this->options['form_method'].'">' . "\n";
}
/**
* Returns </form>. That's it.
*/
public function stop()
{
return '</form>' . "\n";
}
/**
* Makes a small asterisk thingy that is supposed to symbolise that the field is required.
*/
private function make_required_field($options)
{
$returnValue = '';
switch($options['type'])
{
case 'text':
case 'textarea':
$needed = false;
if (!isset($options['validation']))
$needed = true;
else
{
if (!isset($options['validation']['empty']))
$needed = true;
if (isset($options['validation']['valuemin']) || isset($options['validation']['valuemax']))
$needed = false;
}
if ($needed)
$returnValue .= '<sup><span class="screen-reader-text aural-info"> ('.$this->l('Required field').')</span><span title="'.$this->l('Required field').'">*</span></sup>';
break;
default:
break;
}
return $returnValue;
}
/**
* Returns the label of this input.
*/
public function make_label($options)
{
// Merge the given options with the options we were constructed with.
$options = array_merge($this->options, $options);
if (!isset($options['label']))
return null;
$extra = '';
if ($options['title'] != '')
$extra .= ' title="'.$options['title'].'"';
$requiredField = $this->make_required_field($options);
return '<label for="'.$this->make_id($options).'"'.$extra.'>'.$options['label'].$requiredField.'</label>';
}
/**
* Returns the description of this input.
*/
public function make_description($options)
{
// Merge the given options with the options we were constructed with.
$options = array_merge($this->options, $options);
if ($options['description'] == '')
return '';
$returnValue = '
<div>
<div class="screen-reader-text aural-info">
'.$this->l('Description').':
</div>
'.$options['description'].'
</div>';
$returnValue .= $this->make_validation($options);
return $returnValue;
}
private function make_validation($options)
{
$validation = array();
if (isset($options['validation']))
{
$validationArray = $options['validation'];
if ( isset($validationArray['valuemin']) && !isset($validationArray['valuemax']) )
$validation[] = $this->l('The value must be larger than or equal to') . ' ' . $validationArray['valuemin'];
if ( !isset($validationArray['valuemin']) && isset($validationArray['valuemax']) )
$validation[] = $this->l('The value must be smaller or equal to') . ' ' . $validationArray['valuemax'];
if ( isset($validationArray['valuemin']) && isset($validationArray['valuemax']) )
$validation[] = $this->l('Valid values') . ': ' . $validationArray['valuemin'] . ' ' . $this->l('to') . ' ' . $validationArray['valuemax'];
if ( isset($validationArray['lengthmin']) )
$validation[] = $this->l('Minimum length') . ': ' . $validationArray['lengthmin'] . ' ' . $this->l('characters');
if ( isset($validationArray['passwordstrength']) )
{
$type = $validationArray['passwordstrength'];
$checkFunction = "passwordStrengthGet$type";
$rules = $this->$checkFunction();
$rules = $this->l('The password must') . ': ' . implode(', ', $rules);
$validation[] = $rules;
}
if ( isset($validationArray['datetime']) )
{
$formatString = $validationArray['datetime'];
$formatString = str_replace('m', $this->l('MM'), $formatString);
$formatString = str_replace('d', $this->l('DD'), $formatString);
$formatString = str_replace('H', $this->l('HH'), $formatString);
$formatString = str_replace('i', $this->l('MM'), $formatString);
$formatString = str_replace('s', $this->l('SS'), $formatString);
$formatString = str_replace('Y', $this->l('YYYY'), $formatString);
$validation[] = $this->l('Date format') . ': ' . $formatString;
}
if ( isset($validationArray['datemaximum']) )
{
$validation[] = $this->l('Latest valid date') . ': ' . $validationArray['datemaximum'];
}
}
if (count($validation)>0)
return '<div>' . implode(', ', $validation) . '</div>';
else
return '';
}
/**
* Makes an input string.
*/
public function make_input($options)
{
// Merge the given options with the options we were constructed with.
$options = array_merge($this->options, $options);
$extraOptions = '';
if ($options['disabled'])
$extraOptions .= ' disabled="disabled" ';
if ($options['readonly'])
$extraOptions .= ' readonly="readonly" ';
$classes = $options['type'];
if ($options['css_class'] != '')
$classes .= ' ' . $options['css_class'];
// Add title to all
$extraOptions .= ' title="'.$options['title'].'"';
// Add alt to all except textarea
if (!in_array($options['type'], array('select', 'textarea')))
$extraOptions .= ' alt="'.$options['alt'].'"';
if ($options['css_style'] != '')
$extraOptions .= ' style="'.$options['css_style'].'"';
// Add the global prefix
$options['nameprefix'] = $options['global_nameprefix'] . $options['nameprefix'];
switch ($options['type'])
{
case 'select':
if ($options['multiple'])
{
$extraOptions .= ' multiple="multiple" ';
$nameSuffix = '[]'; // Names for multiple selects need []
}
else
$nameSuffix = '';
// Convert the value text to an array
if (!is_array($options['value']))
$options['value'] = array($options['value']);
// Make the options
$optionsText = '';
foreach($options['options'] as $option_value => $option_text )
{
// 2011-07-25 - options array is now an array of value => text, so this is for backwards compatability.
if ( is_array( $option_text ) )
{
$option_value = $option_text['value'];
$option_text = $option_text['text'];
}
$selected = in_array($option_value, $options['value'], true) ? 'selected="selected"' : '';
$optionsText .= '
<option value="'.$option_value.'" '.$selected.'>'.$option_text.'</option>
';
}
$returnValue = '<select class="'.$classes.'" name="'.self::make_name($options).$nameSuffix.'" id="'.$this->make_id($options).'" size="'.$options['size'].'" '.$extraOptions.'>
'.$optionsText.'
</select>
';
break;
case 'radio':
// Make the options
$returnValue = '';
$baseOptions = array_merge($this->options, $options);
foreach( $options['options'] as $option_value => $option_text )
{
$checked = ($option_value == $options['value']) ? 'checked="checked"' : '';
$option = $baseOptions;
$option['namesuffix'] = $option_value;
$option['label'] = $option_text;
$returnValue .= '
<div>
<input class="'.$classes.'" type="'.$options['type'].'" name="'.self::make_name($options).'" value="'.$option_value.'" id="'.$this->make_id($option).'" '.$checked.' '.$extraOptions.' />
'.$this->make_label($option).'
</div>
';
}
break;
case 'hidden':
$returnValue = '<input class="'.$classes.'" type="'.$options['type'].'" name="'.self::make_name($options).'" value="'.$options['value'].'"'.$extraOptions.' />';
break;
case 'checkbox':
if (!isset($options['checked']))
{
$options['checked'] = (intval($options['value']) == 1);
if ($options['value'] == '' || $options['value'] == '0')
$options['value'] = 1;
}
$checked = ($options['checked'] == true ? ' checked="checked" ' : '');
$returnValue = '<input class="'.$classes.'" type="'.$options['type'].'" name="'.self::make_name($options).'" id="'.$this->make_id($options).'" value="'.$options['value'].'" '.$checked.' '.$extraOptions.' />';
break;
case 'submit':
$returnValue = '<input class="'.$classes.'" type="'.$options['type'].'" name="'.self::make_name($options).'" id="'.$this->make_id($options).'" value="'.$options['value'].'" '.$extraOptions.' />';
break;
case 'file':
$returnValue = '<input class="'.$classes.'" type="'.$options['type'].'" name="'.self::make_name($options).'" id="'.$this->make_id($options).'" value="'.$options['value'].'" '.$extraOptions.' />';
break;
case 'password':
if (isset($options['size']))
{
$options['size'] = min($options['size'], $options['maxlength']); // Size can't be bigger than maxlength
$text['size'] = 'size="'.$options['size'].'"';
}
$returnValue = '<input class="'.$classes.'" type="'.$options['type'].'" '.$text['size'].' maxlength="'.$options['maxlength'].'" name="'.self::make_name($options).'" value="'.htmlspecialchars($options['value']).'" id="'.$this->make_id($options).'"'.$extraOptions.' />';
break;
case 'textarea':
$returnValue = '<textarea class="'.$classes.'" cols="'.$options['cols'].'" rows="'.$options['rows'].'" name="'.self::make_name($options).'" id="'.$this->make_id($options).'"'.$extraOptions.'>'.$options['value'].'</textarea>';
break;
case 'image':
$returnValue = '<input class="'.$classes.'" type="'.$options['type'].'" name="'.self::make_name($options).'[]" id="'.$this->make_id($options).'" value="'.$options['value'].'" title="'.$options['title'].'" src="'.$options['src'].'" '.$extraOptions.' />';
break;
default: // Default = 'text'
if (isset($options['size']))
{
$options['size'] = min($options['size'], $options['maxlength']); // Size can't be bigger than maxlength
$text['size'] = 'size="'.$options['size'].'"';
}
$returnValue = '<input class="text '.$classes.'" type="text" '.$text['size'].' maxlength="'.$options['maxlength'].'" name="'.self::make_name($options).'" id="'.$this->make_id($options).'" value="'.htmlspecialchars($options['value']).'"'.$extraOptions.' />';
}
return $returnValue;
}
/**
* Adds a section.
*
* $section = array(
* 'name' => 'Name of the section',
* 'description' => 'Section description that tells the user what this section is about.',
* 'inputs' => RESERVED
* )
*/
public function add_section($section)
{
$section['inputs'] = array();
$this->sections[ $section['name'] ] = $section;
}
private function implode_array($data, &$strings, $glueBefore, $glueAfter, $stringPrefix = null, $currentString = null)
{
foreach($data as $key=>$value)
{
if (!is_array($value))
{
$stringToAdd = $stringPrefix . $currentString . $glueBefore . $key . $glueAfter;
$strings[$stringToAdd] = $value;
}
else
$this->implode_array($value, $strings, $glueBefore, $glueAfter, $stringPrefix, $currentString . $glueBefore.$key.$glueAfter);
}
}
public function use_post_value(&$input, $post_data, $key)
{
if ($input['type']=='submit') // Submits don't get their values posted, so return the value.
return $input['value'];
$input['name'] = self::fix_name($input['name']);
// Merge the default options.
// In case this class was created with a nameprefix and the individual inputs weren't, for example.
$input = array_merge($this->options, $input);
if ($post_data === null)
return;
// Nameprefix? Find the right array section in the post.
if ($input['nameprefix'] != '')
{
$strings = '';
$this->implode_array($post_data, $strings, '__', '', $this->options['class'] . '');
}
else
{
if (isset($post_data[$input['name']]))
if (!is_array($post_data[$input['name']]))
$input['value'] = @stripslashes($post_data[$input['name']]); // @ is for unchecked checkboxes. *sigh*
else
{
$input['value'] = array(); // Kill the value, otherwise postvalues are just appended and therefore do nothing.
foreach($post_data[$input['name']] as $index=>$value)
$input['value'][$index] = stripslashes($value);
}
}
$inputID = $this->make_id($input);
if (isset($strings[$inputID]))
{
switch($input['type'])
{
default:
@$input['value'] = stripslashes( $strings[$inputID] );
}
}
}
/**
* Adds an input to a section.
* Kinda like makeInput, but with a section name.
*/
public function add_section_input($section, $input, $settings, $post_data = null)
{
if (!is_string($input))
{
$input = array_merge($this->options, $input);
if ($input['type'] == 'rawtext')
$input['name'] = rand(0, time());
$this->use_post_value($input, $post_data, $input['name']);
}
else
$input = array(
'type' => 'rawtext',
'value' => $input,
);
if ($input['type'] == 'rawtext')
$input['name'] = rand(0, time());
$this->sections[ $section['name'] ]['inputs'][] = $input;
}
public function add_text_section($sectionName, $text)
{
$this->sections[ $sectionName ]['inputs'][] = array(
'type' => 'rawtext',
'value' => $text,
);
}
/**
Adds sections + inputs "automatically".
Using $layout, the modules $settings module and the postdata, it creates a form with
section and inputs.
Example layout
private $inputLayout = array(
0 => array(
'name' => 'ExampleSection',
'description' => 'This section deals with examples. Examples are good.',
'autoinputs' => array(
'IFACMS_STAGE_PAGE_TITLE_SEPARATOR' => array('text'),
), // Inputs
'inputs' => array(
array(
'type' => 'submit',
'name'=>'CHANGE_SETTINGS_BASE',
'value' => 'Change settings',
)
), // Manualinputs
), // 0
); // inputLayout
Tip: If your module requires several pages/tabs of settings, put the layouts in one big
layoutarray and make the tab name the key.
*/
public function add_layout($layouts, $inputData, $settings, $postData = null)
{
$layoutDefaults = array(
'autoinputs' => array(),
'inputs' => array(),
);
foreach($layouts as $sectionNumber => $layout)
{
$this->add_section($layout);
$layout = array_merge($layoutDefaults, $layout);
foreach($layout['autoinputs'] as $inputName)
{
$input = $inputData[$inputName];
$input['name'] = $inputName;
$this->add_section_input($layout, $input, $settings, $postData);
}
foreach($layout['inputs'] as $manualInput)
$this->add_section_input($layout, $manualInput, $settings, $postData);
}
}
/**
* Displays a whole form with sections and all the section inputs.
*/
public function display()
{
$style = array(
'formStart' => '<div class="form-%%STYLE%%-start">',
'formStop' => '</div>',
'sectionStart' => ' <fieldset class="form-%%STYLE%%-section-start %%CSSCLASS%%">',
'sectionStop' => ' </fieldset>',
'sectionNameStart' => ' <legend class="form-%%STYLE%%-section-name">',
'sectionNameStop' => ' </legend>',
'sectionDescriptionStart' => ' <div class="form-%%STYLE%%-section-description">',
'sectionDescriptionStop' => ' </div>',
'rowStart' => ' <div class="form-%%STYLE%%-row-start">',
'rowStop' => ' </div>',
'labelContainerStart' => ' <div class="form-%%STYLE%%-labelcontainer-start">',
'labelContainerStop' => ' </div>',
'labelContainerSingleStart' => ' <div class="form-%%STYLE%%-labelcontainer-single-start">',
'labelContainerSingleStop' => ' </div>',
'labelStart' => ' <div class="form-%%STYLE%%-label-start">',
'labelStop' => ' </div>',
'inputContainerStart' => ' <div class="form-%%STYLE%%-inputcontainer-start">',
'inputContainerStop' => ' </div>',
'inputContainerSingleStart' => ' <div class="form-%%STYLE%%-inputcontainer-single-start">',
'inputContainerSingleStop' => ' </div>',
'inputStart' => ' <div class="form-%%STYLE%%-input-start">',
'inputStop' => ' </div>',
'descriptionContainerStart' => ' <div class="form-%%STYLE%%-descriptioncontainer-start">',
'descriptionContainerStop' => ' </div>',
'descriptionStart' => ' <div class="form-%%STYLE%%-description-start">',
'descriptionStop' => ' </div>',
);
$returnValue = $style['formStart'] . "\n";
foreach($this->sections as $sectionName => $sectionData)
{
$sectionData = array_merge(array(
'description' => null,
'css_class' => null,
), $sectionData);
$sectionDescription = ($sectionData['description']!=null ? $style['sectionDescriptionStart'] . $sectionData['description'] . $style['sectionDescriptionStop'] . "\n" : '');
$returnValue .= $style['sectionStart'] . "\n" .
$style['sectionNameStart'] . "\n" .
' ' . $sectionName . "\n" .
$style['sectionNameStop'] . "\n" .
$sectionDescription;
$returnValue = str_replace('%%CSSCLASS%%', $sectionData['cssClass'], $returnValue);
foreach($sectionData['inputs'] as $index=>$input)
{
if ($input['type'] == 'hidden')
{
$returnValue .= $this->make_input($input);
continue;
}
// Force validation stuff to make a description if there isn't one already.
$validation = $this->make_validation($input);
if ($validation != '' && !isset($input['description']))
$input['description'] = '';
$description = (isset($input['description']) ?
$style['descriptionContainerStart'] . "\n".
$style['descriptionStart'] . "\n".
$this->make_description($input) . "\n".
$style['descriptionStop'] . "\n".
$style['descriptionContainerStop'] . "\n"
: '');
if ($input['type'] == 'rawtext')
{
if (isset($input['css_class']))
$inputData = '<div class="'.$input['css_class'].'">'.$input['value'].'</div>';
else
$inputData = $input['value'];
}
else
{
if (!isset($input['display_two_rows']))
$input['display_two_rows'] = false; // Standard is one row
if ($input['type'] == 'submit')
$input['display_two_rows'] = true;
if ($input['display_two_rows'] == true)
{
$inputData =
$style['labelContainerSingleStart'] . "\n".
$style['labelStart'] . "\n".
' ' . $this->make_label($input) . "\n".
$style['labelStop'] . "\n".
$style['labelContainerSingleStop'] . "\n".
$style['inputContainerSingleStart'] . "\n".
$style['inputStart'] . "\n".
' ' . $this->make_input($input) . "\n".
$style['inputStop'] . "\n".
$style['inputContainerSingleStop'] . "\n".
$description;
}
else
{
$inputData =
'<div class="container_for_'.$input['type'].'">' .
$style['labelContainerStart'] . "\n".
$style['labelStart'] . "\n".
' ' . $this->make_label($input) . "\n".
$style['labelStop'] . "\n".
$style['labelContainerStop'] . "\n".
$style['inputContainerStart'] . "\n".
$style['inputStart'] . "\n".
' ' . $this->make_input($input) . "\n".
$style['inputStop'] . "\n".
$style['inputContainerStop'] . "\n".
"</div>" .
$description;
}
}
$returnValue .=
' <div class="row'.($index+1).'">' . "\n" .
$style['rowStart'] . "\n".
$inputData . "\n" .
$style['rowStop'] . "\n" .
' </div>' . "\n";
}
$returnValue .= $style['sectionStop'] . "\n";
}
$returnValue .= $style['formStop'] . "\n";
return str_replace('%%STYLE%%', $this->options['style'], $returnValue);
}
/**
Generates an SQL-statement that either updates or inserts the values into a table.
On an update, it only changes the values that have changed (compares newvalues to oldvalues).
@param $inputs array An array of inputs in standard input format (see top).
@param $inputsToChange array An array of names of which inputs to change.
@param $tableName string The table's name.
@param $uniqueKey string The unique key column name.
@param $oldValues array Associative array of old values.
@param $newValues array Associative array of new values.
@return string Prepared SQL string.
*/
public static function generate_changed_sql($inputs, $inputsToChange, $tableName, $uniqueKey, $oldValues, $newValues)
{
if ($oldValues === null)
{
// Insert.
// Make the keys and values paranthesis.
$keys = '';
$values = '';
foreach($inputsToChange as $key)
{
if ($key == $uniqueKey) // otherwise a null-value is assigned the the query has no effect.
continue;
$keys .= $key . ', ';
switch($inputs[$key]['type'])
{
case 'rawtext':
continue;
break;
case 'checkbox':
if (isset($newValues[$key]))
$value = "'1'";
else
$value = "'0'";
break;
default:
if ($newValues[$key] == '')
$value = 'NULL';
else
$value = "'$newValues[$key]'";
break;
}
$values .= $value . ', ';
}
$keys = '(' . trim($keys, ', ') . ')';
$values = '(' . trim($values, ', ') . ')';
$returnValue = 'INSERT INTO ' . $tableName . " $keys VALUES $values";
}
else
{
// Update.
// Sometimes, there might be no new values at all for specific keys. Make sure each newvalue key exists.
foreach($inputsToChange as $newKey)
if (!isset($newValues[$newKey]))
$newValues[$newKey] = null;
// Make the sets
$sets = '';
foreach($inputsToChange as $key)
{
switch($inputs[$key]['type'])
{
case 'rawtext':
continue;
break;
case 'checkbox':
{
if ($oldValues[$key] == '1' && !isset($newValues[$key]))
$sets .= "$key = '0', ";
if ($oldValues[$key] == '0' && isset($newValues[$key]))
if ($newValues[$key] !== null)
$sets .= "$key = '1', ";
}
break;
default:
if ($oldValues[$key] !== $newValues[$key])
{
if ($newValues[$key] === '' | $newValues[$key] === null)
$sets .= "$key = NULL, " ;
else
{
// If value is an array (multiple choice select input), serialize it.
if (is_array($newValues[$key]))
$newValues[$key] = serialize($newValues[$key]);
$sets .= "$key = '".addslashes($newValues[$key])."', ";
}
}
break;
}
}
$sets = trim($sets, ', ');
if ($sets != '')
$returnValue = 'UPDATE ' . $tableName . ' SET ' . $sets . " WHERE $uniqueKey = '$oldValues[$uniqueKey]'";
else
$returnValue = '';
}
return $returnValue;
}
/**
Validate an email address.
@param $email $email Email address to validate
@return bool True, if the address is valid.
*/
public static function valid_email($email)
{
$isValid = true;
$atIndex = strrpos($email, "@");
if (is_bool($atIndex) && !$atIndex)
{
$isValid = false;
}
else
{
$domain = substr($email, $atIndex+1);
$local = substr($email, 0, $atIndex);
$localLen = strlen($local);
$domainLen = strlen($domain);
if ($localLen < 1 || $localLen > 64)
{
// local part length exceeded
$isValid = false;
}
else if ($domainLen < 1 || $domainLen > 255)
{
// domain part length exceeded
$isValid = false;
}
else if ($local[0] == '.' || $local[$localLen-1] == '.')
{
// local part starts or ends with '.'
$isValid = false;
}
else if (preg_match('/\\.\\./', $local))
{
// local part has two consecutive dots
$isValid = false;
}
else if (!preg_match('/^[A-Za-z0-9\\-\\.]+$/', $domain))
{
// character not valid in domain part
$isValid = false;