| 26 |
rodolico |
1 |
<!DOCTYPE html>
|
|
|
2 |
<html lang="en">
|
|
|
3 |
<head>
|
|
|
4 |
<meta charset="utf-8">
|
|
|
5 |
<title>Documentation</title>
|
|
|
6 |
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
7 |
<base href="../">
|
|
|
8 |
<link rel="icon" href="images/favicon.ico"/>
|
|
|
9 |
<link rel="stylesheet" href="css/normalize.css">
|
|
|
10 |
<link rel="stylesheet" href="css/base.css">
|
|
|
11 |
<link rel="preconnect" href="https://fonts.gstatic.com">
|
|
|
12 |
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
|
|
|
13 |
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
|
|
|
14 |
<link rel="stylesheet" href="css/template.css">
|
|
|
15 |
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
|
|
|
16 |
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
|
|
|
17 |
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
|
|
|
18 |
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
|
|
|
19 |
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
|
|
|
20 |
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
|
|
|
21 |
<script src="js/search.js"></script>
|
|
|
22 |
<script defer src="js/searchIndex.js"></script>
|
|
|
23 |
</head>
|
|
|
24 |
<body id="top">
|
|
|
25 |
<header class="phpdocumentor-header phpdocumentor-section">
|
|
|
26 |
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
|
|
|
27 |
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
|
|
|
28 |
<label class="phpdocumentor-header__menu-icon" for="menu-button">
|
|
|
29 |
<i class="fas fa-bars"></i>
|
|
|
30 |
</label>
|
|
|
31 |
<section data-search-form class="phpdocumentor-search">
|
|
|
32 |
<label>
|
|
|
33 |
<span class="visually-hidden">Search for</span>
|
|
|
34 |
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
|
35 |
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
|
|
|
36 |
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
|
|
|
37 |
</svg>
|
|
|
38 |
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
|
|
|
39 |
</label>
|
|
|
40 |
</section>
|
|
|
41 |
|
|
|
42 |
<nav class="phpdocumentor-topnav">
|
|
|
43 |
<ul class="phpdocumentor-topnav__menu">
|
|
|
44 |
</ul>
|
|
|
45 |
</nav>
|
|
|
46 |
</header>
|
|
|
47 |
|
|
|
48 |
<main class="phpdocumentor">
|
|
|
49 |
<div class="phpdocumentor-section">
|
|
|
50 |
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
|
|
|
51 |
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
|
|
|
52 |
Menu
|
|
|
53 |
</label>
|
|
|
54 |
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
|
|
|
55 |
|
|
|
56 |
<section class="phpdocumentor-sidebar__category">
|
|
|
57 |
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
|
|
|
58 |
</section>
|
|
|
59 |
|
|
|
60 |
<section class="phpdocumentor-sidebar__category">
|
|
|
61 |
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
|
|
|
62 |
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Application.html"><abbr title="\Application">Application</abbr></a></h3>
|
|
|
63 |
</section>
|
|
|
64 |
|
|
|
65 |
<section class="phpdocumentor-sidebar__category">
|
|
|
66 |
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
|
|
67 |
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
|
|
|
68 |
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
|
|
|
69 |
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
|
|
|
70 |
</section>
|
|
|
71 |
|
|
|
72 |
<section class="phpdocumentor-sidebar__category">
|
|
|
73 |
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
|
|
|
74 |
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
|
|
|
75 |
</section>
|
|
|
76 |
</aside>
|
|
|
77 |
|
|
|
78 |
<div class="phpdocumentor-column -eight phpdocumentor-content">
|
|
|
79 |
<ul class="phpdocumentor-breadcrumbs">
|
|
|
80 |
<li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
|
|
|
81 |
</ul>
|
|
|
82 |
|
|
|
83 |
<article class="phpdocumentor-element -class">
|
|
|
84 |
<h2 class="phpdocumentor-content__title">
|
|
|
85 |
usersDataSource
|
|
|
86 |
|
|
|
87 |
|
|
|
88 |
<div class="phpdocumentor-element__package">
|
|
|
89 |
in package
|
|
|
90 |
<ul class="phpdocumentor-breadcrumbs">
|
|
|
91 |
<li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
|
|
|
92 |
</ul>
|
|
|
93 |
</div>
|
|
|
94 |
|
|
|
95 |
|
|
|
96 |
</h2>
|
|
|
97 |
|
|
|
98 |
<aside class="phpdocumentor-element-found-in">
|
|
|
99 |
<abbr class="phpdocumentor-element-found-in__file" title="UsersDataSource.class.php"><a href="files/usersdatasource-class.html"><abbr title="UsersDataSource.class.php">UsersDataSource.class.php</abbr></a></abbr>
|
|
|
100 |
:
|
|
|
101 |
<span class="phpdocumentor-element-found-in__line">64</span>
|
|
|
102 |
|
|
|
103 |
</aside>
|
|
|
104 |
|
|
|
105 |
<p class="phpdocumentor-summary">usersDataSource class</p>
|
|
|
106 |
|
|
|
107 |
<section class="phpdocumentor-description"><p>usersDataSource provides the data access capabilities for the Users
|
|
|
108 |
class.</p>
|
|
|
109 |
<p>To build a data access class for Users, the following 5 methods must
|
|
|
110 |
exist.
|
|
|
111 |
getPassword(username)
|
|
|
112 |
getAllUsers()
|
|
|
113 |
getARecord
|
|
|
114 |
update</p>
|
|
|
115 |
<p>Additionally, where appropriate, the following function is useful
|
|
|
116 |
buildTable()</p>
|
|
|
117 |
<p>This particular instance provides an interface to MySQL using
|
|
|
118 |
the mysqli libraries.</p>
|
|
|
119 |
<p>Create an instance of this, then pass the variable to several Users
|
|
|
120 |
calls.</p>
|
|
|
121 |
</section>
|
|
|
122 |
|
|
|
123 |
|
|
|
124 |
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
|
125 |
Tags
|
|
|
126 |
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
127 |
</h5>
|
|
|
128 |
<dl class="phpdocumentor-tag-list">
|
|
|
129 |
<dt class="phpdocumentor-tag-list__entry">
|
|
|
130 |
<span class="phpdocumentor-tag__name">author</span>
|
|
|
131 |
</dt>
|
|
|
132 |
<dd class="phpdocumentor-tag-list__definition">
|
|
|
133 |
|
|
|
134 |
<section class="phpdocumentor-description"><p>R. W. Rodolico <a href="mailto:rodo@unixservertech.com">rodo@unixservertech.com</a></p>
|
|
|
135 |
</section>
|
|
|
136 |
|
|
|
137 |
</dd>
|
|
|
138 |
<dt class="phpdocumentor-tag-list__entry">
|
|
|
139 |
<span class="phpdocumentor-tag__name">version</span>
|
|
|
140 |
</dt>
|
|
|
141 |
<dd class="phpdocumentor-tag-list__definition">
|
|
|
142 |
<span class="phpdocumentor-tag-link">0.9.0</span>
|
|
|
143 |
|
|
|
144 |
<section class="phpdocumentor-description"><p>(beta)</p>
|
|
|
145 |
</section>
|
|
|
146 |
|
|
|
147 |
</dd>
|
|
|
148 |
<dt class="phpdocumentor-tag-list__entry">
|
|
|
149 |
<span class="phpdocumentor-tag__name">copyright</span>
|
|
|
150 |
</dt>
|
|
|
151 |
<dd class="phpdocumentor-tag-list__definition">
|
|
|
152 |
|
|
|
153 |
<section class="phpdocumentor-description"><p>2021 Daily Data, Inc.</p>
|
|
|
154 |
</section>
|
|
|
155 |
|
|
|
156 |
</dd>
|
|
|
157 |
</dl>
|
|
|
158 |
|
|
|
159 |
|
|
|
160 |
|
|
|
161 |
|
|
|
162 |
|
|
|
163 |
|
|
|
164 |
<h3 id="toc">
|
|
|
165 |
Table of Contents
|
|
|
166 |
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
167 |
</h3>
|
|
|
168 |
|
|
|
169 |
<dl class="phpdocumentor-table-of-contents">
|
|
|
170 |
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
|
171 |
<a href="classes/usersDataSource.html#property_configuration">$configuration</a>
|
|
|
172 |
<span>
|
|
|
173 |
: array<string|int, string> </span>
|
|
|
174 |
</dt>
|
|
|
175 |
<dd></dd>
|
|
|
176 |
|
|
|
177 |
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
178 |
<a href="classes/usersDataSource.html#method___construct">__construct()</a>
|
|
|
179 |
<span>
|
|
|
180 |
: null </span>
|
|
|
181 |
</dt>
|
|
|
182 |
<dd>constructor for an instance of the class</dd>
|
|
|
183 |
|
|
|
184 |
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
185 |
<a href="classes/usersDataSource.html#method_getAllUsers">getAllUsers()</a>
|
|
|
186 |
<span>
|
|
|
187 |
: array<string|int, string> </span>
|
|
|
188 |
</dt>
|
|
|
189 |
<dd>retrieves all users from the database</dd>
|
|
|
190 |
|
|
|
191 |
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
192 |
<a href="classes/usersDataSource.html#method_getARecord">getARecord()</a>
|
|
|
193 |
<span>
|
|
|
194 |
: array<string|int, string> </span>
|
|
|
195 |
</dt>
|
|
|
196 |
<dd>Get a record from the database</dd>
|
|
|
197 |
|
|
|
198 |
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
199 |
<a href="classes/usersDataSource.html#method_getPassword">getPassword()</a>
|
|
|
200 |
<span>
|
|
|
201 |
: array<string|int, string> </span>
|
|
|
202 |
</dt>
|
|
|
203 |
<dd>Retrieves the password field from table</dd>
|
|
|
204 |
|
|
|
205 |
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
|
206 |
<a href="classes/usersDataSource.html#method_update">update()</a>
|
|
|
207 |
<span>
|
|
|
208 |
: <abbr title="\mysqli_result">mysqli_result</abbr>|bool </span>
|
|
|
209 |
</dt>
|
|
|
210 |
<dd>updates row in database with $newData</dd>
|
|
|
211 |
|
|
|
212 |
</dl>
|
|
|
213 |
|
|
|
214 |
|
|
|
215 |
|
|
|
216 |
|
|
|
217 |
|
|
|
218 |
|
|
|
219 |
<section class="phpdocumentor-properties">
|
|
|
220 |
<h3 class="phpdocumentor-elements__header" id="properties">
|
|
|
221 |
Properties
|
|
|
222 |
<a href="classes/usersDataSource.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
223 |
</h3>
|
|
|
224 |
<article
|
|
|
225 |
class="
|
|
|
226 |
phpdocumentor-element
|
|
|
227 |
-property
|
|
|
228 |
-protected
|
|
|
229 |
"
|
|
|
230 |
>
|
|
|
231 |
<h4 class="phpdocumentor-element__name" id="property_configuration">
|
|
|
232 |
$configuration
|
|
|
233 |
<a href="classes/usersDataSource.html#property_configuration" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
234 |
<span class="phpdocumentor-element__modifiers">
|
|
|
235 |
</span>
|
|
|
236 |
</h4>
|
|
|
237 |
<aside class="phpdocumentor-element-found-in">
|
|
|
238 |
<abbr class="phpdocumentor-element-found-in__file" title="UsersDataSource.class.php"><a href="files/usersdatasource-class.html"><abbr title="UsersDataSource.class.php">UsersDataSource.class.php</abbr></a></abbr>
|
|
|
239 |
:
|
|
|
240 |
<span class="phpdocumentor-element-found-in__line">71</span>
|
|
|
241 |
|
|
|
242 |
</aside>
|
|
|
243 |
|
|
|
244 |
|
|
|
245 |
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
246 |
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
|
247 |
<span class="phpdocumentor-signature__type">array<string|int, string></span>
|
|
|
248 |
<span class="phpdocumentor-signature__name">$configuration</span>
|
|
|
249 |
= <span class="phpdocumentor-signature__default-value">array()</span></code>
|
|
|
250 |
|
|
|
251 |
|
|
|
252 |
<section class="phpdocumentor-description"><p>Contains the configuration for the class</p>
|
|
|
253 |
<p>May be modified by the calling program. Must be replicated in userDataSource class</p>
|
|
|
254 |
</section>
|
|
|
255 |
|
|
|
256 |
|
|
|
257 |
|
|
|
258 |
</article>
|
|
|
259 |
</section>
|
|
|
260 |
|
|
|
261 |
<section class="phpdocumentor-methods">
|
|
|
262 |
<h3 class="phpdocumentor-elements__header" id="methods">
|
|
|
263 |
Methods
|
|
|
264 |
<a href="classes/usersDataSource.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
265 |
</h3>
|
|
|
266 |
<article
|
|
|
267 |
class="phpdocumentor-element
|
|
|
268 |
-method
|
|
|
269 |
-public
|
|
|
270 |
"
|
|
|
271 |
>
|
|
|
272 |
<h4 class="phpdocumentor-element__name" id="method___construct">
|
|
|
273 |
__construct()
|
|
|
274 |
<a href="classes/usersDataSource.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
275 |
</h4>
|
|
|
276 |
<aside class="phpdocumentor-element-found-in">
|
|
|
277 |
<abbr class="phpdocumentor-element-found-in__file" title="UsersDataSource.class.php"><a href="files/usersdatasource-class.html"><abbr title="UsersDataSource.class.php">UsersDataSource.class.php</abbr></a></abbr>
|
|
|
278 |
:
|
|
|
279 |
<span class="phpdocumentor-element-found-in__line">89</span>
|
|
|
280 |
|
|
|
281 |
</aside>
|
|
|
282 |
|
|
|
283 |
<p class="phpdocumentor-summary">constructor for an instance of the class</p>
|
|
|
284 |
|
|
|
285 |
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
286 |
<span class="phpdocumentor-signature__visibility">public</span>
|
|
|
287 |
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array<string|int, string> </span><span class="phpdocumentor-signature__argument__name">$dbDef</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">array()</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">null</span></code>
|
|
|
288 |
|
|
|
289 |
<section class="phpdocumentor-description"><p>If $dbConnection is not null, will be used for database access
|
|
|
290 |
If $dbLoginInfo is not null, will override $dbConnection, make
|
|
|
291 |
a new connection and use that.</p>
|
|
|
292 |
<p>If $dbDef is set, will be merged with $configuration</p>
|
|
|
293 |
</section>
|
|
|
294 |
|
|
|
295 |
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
|
296 |
<dl class="phpdocumentor-argument-list">
|
|
|
297 |
<dt class="phpdocumentor-argument-list__entry">
|
|
|
298 |
<span class="phpdocumentor-signature__argument__name">$dbDef</span>
|
|
|
299 |
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, string></span>
|
|
|
300 |
= <span class="phpdocumentor-signature__argument__default-value">array()</span> </dt>
|
|
|
301 |
<dd class="phpdocumentor-argument-list__definition">
|
|
|
302 |
<section class="phpdocumentor-description"><p>Array to be merged with $configuration</p>
|
|
|
303 |
</section>
|
|
|
304 |
|
|
|
305 |
</dd>
|
|
|
306 |
</dl>
|
|
|
307 |
|
|
|
308 |
|
|
|
309 |
|
|
|
310 |
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
311 |
<span class="phpdocumentor-signature__response_type">null</span>
|
|
|
312 |
—
|
|
|
313 |
|
|
|
314 |
|
|
|
315 |
</article>
|
|
|
316 |
<article
|
|
|
317 |
class="phpdocumentor-element
|
|
|
318 |
-method
|
|
|
319 |
-public
|
|
|
320 |
-abstract "
|
|
|
321 |
>
|
|
|
322 |
<h4 class="phpdocumentor-element__name" id="method_getAllUsers">
|
|
|
323 |
getAllUsers()
|
|
|
324 |
<a href="classes/usersDataSource.html#method_getAllUsers" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
325 |
</h4>
|
|
|
326 |
<aside class="phpdocumentor-element-found-in">
|
|
|
327 |
<abbr class="phpdocumentor-element-found-in__file" title="UsersDataSource.class.php"><a href="files/usersdatasource-class.html"><abbr title="UsersDataSource.class.php">UsersDataSource.class.php</abbr></a></abbr>
|
|
|
328 |
:
|
|
|
329 |
<span class="phpdocumentor-element-found-in__line">136</span>
|
|
|
330 |
|
|
|
331 |
</aside>
|
|
|
332 |
|
|
|
333 |
<p class="phpdocumentor-summary">retrieves all users from the database</p>
|
|
|
334 |
|
|
|
335 |
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
336 |
<span class="phpdocumentor-signature__visibility">public</span>
|
|
|
337 |
<span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">getAllUsers</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, string></span></code>
|
|
|
338 |
|
|
|
339 |
<section class="phpdocumentor-description"><p>Retrieves all data for all users from table</p>
|
|
|
340 |
</section>
|
|
|
341 |
|
|
|
342 |
|
|
|
343 |
|
|
|
344 |
|
|
|
345 |
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
346 |
<span class="phpdocumentor-signature__response_type">array<string|int, string></span>
|
|
|
347 |
—
|
|
|
348 |
<section class="phpdocumentor-description"><p>array of array of rows/columns</p>
|
|
|
349 |
</section>
|
|
|
350 |
|
|
|
351 |
|
|
|
352 |
</article>
|
|
|
353 |
<article
|
|
|
354 |
class="phpdocumentor-element
|
|
|
355 |
-method
|
|
|
356 |
-public
|
|
|
357 |
-abstract "
|
|
|
358 |
>
|
|
|
359 |
<h4 class="phpdocumentor-element__name" id="method_getARecord">
|
|
|
360 |
getARecord()
|
|
|
361 |
<a href="classes/usersDataSource.html#method_getARecord" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
362 |
</h4>
|
|
|
363 |
<aside class="phpdocumentor-element-found-in">
|
|
|
364 |
<abbr class="phpdocumentor-element-found-in__file" title="UsersDataSource.class.php"><a href="files/usersdatasource-class.html"><abbr title="UsersDataSource.class.php">UsersDataSource.class.php</abbr></a></abbr>
|
|
|
365 |
:
|
|
|
366 |
<span class="phpdocumentor-element-found-in__line">108</span>
|
|
|
367 |
|
|
|
368 |
</aside>
|
|
|
369 |
|
|
|
370 |
<p class="phpdocumentor-summary">Get a record from the database</p>
|
|
|
371 |
|
|
|
372 |
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
373 |
<span class="phpdocumentor-signature__visibility">public</span>
|
|
|
374 |
<span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">getARecord</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, string> </span><span class="phpdocumentor-signature__argument__name">$whereFields</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, string> </span><span class="phpdocumentor-signature__argument__name">$fieldList</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, string></span></code>
|
|
|
375 |
|
|
|
376 |
<section class="phpdocumentor-description"><p>Gets a single record from the database which matches $field containing
|
|
|
377 |
$username. If more than one record is returned, will return the first
|
|
|
378 |
one</p>
|
|
|
379 |
</section>
|
|
|
380 |
|
|
|
381 |
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
|
382 |
<dl class="phpdocumentor-argument-list">
|
|
|
383 |
<dt class="phpdocumentor-argument-list__entry">
|
|
|
384 |
<span class="phpdocumentor-signature__argument__name">$whereFields</span>
|
|
|
385 |
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, string></span>
|
|
|
386 |
</dt>
|
|
|
387 |
<dd class="phpdocumentor-argument-list__definition">
|
|
|
388 |
<section class="phpdocumentor-description"><p>column=>value pairs for where clause</p>
|
|
|
389 |
</section>
|
|
|
390 |
|
|
|
391 |
</dd>
|
|
|
392 |
<dt class="phpdocumentor-argument-list__entry">
|
|
|
393 |
<span class="phpdocumentor-signature__argument__name">$fieldList</span>
|
|
|
394 |
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, string></span>
|
|
|
395 |
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
|
|
|
396 |
<dd class="phpdocumentor-argument-list__definition">
|
|
|
397 |
<section class="phpdocumentor-description"><p>a list of columns to return. If empty, returns all columns</p>
|
|
|
398 |
</section>
|
|
|
399 |
|
|
|
400 |
</dd>
|
|
|
401 |
</dl>
|
|
|
402 |
|
|
|
403 |
|
|
|
404 |
|
|
|
405 |
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
406 |
<span class="phpdocumentor-signature__response_type">array<string|int, string></span>
|
|
|
407 |
—
|
|
|
408 |
<section class="phpdocumentor-description"><p>a hash containing fieldname=>value pairs from fetch_assoc</p>
|
|
|
409 |
</section>
|
|
|
410 |
|
|
|
411 |
|
|
|
412 |
</article>
|
|
|
413 |
<article
|
|
|
414 |
class="phpdocumentor-element
|
|
|
415 |
-method
|
|
|
416 |
-public
|
|
|
417 |
-abstract "
|
|
|
418 |
>
|
|
|
419 |
<h4 class="phpdocumentor-element__name" id="method_getPassword">
|
|
|
420 |
getPassword()
|
|
|
421 |
<a href="classes/usersDataSource.html#method_getPassword" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
422 |
</h4>
|
|
|
423 |
<aside class="phpdocumentor-element-found-in">
|
|
|
424 |
<abbr class="phpdocumentor-element-found-in__file" title="UsersDataSource.class.php"><a href="files/usersdatasource-class.html"><abbr title="UsersDataSource.class.php">UsersDataSource.class.php</abbr></a></abbr>
|
|
|
425 |
:
|
|
|
426 |
<span class="phpdocumentor-element-found-in__line">118</span>
|
|
|
427 |
|
|
|
428 |
</aside>
|
|
|
429 |
|
|
|
430 |
<p class="phpdocumentor-summary">Retrieves the password field from table</p>
|
|
|
431 |
|
|
|
432 |
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
433 |
<span class="phpdocumentor-signature__visibility">public</span>
|
|
|
434 |
<span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">getPassword</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$username</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, string></span></code>
|
|
|
435 |
|
|
|
436 |
<section class="phpdocumentor-description"><p>Note that the password is stored as a hash in the table</p>
|
|
|
437 |
</section>
|
|
|
438 |
|
|
|
439 |
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
|
440 |
<dl class="phpdocumentor-argument-list">
|
|
|
441 |
<dt class="phpdocumentor-argument-list__entry">
|
|
|
442 |
<span class="phpdocumentor-signature__argument__name">$username</span>
|
|
|
443 |
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
|
444 |
</dt>
|
|
|
445 |
<dd class="phpdocumentor-argument-list__definition">
|
|
|
446 |
<section class="phpdocumentor-description"><p>username used to find record</p>
|
|
|
447 |
</section>
|
|
|
448 |
|
|
|
449 |
</dd>
|
|
|
450 |
</dl>
|
|
|
451 |
|
|
|
452 |
|
|
|
453 |
|
|
|
454 |
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
455 |
<span class="phpdocumentor-signature__response_type">array<string|int, string></span>
|
|
|
456 |
—
|
|
|
457 |
<section class="phpdocumentor-description"><p>an array of values key/value pairs</p>
|
|
|
458 |
</section>
|
|
|
459 |
|
|
|
460 |
|
|
|
461 |
</article>
|
|
|
462 |
<article
|
|
|
463 |
class="phpdocumentor-element
|
|
|
464 |
-method
|
|
|
465 |
-public
|
|
|
466 |
-abstract "
|
|
|
467 |
>
|
|
|
468 |
<h4 class="phpdocumentor-element__name" id="method_update">
|
|
|
469 |
update()
|
|
|
470 |
<a href="classes/usersDataSource.html#method_update" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
471 |
</h4>
|
|
|
472 |
<aside class="phpdocumentor-element-found-in">
|
|
|
473 |
<abbr class="phpdocumentor-element-found-in__file" title="UsersDataSource.class.php"><a href="files/usersdatasource-class.html"><abbr title="UsersDataSource.class.php">UsersDataSource.class.php</abbr></a></abbr>
|
|
|
474 |
:
|
|
|
475 |
<span class="phpdocumentor-element-found-in__line">127</span>
|
|
|
476 |
|
|
|
477 |
</aside>
|
|
|
478 |
|
|
|
479 |
<p class="phpdocumentor-summary">updates row in database with $newData</p>
|
|
|
480 |
|
|
|
481 |
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
|
482 |
<span class="phpdocumentor-signature__visibility">public</span>
|
|
|
483 |
<span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">update</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">array<string|int, string> </span><span class="phpdocumentor-signature__argument__name">$newData</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\mysqli_result">mysqli_result</abbr>|bool</span></code>
|
|
|
484 |
|
|
|
485 |
|
|
|
486 |
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
|
487 |
<dl class="phpdocumentor-argument-list">
|
|
|
488 |
<dt class="phpdocumentor-argument-list__entry">
|
|
|
489 |
<span class="phpdocumentor-signature__argument__name">$newData</span>
|
|
|
490 |
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, string></span>
|
|
|
491 |
</dt>
|
|
|
492 |
<dd class="phpdocumentor-argument-list__definition">
|
|
|
493 |
<section class="phpdocumentor-description"><p>fieldname/value pairs to be updated in table</p>
|
|
|
494 |
</section>
|
|
|
495 |
|
|
|
496 |
</dd>
|
|
|
497 |
</dl>
|
|
|
498 |
|
|
|
499 |
|
|
|
500 |
|
|
|
501 |
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
|
502 |
<span class="phpdocumentor-signature__response_type"><abbr title="\mysqli_result">mysqli_result</abbr>|bool</span>
|
|
|
503 |
—
|
|
|
504 |
<section class="phpdocumentor-description"><p>The mysqli result from a query</p>
|
|
|
505 |
</section>
|
|
|
506 |
|
|
|
507 |
|
|
|
508 |
</article>
|
|
|
509 |
</section>
|
|
|
510 |
|
|
|
511 |
|
|
|
512 |
<script type="text/javascript">
|
|
|
513 |
function loadExternalCodeSnippets(line) {
|
|
|
514 |
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach((pre) => {
|
|
|
515 |
var src = pre.getAttribute('data-src').replace( /\\/g, '/');
|
|
|
516 |
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
|
|
|
517 |
var language = 'php';
|
|
|
518 |
|
|
|
519 |
var code = document.createElement('code');
|
|
|
520 |
code.className = 'language-' + language;
|
|
|
521 |
|
|
|
522 |
pre.textContent = '';
|
|
|
523 |
|
|
|
524 |
pre.setAttribute('data-line', line)
|
|
|
525 |
code.textContent = 'Loading…';
|
|
|
526 |
|
|
|
527 |
pre.appendChild(code);
|
|
|
528 |
|
|
|
529 |
var xhr = new XMLHttpRequest();
|
|
|
530 |
|
|
|
531 |
xhr.open('GET', src, true);
|
|
|
532 |
|
|
|
533 |
xhr.onreadystatechange = function () {
|
|
|
534 |
if (xhr.readyState == 4) {
|
|
|
535 |
|
|
|
536 |
if (xhr.status < 400 && xhr.responseText) {
|
|
|
537 |
code.textContent = xhr.responseText;
|
|
|
538 |
|
|
|
539 |
Prism.highlightElement(code);
|
|
|
540 |
}
|
|
|
541 |
else if (xhr.status >= 400) {
|
|
|
542 |
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
|
|
|
543 |
}
|
|
|
544 |
else {
|
|
|
545 |
code.textContent = '✖ Error: File does not exist, is empty or trying to view from localhost';
|
|
|
546 |
}
|
|
|
547 |
}
|
|
|
548 |
};
|
|
|
549 |
|
|
|
550 |
xhr.send(null);
|
|
|
551 |
});
|
|
|
552 |
}
|
|
|
553 |
|
|
|
554 |
var modals = document.querySelectorAll("[data-modal]");
|
|
|
555 |
|
|
|
556 |
modals.forEach(function (trigger) {
|
|
|
557 |
trigger.addEventListener("click", function (event) {
|
|
|
558 |
//event.preventDefault();
|
|
|
559 |
const modal = document.getElementById(trigger.dataset.modal);
|
|
|
560 |
modal.classList.add("phpdocumentor-modal__open");
|
|
|
561 |
loadExternalCodeSnippets(trigger.dataset.line)
|
|
|
562 |
const exits = modal.querySelectorAll("[data-exit-button]");
|
|
|
563 |
exits.forEach(function (exit) {
|
|
|
564 |
exit.addEventListener("click", function (event) {
|
|
|
565 |
event.preventDefault();
|
|
|
566 |
modal.classList.remove("phpdocumentor-modal__open");
|
|
|
567 |
});
|
|
|
568 |
});
|
|
|
569 |
});
|
|
|
570 |
});
|
|
|
571 |
</script>
|
|
|
572 |
|
|
|
573 |
</article>
|
|
|
574 |
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
|
|
|
575 |
<section class="phpdocumentor-search-results__dialog">
|
|
|
576 |
<header class="phpdocumentor-search-results__header">
|
|
|
577 |
<h2 class="phpdocumentor-search-results__title">Search results</h2>
|
|
|
578 |
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
|
|
|
579 |
</header>
|
|
|
580 |
<section class="phpdocumentor-search-results__body">
|
|
|
581 |
<ul class="phpdocumentor-search-results__entries"></ul>
|
|
|
582 |
</section>
|
|
|
583 |
</section>
|
|
|
584 |
</section>
|
|
|
585 |
</div>
|
|
|
586 |
</div>
|
|
|
587 |
<a href="classes/usersDataSource.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
588 |
|
|
|
589 |
</main>
|
|
|
590 |
|
|
|
591 |
<script>
|
|
|
592 |
cssVars({});
|
|
|
593 |
</script>
|
|
|
594 |
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
|
|
|
595 |
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
|
|
|
596 |
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
|
|
|
597 |
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
|
|
|
598 |
</body>
|
|
|
599 |
</html>
|