-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathredirections.html
441 lines (368 loc) · 21.6 KB
/
redirections.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
<!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">Generate Url & Redirection</span>
<br>
<div class="row">
<div class="col-lg-8">
<ul class="hash-toc">
<li>Contents
<ul>
<li><a href="#about">About Url Class</a></li>
<li><a href="#redirect">Redirect to Controller</a></li>
<li><a href="#area">Create Area</a></li>
<li><a href="#methods">Other Methods</a></li>
</ul>
</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;">Url
<!-- <ul><li>Library</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</span>\Url
</div>
</div>
</div>
<!--end: Required Namespace -->
</div>
<br><br>
<!--start: topic-->
<h4 id="about">About Url Class <small><a href="#content">#top</a></small></h4>
<p>
Ness PHP uses controllers to map your routes. You does not require to specify routes when you are codding your page relationships. You can read <a href="structure.html#url">URL Structure</a> of Ness PHP before reading and trying redirections.
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="redirect">Redirect to Controller's Action <small><a href="#content">#top</a></small></h4>
<p>
Let's say you are developing a blog application and you have two controllers a postController and authController with actions;
<ol style="list-style-type: circle;">
<li>postController
<ol style="list-style-type:disc;">
<li>indexAction: List all posts</li>
<li>viewAction: View a selected post</li>
<li>editAction: Edit the selected post</li>
</ol>
</li>
<br>
<li>authController
<ol style="list-style-type:disc;">
<li>indexAction: Login page</li>
<li>loginAction: Same with indexAction (just call $this->indexAction(); from this action</li>
<li>logoutAction: Sign out action</li>
<li>registerAction: Create a new user account</li>
</ol>
</li>
</ol>
<br>
For the structure above your controllers should look like;
<br>
<pre><code class="php">
class postController extends Ness\Controller{
public function indexAction(){
//Your codes here
}
public function viewAction($id = 1){
//Your codes here
}
public function editAction($id = 0){
//your codes here
}
}
</code></pre>
<br><br>
<pre><code class="php">
class authController extends Ness\Controller{
public function indexAction(){
//Your codes here
}
public function loginAction(){
//Your codes here
}
public function logoutAction(){
//your codes here
}
public function registerAction($type = 'admin'){
if($type == 'admin'){
//Admin registration
}else {
//Member Registration
}
}
}
</code></pre>
<br><br>
For these two classes above generatable urls should be;
<ol style="list-style-type: circle;">
<li>postController
<ol style="list-style-type:disc;">
<li>http://examplesite.com/post/ <small>Because there is an indexAction</small></li>
<li>http://examplesite.com/post/index</li>
<li>http://examplesite.com/post/view/ID</li>
<li>http://examplesite.com/post/edit/ID</li>
</ol>
</li>
<br>
<li>authController
<ol style="list-style-type:disc;">
<li>http://examplesite.com/auth</li>
<li>http://examplesite.com/auth/index</li>
<li>http://examplesite.com/auth/login</li>
<li>http://examplesite.com/auth/logout</li>
<li>http://examplesite.com/auth/register/{PARAMETER}</li>
</ol>
</li>
</ol>
Let's say you want to generate an url for post controller's viewAction and with post ID 4785;<br>
<pre>
<code class="php">Url::RedirectToAction("post", "view", "4785");</code>
</pre>
This code line will return a string (which you can use it with html's a tag); http://examplesite.com/post/view/4785
<br><br><br>
<h5>Method Explained</h5>
<pre>
<code class="php">Url::RedirectToAction($controller_name, $action_name, $parameter_if_available);</code>
</pre>
<table class="code-desc">
<tr>
<td colspan="3">This function returns a redirectable url from your controllers's actions. For example you can use this with html's a tags href attribute.</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">String </td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$controller_name String; Cotroller name with out 'Controller' suffix<br>
$action_name String; Action name with out 'Action' suffix<br>
$parameter_if_available String; If action method contains a parameter you can set a parameter here. [Note]: if actionnameAction does not contains a parameter you should not set this.</td>
</tr>
</table><br>
<div class="alert alert-warning">
<strong>Recommendation</strong> Ness PHP recommends you to create always Actions with parameters. With default value Even if you won't use it.
</div>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="area">Create & Divide Projects <small><a href="#content">#top</a></small></h4>
<p>
Ness PHP supports creating areas by adding a sub-folder to 'Controller' directory. You can create new folders in Controller directory to divide big projects and get rid of the complexity.
<br><br>
Let's say you are developing a project with backend and you need to separate admin area from member area. Create a folder in Controller path called 'adminArea'.You can create now unlimited controllers in adminArea to manage your url's, codes and logic.
<div class="alert alert-warning">
<strong>Area Suffix</strong> Do not forget to add Area suffix to your folders. Ness PHP looks for 'Area' suffix to undertand that folder is area and should make redirections to controllers in that folder.
</div>
<br><br><br>
<h5>Method Explained for Area Redirections</h5>
<pre>
<code class="php">Url::RedirectToArea($area ,$controller_name, $action_name, $parameter_if_available);</code>
</pre>
<table class="code-desc">
<tr>
<td colspan="3">This function returns a redirectable url from your controllers's actions in an Area. For example you can use this with html's a tags href attribute.</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">String </td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$area String; Area name without 'Area' suffix
$controller_name String; Cotroller name with out 'Controller' suffix<br>
$action_name String; Action name with out 'Action' suffix<br>
$parameter_if_available String; If action method contains a parameter you can set a parameter here. [Note]: if actionnameAction does not contains a parameter you should not set this.</td>
</tr>
</table><br>
<br><br>
Here is an example for creating a redirectable url in adminArea->userController->editAction->userid=4758
<pre>
<code class="php">Url::RedirectToArea('admin', 'user', 'edit', '4758');</code>
</pre>
This will return: http://mysite.com/user/edit/4758?p=admin
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="methods">Other Methods Available <small><a href="#content">#top</a></small></h4>
<p>
Url class contains some more methods which can be useful in your projects. Here is a short description about that commands.
<br><br><br>
<h5>getArea</h5>
<pre>
<code class="php">Url::getArea();</code>
</pre>
<table class="code-desc">
<tr>
<td colspan="3">Get area data from url.</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">String</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">None</td>
</tr>
</table>
<br><br><br>
<h5>Redirect</h5>
<pre>
<code class="php">Url::Redirect($url, $sec);</code>
</pre>
<table class="code-desc">
<tr>
<td colspan="3">Redirect directly.</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">Request</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$url String; Url to get redirected<br>
$sec Integer; seconds to wait before redirection</td>
</tr>
</table>
<br><br><br>
<h5>getUrl</h5>
<pre>
<code class="php">Url::getUrl();</code>
</pre>
<table class="code-desc">
<tr>
<td colspan="3">Get the current url</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">String</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">None</td>
</tr>
</table>
<br><br><br>
<h5>getData</h5>
<pre>
<code class="php">Url::getData(String $id);</code>
</pre>
<table class="code-desc">
<tr>
<td colspan="3">Get the data from parameter in url.</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">String</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$id String; parameter to get data from. for example; www.mysite.com/users/edit/4758?p=admin&option=delete <br><br>
if you call the Url::getData("option"); that will return 'delete'.
</td>
</tr>
</table>
</p>
<br>
<!--end: topic-->
</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>