-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmysql.html
More file actions
391 lines (331 loc) · 17.6 KB
/
mysql.html
File metadata and controls
391 lines (331 loc) · 17.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
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
<!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">MySql Database Connection</span>
<br>
<div class="row">
<div class="col-lg-8">
<ul class="hash-toc">
<li>Contents
<ul>
<li><a href="#getting-started">Gettin Started</a></li>
<li><a href="#using-mysqldatabase">Using MySql Database</a></li>
<li><a href="#create-connection">Create A Connection</a></li>
<li><a href="#connection-source">Connection Source</a></li>
<li><a href="#connection-check">Check COnnection</a></li>
<li><a href="#connection-errors">Last Error</a></li>
<li><a href="#connection-open">Reconnect</a></li>
<li><a href="#connection-close">Close a Connection</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;">Autopulse
<ul><li>MySqlConnect</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>\MySqlConnect
</div>
</div>
</div>
<!--end: Required Namespace -->
</div>
<br><br>
<!--start: topic-->
<h4 id="getting-started" >Getting Started <small><a href="#content">#top</a></small></h4>
<p>
Ness PHP Framework uses libraries derived from PHP's PDO library for database
operations. There are currently classes for MySQL databases that are frequently
preferred by developers. However, Ness PHP supports all databases supported by the
PHP PDO plugin. All you need to do is specify the required connection string at the
time the class is derived. This article is followed by articles describing all these
operations and showing the use of the functions.You can use MySql connections
with the MySqlConnect class and use the dbConnect class for all other PDO-enabled
transactions.Once you have successfully defined your connection, you can run your
queries using the <a href="mysqlCommand.html">MySqlCommand</a> or <a href="dbconnect.html">dbCommand + dbConnect</a> classes.
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="using-mysqldatabase">Using MySql Database <small><a href="#content">#top</a></small></h4>
<p>
This library is used to manage your mysql connections.
<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 MySqlConnect($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>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="connection-source">Connection Source <small><a href="#content">#top</a></small></h4>
<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 MySqlCommand 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>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="connection-check">Check Connection <small><a href="#content">#top</a></small></h4>
<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>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="connection-errors">Error List <small><a href="#content">#top</a></small></h4>
<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>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="connection-open">Reconnect to Database <small><a href="#content">#top</a></small></h4>
<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>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="connection-close">Close an active Connection <small><a href="#content">#top</a></small></h4>
<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>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="example">Example <small><a href="#content">#top</a></small></h4>
<p>
Lets create a connection to a database called blogdb and print message if connection is available;<br>
<pre>
<code class="php">
use Ness\Controller as myController;
use Ness\Autopulse\MySqlConnect;
class indexController extends myController
{
public function indexAction($param = 0)
{
$con_str = array("host"=>"localhost",
"password"=>"",
"user"=>"root",
"database-name"=>"blogdb");
$con = new MySqlConnect($con_str["host"],
$con_str["user"],
$con_str["password"],
$con_str["database-name"]);
if($con->isConnected()){
echo "Connection Available";
}else{
echo "Connection Error -: ".$con->lastError();
}
}
}
</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>