-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathcontrollers.html
More file actions
334 lines (280 loc) · 15.6 KB
/
controllers.html
File metadata and controls
334 lines (280 loc) · 15.6 KB
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
<!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">Controllers</span>
<br>
<div class="row">
<div class="col-lg-8">
<ul class="hash-toc">
<li>Contents
<ul>
<li><a href="#about">About Controllers</a></li>
<li><a href="#default">Default Controller</a></li>
<li><a href="#example">Example Controller</a></li>
<li><a href="#owning">Owning & Versioning a Controller</a></li>
<li><a href="#methods">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;">Controller
<!-- <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>\Controller
</div>
</div>
</div>
<!--end: Required Namespace -->
</div>
<br><br>
<!--start: topic-->
<h4 id="about">About Controllers <small><a href="#content">#top</a></small></h4>
<p>
A controller is a class which responds to http requests. All your controller class files must be located in controller folder and must contain a Controller suffix. You can read more about directory structure <a href="structure.html">Here</a>.
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="default">Default Controller <small><a href="#content">#top</a></small></h4>
<p>
By default in controller folder there is a indexController.php file. This is the default controller class for Ness PHP. The core framework file (Ness\system\boot.php) looks in controller folder and search's indexController.php file with a class named indexController and public function IndexAction if not specified in url.
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="example">Example Controller <small><a href="#content">#top</a></small></h4>
<p>
<pre><code class="php">
class AuthController extends Ness\Controller
{
public function indexAction($param=0)
{
$this->View->Render("startpage.php");
}
}
</code></pre>
Save this file to project_name\Application\Controller\AuthController .php Now when you navigate to : http://localhost/project_name/auth/index or http://localhost/project_name/auth you will see the startpage.php view run.
<div class="alert alert-warning">
<strong>Controller File Names: </strong>Class name must be same with the file name in controller file. In this example you can see that Controller/AuthController.php has the class AuthController.
</div>
<br>
<div class="alert alert-warning">
<strong>Action Suffix: </strong> All functions considered to use as action in controller must be public and must have the Action suffix. For example in the code above you can see that index action is called indexAction (but in url is only; index) and it is public function.
</div>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="owning">Owning & Versioning a Controller <small><a href="#content">#top</a></small></h4>
<p>
If your team works on a big project you can use some commands to own and version the controller. This will make easy to the project leader to track which developer is developed the controller/area and whats is the version number of the controller.
<pre><code class="php">$this->setVersion(integer $prm);</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">Call this method in __construct for setting a version number to your controller</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">void</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$prm integer; Version Number.</td>
</tr>
</table>
<br>
You can use the command below for getting the version number of controller.
<br><br>
<pre><code class="php">$this->getVersion();</code></pre>
<table class="code-desc">
<tr>
<td>Return</td>
<td colspan="2">Integer</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">None</td>
</tr>
</table>
<br><br>
For using version information of your controller in another controller class just create an instance of controller and call getVersion() function.
<br><br><br>
For setting an author for your controller.<br>
<pre><code class="php">$this->setAuthor(string $prm);</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">Call this method in __construct for setting an author to your controller</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">void</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$prm string; Author name.</td>
</tr>
</table>
<br><br>
You can use the command below for getting the author name;<br>
<pre><code class="php">$this->getAuthor();</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">Call this method for getting the author name</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">String</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">None</td>
</tr>
</table>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="methods">Methods <small><a href="#content">#top</a></small></h4>
<p>
<h5>Public Methods</h5>
<p>
If you want to declare a action result to controller your function must have the <span class="ug-code ug-method">Action</span> suffix.Other functions not considered to be used as actions, can be defined as private methods.
</p>
<br><br><br>
<h5>Private Methods</h5>
<p>
Private methods can be defined and used in controllers.
<pre><code class="php">
public function ResetAction()
{
if($this->check())
{
$this->View->Render("Auth/Reset_Password.phtml");
}
echo "Hello World";
}
private function check(&$param)
{
if(!$param== 1){
return false;
}else {return true;}
}
</code></pre>
</p>
<br><br><br>
<h5>Constructor</h5>
<p>
You can define your own constructors in controllers, here is an example.
<pre><code class="php">
function __construct()
{
parent::__construct();
//other constructor code here;
//load libraries;
//etc;
}
</code></pre>
</p>
</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>