security_logger
in package
Option handler class
Table of Contents
Methods
- __construct() : security_logger
- class instantiation function
- admin_XSRF_access() : bool
- Loggs Cross Site Request Forgeries
- adminAlbumGate() : mixed
- Logs blocked accesses to Managed albums
- adminCookie() : mixed
- adminGate() : mixed
- Logs blocked accesses to Admin pages
- adminLoginLogger() : int
- Logs an attempt to log onto the back-end or as an admin user Returns the rights to grant
- federatedLoginLogger() : int
- Logs an attempt to log on via the federated_logon plugin Returns the rights to grant
- getOptionsSupported() : array<string|int, mixed>
- Reports the supported options
- guestLoginLogger() : bool
- Logs an attempt for a guest user to log onto the site Returns the "success" parameter.
- handleOption() : mixed
- log_action() : mixed
- logs security log actions
- log_setup() : mixed
- Logs setup actions
- security_misc() : mixed
- Catch all logger for miscellaneous security records
- UserSave() : mixed
- logs attempts to save on the user tab
- Logger() : mixed
- Does the log handling
- populate_user() : mixed
- returns the user id and name of the logged in user
Methods
__construct()
class instantiation function
public
__construct() : security_logger
Return values
security_loggeradmin_XSRF_access()
Loggs Cross Site Request Forgeries
public
static admin_XSRF_access(bool $discard, string $token) : bool
Parameters
- $discard : bool
- $token : string
Return values
booladminAlbumGate()
Logs blocked accesses to Managed albums
public
static adminAlbumGate(bool $allow, string $page) : mixed
Parameters
- $allow : bool
-
set to true to override the block
- $page : string
-
the "return" link
adminCookie()
public
static adminCookie(mixed $allow, mixed $auth, mixed $id) : mixed
Parameters
- $allow : mixed
- $auth : mixed
- $id : mixed
adminGate()
Logs blocked accesses to Admin pages
public
static adminGate(bool $allow, string $page) : mixed
Parameters
- $allow : bool
-
set to true to override the block
- $page : string
-
the "return" link
adminLoginLogger()
Logs an attempt to log onto the back-end or as an admin user Returns the rights to grant
public
static adminLoginLogger(int $success, string $user, string $pass[, mixed $auth = 'zp_admin_auth' ]) : int
Parameters
- $success : int
-
the admin rights granted
- $user : string
- $pass : string
- $auth : mixed = 'zp_admin_auth'
Return values
intfederatedLoginLogger()
Logs an attempt to log on via the federated_logon plugin Returns the rights to grant
public
static federatedLoginLogger(int $success, string $user) : int
Parameters
- $success : int
-
the admin rights granted
- $user : string
Tags
Return values
intgetOptionsSupported()
Reports the supported options
public
getOptionsSupported() : array<string|int, mixed>
Return values
array<string|int, mixed>guestLoginLogger()
Logs an attempt for a guest user to log onto the site Returns the "success" parameter.
public
static guestLoginLogger(bool $success, string $user, string $pass, string $athority) : bool
Parameters
- $success : bool
- $user : string
- $pass : string
- $athority : string
-
what kind of login
Return values
boolhandleOption()
public
handleOption(mixed $option, mixed $currentValue) : mixed
Parameters
- $option : mixed
- $currentValue : mixed
log_action()
logs security log actions
public
static log_action(bool $allow, string $log, string $action) : mixed
Parameters
- $allow : bool
- $log : string
- $action : string
log_setup()
Logs setup actions
public
static log_setup(bool $success, string $action, mixed $txt) : mixed
Parameters
- $success : bool
- $action : string
- $txt : mixed
security_misc()
Catch all logger for miscellaneous security records
public
static security_misc(bool $success, string $requestor, string $auth, string $txt) : mixed
Parameters
- $success : bool
- $requestor : string
- $auth : string
- $txt : string
UserSave()
logs attempts to save on the user tab
public
static UserSave(string $discard, object $userobj, string $class) : mixed
Parameters
- $discard : string
- $userobj : object
-
user object upon which the save was targeted
- $class : string
-
what the action was.
Logger()
Does the log handling
private
static Logger(int $success, string $user, string $name, mixed $action, string $authority[, string $addl = NULL ]) : mixed
Parameters
- $success : int
- $user : string
- $name : string
- $action : mixed
- $authority : string
-
kind of login
- $addl : string = NULL
-
more info
populate_user()
returns the user id and name of the logged in user
private
static populate_user() : mixed