\WifiCPE

Client side wireless equipment management subsystem

Synopsis

class WifiCPE {

• // constants
• const URL_ME = '?module=wcpe';
• const URL_SIGMON = '?module=mtsigmon';
• // members
• protected array $altCfg = ;
• public array $allAP = ;
• protected array $allSSids = ;
• protected array $deviceModels = ;
• public array $allCPE = ;
• protected array $allAssigns = ;
• protected array $allUsersData = ;
• protected  $messages = '';
• protected bool $SigmonEnabled = false;
• protected  $ubConfig = NULL;
• protected string $apSortOrder = "id";
• // methods
• public void __construct()
• protected void loadConfigs()
• protected void initMessages()
• protected void loadAps()
• protected string extractSsid()
• protected void loadCPEs()
• protected void loadAssigns()
• protected void loadUserData()
• protected void loadDeviceModels()
• public void getAllCPE()
• public bool/int getCPEIDByMAC()
• public array|bool getCPEData()
• public void/string createCPE()
• public void/string deleteCPE()
• protected string isCPEProtected()
• protected int userHaveCPE()
• protected int cpeHaveUser()
• public string renderCPECreateForm()
• public string renderCPEList()
• public void getCPEListJson()
• protected bool isUserUnassigned()
• public void/string assignCPEUser()
• public void/string deassignCPEUser()
• public string renderCPEEditForm()
• public void/string saveCPE()
• public string renderAssignedUsersArray()
• public string renderCPEAssignedUsers()
• protected string renderCPEAssignControl()
• public string renderCpeUserControls()
• public string panel()
• public string renderDevicesMap()
• public array getAPCPESignalControls()
• public string getAPCPEGraphRefreshButton()
• public string getSignalRefreshJS()
• public string getGraphRefreshJS()
• private void renderAPEssentialData()
}


Constants

Name	Value
URL_ME	'?module=wcpe'
URL_SIGMON	'?module=mtsigmon'

Members

protected

• $SigmonEnabled — bool
  Is MTSIGMON enbaled?
• $allAssigns — array
  Contains all available user to CPE assigns as id=>assignData
• $allSSids — array
  Contains available AP SSIDs if exists as id=>ssid
• $allUsersData — array
  Contains array of all existing users data as login=>userData
• $altCfg — array
  Contains system alter config as key=>value
• $apSortOrder — string
  Sorting order of APs in lists and dropdowns Possible values: id, ip, location
• $deviceModels — array
  Contains all available devices models as modelid=>name
• $messages —
  Messages helper object placeholder
• $ubConfig —
  Placeholder for UbillingConfig object instance

public

• $allAP — array
  Contains all available APs as id=>APdata
• $allCPE — array
  Contains all available CPEs as id=>CPEdata

Methods

private

• renderAPEssentialData()

protected

• cpeHaveUser() — Returns user CPE assign ID or 0 if assign not exists
• extractSsid() — Ectracts SSID if exists from AP description
• initMessages() — Initalizes system message helper instance
• isCPEProtected() — Checks is CPE assigned with some users or not?
• isUserUnassigned() — Checks is user available for CPE assign?
• loadAps() — Loads all available AP devices from switches directory
• loadAssigns() — Loads existing CPE assigns from database
• loadCPEs() — Loads all available CPE to protected property
• loadConfigs() — Loads system alter config to protected property for further usage
• loadDeviceModels() — Loads available device models from database
• loadUserData() — Loads all existing users data into protected property
• renderCPEAssignControl() — Returns CPE assign controls to user profile, if no CPE is attached to user yet
• userHaveCPE() — Returns user CPE assign ID or 0 if assign not exists

public

• __construct()
• assignCPEUser() — Assigns existing CPE to some user login
• createCPE() — Creates new CPE in database
• deassignCPEUser() — Deletes CPE to user assign from database
• deleteCPE() — Deletes existing CPE from database
• getAPCPEGraphRefreshButton() — Returns signal history graph for given CPE.
• getAPCPESignalControls() — Returns signal show&repoll controls $SignalContainerSelector and $PollDateContainerSelector must be a valid JQuery selectors where returned data will be stored in
• getAllCPE()
• getCPEData() — Returns array with all CPE data from database if record with CPEID found or false if not
• getCPEIDByMAC() — Returns CPE ID from database if record with CPEMAC found or false if not
• getCPEListJson() — Renders JSON data of available CPE devices
• getGraphRefreshJS() — Returns JS code for controls returned by "getAPCPEGraphRefreshButton()" function Without this code controls returned by "getAPCPEGraphRefreshButton()" function will not work properly
• getSignalRefreshJS() — Returns JS code for controls returned by "getAPCPESignalControls()" function Without this code controls returned by "getAPCPESignalControls()" function will not work properly
• panel() — Renders main module control panel
• renderAssignedUsersArray() — Returns user array in table view
• renderCPEAssignedUsers() — Renders list of users assigned with some CPE
• renderCPECreateForm() — Renders CPE creation form
• renderCPEEditForm() — Renders CPE edit form
• renderCPEList() — Renders available CPE list container
• renderCpeUserControls() — Renders user profile CPE controls
• renderDevicesMap() — Renders wireless devices map
• saveCPE() — Performs CPE changes, return string on error