261 |
action |
Method |
This method is used internally by the DB class to pass SQL queries and tables to the database |
View |
312 |
addError |
Method |
Adds an error message when an item fails validation |
View |
56 |
addPage |
Function |
Add a permission level to a page |
View |
65 |
addPermission |
Function |
Adds a permission level to a user |
View |
201 |
adminNotifications |
Function |
|
View |
320 |
archiveOldNotifications |
Method |
|
View |
104 |
Azure |
Guide |
Learn how to connect to an Azure database |
View |
184 |
bin |
Function |
Echoes a green Yes, red No, or blue Other depending on what is passed to it. |
View |
15 |
bold |
Function |
Puts a bold message at the top of a page |
View |
277 |
cell |
Method |
|
View |
297 |
check |
Method |
|
View |
311 |
check |
Method |
|
View |
131 |
checkAccess |
Function |
|
View |
230 |
checkAPIkey |
Function |
|
View |
196 |
checkBan |
Function |
|
View |
61 |
checkMenu |
Function |
Check if a user has a permission level |
View |
147 |
checkPermission |
Function |
|
View |
303 |
checkUser |
Method |
|
View |
189 |
clean |
Function |
|
View |
129 |
cleanupPermissionPageMatches |
Function |
|
View |
69 |
Config::get |
Method |
Get configuration info from the init.php file |
View |
76 |
Cookie::delete |
Method |
Expires cookie |
View |
73 |
Cookie::exists |
Method |
Checks if a given cookie exists |
View |
74 |
Cookie::get |
Method |
Get's the cookie and assigns it to a variable |
View |
75 |
Cookie::put |
Method |
Puts a cookie on the user's system |
View |
270 |
count |
Method |
|
View |
299 |
create |
Method |
|
View |
55 |
createPages |
Function |
Adds a page to the Database |
View |
212 |
currentFile |
Function |
|
View |
4 |
currentFolder |
Function |
Returns the folder of the current file |
View |
3 |
currentPage |
Function |
Returns the file name of the current page (not including path) |
View |
149 |
currentPageId |
Function |
|
View |
204 |
currentPageStrict |
Function |
|
View |
123 |
Customizing the Dashboard |
Guide |
Personalize your Dashboard to your liking |
View |
121 |
Customizing UserSpice |
Guide |
The definitive guide for customizing UserSpice |
View |
305 |
data |
Method |
|
View |
254 |
delete |
Method |
|
View |
264 |
delete |
Method |
|
View |
292 |
delete |
Method |
|
View |
265 |
deleteById |
Method |
|
View |
50 |
deletePages |
Function |
Deletes pages From the database |
View |
66 |
deletePermission |
Function |
Deletes multiple permission levels |
View |
37 |
deleteUsers |
Function |
Deletes multiple users |
View |
219 |
deRegisterHooks |
Function |
|
View |
237 |
display |
Method |
|
View |
9 |
display_errors |
Function |
Deprecated. Do Not Use. |
View |
314 |
display_errors |
Method |
|
View |
10 |
display_successes |
Function |
Deprecated. Do Not Use. |
View |
14 |
dnd |
Function |
Provides a formatted var_dump of a variable and kills the page |
View |
13 |
dump |
Function |
Provides a formatted var_dump of a variable |
View |
193 |
echodatetime |
Function |
|
View |
158 |
echoId |
Function |
|
View |
183 |
echoId |
Function |
|
View |
68 |
echopage |
Function |
Echoes page name when given a page id |
View |
38 |
echouser |
Function |
A flexible function to echo out some type of user name |
View |
39 |
echousername |
Function |
Returns the username of the user. Does not actually echo it. |
View |
11 |
email |
Function |
Send an email if properly configured |
View |
156 |
emailExists |
Function |
|
View |
181 |
emailExists |
Function |
|
View |
12 |
email_body |
Function |
Predefined email templates can be stored in users/views |
View |
191 |
encodeURIComponent |
Function |
|
View |
16 |
err |
Function |
Puts a red message at the top of a page |
View |
271 |
error |
Method |
|
View |
272 |
errorInfo |
Method |
|
View |
316 |
errors |
Method |
|
View |
273 |
errorString |
Method |
|
View |
251 |
exists |
Method |
|
View |
283 |
exists |
Method |
|
View |
290 |
exists |
Method |
|
View |
304 |
exists |
Method |
|
View |
207 |
fetchAdminSessions |
Function |
|
View |
51 |
fetchAllPages |
Function |
Grabs all pages from the database |
View |
62 |
fetchAllPermissions |
Function |
Grabs all permission levels |
View |
35 |
fetchAllUsers |
Function |
Fetches an object of users based on the parameters included |
View |
234 |
fetchFolderFiles |
Function |
|
View |
171 |
fetchGroupsByMenu |
Function |
|
View |
52 |
fetchPageDetails |
Function |
Returns information about a page based on id |
View |
58 |
fetchPagePermissions |
Function |
Returns a list of permission levels that can access a page |
View |
44 |
fetchPermissionDetails |
Function |
Returns the id and permission name of a permission level |
View |
59 |
fetchPermissionPages |
Function |
Returns a list of pages that a permission level can access |
View |
47 |
fetchPermissionUsers |
Function |
Retrieve a list of users who have a permission level |
View |
233 |
fetchProfilePicture |
Function |
|
View |
127 |
fetchUser |
Function |
Returns everything in the users table for a given user id |
View |
36 |
fetchUserDetails |
Function |
Legacy function to retrieves info on a single user |
View |
41 |
fetchUserName |
Function |
Returns First and Last Name of user |
View |
46 |
fetchUserPermissions |
Function |
Retrieve a list of permission levels that a user has |
View |
206 |
fetchUserSessions |
Function |
|
View |
300 |
find |
Method |
|
View |
259 |
findAll |
Method |
|
View |
260 |
findById |
Method |
|
View |
269 |
first |
Method |
|
View |
294 |
flash |
Method |
|
View |
113 |
Form manager advanced features |
Guide |
Advanced form processing |
View |
112 |
Form manager basics |
Guide |
Understanding the form manager plugin |
View |
238 |
generate |
Method |
|
View |
296 |
generate |
Method |
|
View |
186 |
generateAddForm |
Function |
|
View |
185 |
generateForm |
Function |
|
View |
250 |
get |
Method |
|
View |
252 |
get |
Method |
|
View |
263 |
get |
Method |
|
View |
284 |
get |
Method |
|
View |
293 |
get |
Method |
|
View |
319 |
getAllNotifications |
Method |
|
View |
278 |
getColCount |
Method |
|
View |
279 |
getColMeta |
Method |
|
View |
326 |
getCount |
Method |
|
View |
257 |
getDB |
Method |
|
View |
324 |
getError |
Method |
|
View |
256 |
getInstance |
Method |
|
View |
328 |
getLiveUnreadCount |
Method |
|
View |
216 |
getMyHooks |
Function |
|
View |
325 |
getNotifications |
Method |
|
View |
151 |
getPageFiles |
Function |
|
View |
175 |
getPageFiles |
Function |
|
View |
49 |
getPathPhpFiles |
Function |
Retrieve a list of all .php files in folder |
View |
275 |
getQueryCount |
Method |
|
View |
122 |
Getting Started |
Guide |
What to do after installing UserSpice |
View |
327 |
getUnreadCount |
Method |
|
View |
329 |
getUnreadNotifications |
Method |
|
View |
150 |
getUSPageFiles |
Function |
|
View |
176 |
getUSPageFiles |
Function |
|
View |
170 |
get_gravatar |
Function |
|
View |
276 |
get_subquery_sql |
Method |
|
View |
70 |
Hash::make |
Method |
Creates an SHA-256 hash (optionally salted hash) from a string |
View |
72 |
Hash::unique |
Method |
Create a unique, time-based hash |
View |
67 |
hasPerm |
Function |
Allows you to check if a user group has a certain permission level |
View |
240 |
hasPerms |
Method |
|
View |
213 |
importSQL |
Function |
|
View |
217 |
includeHook |
Function |
|
View |
85 |
Input::exists |
Method |
Checks if $_GET or $_POST form input exists |
View |
86 |
Input::get |
Method |
Gets and sanitizes form input for form processing. |
View |
87 |
Input::sanitize |
Method |
Sanitizes non form data for storage in the database |
View |
148 |
inputBlock |
Function |
|
View |
266 |
insert |
Method |
|
View |
103 |
Installation Issues |
Guide |
Learn how to diagnose common installation issues |
View |
167 |
ipCheck |
Function |
|
View |
168 |
ipCheckBan |
Function |
|
View |
195 |
ipReason |
Function |
|
View |
42 |
isAdmin |
Function |
Returns whether or not a user has permission level 2 |
View |
203 |
isLocalhost |
Function |
|
View |
306 |
isLoggedIn |
Method |
|
View |
229 |
isSelected |
Function |
|
View |
130 |
isStandardUser |
Function |
|
View |
228 |
isUserLoggedIn |
Function |
|
View |
180 |
isValidEmail |
Function |
|
View |
287 |
json |
Method |
|
View |
208 |
killSessions |
Function |
|
View |
179 |
lang |
Function |
|
View |
114 |
Language and Translation |
Guide |
Learn how to translate UserSpice and edit translations |
View |
215 |
languageSwitcher |
Function |
|
View |
274 |
lastId |
Method |
|
View |
192 |
logger |
Function |
|
View |
301 |
login |
Method |
|
View |
302 |
loginEmail |
Method |
|
View |
202 |
lognote |
Function |
|
View |
308 |
logout |
Method |
|
View |
280 |
make |
Method |
|
View |
120 |
Master Account |
Guide |
Understanding the Master Account system |
View |
166 |
migrateUSMainMenu |
Function |
|
View |
242 |
miniMap |
Method |
|
View |
243 |
miniMapLinks |
Method |
|
View |
7 |
money |
Function |
Formats numbers to US currency format |
View |
107 |
Monitoring additional folders |
Guide |
Learn how to control folders with UserSpice |
View |
188 |
mqtt |
Function |
|
View |
8 |
name_from_id |
Function |
Returns the username when given a user's id |
View |
128 |
name_from_id |
Function |
Another legacy function that fetches a username from a user id |
View |
307 |
notLoggedInRedirect |
Method |
|
View |
235 |
offsetDate |
Function |
|
View |
146 |
output_message |
Function |
|
View |
211 |
oxfordList |
Function |
|
View |
53 |
pageIdExists |
Function |
Tells whether a page id is used in UserSpice |
View |
159 |
parseMenuLabel |
Function |
|
View |
223 |
parseSessionMessages |
Function |
|
View |
17 |
parse_ini_file |
Function |
Internal use only |
View |
165 |
parse_menu_hook |
Function |
|
View |
317 |
passed |
Method |
|
View |
209 |
passwordResetKillSessions |
Function |
|
View |
109 |
Permission Levels |
Guide |
|
View |
43 |
permissionIdExists |
Function |
Tells whether a permission id exists in UserSpice |
View |
64 |
permissionNameExists |
Function |
Tells whether a permission name exits in UserSpice |
View |
152 |
permissionNameExists |
Function |
|
View |
119 |
Plugin hooks |
Guide |
Learn how to use your plugins to inject code into existing UserSpice pages |
View |
214 |
pluginActive |
Function |
|
View |
163 |
prepareDropdownString |
Function |
|
View |
162 |
prepareIndentedMenuTree |
Function |
|
View |
164 |
prepareItemString |
Function |
|
View |
161 |
prepareMenuTree |
Function |
|
View |
253 |
put |
Method |
|
View |
291 |
put |
Method |
|
View |
258 |
query |
Method |
|
View |
169 |
randomstring |
Function |
|
View |
197 |
random_password |
Function |
|
View |
286 |
recursive |
Method |
|
View |
239 |
recursivelyDeleteMenuItem |
Method |
|
View |
22 |
redirect |
Function |
Redirect to another page |
View |
218 |
registerHooks |
Function |
|
View |
60 |
removePage |
Function |
Removes a page from permission_page_matches |
View |
48 |
removePermission |
Function |
Removes a permission level from user_permission_matches |
View |
200 |
requestCheck |
Function |
|
View |
178 |
resultBlock |
Function |
|
View |
268 |
results |
Method |
|
View |
198 |
returnError |
Function |
|
View |
313 |
ruleBroken |
Method |
|
View |
315 |
rulesBroken |
Method |
|
View |
289 |
safe |
Method |
|
View |
19 |
safefilerewrite |
Function |
Write to a file without conflicts |
View |
281 |
salt |
Method |
|
View |
2 |
sanitize |
Function |
Sanitizes a string, array or object using the Input class and returns it. |
View |
285 |
sanitize |
Method |
|
View |
177 |
sanitizedDest |
Function |
|
View |
57 |
securePage |
Function |
Checks if a user has access to a page |
View |
116 |
Security Audit - 4.4 |
Guide |
A 3rd party audited v 4.4.09 |
View |
78 |
Session::delete |
Method |
Deletes the current session |
View |
77 |
Session::exits |
Method |
Checks for the existence of a session |
View |
80 |
Session::flash |
Method |
Refreshes a session |
View |
79 |
Session::get |
Method |
Gets the value of a session |
View |
82 |
Session::put |
Method |
Adds information to a user\'s session |
View |
81 |
Session::uagent_no_version |
Method |
Returns some basic info about the visitor's system |
View |
224 |
sessionValMessages |
Function |
|
View |
245 |
setInitialDisplayOrder |
Method |
|
View |
244 |
setInitialTypes |
Method |
|
View |
322 |
setRead |
Method |
|
View |
323 |
setReadAll |
Method |
|
View |
106 |
Setting up Email |
Guide |
Learn how to configure your email server |
View |
220 |
shakerIsInstalled |
Function |
|
View |
1 |
size |
Function |
Returns the size of a file |
View |
115 |
Social Logins |
Guide |
Setup google and facebook logins (now plugins) |
View |
124 |
Spice Shaker |
Guide |
Install official and community addons |
View |
153 |
stripPagePermissions |
Function |
|
View |
190 |
stripPagePermissions |
Function |
|
View |
125 |
Templates (Themes) |
Guide |
Learn how to customize the look and feel of UserSpice |
View |
194 |
time2str |
Function |
|
View |
288 |
to |
Method |
|
View |
84 |
Token::check |
Method |
Checks if the token in the session matches the token posted in the form |
View |
83 |
Token::generate |
Method |
Generates a token and saves it to a session variable. |
View |
232 |
tokenHere |
Function |
|
View |
295 |
uagent_no_version |
Method |
|
View |
330 |
UltraMenu |
Guide |
Guide to the new UserSpice UltaMenu |
View |
126 |
Understanding Usersc |
Guide |
Learn about the magic of the usersc folder |
View |
282 |
unique |
Method |
|
View |
267 |
update |
Method |
|
View |
309 |
update |
Method |
|
View |
157 |
updateEmail |
Function |
|
View |
182 |
updateEmail |
Function |
|
View |
187 |
updateFields2 |
Function |
|
View |
172 |
updateGroupsMenus |
Function |
|
View |
45 |
updatePermissionName |
Function |
Change a permission level's name |
View |
54 |
updatePrivate |
Function |
Toggles the private/public setting of a page |
View |
40 |
updateUser |
Function |
Updates a single piece of user data |
View |
108 |
Upgrading from 3.x to 4.0 |
Guide |
Learn how to make the jump |
View |
110 |
User Management |
Guide |
Learn how to manage your users |
View |
93 |
user->checkUser |
Method |
Internal use only |
View |
89 |
user->create |
Method |
Creates a new UserSpice user and returns the id |
View |
95 |
user->data |
Method |
Provides quick access to a piece of info about a logged in user |
View |
94 |
user->exists |
Method |
Checks if a user is logged in and the user class is instantiated |
View |
90 |
user->find |
Method |
Finds if a user exists based on id, username, or email |
View |
96 |
user->isLoggedIn |
Method |
Checks if a user is logged in |
View |
91 |
user->login |
Method |
Logs in a user |
View |
92 |
user->loginEmail |
Method |
Logs in a user with an email address instead of username |
View |
98 |
user->logout |
Method |
Logs out a user |
View |
97 |
user->notLoggedInRedirect |
Method |
A conditional redirect statement |
View |
99 |
user->update |
Method |
Updates an array of fields in the user table for the logged in user |
View |
154 |
userHasPermission |
Function |
|
View |
34 |
userIdExists |
Function |
Check if the provided User ID exists in the users table |
View |
155 |
usernameExists |
Function |
|
View |
174 |
usernameExists |
Function |
|
View |
210 |
username_helper |
Function |
|
View |
225 |
usError |
Function |
|
View |
205 |
UserSessionCount |
Function |
|
View |
231 |
UserSpice_getLogs |
Function |
|
View |
117 |
Using the database |
Guide |
Learn how to use the database with video and text tutorials |
View |
227 |
usMessage |
Function |
|
View |
226 |
usSuccess |
Function |
|
View |
222 |
validateJson |
Function |
|
View |
221 |
verifyadmin |
Function |
|
View |
18 |
write_php_ini |
Function |
Provides a safe way to turn an array into an ini file |
View |
118 |
Writing a plugin |
Guide |
See an example of how to write your own plugin |
View |
160 |
_assert |
Function |
|
View |
262 |
_calcWhere |
Method |
|
View |
241 |
_generateHtml |
Method |
|
View |
249 |
_loadItems |
Method |
|
View |
248 |
_loadTree |
Method |
|
View |
246 |
_populateInitialDisplayOrder |
Method |
|
View |
247 |
_populateTypeColumn |
Method |
|
View |