-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathdbconnect.html
More file actions
497 lines (415 loc) · 22.4 KB
/
dbconnect.html
File metadata and controls
497 lines (415 loc) · 22.4 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
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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
<!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">Connecting & Using Other Databases</span>
<br>
<div class="row">
<div class="col-lg-8">
<ul class="hash-toc">
<li>Contents
<ul>
<li><a href="#dbconnect">dbConnect</a></li>
<li><a href="#dbcommand">dbCommand</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;">Autopulse
<ul><li>dbConnect</li></ul>
</li>
</ul>
</li>
<li style="color:#28A745;">Ness
<ul>
<li style="color:#fff;">Autopulse
<ul><li>dbCommand</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\Autopulse</span>\dbConnect
<br><br>
<span style="color:#3490CF;">use</span>
<span style="color:#28A745;">Ness\Autopulse</span>\dbCommand
</div>
</div>
</div>
<!--end: Required Namespace -->
</div>
<br><br>
<!--start: topic-->
<h4 id="dbconnect">dbConnect Class <small><a href="#content">#top</a></small></h4>
<p>
<h5 id="create-connection">Create a Connection</h5>
<p>
You can create your connection in construct when you define your database variable.
<pre>
<code class="php">$connection = new dbConnect($host, $user, $pass, $db, $options);</code>
</pre>
<table class="code-desc">
<tr>
<td colspan="3">Create a new connection</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">Object</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$host String; Connection Host<br>
$user String; Username of connection<br>
$pass String; Password for connection<br>
$db String; Database name<br>
$options Array <i>Optional</i>;PHP PDO Options</td>
</tr>
</table><br><br><br>
</p>
<br><br><br>
<!---->
<h5 id="connection-source">Connection Source</h5>
<p>
This function is used to return an active database connection.
<pre>
<code class="php">$connection->Source();</code>
</pre>
<table class="code-desc">
<tr>
<td colspan="3">Get an active connection for using with dbConnect class.</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">PDO Connection</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">None</td>
</tr>
</table><br><br><br>
<!---->
<h5 id="connection-check">Check Connection</h5>
<p>
Check if connection is available
<pre>
<code class="php">$connection->isConnected();</code>
</pre>
<table class="code-desc">
<tr>
<td colspan="3">Check for active connection</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">Boolean</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">None</td>
</tr>
</table><br><br><br>
</p>
<br><br><br>
<!---->
<h5 id="connection-errors">Error List</h5>
<p>
Show last connection errors.
<pre>
<code class="php">$connection->lastError();</code>
</pre>
<table class="code-desc">
<tr>
<td colspan="3">Check for last connection error</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>
</p>
<br><br><br>
<!---->
<h5 id="connection-open">Reconnect to Database</h5>
<p>
Reconnect to active database.
<pre>
<code class="php">$connection->Connection($host, $user, $pass, $db, $options);</code>
</pre>
<table class="code-desc">
<tr>
<td colspan="3">Create a new connection</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">Object</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$host String; Connection Host<br>
$user String; Username of connection<br>
$pass String; Password for connection<br>
$db String; Database name<br>
$options Array <i>Optional</i>;PHP PDO Options</td>
</tr>
</table><br><br><br>
</p>
<br><br><br>
<!---->
<h5 id="connection-close">Close an Active COnnection</h5>
<p>
Close connection to active database.
<pre>
<code class="php">$connection->Close();</code>
</pre>
<table class="code-desc">
<tr>
<td colspan="3">Close a connection</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">Boolean</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">None</td>
</tr>
</table><br><br><br>
</p>
<br><br><br>
</p>
<br><br>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="dbcommand">dbCommand Class <small><a href="#content">#top</a></small></h4>
<p>
<!---->
<h5 id="create-command">Create Command</h5>
<pre><code class="php">$cmd = new dbCommand(String $command, dbConnect | MySqlConnect $source);</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">You need create an instance of dbCommand library for your commands. You can define your command when creating a dbCommand instance</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">Command Object</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$command String; Command to run <br> $source Connection Source; MySqlConnect or dbConnect connection source; ex: $connection->Source();</td>
</tr>
</table><br>
<b>Example: <br></b>
<pre>
<code class="php">$cmd = new dbCommand("select * from db", $mysqlconnection->Source());</code>
</pre>
<br><br>
<!---->
<h5 id="set-parameter">Set Parameters</h5>
<pre><code class="php">$cmd->SetParameter( String $param, String $value, $type = null)</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">This function is used when you use parameterized queries.</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">Void</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">$param String; Parameter id <br>
$value Type; Parameter value <br>
$type PDO Parameter type;PDO::Parameter_TYPE.</td>
</tr>
</table><br>
<b>Example: <br></b>
<pre>
<code class="php">
$cmd = new dbCommand("select * from user where status=:status",$myconnnection->Source());
$cmd->setParameter(":status", "active");
$data = $cmd->FetchAll();
</code>
</pre>
<br><br>
<!---->
<h5 id="fetch-all">Fetch All</h5>
<pre><code class="php">$cmd->FetchAll();</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">Fetch all records from returned query </td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">Array</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">None</td>
</tr>
</table><br>
<!---->
<h5 id="fetch">Fetch</h5>
<pre><code class="php">$cmd->Fetch();</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">Fetch a single record from returned query </td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">Array</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">None</td>
</tr>
</table><br>
<!---->
<h5 id="rowcount">Count Rows</h5>
<pre><code class="php">$cmd->RowCount();</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">Count affected rows</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">Integer</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">None</td>
</tr>
</table><br>
<!---->
<h5 id="lastid">Last Inserted Id</h5>
<pre><code class="php">$cmd->LastInsertedID();</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">Return last inserted id</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">Integer</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">None</td>
</tr>
</table><br>
<!---->
<h5 id="execute">Execute a Command</h5>
<pre><code class="php">$cmd->Execute();</code></pre>
<table class="code-desc">
<tr>
<td colspan="3">Execute the command in constructor.</td>
</tr>
<tr>
<td>Return</td>
<td colspan="2">Array</td>
</tr>
<tr>
<td>Parameters</td>
<td colspan="2">None</td>
</tr>
</table><br>
</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>