-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathautopulse.html
287 lines (235 loc) · 14.6 KB
/
autopulse.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
<!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">AutoPulse; A simple CRUD Library</span>
<br>
<div class="alert alert-info">
<strong>Database Connection </strong> All methods and commands in this library requires an active database connection. You can define your connection witg MySqlConnect or DbConnect class. You can read more about
connecting a database <a href="mysql.html">Here </a> or <a href="dbconnect.html">Here </a> </span>
</div>
<div class="row">
<div class="col-lg-8">
<ul class="hash-toc">
<li><a href="#pagedescription">Autopulse Library</a></li>
<li>Methods
<ol class="ug-tocs">
<li><a href="#loadmodel">LoadModel()</a></li>
<li><a href="#loadarray">LoadArray()</a></li>
<li><a href="#update">Update()</a></li>
<li><a href="#delete">Delete()</a></li>
<li><a href="#deletewithmodel">DeleteWithModel()</a></li>
</ol>
</li>
<li><a href="#example">Example</a></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>Autopulse</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>\Autopulse
</div>
</div>
</div>
<!--end: Required Namespace -->
</div>
<br><br>
<!--start: topic-->
<h4 id="pagedescription">Database: Autopulse Library <small><a href="#content">#top</a></small></h4>
<p>
With this library you can easily access and manage your database.
<br><br>
This class, contains functions that make it easier to process your data. AutoPulse will save you writing complex dml queries. The only think you need is to call required function.
<br>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="loadmodel">Load a model to database <small><a href="#content">#top</a></small></h4>
<p>
This function is used to load a model class directly to your database.
<pre><code class="php">Autopulse::LoadModel(Mixed $modelForm, DbConnect | MySqlConnect $dbclassinstance);</code>
</pre><br>
<span class="ug-keyword ug-code ug-bold">$modelForm</span>: Model class posted from view <br>
<span class="ug-keyword ug-code ug-bold">$dbclassinstance</span>: An active database connection source.
<br>
<div class="alert alert-warning">
<strong>Warning </strong> If you want to use LoadModel method, your model Class name must be same with your table name and variables defined in model class must be same with column names in your table.</span>
</div>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="loadarray">Load an array to database <small><a href="#content">#top</a></small></h4>
<p>
This function is used to load an array to your database.
<pre><code class="php">Autopulse::LoadArray(String $tableName = '', Array $fieldList, DbConnect | MySqlConnect $dbclassinstance);</code></pre>
<span class="ug-keyword ug-code ug-bold">$tableName</span>: Table name <br>
<span class="ug-keyword ug-code ug-bold">$fieldList</span>: Fields with values. array key must be column name of table.<br>
<span class="ug-keyword ug-code ug-bold">$dbclassinstance</span>: An active database connection source.<br>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="update">Update data <small><a href="#content">#top</a></small></h4>
<p>
Update a data using arrays
<pre><code class="php">Autopulse::Update(Mixed $tableName, Array $fieldList = null, String $whereOption = null, DbConnect | MySqlConnect $dbclassinstance);</code></pre>
<span class="ug-keyword ug-code ug-bold">$tableName</span>: Table name to update. <br>
<span class="ug-keyword ug-code ug-bold">$fieldList</span>: Fields with values. array key must be column name of table.<br>
<span class="ug-keyword ug-code ug-bold">$whereOption</span>: Update where...<br>
<span class="ug-keyword ug-code ug-bold">$dbclassinstance</span>: An active database connection source.<br>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="delete">Delete a record <small><a href="#content">#top</a></small></h4>
<p>
Delete from database
<pre>
<code class="php">Autopulse::Delete(Mixed $TableName, DbConnect | MySqlConnect $dbclassinstance,String $whereOption = null);</code>
</pre>
<span class="ug-keyword ug-code ug-bold">$TableName</span>: Table name to delete from. <br>
<span class="ug-keyword ug-code ug-bold">$whereOption</span>: Update where...<br>
<span class="ug-keyword ug-code ug-bold">$dbclassinstance</span>: An active database connection source.<br>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="deletewithmodel">Delete record using Model <small><a href="#content">#top</a></small></h4>
<p>
Delete from database
<pre>
<code class="php">Autopulse::Delete(Mixed $modelForm, DbConnect | MySqlConnect $dbclassinstance,String $whereOption = null);</code>
</pre>
<span class="ug-keyword ug-code ug-bold">$modelForm</span>: Model Form, Autopulse library use this for getting table name from class name. <br>
<span class="ug-keyword ug-code ug-bold">$whereOption</span>: Update where...<br>
<span class="ug-keyword ug-code ug-bold">$dbclassinstance</span>: An active database connection source.<br>
</p>
<br>
<!--end: topic-->
<!--start: topic-->
<h4 id="example">Example <small><a href="#content">#top</a></small></h4>
<p>
Let's create a Autopulse command to insert an array to "User" table.
<pre><code class="php">
use Ness\Autopulse\Autopulse;
/**
* OTHER CODES
**/
$cons = omap::GetValue("database_1");
$myconnnection = new MySqlConnect($cons["host"],$cons["user"],$cons["password"],$cons["database"]);
$myUser = array("userid"=>null,
"name"=>"Example",
"surname"=>"RECORD",
"email"=>"test@test.com");
if(Autopulse::LoadArray("user", $myUser, $myconnnection->Source()))
{
echo "User Saved";
}else{
echo "Error while saving user";
}
</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>