-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathviews.html
296 lines (248 loc) · 14 KB
/
views.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
<!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">Views</span>
<br>
<div class="row">
<div class="col-lg-8">
<ul class="hash-toc">
<li>Contents
<ul>
<li><a href="#about">About Views</a></li>
<li><a href="#render">Render View</a></li>
<li><a href="#render-content">Render Content</a></li>
<li><a href="#isavailable">Check if a View is Available</a></li>
<li><a href="#datatransfer">Transfer Values Between Controller/View</a></li>
<li><a href="#example">Examples</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;">System
<ul><li>View</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\System</span>\View
</div>
</div>
</div>
<!--end: Required Namespace -->
</div>
<br><br>
<!--start: topic-->
<h4 id="about">About Views <small><a href="#content">#top</a></small></h4>
<p>
Views are html pages that can be loaded by a controller, you can not directly redirect your application to a view file. Ness PHP stores view files in a folder called 'View'. You can create sub folders in view folder if you want to seperate parts of your application.
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="render">Render a View <small><a href="#content">#top</a></small></h4>
<p>
Render command can be used to create a view from php view file and load to browser screen.
<pre><code class="php">$this->View->Render(string $prm_file,boolean $isusual = true);</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">Return a view to user.</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">Object</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$prm_file String; View's file name which is located in 'View' path<br>
$isusual Boolean; *optional. If your view is not located in 'View' directory. </td>
</tr>
</table><br>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="render-content">Render Content <small><a href="#content">#top</a></small></h4>
<p>
Render command can be also used for rendering string messages to browser screen.
<pre><code class="php">$this->Content->Render(string $prm);</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">Return a view to user.</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">Object</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$prm String; Value to print</td>
</tr>
</table><br>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="isavailable">Check if a View is Available <small><a href="#content">#top</a></small></h4>
<p>
This command is used to check if a view file is available, returns true if file is found.
<pre><code class="php">$this->View->isAvailable(string $prm_file,boolean $isusual = true);</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">Check if view file is available</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">Boolean</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$prm_file String; View's file name which is located in 'View' path<br>
$isusual Boolean; *optional. If your view is not located in 'View' directory. </td>
</tr>
</table><br><br><br>
</p>
<!--end: topic-->
<!--start: topic-->
<h4 id="datatransfer">Transfer Values Between Controller/View <small><a href="#content">#top</a></small></h4>
<p>
Let's say you have a indexController.php controller in your controller directory, and you want to set a variable in your view file. There is lots of methods to do that like ObjectMapper of Ness framework, but in classic way you need to define a variable in your view file;
<pre><code class="php">
...HTML CODES
<?= $this->sayhello; ?>
...HTML CODES
</code></pre>
And in your controller;
<pre><code class="php">
class indexController extends Ness\Controller{
public function IndexAction($param=0)
{
$this->View->sayhello = "Hello World :)";
$this->View->Render("test.php");
}
}
</code></pre>
</p>
<!--end: topic-->
<!--start: topic-->
<h4 id="example">Examples <small><a href="#content">#top</a></small></h4>
<p>
<b>Check if View file is available</b><br>
<pre><code class="php">$this->View->isAvailable("home\index.php");</code></pre>
will look for Application/View/home/index.php
<br>
<br><br>
<b>Check if view file is anywhere else</b><br>
<pre><code class="php">$this->View->isAvailable("test_folder\index.php", false);</code></pre>
will look for Application/test_folder/index.php
<br>
<br>
<br><br>
<b>Load if view exists</b><br>
<pre><code class="php">
if($this->View->isAvailable("home/home.php"))
{
$this->View->Render("home/home.php");
}else{
$this->Content->Render("View Not Found");
}
</code></pre>
<br>
</p>
<!--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>