-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathforms.html
667 lines (454 loc) · 29.8 KB
/
forms.html
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
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Ness PHP Framework | Docs</title>
<link rel="stylesheet" type="text/css" href="assets/css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="assets/fnt-aw/css/font-awesome.min.css">
<link rel="stylesheet" type="text/css" href="assets/css/style.css">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
<!--Load highlightjs package -->
<link rel="stylesheet" href="assets/js/highlightjs/styles/vs2015.css">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js"></script>
</head>
<body>
<div class="wrapper">
<!-- Sidebar -->
<nav id="sidebar">
<div id="sidebar-header" class="text-center">
<br>
<a href="index.html" id="logo-area-link">
<img src="assets/img/nessphp_bordered.png" alt="Ness PHP Documentation" width="70%"/>
<h3>Ness PHP</h3>
<h4>Documentation</h4>
</a>
<a href="index.html" class="btn btn-light btn-sm" style="width: 100%;">
<i class="fa fa-angle-left" aria-hidden="true"></i> Back
</a>
</div>
<br>
<!--Load LATER-->
<div id="sidebar-loader" class="sidebar-contents">
</div>
</nav>
<div id="content">
<!--Nabvar:start-->
<nav class="navbar navbar-expand-lg">
<div class="container-fluid">
<button id="sidebarCollapse" class="btn-circle">
<i class="fa fa-bars" aria-hidden="true"></i>
</button>
<ul class="nav navbar-nav">
<li class="nav-item">
<a href="index.html" class="navbar-text-header">
Ness PHP Framework
</a>
</li>
</ul>
<button class="btn-circle d-inline-block d-lg-none ml-auto" type="button" data-toggle="collapse" data-target="#headernav-links" aria-controls="headernav-links" aria-expanded="false" aria-label="Toggle Menu">
<i class="fa fa-ellipsis-v" aria-hidden="true"></i>
</button>
<div class="collapse navbar-collapse" id="headernav-links">
<ul class="nav navbar-nav ml-auto">
<li class="nav-item">
<a class="nav-link " href="https://nessphp.github.io/">
<i class="fa fa-terminal" aria-hidden="true"></i>
Ness PHP
</a>
</li>
<li class="nav-item">
<a class="nav-link " href="https://github.com/nessphp/application">
<i class="fa fa-github" aria-hidden="true"></i>
GitHub
</a>
</li>
<li class="nav-item">
<a class="nav-link" href="support.html">
<i class="fa fa-heart" aria-hidden="true"></i>
Support
</a>
</li>
</ul>
</div>
</div>
</nav>
<!--Nabvar:end-->
<!-- ========================content:start======================== -->
<div id="holder">
<span class="pageheader">Ness PHP Forms</span>
<br>
<div class="row">
<div class="col-lg-8">
<ul class="hash-toc">
<li><a href="#pagedescription">Form Class</a></li>
<li>Methods
<ol class="hash-toc">
<li><a href="#DefineForm">DefineForm()</a></li>
<li><a href="#setModel">setModel()</a></li>
<li><a href="#setElement">setElement()</a></li>
<li><a href="#FinishForm">FinishForm()</a></li>
<li><a href="#Call">Call()</a></li>
</ol>
</li>
<li><a href="#example">Example</a></li>
<li><a href="#elements">FormElements Class</a></li>
</ul>
</div>
<!--Required Namespace -->
<div class="col-lg-4">
<div class="card bg-dark text-white">
<div class="card-header">Required Namespace</div>
<div class="card-body" >
<ul class="tree">
<li style="color:#28A745;">Ness
<ul>
<li style="color:#fff;">Forms
<ul><li>Form</li></ul>
</li>
</ul>
<ul>
<li style="color:#fff;">Forms
<ul><li>FormElements</li></ul>
</li>
</ul>
</li>
</ul>
<hr>
<span><small>You can include this library to your code file by typing the below code;</small></span>
<br><br>
<span style="color:#3490CF;">use</span>
<span style="color:#28A745;">Ness\Forms</span>\Form
<br><br>
<span style="color:#3490CF;">use</span>
<span style="color:#28A745;">Ness\Forms</span>\FormElements
</div>
</div>
</div>
<!--end: Required Namespace -->
</div>
<br><br>
<!--start: topic-->
<h4 id="pagedescription">About Forms <small><a href="#content">#top</a></small></h4>
<p>
Ness PHP form is used to get data from user and send the data to model or controller. You can simply create forms and attach a model class to that form to manage user input. Form class is generally used in view files to fill a model class with user inputs.
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="defineform">Define A New Form <small><a href="#content">#top</a></small></h4>
<p>
Create a form
<pre><code class="php">
$register-><span class="ug-method">DefineForm</span>(<span class="ug-type">Array</span> $attr = null) : <span class="ug-type">String</span>
</code></pre><br>
<span class="ug-keyword ug-code ug-bold">$attr</span>: Form attributes<br>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="setmodel">Set Model <small><a href="#content">#top</a></small></h4>
<p>
If you did not want to set model in form definition you can set it with this function.
<pre><code class="php">
$register-><span class="ug-method">setModel</span>(<span class="ug-type">String</span> $model = "") : <span class="ug-type">void</span>
</code></pre><br>
<span class="ug-keyword ug-code ug-bold">$model</span>: Model class name
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="setelement">Set Element <small><a href="#content">#top</a></small></h4>
<p>
Add input or other elements to your form
<pre><code class="php">
$register-><span class="ug-method">setElement</span>(<span class="ug-type">String</span> $element = "") : <span class="ug-type">String</span>
</code></pre><br>
<span class="ug-keyword ug-code ug-bold">$element</span>: A form elemnt. You can use <span class="ug-code ug-keyword ug-bold">FormElements Class</span><br>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="finishform">Finish Form <small><a href="#content">#top</a></small></h4>
<p>
All forms started with <span class="ug-method">DefineForm</span> must end with <span class="ug-method">FinishForm</span>
<pre><code class="php">
$register-><span class="ug-method">FinishForm</span>() : <span class="ug-type">String</span>
</code></pre><br>
<span class="ug-keyword ug-code ug-bold">$relatedModel</span>: Model Class Name to manage input<br>
<span class="ug-keyword ug-code ug-bold">$attr</span>: Form attributes<br>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="call">Call a function <small><a href="#content">#top</a></small></h4>
<p>
Call a function in a model after form posted.
<pre><code class="php">
$register-><span class="ug-method">Call</span>(String $functionName) : <span class="ug-type">String</span>
</code></pre><br>
<span class="ug-keyword ug-code ug-bold">$functionName</span>: Name of function in model class to run after form posted.<br>
</p>
<div class="alert alert-warning">
<strong>Warning </strong> Ness PHP framework fills automatically model class variables from form. You need to set
<span class="ug-code ug-bold ug-keyword">name</span> attribute of form, with same name of your variable in model class attached.
</span>
</div>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="example">Example <small><a href="#content">#top</a></small></h4>
<p>
Let's say you need the <span class="ug-code ug-file">username</span>, <span class="ug-code ug-file">email</span> and <span class="ug-code ug-file">password</span> of your user for registration. You need to crate a UserModel and a register form for that. <br> <br>
<b>view\register.php</b>
<br>
<pre><code class="php">
use Ness\UI\Page;
use Ness\Forms\Form;
use Ness\Forms\FormElements;
$view = new Page();
$register = new Form();
$view->SetLayout("master.phtml");
$view->BeginContent();
echo $register->DefineForm(array("class"=>"form-group", "method"=>"POST"));
$register->setModel("UserModel");
echo $register->setElement(FormElements::Label("E-mail", "email"));
echo $register->setElement(FormElements::TextBox("email", array("class"=>"form-control")));
echo $register->setElement(FormElements::Label("Username", "username"));
echo $register->setElement(FormElements::TextBox("username", array("class"=>"form-control")));
echo $register->setElement(FormElements::Label("Password", "password"));
echo $register->setElement(FormElements::Password("password", array("class"=>"form-control")));
echo $register->setElement(FormElements::Submit("UserModel", array("class"=>"btn btn-success")));
$register->Call("SaveUser");
$view->EndContent(); ?>
</code>
</pre>
<b>model\UserModel.php</b>
<br>
<pre><code class="php">
use Ness\Autopulse\Autopulse;
use Ness\Autopulse\MySqlConnect;
class UserModel
{
public $username;
public $email;
public $password;
public function SaveUser()
{
$con = new mysqlconnect("localhost","root","","papp");
$myUser = array("username" => $this->username,
"email"=> $this->email,
"password"=> $this->password);
if(Autopulse::LoadArray("users",$myUser,$con->Source()))
{
echo "< h1> User Registration Completed </ h1>";
}else{
echo "< h1> User Registration ERROR </ h1>";
}
}
</code>
</pre>
<b>Result: </b>
<img src="../assets/images/frm-result0.png" style="width: 100%;" >
</p>
<br>
<!--end: topic-->
<!-- ==================================FORM ELEMENTS ==========================-->
<h2 id="elements">FormElements Class </h2>
<p>
<br>
<h4>TextBox()</h4>
Create TextBox input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::TextBox (<span class="ug-type">String </span>$fieldName,<span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code></pre>
</p>
<h4>FileUpload()</h4>
Create Submit input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::FileUpload (<span class="ug-type">String </span>$fieldName,<span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code></pre>
</p>
<h4>Password()</h4>
Create Password input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::Password (<span class="ug-type">String </span>$fieldName,<span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code></pre>
</p>
<h4>Submit()</h4>
Create Submit input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::Submit (<span class="ug-type">String </span>$fieldName,<span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code></pre>
</p>
<h4>Reset()</h4>
Create Reset input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::Reset (<span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code></pre>
</p>
<h4>Radio()</h4>
Create Radio input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::Radio (<span class="ug-type">String </span>$fieldName, <span class="ug-type">String </span>$value, <span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code></pre>
</p>
<h4>Checkbox()</h4>
Create Checkbox input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::Checkbox (<span class="ug-type">String </span>$fieldName, <span class="ug-type">String </span>$value, <span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code></pre>
</p>
<h4>Button()</h4>
Create Button input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::Button (<span class="ug-type">String </span>$fieldName, <span class="ug-type">String </span>$value, <span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code></pre>
</p>
<h4>ColorDialog()</h4>
Create ColorDialog input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::ColorDialog (<span class="ug-type">String </span>$fieldName,<span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code></pre>
</p>
<h4>DateSelect()</h4>
Create DateSelect input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::DateSelect (<span class="ug-type">String </span>$fieldName,<span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code></pre>
</p>
<h4>Email()</h4>
Create Email input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::Email (<span class="ug-type">String </span>$fieldName,<span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code></pre>
</p>
<h4>Month()</h4>
Create Month input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::Month (<span class="ug-type">String </span>$fieldName,<span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code></pre>
</p>
<h4>Numeric()</h4>
Create Numeric input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::Numeric (<span class="ug-type">String </span>$fieldName,<span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code></pre>
</p>
<h4>SearchBox()</h4>
Create Email input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::SearchBox (<span class="ug-type">String </span>$fieldName,<span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code></pre>
</p>
<h4>Phone()</h4>
Create Phone input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::Phone (<span class="ug-type">String </span>$fieldName,<span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code> </pre>
</p>
<h4>Url()</h4>
Create Url input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::Url (<span class="ug-type">String </span>$fieldName,<span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code></pre>
</p>
<h4>Time()</h4>
Create Time input element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::Time (<span class="ug-type">String </span>$fieldName,<span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code> </pre>
</p>
<h4>Label()</h4>
Create Label element in your form.
<pre><code class="php">
<span class="badge badge-light">FormElements</span>::Label (<span class="ug-type">String </span>$text,<span class="ug-type">String </span>$labelFor ,<span class="ug-type">Array </span>$attrb ) : <span class="ug-type">String </span>
</code> </pre>
</p>
<br><br><br>
<h2 id="csrf_protection">CSRF Protection</h2>
<p>
For enabling csrf protection on your forms please add csrfField tag to your form. Below is a example for using a csrf protection field in your form.
<br>
<b>view\Register.php</b>
<pre><code class="php">
<b>Usage</b> <br>
<span class="badge badge-light">FormElements</span>::csrfField() : <span class="ug-type">String </span>
<br><br>
<b>Example</b><br>
//------------------------------------------------------------------------ <br>
use Ness\UI\Page;
use Ness\Url as pUrl;
use Ness\Forms\Form;
use Ness\Forms\FormElements;
$view = new Page();
$view->SetLayout("master.php");
$view->SetParameter("pageHeader", "TEST PAGE");
$view->BeginContent();
#-------------------------------------------------------------------------------
echo "User Login";
$frm = new Form("register");
echo $frm->DefineForm(array("method"=>"POST"));
$frm->SetModel("userModel");
$frm->Call("btnClick_Register");
<b>echo $frm->setElement(FormElements::csrfField());</b>
echo $frm->setElement(FormElements::TextBox("username", array("class"=>"form-control", "placeholder"=>"Username")));
echo $frm->setElement(FormElements::Password("pwd", array("class"=>"form-control", "placeholder"=>"****")));
echo $frm->FinishForm();
#-------------------------------------------------------------------------------
$view->EndContent();
</code>
</pre>
</p>
<br><br><br>
<h2 id="xss_protection">XSS Protection</h2>
<p>
You can use setProtected(true) function for enabling or disabling XSS protection enabled, by default it is enabled.
<pre><code class="php">
$frm = new Form("testform");<br>
...<br>
..<br>
.<br>
<b style="color:#3490CF;">$frm->setProtected($status);</b></code>
</pre>
<span class="badge badge-light">$status</span> TRUE | FALSE
<br><br><br>
<b>Example use in forms</b>
<br>
<b>view\Register.php</b>
<pre><code class="php">
use Ness\UI\Page;
use Ness\Url as pUrl;
use Ness\Forms\Form;
use Ness\Forms\FormElements;
$view = new Page();
$view->SetLayout("master.php");
$view->SetParameter("pageHeader", "TEST PAGE");
$view->BeginContent();
#-------------------------------------------------------------------------------
echo "User Login";
$frm = new Form("register");
echo $frm->DefineForm(array("method"=>"POST"));
$frm->SetModel("userModel");
<b style="color:#3490CF;">$frm->setProtected(TRUE); </b>// $frm->setProtected(FALSE);
$frm->Call("btnClick_Register");
<b style="color:#3490CF;">echo $frm->setElement(FormElements::csrfField());</b>
echo $frm->setElement(FormElements::TextBox("username", array("class"=>"form-control", "placeholder"=>"Username")));
echo $frm->setElement(FormElements::Password("pwd", array("class"=>"form-control", "placeholder"=>"****")));
echo $frm->FinishForm();
#-------------------------------------------------------------------------------
$view->EndContent();
</code>
</pre>
</p>
</div>
<!-- ========================content:end======================== -->
</div>
</div>
<script src="assets/js/bootstrap.min.js"></script>
<script src="assets/js/nessphp.js"></script>
<script src="assets/js/highlightjs/highlight.pack.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</body>
</html>