\Districts
Coverage map districts absctraction
Synopsis
class Districts
{
- // constants
- const CACHE_TIME = 3600;
- const URL_ME = '?module=districts';
- const URL_PROFILE = '?module=userprofile&username=';
- // members
- protected array $allDistricts = ;
- protected array $allDistrictData = ;
- protected array $allCities = ;
- protected array $allStreets = ;
- protected array $allBuilds = ;
- protected array $allApts = ;
- protected array $allAddress = ;
- protected array $allUserData = ;
- protected bool $accurateActivityDetection = true;
- protected $messages = '';
- protected $cache = '';
- protected array $cachedData = ;
- // methods
- public void __construct()
- protected void initMessages()
- protected void initCache()
- protected void loadDistricts()
- protected void loadDistrictData()
- protected void loadCityData()
- protected void loadStreetData()
- protected void loadBuildData()
- protected void loadAptData()
- protected void loadAddressData()
- protected void loadUserData()
- public string renderDistrictsCreateForm()
- public string renderDistrictsEditForm()
- public void createDistrict()
- public void deleteDistrict()
- public void saveDistrictName()
- public string renderDistrictsList()
- protected string getBuildForm()
- public string renderDistrictDataCreateForm()
- public void catchDistrictDataCreate()
- public string getDistrictName()
- public array getDistricts()
- public string renderDistrictData()
- public void deleteDistrictData()
- public string renderDistrictUsersContainer()
- protected bool isUserActive()
- protected bool isUserInDistrict()
- public void renderDistrictUsersAjaxData()
- public void fillDistrictsCache()
- public array getUserDistrictsFast()
- public bool checkUserDistrictFast()
- public string getUserDistrictsListFast()
Constants
Name | Value |
---|---|
CACHE_TIME | 3600 |
URL_ME | '?module=districts' |
URL_PROFILE | '?module=userprofile&username=' |
Members
protected
- $accurateActivityDetection
—
bool
Flag that signalizes, how accurate we need to detect user ativity. - $allAddress
—
array
Contains available address data as login=>aptid - $allApts
—
array
Contains available apts as id=>data - $allBuilds
—
array
Contains available builds as id=>data - $allCities
—
array
Contains available cities as id=>data - $allDistrictData
—
array
Contains array of available districts data as id=>data - $allDistricts
—
array
Contains available districts as id=>name - $allStreets
—
array
Contains available streets as id=>data - $allUserData
—
array
Contains available users data as login=>data - $cache
—
System caching object placeholder - $cachedData
—
array
Contains previously cached login=>districts data - $messages
—
System message helper object placeholder
Methods
protected
- getBuildForm() — Returns list of checkbox controls for some previously selected street
- initCache() — Initalizes system caching object for further usage
- initMessages() — Inits system messages helper object instance
- isUserActive() — Returns is user active or not. Customizable in future.
- isUserInDistrict() — Checks is user in some district or not
- loadAddressData() — Loads available address apt=>login data from database
- loadAptData() — Loads available apt data from database
- loadBuildData() — Loads available builds data from database
- loadCityData() — Loads available cities from database
- loadDistrictData() — Loads existing districts data from database
- loadDistricts() — Loads existing districts from database
- loadStreetData() — Loads available streets from database
- loadUserData() — Loads existing users data
public
- __construct() — Creates new districts instance
- catchDistrictDataCreate() — Catches new district data creation request
- checkUserDistrictFast() — Check user district based on cached data
- createDistrict() — Creates new district in database
- deleteDistrict() — Deletes some district from database
- deleteDistrictData() — Deletes some district data row from database
- fillDistrictsCache() — Fills districts cache for further fast usage
- getDistrictName() — Returns district name by its ID
- getDistricts() — Returns array of available districts as id=>name
- getUserDistrictsFast() — Returns some user districts array as id=>name from cache
- getUserDistrictsListFast() — Returns list of user districts text list from cache
- renderDistrictData() — Renders available district data with some controls
- renderDistrictDataCreateForm() — Renders new district data creation form
- renderDistrictUsersAjaxData() — Renders datatables report JSON data
- renderDistrictUsersContainer() — Renders districts users report container
- renderDistrictsCreateForm() — Renders district creation form
- renderDistrictsEditForm() — Renders district edit form
- renderDistrictsList() — Renders available districts list with some controls
- saveDistrictName() — Changes district name in database