Module main class
This class helps to make new features, REST API methods, interacts with PBX core system
On the template repository, you can find an example in the file ModuleTemplate/Lib/TemplateConf.php You can use it for your project according to your preferences. The name of this class should be consist of a module unique identifier and ends with the Conf word.
Good examples:
MyFirstModuleConf
MikoCallTrackingConf
TheBestModuleConf
Non-workable examples:
TemplateConf
MyFirstModuleConf1
TheBestModuleConfig
After applying the instructions your config class will be renamed automatically.
Asterisk configs generators
generateConfig
Generates core modules config files with cli messages before and after generation.
Example:
public function generateConfig(): void;extensions.conf
extensionGlobals
Prepares additional parameters for [globals] section in extensions.conf file
Example:
public function extensionGlobals(): string;extensionGenContexts
Prepares additional contexts sections in extensions.conf file
Example:
/**
* Adds the context "miko_new_context" with the extension "10000107"
*
* @return string
*/
public function extensionGenContexts(): string
{
$conf = "[miko_new_context]\n";
$conf .= 'exten => 10000107,1,Answer()' . "\n\t";
$conf .= ' same => n,Set(CHANNEL(hangup_handler_wipe)=hangup_handler_meetme,s,1)' . "\n\t";
$conf .= ' same => n,AGI(cdr_connector.php,meetme_dial)' . "\n\t";
$conf .= ' same => n,Meetme(${mikoidconf},${mikoparamconf})' . "\n\t";
$conf .= ' same => n,Hangup()' . "\n\n";
return $conf;
}getIncludeInternal
Prepares additional includes for [internal] context section in the extensions.conf file
Example:
/**
* Prepares additional includes for [internal] context section in the extensions.conf file
*
* @return string
*/
public function getIncludeInternal(): string
{
$conf = '';
$settings = ModuleSmartIVR::findFirst();
if ($settings !== null) {
$conf = 'include => module_smartivr ' . PHP_EOL;
}
return $conf;
}extensionGenInternal
Prepares additional rules for [internal] context section in the extensions.conf file
Example:
public function extensionGenInternal(): string;getIncludeInternalTransfer
Prepares additional includes for [internal-transfer] context section in the extensions.conf file
Example:
public function getIncludeInternalTransfer(): string;extensionGenInternalTransfer
Prepares additional rules for [internal-transfer] context section in the extensions.conf file
Example:
public function extensionGenInternalTransfer(): string;extensionGenInternalUsersPreDial
Prepares additional rules for [internal-users] context section in the extensions.conf file
Example:
public function extensionGenInternalUsersPreDial(): string;extensionGenHints
Prepares additional hints for [internal-hints] context section in the extensions.conf file
Example:
public function extensionGenHints(): string;extensionGenCreateChannelDialplan
Adds priorities for [dial_create_chan] context section in the extensions.conf file
Example:
public function extensionGenCreateChannelDialplan(): string;generateIncomingRoutBeforeDialPreSystem
Prepares additional parameters for each incoming context for each incoming route before dial in the extensions.conf file
Example:
/**
* Prepares additional parameters for each incoming context for each
* incoming route before dial in the extensions.conf file
*
* @param string $rout_number
*
* @return string
*/
public function generateIncomingRoutBeforeDialPreSystem(string $rout_number): string
{
return '';
}generateIncomingRoutBeforeDial
Prepares additional parameters for each incoming context for each incoming route before dial in extensions.conf file
Example:
/**
* Sends AMI UserEvent with name Interception and the next parameters:
* CALLERID(num), CHANNEL, FROM_DID on every incomming call.
*
* @param $rout_number
*
* @return string
*/
public function generateIncomingRoutBeforeDial(string $rout_number): string
{
$conf = "\t";
$conf = 'same => n,UserEvent(Interception,CALLERID: ${CALLERID(num)},chan: ${CHANNEL},FROM_DID: ${FROM_DID})';
return $conf;
}generateIncomingRoutBeforeDialSystem
Prepares additional parameters for each incoming context for each incoming route before dial in the extensions.conf file
Example:
/**
* Prepares additional parameters for each incoming context for each
* incoming route before dial in the extensions.conf file
*
* @param string $rout_number
*
* @return string
*/
public function generateIncomingRoutBeforeDialSystem(string $rout_number): string
{
return '';
}generateIncomingRoutAfterDialContext
Prepares additional parameters for each incoming context * and incoming route after dial command in an extensions.conf file
Example:
public function generateIncomingRoutAfterDialContext(string $uniqId): string;generatePublicContext
Prepares additional parameters for [public-direct-dial] section in the extensions.conf file
Example:
public function generatePublicContext(): string;generateOutRoutContext
Prepares additional parameters for each outgoing route context before dial call in the extensions.conf file
Example:
/**
* Prepares additional parameters for each outgoing route context
* before dial call in the extensions.conf file
*
* @param $rout
*
* @return string
*/
public function generateOutRoutContext($rout): string
{
$conf = "\t".'same => n,ExecIf($["x${FROM_PEER}" == "x" && "${CHANNEL(channeltype)}" == "PJSIP" ]?Gosub(set_from_peer,s,1))' . " \n\t";
$conf .= 'same => n,Set(GR_VARS=${DB(UsersGroups/${FROM_PEER})})' . " \n\t";
$conf .= 'same => n,ExecIf($["${GR_VARS}x" != "x"]?Exec(Set(${GR_VARS})))' . " \n\t";
$conf .= 'same => n,ExecIf($["${GR_PERM_ENABLE}" == "1" && "${GR_ID_' . $rout['id'] . '}" != "1"]?return)' . " \n\t";
$conf .= 'same => n,ExecIf($["${GR_PERM_ENABLE}" == "1" && "${GR_CID_' . $rout['id'] . '}x" != "x"]?MSet(GR_OLD_CALLERID=${CALLERID(num)},OUTGOING_CID=${GR_CID_' . $rout['id'] . '}))';
return $conf;
}generateOutRoutAfterDialContext
Prepares additional parameters for each outgoing route context after dial call in the extensions.conf file
Example:
/**
* Prepares additional parameters for each outgoing route context after dial action
*
* @param array $rout
*
* @return string
*/
public function generateOutRoutAfterDialContext(array $rout): string
{
return "\t".'same => n,ExecIf($["${GR_PERM_ENABLE}" == "1" && "${GR_OLD_CALLERID}x" != "x"]?MSet(CALLERID(num)=${GR_OLD_CALLERID},GR_OLD_CALLERID=${UNDEFINED}))';
}managers.conf
generateManagerConf
Prepares additional AMI users data in the manager.conf file. This record is not present on the web interface.
Example:
/**
* Prepares additional AMI users data in the manager.conf file
*
*
* @return string
*/
public function generateManagerConf(): string
{
$arr_params = [
'Cdr',
'Dial',
'DialBegin',
'DialEnd',
'ExtensionStatus',
'Hangup',
];
$managerUser = self::MODULE_AMI_USER;
$conf = "[{$managerUser}]" . PHP_EOL;
$conf .= "secret={$managerUser}" . PHP_EOL;
$conf .= 'deny=0.0.0.0/0.0.0.0' . PHP_EOL;
$conf .= 'permit=127.0.0.1/255.255.255.255' . PHP_EOL;
$conf .= 'read=agent,call,cdr,user' . PHP_EOL;
$conf .= 'write=system,call,originate,reporting' . PHP_EOL;
$conf .= 'eventfilter=!UserEvent: CdrConnector' . PHP_EOL;
$conf .= 'eventfilter=Event: (' . implode('|', $arr_params) . ')' . PHP_EOL;
$conf .= PHP_EOL;
return $conf;
}pjsip.conf
generatePeersPj
Prepares additional peers data in the pjsip.conf file
Example:
public function generatePeersPj(): string;generatePeerPjAdditionalOptions
Prepares additional pjsip options on endpoint section in the pjsip.conf file for peer
Example:
public function generatePeerPjAdditionalOptions(array $peer): string;overrideProviderPJSIPOptions
Override pjsip options for provider in the pjsip.conf file
Example:
/**
* Override pjsip options for provider in the pjsip.conf file
*
* @param string $uniqid the provider unique identifier
* @param array $options list of pjsip options
*
* @return array
*/
public function overrideProviderPJSIPOptions(string $uniqid, array $options): array
{
}overridePJSIPOptions
Override pjsip options for peer in the pjsip.conf file
Example:
/**
* Override pjsip options for peer in the pjsip.conf file
* @param string $id
* @param array $options
* @return array
*/
public function overridePJSIPOptions(string $id, array $options):array
{
$groupID = $this->listUsers[$id]??'';
$type = $options['type']??'';
if(!empty($groupID) && $type === 'endpoint'){
$options['call_group'] = $groupID;
$options['pickup_group'] = $groupID;
}
return $options;
}features.conf
getFeatureMap
Prepares additional parameters for [featuremap] section in the features.conf file
Example:
public function getFeatureMap(): string;Other
/**
* Prepares settings dataset for a PBX module
*/
public function getSettings(): void;
/**
* Returns the messages variable
*
* @return array
*/
public function getMessages(): array;
/**
* Returns models list of models which affect the current module settings
*
* @return array
*/
public function getDependenceModels(): array;
getMethodPriority
This method allows overriding the execution priority of a method when called through hookModulesMethod. By defining this method in the Conf class of a module, you can flexibly control the execution priority of HOOK methods. This provides the ability to specify a high priority for a method that generates CRON tasks in an external module, and a low priority for a method that generates peers for pjsip.conf. By changing the priority, you can control the order in which module methods are applied.
Example:
/**
* Allows overriding the execution priority of a method when called
* through hookModulesMethod.
*
* @param string $methodName The name of the method.
* @return int The priority value assigned to the method.
*/
public function getMethodPriority(string $methodName = ''): int
{
switch ($methodName) {
case SystemConfigInterface::CREATE_CRON_TASKS:
$result = 200; // Set a high priority for the method "CREATE_CRON_TASKS"
break;
case AsteriskConfigInterface::GENERATE_PEERS_PJ:
$result = 50000; // Set a low priority for the method "GENERATE_PEERS_PJ"
break;
default:
$result = $this->priority;
}
return $result;
}}REST API Core generators
getPBXCoreRESTAdditionalRoutes
Returns array of additional routes for PBXCoreREST interface from module
[ControllerClass, ActionMethod, RequestTemplate, HttpMethod, RootUrl, NoAuth ]
Example:
public function getPBXCoreRESTAdditionalRoutes(): array
{
return [
[
GetController::class,
'callAction',
'/pbxcore/api/backup/{actionName}',
'get',
'/',
false,
],
[
PostController::class,
'callAction',
'/pbxcore/api/backup/{actionName}',
'post',
'/',
false
],
];
}moduleRestAPICallback
Process PBXCoreREST requests under root rights
Example:
/**
* Process CoreAPI requests under root rights
*
* @param array $request
*
* @return PBXApiResult
*/
public function moduleRestAPICallback(array $request): PBXApiResult
{
$res = new PBXApiResult();
$res->processor = __METHOD__;
$action = strtoupper($request['action']);
if($action === 'CHECK'){
$templateMain = new PT1CCoreMain();
$res = $templateMain->checkModuleWorkProperly();
} else {
$res->success = false;
$res->messages[] = 'API action not found in moduleRestAPICallback';
}
return $res;
}System generators
System events
onAfterPbxStarted
The callback function will execute after PBX started
Example:
public function onAfterPbxStarted(): void;onBeforeModuleEnable
Process before enable action in web interface
Example:
public function onBeforeModuleEnable(): bool;onAfterModuleEnable
Process after enable action in web interface
Example:
/**
* Process enable action
*
* @return void
*/
public function onAfterModuleEnable(): void
{
PBX::dialplanReload();
}onBeforeModuleDisable
Process before disable action in web interface
Example:
public function onBeforeModuleDisable(): bool;onAfterModuleDisable
Process after disable action in web interface
Example:
/**
* Process after disable action in web interface
*
* @return void
*/
public function onAfterModuleDisable(): void
{
PBX::dialplanReload();
}modelsEventChangeData
This method calls in the WorkerModelsEvents after receive each models change
Example:
/**
* Receive information about mikopbx main database changes
*
* @param $data
*/
public function modelsEventChangeData($data): void
{
// f.e. if user changes PBXLanguage, we will restart all workers
if (
$data['model'] === PbxSettings::class
&& $data['recordId'] === 'PBXLanguage'
){
$templateMain = new TemplateMain();
$templateMain->startAllServices(true);
}
}modelsEventNeedReload
This method calls in the WorkerModelsEvents after finished process models changing
Example:
public function modelsEventNeedReload(array $modified_tables): void;Core workers
getModuleWorkers
Returns array of workers classes for WorkerSafeScripts
Example:
/**
* Returns module workers to start it at WorkerSafeScript
*
* @return array
*/
public function getModuleWorkers(): array
{
return [
[
'type' => WorkerSafeScriptsCore::CHECK_BY_BEANSTALK,
'worker' => WorkerTelegramMenu::class,
],
[
'type' => WorkerSafeScriptsCore::CHECK_BY_AMI,
'worker' => WorkerTelegramNotifyAMI::class,
],
];
}Crond
createCronTasks
Add crond tasks
Example:
/**
* Adds crond tasks
*
* @param $tasks
*/
public function createCronTasks(&$tasks): void
{
$workerPath = $this->moduleDir.DIRECTORY_SEPARATOR.'bin'.DIRECTORY_SEPARATOR.'safeScript.php';
$phpPath = Util::which('php');
$tasks[] = "*/1 * * * * {$phpPath} -f {$workerPath} > /dev/null 2> /dev/null\n";
}Iptables
getDefaultFirewallRules
Returns array of additional firewall rules for module
Example:
/**
* Returns array of additional firewall rules for module
*
* @return array
*/
public function getDefaultFirewallRules(): array
{
$defaultWeb = PbxSettings::getValueByKey('WEBPort');
$ajamPort = PbxSettings::getValueByKey('AJAMPort');
return [
'ModulePT1CCore' => [
'rules' => [
[
'portfrom' => $defaultWeb,
'portto' => $defaultWeb,
'protocol' => 'tcp',
'name' => 'PT1CHTTPPort',
'portFromKey' => 'WEBPort',
'portToKey' => 'WEBPort',
],
[
'portfrom' => $ajamPort,
'portto' => $ajamPort,
'protocol' => 'tcp',
'name' => 'PT1CAjamPort',
'portFromKey' => 'AJAMPort',
'portToKey' => 'AJAMPort',
],
],
'action' => 'allow',
'shortName' => 'CTI client 1.0',
],
];
}Fail2Ban
generateFail2BanJails
Generates additional fail2ban jail conf rules
Example:
/**
* Generates additional fail2ban jail conf rules
*
* @return string
*/
public function generateFail2BanJails():string
{
return "[INCLUDES]\n" .
"before = common.conf\n" .
"[Definition]\n" .
"_daemon = (authpriv.warn |auth.warn )?miko_ajam\n" .
'failregex = ^%(__prefix_line)sFrom\s+<HOST>.\s+UserAgent:\s+[a-zA-Z0-9 \s\.,/:;\+\-_\)\(\[\]]*.\s+Fail\s+auth\s+http.$' . "\n" .
' ^%(__prefix_line)sFrom\s+<HOST>.\s+UserAgent:\s+[a-zA-Z0-9 \s\.,/:;\+\-_\)\(\[\]]*.\s+File\s+not\s+found.$' . "\n" .
"ignoreregex =\n";
}Nginx
createNginxLocations
Create additional Nginx locations from modules
Example:
/**
* Create additional Nginx locations from modules
*
*/
public function createNginxLocations(): string
{
$luaScriptPath = $this->moduleDir.'/Lib/http_get_variables.lua';
return "location /pbxcore/api/miko_ajam/getvar {
default_type 'text/plain';
content_by_lua_file {$luaScriptPath};
keepalive_timeout 0;
}";
}WebUI - manipulations
Assets
onAfterAssetsPrepared
Adds assets to the assets manager after it has been prepared.
Example:
/**
* Modifies the system assets on the fly.
*
* @param Phalcon\Assets\Manager $assets The assets manager
* for additional modifications from module.
* @param Phalcon\Mvc\Dispatcher $dispatcher The dispatcher instance.
*
* @return void
*/
public function onAfterAssetsPrepared(Manager $assets, Dispatcher $dispatcher):void
{
$currentController = $dispatcher->getControllerName();
$currentAction = $dispatcher->getActionName();
if ($currentController==='Extensions' and $currentAction==='modify') {
$assets->collection(AssetProvider::FOOTER_JS)
->addJs("js/cache/{$this->moduleUniqueId}/extensions-modify.js", true);
$assets->collection(AssetProvider::HEADER_CSS)
->addCss("css/cache/{$this->moduleUniqueId}/extensions-modify.css", true);
}
}ACL
authenticateUser
Authenticates a user over an external module.
Example:
/**
* Authenticates a user over an external module.
*
* @param string $login The user login entered on the login page.
* @param string $password The user password entered on the login page.
*
* @return array The session data.
*/
public function authenticateUser(string $login, string $password): array
{
if ($login==='cdrView' && $password==='cdrView' )
{
return [
'role' => 'cdrView',
'homePage'=>'call-detail-records/index'
];
}
return [];
}onAfterACLPrepared
Adds roles and permissions to the ACL list after it has been prepared.
Example:
/**
* Adds roles and permissions to the ACL list after it has been prepared.
*
* @param AclList $aclList The ACL list.
*
* @return void
*/
public function onAfterACLPrepared(AclList $aclList): void
{
// Add role for CDR viewers
$aclList->addRole(new AclRole('cdrView', 'Only CDR viewers'));
// Add components and permissions for Extensions
$aclList->addComponent(new Component('Extensions'), ['index']);
// Allow CDR viewers to access Extensions
$aclList->allow('cdrView', 'Extensions', ['index']);
// Add components and permissions for Call Detail Records
$aclList->addComponent(new Component('CallDetailRecords'),
['index', 'get-new-records']);
// Allow CDR viewers to access Call Detail Records (all actions)
$aclList->allow('cdrView', 'CallDetailRecords', '*');
// Add components and permissions for ModuleUsersUiNewMenuItem
$aclList->addComponent(new Component('ModuleUsersUiNewMenuItem'), ['index']);
// Allow CDR viewers to access ModuleUsersUiNewMenuItem
$aclList->allow('cdrView','ModuleUsersUiNewMenuItem',['index']);
// Add components and permissions for /pbxcore/api/sip
$aclList->addComponent(new Component('/pbxcore/api/sip'), ['getPeersStatuses']);
// Allow CDR viewers to access /pbxcore/api/sip with getPeersStatuses action
$aclList->allow('cdrView','/pbxcore/api/sip',['getPeersStatuses']);
// Add components and permissions for /pbxcore/api/advices
$aclList->addComponent(new Component('/pbxcore/api/advices'), ['getList']);
// Allow CDR viewers to access /pbxcore/api/advices with getList action
$aclList->allow('cdrView','/pbxcore/api/advices',['getList']);
}Routes
onAfterExecuteRoute
Example:
/**
* Executes after a route has been executed by the controller.
*
* @param Controller $controller The controller instance.
*
* @return void
*/
public function onAfterExecuteRoute(Controller $controller): void
{
// Check if the controller is an instance of ExtensionsController
if (is_a($controller, ExtensionsController::class)) {
// Intercept the form submission of Extensions with
// fields mod_usrgr_select_group and user_id
$userGroup = $controller->request->getPost('mod_usrgr_select_group');
$userId = $controller->request->getPost('user_id');
// Check if the user group field is not empty
if (!empty($userGroup)) {
$parameters = [
'conditions' => 'user_id = :user_id:',
'bind' => [
'user_id' => $userId,
]
];
// Find the existing group membership based on user ID
$curUserGroup = GroupMembers::findFirst($parameters);
// Update or create the group membership
if ($curUserGroup !== null) {
// Update the group ID with the selected user group
$curUserGroup->group_id = $userGroup;
} else {
// Create a new group membership
$curUserGroup = new GroupMembers();
$curUserGroup->user_id = $userId;
$curUserGroup->group_id = $userGroup;
}
// Save the changes to the database
$curUserGroup->save();
}
}
}Volt
onVoltBlockCompile
The function compiles a Volt block and provides the file path of the compiled template. All available blocks can be found in the src/AdminCabinet/Views folder. For example, in the Asterisk manager modify form, there is a block called MainFields, which is represented in the Volt file using the following syntax:
{{ partial("PbxExtensionModules/hookVoltBlock",
['arrayOfPartials':hookVoltBlock('MainFields')]) Example:
/**
* Compiles a Volt block and returns the compiled template file path.
*
* @param string $controller The name of the controller.
* @param string $blockName The name of the block.
* @param View $view The View instance.
*
* @return string The compiled template file path.
*/
public function onVoltBlockCompile(
string $controller, string $blockName, View $view): string
{
$result = '';
// Combine the controller and block name to create a unique case identifier
$caseIdentifier = "$controller:$blockName";
// Check the combined case identifier to determine the template file path
switch ($caseIdentifier) {
case 'AsteriskManagers:MainFields':
// Add fields to the main tab on the AsteriskManager edit page
$result = "{$this->moduleDir}/App/Views/AsteriskManagers/mainfields";
break;
case 'Extensions:GeneralTabFields':
// Add fields to the general tab in the advanced settings section
// on the Extension edit page
$result = "{$this->moduleDir}/App/Views/Extensions/generaltabfields";
break;
case 'Extensions:TabularMenu':
// Add an additional tab to the Extension edit page
$result = "{$this->moduleDir}/App/Views/Extensions/tabularmenu";
break;
case 'Extensions:AdditionalTab':
// Add content for an additional tab on the Extension edit page
$result = "{$this->moduleDir}/App/Views/Extensions/additionaltab";
break;
default:
// No specific template file path for other case identifiers
}
return $result;
}Forms
onBeforeFormInitialize
Initializes the form before it is rendered. It useful to add an extra form fields before it compile.
Example:
/**
* Initializes the form before it is rendered.
*
* @param Form $form The form object.
* @param mixed $entity The entity associated with the form.
* @param mixed $options Additional options for the form initialization.
*
* @return void
*/
public function onBeforeFormInitialize(Form $form, $entity, $options): void
{
// Check if the form is an instance of ExtensionEditForm
if (is_a($form, ExtensionEditForm::class)) {
// Define an array of DTMF types with their corresponding translations
$arrDTMFType = [
'auto' => $this->translation->_('auto'),
'inband' => $this->translation->_('inband'),
'info' => $this->translation->_('info'),
'rfc4733' => $this->translation->_('rfc4733'),
'auto_info' => $this->translation->_('auto_info'),
];
// Create a Select element for the 'module_dtmfmode' field
$dtmfmode = new Select(
'module_dtmfmode',
$arrDTMFType,
[
'using' => [
'id',
'name',
],
'useEmpty' => false,
'value' => 'auto',
'class' => 'ui selection dropdown',
]
);
// Add the DTMF mode field to the form
$form->add($dtmfmode);
}
}Sidebar menu
onBeforeHeaderMenuShow
Modifies the sidebar menu items before it is shown.
Example:
/**
* Modifies the sidebar menu items before it is shown.
*
* @param array $menuItems The menu items for modifications.
*
* @return void
*/
public function onBeforeHeaderMenuShow(array &$menuItems):void
{
// Add Module Users UI Admin menu item
$menuItems['ModuleUsersUIAdmin']=[
'caption'=>'module_usersUiMainMenuItem',
'iconclass'=>'',
'submenu'=>[
'/module-users-ui/access-groups'=>[
'caption' => 'module_usersUiAccessGroups',
'iconclass' => 'gear',
'action' => 'index',
'param' => '',
'style' => '',
],
]
];
}Last updated
Was this helpful?