-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathresources.html
More file actions
401 lines (328 loc) · 19.3 KB
/
resources.html
File metadata and controls
401 lines (328 loc) · 19.3 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
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
<!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 Resource Management</span>
<br>
<div class="row">
<div class="col-lg-8">
<ul class="hash-toc">
<li>Contents
<ul>
<li><a href="#about">About Resource Management</a></li>
<li><a href="#enable">Enable Resources</a></li>
<li><a href="#types">Resource Types</a></li>
<li><a href="#methods">Methods</a></li>
<li><a href="#example">Example</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;">Resources
<!--<ul><li>DataSize</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>\Resources
</div>
</div>
</div>
<!--end: Required Namespace -->
</div>
<br><br>
<!--start: topic-->
<h4 id="about">About Resource Management Class <small><a href="#content">#top</a></small></h4>
<p>
Ness PHP Framework contains a resource class which is designed to help you to manage your static values. You can define two type of resource in the current version of Ness.
<br><br>
A string resource provides you an external file to get static string values which can be Application name, address lines, color codes or any other static data.
<br><br>
Image resources provides you an external xml file to store local or remote images with width and height attributes also base64 values, so you can include images to your html with a single line.
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="enable">Enable Resources <small><a href="#content">#top</a></small></h4>
<p>
Please follow this simple instructions to start using Resource helper class in your projects.
<br>
<ol>
<li>Create a resource file in your project root or anywhere else in your project's application path. There is also a default empty resource file available called 'resources.xml'. Please do not forget you must define a valid xml file to define your resource values.</li>
<li>Define a new string/image value your xml resource file.</li>
<li>Include Resource class in your code file and start using resources.</li>
</ol>
</p>
<br><br>
<h4 id="types">Resource Types & Resource Definitions <small><a href="#content">#top</a></small></h4>
<p>
Here is a short description & example for using Resource class and defining a new resource in your projects.
<br><br><br>
<h5>String Resources</h5>
<pre><code class="xml">
<?xml version="1.0" encoding="utf-8"?>
<resources>
<string id="appname">Empty Ness Application</string>
<string id="version">1.0</string>
<string id="author">Sinan SALIH</string>
<string id="message1">Good Morning User</string>
</resources>
</code></pre>
<br><br><br>
<h5>Image Resources</h5>
<pre><code class="xml">
<?xml version="1.0" encoding="utf-8"?>
<resources>
<image id="myimge" width="48" height="48">C:\Users\Images\image1.png</image>
<image id="myimge2" width="48">data:image/jpeg;base64,/9j/4AAQSkZJ........</image>
<image id="myimge3">https://www.site.com/images/image.jpg</image>
<string id="appname">Empty Ness Application</string>
<string id="version">1.0</string>
<string id="author">Sinan SALIH</string>
<string id="message1">Good Morning User</string>
</resources>
</code></pre>
<br><br>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="methods">Methods <small><a href="#content">#top</a></small></h4>
<p>
<h5>Get String</h5>
<pre><code class="php">Resources::String->get(string $prm1);</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">Get a string value from xml</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">String</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$prm1 String; id in xml file for string tag</td>
</tr>
</table>
<br><br><br>
<h5>Get Image</h5>
<pre><code class="php">Resources::Image->get(string $prm1);</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">Get a Image with ready to use html img tag.</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">String / Image(img) tag for html views.</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$prm1 String; id in xml file for image tag</td>
</tr>
</table>
<br><br><br>
<h5>Get Image Value</h5>
<pre><code class="php">Resources::Image->getValue(string $prm1);</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">Get a value set in image tag. This method can be used for getting paths and a image object.</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">String</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$prm1 String; id in xml file for image tag</td>
</tr>
</table>
<br><br>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="example">A Simple Example for Resource Class <small><a href="#content">#top</a></small></h4>
<p>
Here is a short example to show how to use your resources in php code.
<br>
<h5>Get String values from xml</h5>
Assume that we need to get a greeting message from the xml file. Lets create a xml resource file;
Create the following file:<br><br>
<span class="ug-code ug-method">[project_root]/Application/Resources.xml</span>
and define your values in the xml file; <br><br>
<pre><code class="xml">
<?xml version="1.0" encoding="utf-8"?>
<resources>
<string id="msg1">Hello Welcome to my new Ness PHP Project</string>
<string id="author_name">Sinan SALIH </string>
<string id="style_red_color"> style="color:red;" </string>
</resources>
</code></pre>
<br><br>
Now we need to check app_config.php file if the Resource.xml is defined.
<br>
<pre><code class="php">
/*
* === [Application Resource Files ] ===
* This function is used to set the
* path of the resource.xml file which is used
* to store static values for your projects(ex; strings, image paths etc)
* Note; the core app location ('Application' by default) is excluded from the value.
*/
Configuration::setResourceFile('Resources.xml');
</code></pre>
find the lines above and check if the filename of resource file is true.
<br><br>
Thats All. Now we can start using resources in our codes. Lets create an action in index
controller to show the message from xml file;<br><br>
<pre><code class="php">
<?php
use Ness\Controller as myController;
use Ness\Resources;
class indexController extends myController
{
public function indexAction($param = 0)
{
echo Resources::String()->get("msg1")." by ". Resources::String()->get("author_name");
}
}
</code></pre><br>
Result:<br>
<code>Hello Welcome to my new Ness PHP Project by Sinan SALIH</code>
<br><br><br>
<h5>Get Images & Image Values from xml</h5>
Follow the steps above to create a xml file and check the app_config.php file for the Resource file path.
<br><br>
Add image values to resource file;<br>
<pre><code class="xml">
<?xml version="1.0" encoding="utf-8"?>
<resources>
<image id="fw_logo">https://github.com/nessphp/framework/blob/master/Application/Content/img/ness_logo_rounded.png?raw=true</image>
<image id="fw_logo_small" width="48" height="48">https://github.com/nessphp/framework/blob/master/Application/Content/img/ness_logo_rounded.png?raw=true</image>
</resources>
</code></pre>
<br><br>
Assume that we have a view called startpage.php and want to show the image set above;<br><br>
<pre><code class="php">
<?php
use Ness\Resources;
$page = new Ness\UI\Page();
$page->setLayout('master_page.php');
$page->BeginContent();
?>
<!-- PAGE CONTENT STARTS -->
<h5>Original Image Get From Xml</h5>
<?= Resources::Image()->get("fw_logo");?>
<hr>
<h5>Get Image With Properties</h5>
<?= Resources::Image()->get("fw_logo_small")?>
<hr>
<h5>Image Value Get From Xml</h5>
<img src="<?= Resources::Image()->getValue("fw_logo");?>" height="48" width="48">
<!-- PAGE CONTENT ENDS -->
<?php
$page->EndContent();
?>
</code></pre>
<br><br>
Result:
<img src="assets/img/resource_example.PNG" class="code-desc"/>
</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>