Subversion Repositories php_users

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
26 rodolico 1
Search.appendIndex(
2
    [
3
                {
4
            "fqsen": "\\Users",
5
            "name": "Users",
6
            "summary": "User\u0020Login\u0020class",
7
            "url": "classes/Users.html"
8
        },                {
9
            "fqsen": "\\Users\u003A\u003A__construct\u0028\u0029",
10
            "name": "__construct",
11
            "summary": "constructor\u0020for\u0020an\u0020instance\u0020of\u0020the\u0020class",
12
            "url": "classes/Users.html#method___construct"
13
        },                {
14
            "fqsen": "\\Users\u003A\u003A\u0024errors",
15
            "name": "errors",
16
            "summary": "",
17
            "url": "classes/Users.html#property_errors"
18
        },                {
19
            "fqsen": "\\Users\u003A\u003AclearErrors\u0028\u0029",
20
            "name": "clearErrors",
21
            "summary": "clears\u0020the\u0020errors\u0020array",
22
            "url": "classes/Users.html#method_clearErrors"
23
        },                {
24
            "fqsen": "\\Users\u003A\u003AisAdmin\u0028\u0029",
25
            "name": "isAdmin",
26
            "summary": "getter\u0020for\u0020isAdmin",
27
            "url": "classes/Users.html#method_isAdmin"
28
        },                {
29
            "fqsen": "\\Users\u003A\u003Aname\u0028\u0029",
30
            "name": "name",
31
            "summary": "getter\u0020for\u0020login\u0020name",
32
            "url": "classes/Users.html#method_name"
33
        },                {
34
            "fqsen": "\\Users\u003A\u003AHTML\u0028\u0029",
35
            "name": "HTML",
36
            "summary": "Main\u0020display\u0020function.",
37
            "url": "classes/Users.html#method_HTML"
38
        },                {
39
            "fqsen": "\\Users\u003A\u003Avalidate\u0028\u0029",
40
            "name": "validate",
41
            "summary": "Validates\u0020a\u0020connection\u0020and,\u0020on\u0020success,\u0020populates\u0020\u0024data",
42
            "url": "classes/Users.html#method_validate"
43
        },                {
44
            "fqsen": "\\Users\u003A\u003AallUsersHTML\u0028\u0029",
45
            "name": "allUsersHTML",
46
            "summary": "Get\u0020all\u0020users\u0020from\u0020data\u0020source\u0020and\u0020put\u0020them\u0020in\u0020an\u0020HTML\u0020list",
47
            "url": "classes/Users.html#method_allUsersHTML"
48
        },                {
49
            "fqsen": "\\Users\u003A\u003AlogOut\u0028\u0029",
50
            "name": "logOut",
51
            "summary": "Logs\u0020user\u0020out\u0020of\u0020system",
52
            "url": "classes/Users.html#method_logOut"
53
        },                {
54
            "fqsen": "\\Users\u003A\u003AgetNextScript\u0028\u0029",
55
            "name": "getNextScript",
56
            "summary": "Simple\u0020helper\u0020script\u0020to\u0020calculate\u0020next\u0020script\u0020to\u0020call",
57
            "url": "classes/Users.html#method_getNextScript"
58
        },                {
59
            "fqsen": "\\Users\u003A\u003AlogInScreen\u0028\u0029",
60
            "name": "logInScreen",
61
            "summary": "Creates\u0020the\u0020fields\u0020needed\u0020for\u0020a\u0020login\u0020screen",
62
            "url": "classes/Users.html#method_logInScreen"
63
        },                {
64
            "fqsen": "\\Users\u003A\u003AmakeHTMLField\u0028\u0029",
65
            "name": "makeHTMLField",
66
            "summary": "Creates\u0020an\u0020HTML\u0020field\u0020for\u0020display",
67
            "url": "classes/Users.html#method_makeHTMLField"
68
        },                {
69
            "fqsen": "\\Users\u003A\u003AeditScreen\u0028\u0029",
70
            "name": "editScreen",
71
            "summary": "Creates\u0020an\u0020edit\u0020screen\u0020for\u0020display\u0020to\u0020user",
72
            "url": "classes/Users.html#method_editScreen"
73
        },                {
74
            "fqsen": "\\Users\u003A\u003AemptyWorkingOn\u0028\u0029",
75
            "name": "emptyWorkingOn",
76
            "summary": "Creates\u0020a\u0020variable\u0020designed\u0020to\u0020replace\u0020\u0024this\u002D\u003EworkingOn",
77
            "url": "classes/Users.html#method_emptyWorkingOn"
78
        },                {
79
            "fqsen": "\\Users\u003A\u003AaddEdit\u0028\u0029",
80
            "name": "addEdit",
81
            "summary": "",
82
            "url": "classes/Users.html#method_addEdit"
83
        },                {
84
            "fqsen": "\\Users\u003A\u003AinitWorkingOn\u0028\u0029",
85
            "name": "initWorkingOn",
86
            "summary": "",
87
            "url": "classes/Users.html#method_initWorkingOn"
88
        },                {
89
            "fqsen": "\\Users\u003A\u003Aadmin\u0028\u0029",
90
            "name": "admin",
91
            "summary": "Sets\u0020up\u0020the\u0020admin\u0020function\u0020which\u0020allows\u0020users\u0020to\u0020edit\u0020themselves\u0020and,\u0020optionally,\u0020others",
92
            "url": "classes/Users.html#method_admin"
93
        },                {
94
            "fqsen": "\\Users\u003A\u003A\u0024configuration",
95
            "name": "configuration",
96
            "summary": "",
97
            "url": "classes/Users.html#property_configuration"
98
        },                {
99
            "fqsen": "\\Users\u003A\u003A\u0024data",
100
            "name": "data",
101
            "summary": "",
102
            "url": "classes/Users.html#property_data"
103
        },                {
104
            "fqsen": "\\Users\u003A\u003A\u0024workingOn",
105
            "name": "workingOn",
106
            "summary": "",
107
            "url": "classes/Users.html#property_workingOn"
108
        },                {
109
            "fqsen": "\\usersDataSource",
110
            "name": "usersDataSource",
111
            "summary": "usersDataSource\u0020class",
112
            "url": "classes/usersDataSource.html"
113
        },                {
114
            "fqsen": "\\usersDataSource\u003A\u003A__construct\u0028\u0029",
115
            "name": "__construct",
116
            "summary": "constructor\u0020for\u0020an\u0020instance\u0020of\u0020the\u0020class",
117
            "url": "classes/usersDataSource.html#method___construct"
118
        },                {
119
            "fqsen": "\\usersDataSource\u003A\u003AgetARecord\u0028\u0029",
120
            "name": "getARecord",
121
            "summary": "Get\u0020a\u0020record\u0020from\u0020the\u0020database",
122
            "url": "classes/usersDataSource.html#method_getARecord"
123
        },                {
124
            "fqsen": "\\usersDataSource\u003A\u003AgetPassword\u0028\u0029",
125
            "name": "getPassword",
126
            "summary": "Retrieves\u0020the\u0020password\u0020field\u0020from\u0020table",
127
            "url": "classes/usersDataSource.html#method_getPassword"
128
        },                {
129
            "fqsen": "\\usersDataSource\u003A\u003Aupdate\u0028\u0029",
130
            "name": "update",
131
            "summary": "updates\u0020row\u0020in\u0020database\u0020with\u0020\u0024newData",
132
            "url": "classes/usersDataSource.html#method_update"
133
        },                {
134
            "fqsen": "\\usersDataSource\u003A\u003AgetAllUsers\u0028\u0029",
135
            "name": "getAllUsers",
136
            "summary": "retrieves\u0020all\u0020users\u0020from\u0020the\u0020database",
137
            "url": "classes/usersDataSource.html#method_getAllUsers"
138
        },                {
139
            "fqsen": "\\usersDataSource\u003A\u003A\u0024configuration",
140
            "name": "configuration",
141
            "summary": "",
142
            "url": "classes/usersDataSource.html#property_configuration"
143
        },                {
144
            "fqsen": "\\usersDataSourceMySQLi",
145
            "name": "usersDataSourceMySQLi",
146
            "summary": "usersDataSource\u0020class",
147
            "url": "classes/usersDataSourceMySQLi.html"
148
        },                {
149
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003A__construct\u0028\u0029",
150
            "name": "__construct",
151
            "summary": "constructor\u0020for\u0020an\u0020instance\u0020of\u0020the\u0020class",
152
            "url": "classes/usersDataSourceMySQLi.html#method___construct"
153
        },                {
154
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003AescapeString\u0028\u0029",
155
            "name": "escapeString",
156
            "summary": "Make\u0020string\u0020safe\u0020for\u0020MySQL",
157
            "url": "classes/usersDataSourceMySQLi.html#method_escapeString"
158
        },                {
159
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003AbuildQuery\u0028\u0029",
160
            "name": "buildQuery",
161
            "summary": "Create\u0020a\u0020query\u0020to\u0020retrieve\u0020info\u0020from\u0020database",
162
            "url": "classes/usersDataSourceMySQLi.html#method_buildQuery"
163
        },                {
164
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003AgetARecord\u0028\u0029",
165
            "name": "getARecord",
166
            "summary": "Get\u0020a\u0020record\u0020from\u0020the\u0020database",
167
            "url": "classes/usersDataSourceMySQLi.html#method_getARecord"
168
        },                {
169
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003AgetPassword\u0028\u0029",
170
            "name": "getPassword",
171
            "summary": "Retrieves\u0020the\u0020password\u0020field\u0020from\u0020table",
172
            "url": "classes/usersDataSourceMySQLi.html#method_getPassword"
173
        },                {
174
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003AgetUserID\u0028\u0029",
175
            "name": "getUserID",
176
            "summary": "retrieves\u0020the\u0020userID\u0020from\u0020the\u0020table",
177
            "url": "classes/usersDataSourceMySQLi.html#method_getUserID"
178
        },                {
179
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003AsetDBConnection\u0028\u0029",
180
            "name": "setDBConnection",
181
            "summary": "Make\u0020the\u0020database\u0020connection",
182
            "url": "classes/usersDataSourceMySQLi.html#method_setDBConnection"
183
        },                {
184
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003AbuildTable\u0028\u0029",
185
            "name": "buildTable",
186
            "summary": "Convenience\u0020function\u0020to\u0020create\u0020the\u0020tables\u0020defined\u0020in\u0020\u0024configuration",
187
            "url": "classes/usersDataSourceMySQLi.html#method_buildTable"
188
        },                {
189
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003AinitTables\u0028\u0029",
190
            "name": "initTables",
191
            "summary": "Convenience\u0020function\u0020to\u0020initialize\u0020tables\u0020to\u0020values",
192
            "url": "classes/usersDataSourceMySQLi.html#method_initTables"
193
        },                {
194
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003AtableColumnName\u0028\u0029",
195
            "name": "tableColumnName",
196
            "summary": "Gets\u0020the\u0020actual\u0020database\u0020column\u0020name\u0020from\u0020the\u0020configuration\u0020file",
197
            "url": "classes/usersDataSourceMySQLi.html#method_tableColumnName"
198
        },                {
199
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003Atest\u0028\u0029",
200
            "name": "test",
201
            "summary": "Tests\u0020that\u0020the\u0020database\u0020connection\u0020works\u0020and\u0020the\u0020table\u0020is\u0020built",
202
            "url": "classes/usersDataSourceMySQLi.html#method_test"
203
        },                {
204
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003Aupdate\u0028\u0029",
205
            "name": "update",
206
            "summary": "updates\u0020row\u0020in\u0020database\u0020with\u0020\u0024newData",
207
            "url": "classes/usersDataSourceMySQLi.html#method_update"
208
        },                {
209
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003AgetAllUsers\u0028\u0029",
210
            "name": "getAllUsers",
211
            "summary": "retrieves\u0020all\u0020users\u0020from\u0020the\u0020database",
212
            "url": "classes/usersDataSourceMySQLi.html#method_getAllUsers"
213
        },                {
214
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003AdoSQL\u0028\u0029",
215
            "name": "doSQL",
216
            "summary": "Executes\u0020an\u0020SQL\u0020statement,\u0020returning\u0020the\u0020result",
217
            "url": "classes/usersDataSourceMySQLi.html#method_doSQL"
218
        },                {
219
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003AgetAField\u0028\u0029",
220
            "name": "getAField",
221
            "summary": "Gets\u0020a\u0020single\u0020field\u0020from\u0020a\u0020table",
222
            "url": "classes/usersDataSourceMySQLi.html#method_getAField"
223
        },                {
224
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003A\u0024configuration",
225
            "name": "configuration",
226
            "summary": "",
227
            "url": "classes/usersDataSourceMySQLi.html#property_configuration"
228
        },                {
229
            "fqsen": "\\usersDataSourceMySQLi\u003A\u003A\u0024dbConnection",
230
            "name": "dbConnection",
231
            "summary": "",
232
            "url": "classes/usersDataSourceMySQLi.html#property_dbConnection"
233
        },                {
234
            "fqsen": "\\UsersPermissions",
235
            "name": "UsersPermissions",
236
            "summary": "User\u0020Permissions\u0020Login\u0020class",
237
            "url": "classes/UsersPermissions.html"
238
        },                {
239
            "fqsen": "\\UsersPermissions\u003A\u003A__construct\u0028\u0029",
240
            "name": "__construct",
241
            "summary": "Extends\u0020Users\u003A\u003A_construct",
242
            "url": "classes/UsersPermissions.html#method___construct"
243
        },                {
244
            "fqsen": "\\UsersPermissions\u003A\u003Avalidate\u0028\u0029",
245
            "name": "validate",
246
            "summary": "Extends\u0020Users\u003A\u003Avalidate",
247
            "url": "classes/UsersPermissions.html#method_validate"
248
        },                {
249
            "fqsen": "\\UsersPermissions\u003A\u003AeditScreen\u0028\u0029",
250
            "name": "editScreen",
251
            "summary": "Extends\u0020Users\u003A\u003AeditScreen",
252
            "url": "classes/UsersPermissions.html#method_editScreen"
253
        },                {
254
            "fqsen": "\\UsersPermissions\u003A\u003AaddEdit\u0028\u0029",
255
            "name": "addEdit",
256
            "summary": "Adds\/Updates\u0020existing\u0020record",
257
            "url": "classes/UsersPermissions.html#method_addEdit"
258
        },                {
259
            "fqsen": "\\UsersPermissions\u003A\u003AinitWorkingOn\u0028\u0029",
260
            "name": "initWorkingOn",
261
            "summary": "Initializes\u0020\u0024this\u002D\u003EworkingOn",
262
            "url": "classes/UsersPermissions.html#method_initWorkingOn"
263
        },                {
264
            "fqsen": "\\UsersPermissions\u003A\u003AisAuthorized\u0028\u0029",
265
            "name": "isAuthorized",
266
            "summary": "returns\u0020boolean\u0020as\u0020to\u0020whether\u0020the\u0020user\u0020has\u0020the\u0020passed\u0020in\u0020permission",
267
            "url": "classes/UsersPermissions.html#method_isAuthorized"
268
        },                {
269
            "fqsen": "\\UsersPermissions\u003A\u003AaddPermission\u0028\u0029",
270
            "name": "addPermission",
271
            "summary": "Adds\u0020a\u0020permission\u0020to\u0020the\u0020permissions\u0020table",
272
            "url": "classes/UsersPermissions.html#method_addPermission"
273
        },                {
274
            "fqsen": "\\usersPermissionsDataSourceMySQLi",
275
            "name": "usersPermissionsDataSourceMySQLi",
276
            "summary": "usersDataSource\u0020class",
277
            "url": "classes/usersPermissionsDataSourceMySQLi.html"
278
        },                {
279
            "fqsen": "\\usersPermissionsDataSourceMySQLi\u003A\u003A__construct\u0028\u0029",
280
            "name": "__construct",
281
            "summary": "extends\u0020usersDataSource",
282
            "url": "classes/usersPermissionsDataSourceMySQLi.html#method___construct"
283
        },                {
284
            "fqsen": "\\usersPermissionsDataSourceMySQLi\u003A\u003AbuildTable\u0028\u0029",
285
            "name": "buildTable",
286
            "summary": "Function\u0020will\u0020build\u0020tables\u0020when\u0020called",
287
            "url": "classes/usersPermissionsDataSourceMySQLi.html#method_buildTable"
288
        },                {
289
            "fqsen": "\\usersPermissionsDataSourceMySQLi\u003A\u003AaddPermission\u0028\u0029",
290
            "name": "addPermission",
291
            "summary": "Adds\u0020a\u0020permission\u0020to\u0020the\u0020permissions\u0020table",
292
            "url": "classes/usersPermissionsDataSourceMySQLi.html#method_addPermission"
293
        },                {
294
            "fqsen": "\\usersPermissionsDataSourceMySQLi\u003A\u003AsetUsersPermissions\u0028\u0029",
295
            "name": "setUsersPermissions",
296
            "summary": "Sets\u0020any\u0020unset\u0020user\u0020permissions",
297
            "url": "classes/usersPermissionsDataSourceMySQLi.html#method_setUsersPermissions"
298
        },                {
299
            "fqsen": "\\usersPermissionsDataSourceMySQLi\u003A\u003AgetARecord\u0028\u0029",
300
            "name": "getARecord",
301
            "summary": "Get\u0020a\u0020record\u0020from\u0020the\u0020database",
302
            "url": "classes/usersPermissionsDataSourceMySQLi.html#method_getARecord"
303
        },                {
304
            "fqsen": "\\usersPermissionsDataSourceMySQLi\u003A\u003AgetPermissions\u0028\u0029",
305
            "name": "getPermissions",
306
            "summary": "Gets\u0020permissions\u0020for\u0020one\u0020user",
307
            "url": "classes/usersPermissionsDataSourceMySQLi.html#method_getPermissions"
308
        },                {
309
            "fqsen": "\\usersPermissionsDataSourceMySQLi\u003A\u003AgetFullPermissions\u0028\u0029",
310
            "name": "getFullPermissions",
311
            "summary": "Gets\u0020all\u0020permissions\u0020with\u0020names,\u0020group\u0020names,\u0020etc...\u0020from\u0020database",
312
            "url": "classes/usersPermissionsDataSourceMySQLi.html#method_getFullPermissions"
313
        },                {
314
            "fqsen": "\\usersPermissionsDataSourceMySQLi\u003A\u003AupdatePermissions\u0028\u0029",
315
            "name": "updatePermissions",
316
            "summary": "Adds\/Updates\u0020a\u0020group\u0020of\u0020permissions\u0020for\u0020a\u0020user",
317
            "url": "classes/usersPermissionsDataSourceMySQLi.html#method_updatePermissions"
318
        },                {
319
            "fqsen": "\\",
320
            "name": "\\",
321
            "summary": "",
322
            "url": "namespaces/default.html"
323
        }            ]
324
);