\UserSideApi
Userside integration API https://www.userside.eu
Synopsis
class UserSideApi
{
- // constants
- const API_VER = '1.5';
- const API_DATE = '06.10.2017';
- // members
- protected array $altCfg = ;
- protected array $allTariffs = ;
- protected array $allTariffSpeeds = ;
- protected array $allTariffPeriods = ;
- protected array $allCities = ;
- protected array $allStreets = ;
- protected array $allBuilds = ;
- protected array $allCfTypes = ;
- protected array $allCfData = ;
- protected array $allUserData = ;
- protected array $allTagTypes = ;
- protected array $supportedMethods = ;
- protected array $supportedChangeMethods = ;
- protected array $supportedChageUserState = ;
- protected array $errorNotices = ;
- protected string $defaultStreetType = '';
- protected string $defaultCityType = '';
- protected array $buildPassports = ;
- protected array $vServices = ;
- protected array $serviceTagMappings = ;
- protected array $allDeviceTypes = ;
- protected array $allSwitchModels = ;
- protected array $allSwitches = ;
- protected bool $debugMode = false;
- // methods
- public void __construct()
- protected void loadAlter()
- protected void setOptions()
- protected void loadUsers()
- protected void loadTariffs()
- protected void loadTariffSpeeds()
- protected void loadTariffPeriods()
- protected void loadCities()
- protected void loadBuilds()
- protected void loadStreets()
- protected void loadCF()
- protected array getUserRegData()
- protected void loadTagTypes()
- protected void loadBuildPassports()
- protected void loadVservices()
- protected void loadSwitchModels()
- protected void loadSwitchesAll()
- protected void renderReply()
- protected array getTariffsData()
- protected array getCitiesData()
- protected array getStreetsData()
- protected array getBuildsData()
- protected array getCFTypesData()
- protected array getUsersStateList()
- protected array getTagTypesList()
- protected array getMethodsList()
- protected array getChangeMethodsList()
- protected array getChangeStateMethodsList()
- protected array getDeviceTypesList()
- protected array getDeviceModels()
- protected array getDevicesList()
- protected int getDeviceType()
- protected array getDeviceConnectionsList()
- protected array getApiInformation()
- protected array getSystemInformation()
- protected array getAllUsersTags()
- protected array getAllUserPaymentIds()
- protected array getAllAddressList()
- protected array getAllAptList()
- protected array getNethostsData()
- protected array getNetworksData()
- protected array getUsersMessages()
- protected array getUsersList()
- protected array getUserTags()
- protected array getServicesList()
- protected array getUserFinanceHistory()
- protected array catchChangeParams()
- protected array changeUserFinance()
- protected array changeUserFinanceCorrect()
- protected array changeUserRealName()
- protected array changeUserNotes()
- protected array changeUserTariff()
- protected array changeUserState()
- public void catchRequest()
Constants
Name | Value |
---|---|
API_VER | '1.5' |
API_DATE | '06.10.2017' |
Members
protected
- $allBuilds
—
array
Contains all available builds array as buildid=>builddata - $allCfData
—
array
Contains available custom fields data as login+cftypeid=>data - $allCfTypes
—
array
Contains available custom fields types as id=>name - $allCities
—
array
Contains available cities as cityid=>data - $allDeviceTypes
—
array
Contains available device types as id=>name - $allStreets
—
array
Contains available streets array as streetid=>data - $allSwitchModels
—
array
Contains available devices models as id=>modeldata - $allSwitches
—
array
Contains available devices directory as id=>devicedata - $allTagTypes
—
array
Contains available tag types as id=>name - $allTariffPeriods
—
array
Contains all tariffs periods as tariffname=>period (month/day) - $allTariffSpeeds
—
array
Contains all of available tariff speeds as tariffname=>data (speeddown/speedup keys) - $allTariffs
—
array
Contains all of available tariffs data as tariffname=>data - $allUserData
—
array
Contains data of all available Internet users as login=>data - $altCfg
—
array
Stores system alter config as key=>value - $buildPassports
—
array
Contains build passports data as buildid=>data - $debugMode
—
bool
Debug mode flag - $defaultCityType
—
string
Default city type. May be configurable in future - $defaultStreetType
—
string
Default streets type. May be configurable in future - $errorNotices
—
array
Contains localised error notices - $serviceTagMappings
—
array
Contains virtual services to user tags mappings as tagid=>serviceid - $supportedChageUserState
—
array
Contains supported user states to change - $supportedChangeMethods
—
array
Contains supported methods for change_user_data request - $supportedMethods
—
array
Contains supported methods list - $vServices
—
array
Contains list of available virtual services as id=>data
Methods
protected
- catchChangeParams() — Catches and preprocess change_user_data request params
- changeUserFinance() — Do some user finance data changes
- changeUserFinanceCorrect() — Do some user finance data correct
- changeUserNotes() — Changes user notes
- changeUserRealName() — Changes user RealName
- changeUserState() — Changes user basic state
- changeUserTariff() — Changes user tariff
- getAllAddressList() — Returns array of all available login=>apt bindings
- getAllAptList() — Returns array of all available apartments data as id=>data
- getAllUserPaymentIds() — Returns array of all available PaymentIDs
- getAllUsersTags() — Returns array of all tagtypes set to users
- getApiInformation() — Returns Userside API information
- getBuildsData() — Returns streets data array
- getCFTypesData() — Returns customfield types data
- getChangeMethodsList() — Returns available change methods list
- getChangeStateMethodsList() — Returns supported change user state options
- getCitiesData() — Returns city data array
- getDeviceConnectionsList() — Returns array of devices connection topology
- getDeviceModels() — Returns available device models
- getDeviceType() — Returns device type id
- getDeviceTypesList() — Returns available devices types
- getDevicesList() — Returns list of available devices in database
- getMethodsList() — Returns available methods array
- getNethostsData() — Returns array of all nethosts data as ip=>data
- getNetworksData() — Returns data of available multinet networks as netid=>data
- getServicesList() — Returns list of available services
- getStreetsData() — Returns streets data array
- getSystemInformation() — Returns server system information
- getTagTypesList() — Returns available tag types data
- getTariffsData() — Returns array of all of existing tariffs data
- getUserFinanceHistory() — Returns users finance operations history
- getUserRegData() — Returns all users registration dates as login=>date
- getUserTags() — Returns array of available tags
- getUsersList() — Returns existing users full info
- getUsersMessages() — Returns all users support tickets
- getUsersStateList() — Returns users states data
- loadAlter() — Loads system alter config into private property for further usage
- loadBuildPassports() — Preloads available build passports for further usage
- loadBuilds() — Loads existing builds from database
- loadCF() — Loads existing custom fields data from database
- loadCities() — Loads existing cities from database
- loadStreets() — Loads existing streets from database
- loadSwitchModels() — Loads available devices models from database
- loadSwitchesAll() — Loads existing devices directory from database
- loadTagTypes() — Loads existing tag types from database
- loadTariffPeriods() — Loads existing tariff periods from database into protected property for further usage
- loadTariffSpeeds() — Loads existing tariff speeds from database into protected property for further usage
- loadTariffs() — Loads existing tariffs from database into protected property for further usage
- loadUsers() — Loads all existing Internet users from database
- loadVservices() — Loads array of available virtual services
- renderReply() — Renders API reply as JSON string
- setOptions() — Sets object default properties
public
- __construct() — Creates new instance of basic UserSide API
- catchRequest() — Listens API requests and renders replies for it