\DarkVoid

Notification area aka DarkVoid class

Synopsis

class DarkVoid {

• // constants
• const CACHE_PATH = 'exports/';
• const CACHE_PREFIX = 'darkvoid.';
• const PROVIDERS_PATH = 'modules/darkvoid/';
• // members
• protected array $altCfg = ;
• protected string $myLogin = '';
• protected string $alerts = '';
• protected string $dynamicArea = '';
• protected integer $cacheTime = 10;
• protected  $ubConfig = NULL;
• protected array $skipOnModules = ;
• protected string $currentModule = '';
• // methods
• public void __construct()
• protected void setCurrentModule()
• protected void setModSkip()
• protected void loadAlerts()
• protected void loadDynamicArea()
• protected  setMyLogin()
• protected void loadAlter()
• protected void updateAlerts()
• protected void appendExternalAlerts()
• public string render()
• public void flushCache()
}


Constants

Name	Value
CACHE_PATH	'exports/'
CACHE_PREFIX	'darkvoid.'
PROVIDERS_PATH	'modules/darkvoid/'

Members

protected

• $alerts — string
  Contains alerts cache
• $altCfg — array
  Contains system alter config as key=>value
• $cacheTime — int
  Contains default cache timeout in minutes
• $currentModule — string
  Contains current module
• $dynamicArea — string
  Contains non-cachable alerts & notifications
• $myLogin — string
  Contains current user login
• $skipOnModules — array
  Array of modules that must be skipped on alert updates
• $ubConfig —
  UbillingConfig object placeholder

Methods

protected

• appendExternalAlerts() — Appends external alerts providers output
• loadAlerts() — Loads alerts from per-user cache or from database if needed
• loadAlter() — Loads global alter.ini config into protected property
• loadDynamicArea() — Loads dynamic, non-cachable dark-void content
• setCurrentModule() — Sets current instance current route module name
• setModSkip() — Sets modules array to be skipped on alert updates to prevent DB ops
• setMyLogin() — Sets private login property
• updateAlerts() — Renders available and enabled alerts into DarkVoid notification area

public

• __construct()
• flushCache() — Flushes all or specified user alert cachesysconf
• render() — Returns raw alerts data