\ClapTrapMgr

CL4P-TP management interface

Synopsis

class ClapTrapMgr {

• // constants
• const URL_ME = '?module=cltpmgr';
• const ROUTE_USERS = 'showusers';
• const ROUTE_CONFIG = 'hookconfig';
• const ROUTE_SENDING = 'messagesending';
• const ROUTE_TEMPLATES = 'templates';
• const ROUTE_FILTERS = 'filters';
• const ROUTE_INSTALL = 'install';
• const PROUTE_HOOK_URL = 'newhookinstall';
• const POOL_PATH = './exports/';
• const URL_MACROHELP = 'http://wiki.ubilling.net.ua/doku.php?id=templating&#smszilla';
• const TABLE_TEMPLATES = 'ct_templates';
• const TABLE_FILTERS = 'ct_filters';
• const REMOTEAPI_ACTION = 'ctzilla';
• // members
• protected array $altCfg = ;
• protected string $token = '';
• protected string $hookUrl = '';
• protected string $authString = '';
• protected  $telegram = '';
• protected  $botInstance = '';
• protected  $messages = '';
• protected array $allTariffs = ;
• protected array $allTariffPrices = ;
• protected array $allCities = ;
• protected array $allUserData = ;
• protected array $allTagTypes = ;
• protected array $templates = ;
• protected array $filters = ;
• protected array $filterNames = ;
• protected array $supportedMacro = ;
• protected array $botAuthRaw = ;
• protected array $botAuthGrouped = ;
• protected array $filteredEntities = ;
• protected array $filteredChatIds = ;
• protected  $fundsFlow = '';
• protected array $inetTags = ;
• protected array $downUsers = ;
• protected array $opCustomers = ;
• protected array $filterStats = ;
• protected  $templatesDb = '';
• protected  $filtersDb = '';
• // methods
• public void __construct()
• protected bool isRemoteApiSendingCall()
• protected void loadAlter()
• protected void setOptions()
• protected void initTelegram()
• protected void initMessages()
• protected void initBotInstance()
• protected void loadCities()
• protected void loadTariffs()
• protected void loadTagTypes()
• protected void loadInetTags()
• protected void loadUsers()
• protected void loadOpCustomers()
• protected void initTemplatesFiltersDb()
• protected void loadTemplates()
• protected void loadFilters()
• protected void loadBotAuth()
• protected int getFilteredChatIdsCount()
• protected void initFundsFlow()
• protected int getUserOnlineLeftDayCount()
• protected string getUserOnlineToDate()
• public string renderControls()
• public string urlSending()
• public string renderSendingControls()
• public int createTemplate()
• public string deleteTemplate()
• public string saveTemplate()
• public string renderTemplateCreateForm()
• protected string renderMacroHelp()
• public string renderTemplateEditForm()
• public string renderTemplatesList()
• public string renderFilterCreateForm()
• public string createFilter()
• protected string renderFilterPreview()
• public string renderFiltersList()
• public string deleteFilter()
• protected bool checkInetTagId()
• protected void initBaseFilteredEntities()
• protected void extractChatIds()
• protected void saveFilterStats()
• protected string renderFilterStats()
• public string renderSendingForm()
• public array filtersPreprocessing()
• protected string renderMessagePoolPreviewContainer()
• public void ajaxPreviewReply()
• protected string generateMessageText()
• protected void generateMessagePool()
• protected void filtercity()
• protected void filteraddress()
• protected void filterrealname()
• protected void filterip()
• protected void filtercashmonth()
• protected void filtercashdays()
• protected void filtercashgreater()
• protected void filtercashlesser()
• protected void filtercashlesszero()
• protected void filtercashzero()
• protected void filtercreditset()
• protected void filtertags()
• protected void filterao()
• protected void filterpassive()
• protected void filternotpassive()
• protected void filteractive()
• protected void filterdown()
• protected void filtertariff()
• protected void filtertariffcontain()
• protected void filtertariffnm()
• public array getActualHookInfo()
• protected string isHookUrlValid()
• public string renderInstallHookForm()
• public string installHook()
• public string renderHookInfo()
• protected string chatIdLed()
• public string renderAuthData()
}


Constants

Name	Value
URL_ME	'?module=cltpmgr'
ROUTE_USERS	'showusers'
ROUTE_CONFIG	'hookconfig'
ROUTE_SENDING	'messagesending'
ROUTE_TEMPLATES	'templates'
ROUTE_FILTERS	'filters'
ROUTE_INSTALL	'install'
PROUTE_HOOK_URL	'newhookinstall'
POOL_PATH	'./exports/'
URL_MACROHELP	'http://wiki.ubilling.net.ua/doku.php?id=templating&#smszilla'
TABLE_TEMPLATES	'ct_templates'
TABLE_FILTERS	'ct_filters'
REMOTEAPI_ACTION	'ctzilla'

Members

protected

• $allCities — array
  Contains available cities as cityid=>data
• $allTagTypes — array
  Contains available tag types as id=>name
• $allTariffPrices — array
  Contains available internet tariffs prices
• $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
  Contains system alter config as key=>value
• $authString — string
  Contains current instance authentication string
• $botAuthGrouped — array
  Contains active bot chat IDs grouped by login as login=>array(chatid)
• $botAuthRaw — array
  Contains bot auth data as id=>authData
• $botInstance —
  ClapTrapBot object instance
• $downUsers — array
  Contains all users and their down state as login=>state
• $filterNames — array
  Contains available filters names
• $filterStats — array
  Filter workflow stats
• $filteredChatIds — array
  Contains filtered chat IDs as login=>array(chatid)
• $filteredEntities — array
  Contains entities that passed full filter set
• $filters — array
  Contains available filters
• $filtersDb —
  Filters database abstraction layer
• $fundsFlow —
  FundsFlow object placeholder
• $hookUrl — string
  Contains current instance hook URL
• $inetTags — array
  Contains tags for internet users as login=>array(tagid=>tagname)
• $messages —
  Contains messages helper object instance
• $opCustomers — array
  OpenPayz customers as login=>paymentid
• $supportedMacro — array
  Contains supported template macros
• $telegram —
  Telegram API object instance
• $templates — array
  Contains available templates as id=>data
• $templatesDb —
  Templates database abstraction layer
• $token — string
  Contains current instance bot token

Methods

protected

• chatIdLed() — Renders chat ID activity as LED indicator
• checkInetTagId() — Checks have user some tag assigned
• extractChatIds() — Extracts chat IDs from filtered entities
• filteractive() — User activity filter
• filteraddress() — Address filter
• filterao() — AlwaysOnline filter
• filtercashdays() — Days less cash filter
• filtercashgreater() — Greater cash filter
• filtercashlesser() — Lesser cash filter
• filtercashlesszero() — Lesser zero cash filter
• filtercashmonth() — Month cash filter
• filtercashzero() — Zero cash filter
• filtercity() — City filter
• filtercreditset() — Credit filter
• filterdown() — Down filter
• filterip() — IP substring filter
• filternotpassive() — Not passive filter
• filterpassive() — Passive filter
• filterrealname() — Real name filter
• filtertags() — Tags filter
• filtertariff() — Tariff filter
• filtertariffcontain() — Tariff contains filter
• filtertariffnm() — Planned tariff change filter
• generateMessagePool() — Generates message pool for preview or queue sending
• generateMessageText() — Generates message text for sending/preview
• getFilteredChatIdsCount() — Returns total count of filtered chat IDs across all logins
• getUserOnlineLeftDayCount() — Returns user online left days
• getUserOnlineToDate() — Returns user online to date
• initBaseFilteredEntities() — Initializes base filtered entities from active bot subscribers
• initBotInstance() — Initializes ClapTrapBot object instance
• initFundsFlow() — Inits funds flow object instance
• initMessages() — Initializes message helper object instance
• initTelegram() — Initializes Telegram object instance
• initTemplatesFiltersDb() — Inits templates and filters database abstraction layers
• isHookUrlValid() — Checks if hook URL is valid
• isRemoteApiSendingCall() — Detects remote API background sending call
• loadAlter() — Loads system alter config into protected property for further usage
• loadBotAuth() — Loads bot auth data and builds active chat IDs grouped by login
• loadCities() — Loads existing cities from database
• loadFilters() — Loads existing filters from database
• loadInetTags() — Loads user tags as login=>array(tagid=>tagname)
• loadOpCustomers() — Sets up OpenPayz paymentIDs as login=>paymentid into protected property for further usage
• loadTagTypes() — Loads existing tag types from database
• loadTariffs() — Loads existing tariffs from database
• loadTemplates() — Loads existing templates from database
• loadUsers() — Loads all existing Internet users from database
• renderFilterPreview() — Renders existing filter preview
• renderFilterStats() — Renders filtered processing stats chart
• renderMacroHelp() — Renders supported templating macro short help
• renderMessagePoolPreviewContainer() — Renders message pool preview container
• saveFilterStats() — Saves each filter workflow stats
• setOptions() — Sets current instance options from config values

public

• __construct()
• ajaxPreviewReply() — Renders previously cached preview JSON data
• createFilter() — Creates new filter in database
• createTemplate() — Creates new message text template
• deleteFilter() — Deletes existing filter from database
• deleteTemplate() — Deletes existing template
• filtersPreprocessing() — Performs filter entities preprocessing
• getActualHookInfo() — Returns actual bot hook state as array
• installHook() — Installs hook for ClapTrapBot
• renderAuthData() — Renders auth data as users list with additional columns
• renderControls() — Renders module control panel
• renderFilterCreateForm() — Renders filter creation form
• renderFiltersList() — Renders available filters list
• renderHookInfo() — Renders actual bot hook state as readable table
• renderInstallHookForm() — Renders install hook form
• renderSendingControls() — Renders message sending section sub-navigation
• renderSendingForm() — Renders template and filters selection form
• renderTemplateCreateForm() — Renders new template creation form
• renderTemplateEditForm() — Renders existing template edit form
• renderTemplatesList() — Renders existing templates list with controls
• saveTemplate() — Saves changes in existing template
• urlSending() — Returns URL for message sending section with optional extra query params