\UbillingBranches

ISP branches implementation

Synopsis

class UbillingBranches {

// constants
const URL_ME = '?module=branches';
const URL_USERPROFILE = '?module=userprofile&username=';
const URL_TRAFFSTATS = '?module=traffstats&username=';
const URL_ADDCASH = '?module=addcash&username=';
const EX_NO_BRANCH = 'EX_BRANCHID_NOT_EXISTS';
const EX_NO_NAME = 'EX_EMPTY_BRANCH_NAME';
const EX_NO_USER = 'EX_EMPTY_LOGIN';
const EX_NO_CITY = 'EX_EMPTY_CITY';
const EX_NO_TARIFF = 'EX_EMPTY_TARIFF';
const EX_NO_SERVICE = 'EX_EMPTY_SERVICE';
const EX_NO_ADMIN = 'EX_EMPTY_ADMIN';

// members
protected string $myLogin = '';
protected array $myBranches = ;
protected array $branches = ;
protected array $branchesLogins = ;
protected array $myUsers = ;
protected array $branchesAdmins = ;
protected array $branchesCities = ;
protected array $allCityNames = ;
protected array $myCities = ;
protected array $branchesTariffs = ;
protected array $allTariffs = ;
protected array $myTariffs = ;
protected array $branchesServices = ;
protected array $allServices = ;
protected array $myServices = ;
protected array $altCfg = ;
protected $messages = '';
protected bool $branchesEnabled = false;

// methods
public void __construct()
protected void setLogin()
protected void loadAlter()
protected void initMessages()
protected void loadBranches()
protected void loadBranchesAdmins()
public void loadCities()
public void loadTariffs()
public void loadServices()
protected void setMyBranches()
protected void loadBranchesUsers()
public int createBranch()
public bool isBranchProtected()
public void deleteBranch()
public void editBranch()
protected bool isAdminBranchAssigned()
public void adminAssignBranch()
public void adminDeassignBranch()
public void userAssignBranch()
public void userDeleteBranch()
public bool isMyUser()
public bool isMyCity()
public bool isMyTariff()
public bool isMyService()
public bool isMyBranch()
public int userGetBranch()
public string userGetBranchName()
public void cityAssignBranch()
public void cityDeassignBranch()
public void tariffAssignBranch()
public void tariffDeassignBranch()
public void serviceAssignBranch()
public void serviceDeassignBranch()
public string panel()
public string renderUserList()
public string getBranchName()
public array getBranchesAvailable()
public void renderUserListJson()
public string renderFinanceReport()
public string renderSignupReport()
protected string renderBranchEditForm()
protected string renderBranchesConfigForm()
protected string renderAdminConfigForm()
public string renderCitiesConfigForm()
public string renderTariffsConfigForm()
public string renderServicesConfigForm()
public string renderSettingsBranches()
public void accessControl()
public string branchSelector()
public string renderUserBranchFrom()
public void catchUserBranchEditRequest()

}

Constants

Name	Value
URL_ME	'?module=branches'
URL_USERPROFILE	'?module=userprofile&username='
URL_TRAFFSTATS	'?module=traffstats&username='
URL_ADDCASH	'?module=addcash&username='
EX_NO_BRANCH	'EX_BRANCHID_NOT_EXISTS'
EX_NO_NAME	'EX_EMPTY_BRANCH_NAME'
EX_NO_USER	'EX_EMPTY_LOGIN'
EX_NO_CITY	'EX_EMPTY_CITY'
EX_NO_TARIFF	'EX_EMPTY_TARIFF'
EX_NO_SERVICE	'EX_EMPTY_SERVICE'
EX_NO_ADMIN	'EX_EMPTY_ADMIN'

Members

protected

$allCityNames — array
Contains available cities names as cityid=>cityname
$allServices — array
Contains array of available services as id=>name
$allTariffs — array
Contains all available tariffs as tariffname=>fee
$altCfg — array
Contains system alter.ini config as key=>value
$branches — array
Contains available branches as id=>branch data
$branchesAdmins — array
Contains branches admins as id=>data
$branchesCities — array
Contains array of id=>assigndata assigns for cities
$branchesEnabled — bool
Branches enabled flag
$branchesLogins — array
Contains login assins for branches as login=>branchid
$branchesServices — array
Contains array of id=>assingdata for services
$branchesTariffs — array
Contains array of id=>assigndata for tariffs
$messages —
Contains system mussages object placeholder

$myBranches — array
Contains available branches as branchid=>admin login

$myCities — array
Contains array of accessible cities for current administrator as cityid=>cityname

$myLogin — string
Contains current user login

$myServices — array
Contains array of accessible services for current administrator as serviceid=>servicename

$myTariffs — array
Contains array of accessible tariffs for current administrator as tariffname=>tariffname

$myUsers — array
Users logins allowed for current administrator as login=>branchid

Methods

protected

initMessages() — Inits system messages helper object for further usage
isAdminBranchAssigned() — Checks is admin assigned to some branch, to prevent duplicates
loadAlter() — Loads system alter config into protected property
loadBranches() — Loads available branches from database
loadBranchesAdmins() — Loads available branches admins from database
loadBranchesUsers() — Loads available user-branch pairs from database
renderAdminConfigForm() — Returns branches admins assignation list and config form
renderBranchEditForm() — Returns branch editing form
renderBranchesConfigForm() — Renders list of available branches and reqired controls for its management
setLogin() — Sets current user login
setMyBranches() — Gets current administrator branches IDs and sets it intoprotected prop

public

__construct()
accessControl() — Contols user module branch access rights
adminAssignBranch() — Assigns administrator with some existing branch
adminDeassignBranch() — Deassigns administrator with some existing branch
branchSelector() — Returns selector widget for accessible branches
catchUserBranchEditRequest() — Catches and performs user branch changing if required
cityAssignBranch() — Perfoms city to branch assign
cityDeassignBranch() — Performs deletion of city assignation to some branch
createBranch() — Creates new branch
deleteBranch() — Deletes branch by its ID
editBranch() — Updates existing branch name
getBranchName() — Returns branch name by its ID
getBranchesAvailable() — Returns array of available branches as branchid=>branchname
isBranchProtected() — Checks is branch have assigned users
isMyBranch() — Checks is branch accessible by current administrator
isMyCity() — Checks is city accessible by current administrator
isMyService() — Checks is service accessible by current administrator
isMyTariff() — Checks is tariff accessible by current administrator
isMyUser() — Checks is user accessible by current administrator
loadCities() — Loads cities assigns from database into protected prop. Must be executed first before isMyCity() usage.
loadServices() — Loads services assings from database into protected properties
loadTariffs() — Loads cities assigns from database into protected prop
panel() — Renders branches module control panel interface
renderCitiesConfigForm() — Returns branches=>cities assign list and config form
renderFinanceReport() — Renders finance report
renderServicesConfigForm() — Returns branches=>services assign list and config form
renderSettingsBranches() — Returns branches management form
renderSignupReport() — Renders branch users signup report
renderTariffsConfigForm() — Returns branches=>tariffs assign list and config form
renderUserBranchFrom() — Renders users assign/editing branch form
renderUserList() — Renders user list container
renderUserListJson() — Builds and renders users list JSON data
serviceAssignBranch() — Perfoms service to branch assign
serviceDeassignBranch() — Performs deletion of service assignation to some branch
tariffAssignBranch() — Perfoms tariff to branch assign
tariffDeassignBranch() — Performs deletion of tariff assignation to some branch
userAssignBranch() — Assigns user login with existing branch ID
userDeleteBranch() — Deletes user assigned branch
userGetBranch() — Returns user assigned branch
userGetBranchName() — Returns user branch name by his login