\PTV

ProstoTV Ubilling abstraction layer

https://docs.api.prosto.tv/

Synopsis

class PTV {

• // constants
• const OPTION_LOGIN = 'PTV_LOGIN';
• const OPTION_PASSWORD = 'PTV_PASSWORD';
• const TABLE_SUBSCRIBERS = 'ptv_subscribers';
• const TABLE_TARIFFS = 'ptv_tariffs';
• const UNDEF = 'undefined_';
• const NEW_WINDOW = 'TARGET="_BLANK"';
• const URL_ME = '?module=prostotv';
• const URL_USERPROFILE = '?module=userprofile&username=';
• const ROUTE_SUBLIST = 'subscribers';
• const ROUTE_SUBAJ = 'ajaxlist';
• const ROUTE_SUBVIEW = 'showsubscriber';
• const ROUTE_TARIFFS = 'tariffs';
• const ROUTE_BUNDLES = 'bundles';
• const ROUTE_PLCREATE = 'createplaylist';
• const ROUTE_PLDEL = 'deleteplaylist';
• const ROUTE_SUBID = 'subscriberid';
• const ROUTE_DEVCREATE = 'createdevice';
• const ROUTE_DEVDEL = 'deletedevice';
• const ROUTE_SUBLOOKUP = 'username';
• const ROUTE_TARDEL = 'deletetariff';
• const PROUTE_SUBREG = 'registersubscriber';
• const PROUTE_CREATETARIFFID = 'newtariffserviceid';
• const PROUTE_CREATETARIFFMAIN = 'newtariffmainflag';
• const PROUTE_CREATETARIFFNAME = 'newtariffname';
• const PROUTE_CREATETARIFFCHANS = 'newtariffchans';
• const PROUTE_CREATETARIFFFEE = 'newtarifffee';
• const PROUTE_TARIFFEDITSUBID = 'changetariffsubscriberid';
• const PROUTE_SETMAINTARIFFID = 'changemaintariffserviceid';
• const PROUTE_SETADDTARIFFID = 'changeaddionaltariffs';
• // members
• protected array $altCfg = ;
• protected string $login = '';
• protected string $password = '';
• protected  $api = '';
• protected array $allUserData = ;
• protected array $allSubscribers = ;
• protected array $allTariffs = ;
• protected  $subscribersDb = '';
• protected  $tariffsDb = '';
• protected  $messages = '';
• // methods
• public void __construct()
• protected void loadConfig()
• protected void setOptions()
• protected void initMessages()
• protected void initApi()
• protected void initSubscribersDb()
• protected void initTariffsDb()
• protected void loadSubscribers()
• protected void loadTariffs()
• protected void loadUserData()
• public array/bool userRegister()
• public array/bool getUserData()
• public bool isValidSubscriber()
• public array/bool getPlaylistsAll()
• public string/bool getSubscriberLogin()
• public int/bool getSubscriberId()
• public array/bool createPlayList()
• public array/bool createDevice()
• public array/bool deleteDevice()
• public void deletePlaylist()
• public void renderSubsribersAjReply()
• public string renderSubscribersList()
• protected string renderServices()
• public string renderSubscriber()
• protected string renderDevices()
• protected string renderPlaylists()
• protected string renderUserTariffEditForm()
• public void setMainTariff()
• protected string renderSubscriberControls()
• protected string renderUserRegisterForm()
• public string renderPanel()
• public string renderBundles()
• protected string renderTariffCreateForm()
• public void/string createTariff()
• public void/string deleteTariff()
• protected bool isTariffProtected()
• public string renderTariffs()
• public void chargeUserFee()
• public void feeProcessing()
• protected void jsonRenderReply()
• public void usReplyUserData()
• public void usReplyUserFullData()
• public void usReplyTariffs()
• public void usUnsubscribe()
• public void usSubscribe()
}


Constants

Name	Value
OPTION_LOGIN	'PTV_LOGIN'
OPTION_PASSWORD	'PTV_PASSWORD'
TABLE_SUBSCRIBERS	'ptv_subscribers'
TABLE_TARIFFS	'ptv_tariffs'
UNDEF	'undefined_'
NEW_WINDOW	'TARGET="_BLANK"'
URL_ME	'?module=prostotv'
URL_USERPROFILE	'?module=userprofile&username='
ROUTE_SUBLIST	'subscribers'
ROUTE_SUBAJ	'ajaxlist'
ROUTE_SUBVIEW	'showsubscriber'
ROUTE_TARIFFS	'tariffs'
ROUTE_BUNDLES	'bundles'
ROUTE_PLCREATE	'createplaylist'
ROUTE_PLDEL	'deleteplaylist'
ROUTE_SUBID	'subscriberid'
ROUTE_DEVCREATE	'createdevice'
ROUTE_DEVDEL	'deletedevice'
ROUTE_SUBLOOKUP	'username'
ROUTE_TARDEL	'deletetariff'
PROUTE_SUBREG	'registersubscriber'
PROUTE_CREATETARIFFID	'newtariffserviceid'
PROUTE_CREATETARIFFMAIN	'newtariffmainflag'
PROUTE_CREATETARIFFNAME	'newtariffname'
PROUTE_CREATETARIFFCHANS	'newtariffchans'
PROUTE_CREATETARIFFFEE	'newtarifffee'
PROUTE_TARIFFEDITSUBID	'changetariffsubscriberid'
PROUTE_SETMAINTARIFFID	'changemaintariffserviceid'
PROUTE_SETADDTARIFFID	'changeaddionaltariffs'

Members

protected

• $allSubscribers — array
  Contains all subscribers data as login=>subscriberData
• $allTariffs — array
  Contains all tariffs data as serviceid=>tariffData
• $allUserData — array
  Contains all available system users data as login=>userdata
• $altCfg — array
  Contains sytem alter.config as key=>value
• $api —
  ProstoTV low-level API abstraction layer
• $login — string
  Contains login preloaded from config
• $messages —
  System message helper object placeholder
• $password — string
  Contains password preloaded from config
• $subscribersDb —
  Subscribers database abstraction layer
• $tariffsDb —
  Tariffs database abstraction layer

Methods

protected

• initApi() — Inits low-level API for further usage
• initMessages() — Inits system message helper
• initSubscribersDb() — Inits subscribers database abstraction layer
• initTariffsDb() — Inits tariffs database abstraction layer
• isTariffProtected() — Checks is some tariff protected of usage by some user
• jsonRenderReply() — Renders JSON reply for some userstats frontend requests
• loadConfig() — Preloads required configs into protected props
• loadSubscribers() — Loads available subscribers from database
• loadTariffs() — Loads available tariffs from database
• loadUserData() — Loads available system users data
• renderDevices() — Renders devices of some subscriber
• renderPlaylists() — Renders playlists of some subscriber
• renderServices() — Renders subscriber services
• renderSubscriberControls() — Returns some subscriber controls
• renderTariffCreateForm() — Renders new tariff creation form
• renderUserRegisterForm() — Renders basic user registration form
• renderUserTariffEditForm() — Renders users tariff change form
• setOptions() — Sets required properties via config options

public

• __construct() — I keep my eyes low, looking for my rival Eyes Low Playing with the rifle White dope Feeling homicidal Ride slow Fucking up your spinal
• chargeUserFee() — Charges some tariff fee from user account
• createDevice() — Creates some device for subscriber
• createPlayList() — Creates new playlist for some subscriber
• createTariff() — Creates new tariff in database
• deleteDevice() — Deletes some device for subscriber
• deletePlaylist() — Deletes some subscriber`s playlist
• deleteTariff() — Deletes existing tariff from database
• feeProcessing() — Performs fee processing of all registered subscribers
• getPlaylistsAll() — Returns array of all existing user playlists
• getSubscriberId() — Returns subscripber ID by some of the users login
• getSubscriberLogin() — Returns existing subscriber user login by its ID
• getUserData() — Returns subscriber remote data
• isValidSubscriber() — Checks is some subscriberId associated with registered user?
• renderBundles() — Renders bundles (server side tariffs) available at service
• renderPanel() — Renders primary module controls
• renderSubscriber() — Renders basic subscriber profile
• renderSubscribersList() — Renders existing subscribers list container
• renderSubsribersAjReply() — Renders available subscribers JSON list
• renderTariffs() — Renders list of tariffs available for users
• setMainTariff() — Sets primary tariff for some subscriber
• usReplyTariffs() — Renders available tariffs list
• usReplyUserData() — Renders user subscription data for some login
• usReplyUserFullData() — Renders subscriber full data
• usSubscribe() — Subscribes user to some service
• usUnsubscribe() — Just deactivates service fro user account
• userRegister() — Registers a new user