securePage (function)

Purpose:

Checks if a user has access to a page

Example:

if (!securePage($_SERVER['PHP_SELF'])){die();}

Data Type(s):

securePage($uri)

Location:

users/helpers/permissions.php

Details:

This is the core UserSpice function that determines if someone is allowed to visit a page.
In order for this to function properly, several things must be true
1. The page should end in a .php extension.
2. The page should have the init file required before securePage is called
3. The page must be in the database.  It should be added automatically assuming that UserSpice is set to monitor that folder.

If a user is in the $master_account array (defined in init.php) this will always return true.
If a user has been banned, this will always return false.
If a user is an admin and this page is protectable but it is not in the database, you will be redirected to the page security settings.
If a user is not admin and visits a page that isn't in the db, they will be told to contact admin.
If a page is public, anyone can visit it.
If it is private and the user is logged out, they will be redirected back to this page after logging in
A person who tries to visit a page for which they do not have permission will be logged in "security logs" in the dashboard

The typical usage for this function is

<?php if (!securePage($_SERVER['PHP_SELF'])){die();} ?>