-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathcontentmanager.html
387 lines (316 loc) · 19.9 KB
/
contentmanager.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
<!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 Content Management</span>
<br>
<div class="row">
<div class="col-lg-8">
<ul class="hash-toc">
<li>Contents
<ul>
<li><a href="#about">About Content Manager</a></li>
<li><a href="#directories">Directories for Contents</a></li>
<li><a href="#diffrence">Diffrences Between Resources & Content Manager</a></li>
<li><a href="#methods">Methods</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;">ContentManager
<!--<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>\ContentManager
</div>
</div>
</div>
<!--end: Required Namespace -->
</div>
<br><br>
<!--start: topic-->
<h4 id="about" >About Content Manager Class <small><a href="#content">#top</a></small></h4>
<p>
Ness PHP contains a class for managing contents of your application easily. using this class you can access different contents from anywhere in your code. For example you are designing a master page and you need to include style sheets and javascript in your page, you can copy the related css and js file in the Content directory and access them easily with just a single line. Content Manager class will help you the problem with relative file paths. Please continue reading this page to get more information about Content Manager class and methods available in Content Manager class.
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="directories">Directories for Contents <small><a href="#content">#top</a></small></h4>
<p>
Content folder can be found in [project_dir]/Application/ path. You can realise there is folder called 'Content' in main 'Application' directory with few sub directories. This sub directories will help you split the files from each other and get rid of the complexity.
<br><br>
Here is a short description for each sub folder in 'Content' directory;<br>
<br><br>
<span class="badge badge-dark">css:</span> This folder is preset for holding your style sheets. You can add all your .css file in that folder. Also you can create subfolders for multiple css files like bootstrap etc.<br><br>
<span class="badge badge-dark">img:</span> You can import all your project's image assets here like logo, headers etc for using later.<br><br>
<span class="badge badge-dark">js:</span> js path is present to store all your javascript code files, like in css path you can create sub-folders.<br><br>
<span class="badge badge-dark">uploads:</span> This folder is created for generating a valid upload path. You can use this with Forms/FileUpload class.<br><br>
<span class="badge badge-dark">widget:</span> Import various html or php code snippets from this path easily.<br><br>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="diffrence">Diffrences Between Resources & Content Manager <small><a href="#content">#top</a></small></h4>
<p>
Ness PHP contains two different libraries for content management. One of them is the Resource class which is described in previous topics and the other one is ContentManager class which is described and tutoried in this page.
<br><br>
These two libraries may look same in logic but there are some diffences in usage. For example Resource class (which is described previously) is designed to use and fit with string values, and the content manager class is more suitable to use with project assets like css,js, headers, logos etc.
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="methods">Available Methods <small><a href="#content">#top</a></small></h4>
<p>
<h5>getImage</h5>
<pre><code class="php">ContentManager::getImage(string $filename);</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">This function returns the filename from the path {Application}\Content\img\{$filename}</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">String</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$filename String; Filename of the img file.</td>
</tr>
</table>
<br><br><br>
<h5>getStyleSheet</h5>
<pre><code class="php">ContentManager::getStyleSheet(string $filename);</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">This function returns the filename from the path {Application}\Content\css\{$filename}</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">String</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$filename String; Filename of the css file.</td>
</tr>
</table>
<br><br><br>
<h5>getJavaScript</h5>
<pre><code class="php">ContentManager::getJavaScript(string $filename);</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">This function returns the filename from the path {Application}\Content\js\{$filename}</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">String</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$filename String; Filename of the js file.</td>
</tr>
</table>
<br><br><br>
<h5>getWidget</h5>
<pre><code class="php">ContentManager::getWidget(string $filename);</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">This function returns the filename from the path {Application}\Content\widget\{$filename}</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">String</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$filename String; Filename of the html/php file.</td>
</tr>
</table>
<br><br><br>
<h5>getFilePath</h5>
<pre><code class="php">ContentManager::getFilePath(string $filename);</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">This function returns the filename from the path {Application}\Content\{$filename}</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">String</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$filename String; Filename from the 'Content' folder. You can create own sub folders and use this function to include that file.</td>
</tr>
</table>
<br><br><br>
<h5>getUploadPath</h5>
<pre><code class="php">ContentManager::getUploadPath(string $filename);</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">This function returns the filename from/in the path {Application}\Content\uploads\{$filename}</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">String</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$filename String; Specified file name for new update to put in uploads path.</td>
</tr>
</table>
<br><br>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="example">Example Usage of Content Manager <small><a href="#content">#top</a></small></h4>
<p>
Assume that we are creating a master page in 'Template' folder and we have theese files; <br>
<ul>
<li>style.css</li>
<li>bootstrap</li>
<li>loader.js</li>
<li>weather.php</li>
</ul>
we need to put files in the following folders;<br>
<span class="ug-code ug-method">style.css</span> ----> css/style.css <br><br>
<span class="ug-code ug-method">bootstrap</span> ----> css/bootstrap/*.css <br><br>
<span class="ug-code ug-method">loader.js</span> ----> js/loader.js <br><br>
<span class="ug-code ug-method">weather.php</span> ----> widget/weather.php <br><br>
<br><br>
and write the following code lines in the Template/master_page.php;<br>
<pre><code class="html">
<?php
	//Our master page to use later with view files in view inheritance.
	use Ness\ContentManager as cm;
?>
<!DOCTYPE html>
<html>
<head>
	<title>New Application | Ness PHP</title>
	<meta charset="UTF-8">
	<meta name="viewport" content="width=device-width, initial-scale=1.0">
	<link rel="stylesheet" type="text/css" href="<?= cm::getStyleSheet("style.css") ?>">
	<link rel="stylesheet" type="text/css" href="<?= cm::getStyleSheet("bootstrap".'/'."bootstrap.min.css")?>">
	<script src="<?= cm::getJavaScript("loader.js")?>"></script>
</head>
<body>
<!--WEATHER WIDGET GET FROM THE WIDGET FOLDER-->
<div class="weather">
	<?php
		$filename = cm::getWidget("weather.php");
		include_once $filename;
	?>
</div>
<?php
	/**
	 * This line below must me available in all your master pages.
	 * echo $this->contents; means your content place holder. Your data in
	 * views will be loaded here.
	 */
	echo $this->contents;
?>
</body>
</html>
</code></pre>
</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>