Documentation

Shortcode_Module extends Core_Module
in package

Shortcode.

Tags
subpackage

Shortcode

version
7.x
author

Hostmake LLC

copyright

© 2005-2023 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru

Table of Contents

$date  : date
Module date
$version  : string
Module version
$_adminForms  : array<string|int, mixed>
Description of Admin Forms
$_adminPages  : array<string|int, mixed>
List of admin pages
$_instance  : mixed
The singleton instances.
$_moduleName  : string
Module name
$_options  : array<string|int, mixed>
Module Options
$_reports  : array<string|int, mixed>
Report tabs array
$_scheduleActions  : array<string|int, mixed>
List of Schedule Actions
$_webhooks  : array<string|int, mixed>
Module's webhooks
$menu  : array<string|int, mixed>
Module menu
__construct()  : mixed
Constructor.
addReport()  : self
Add Module Reports
callNotifications()  : mixed
Call new notifications
callSchedule()  : array<string|int, mixed>
Notify module on the action on schedule
factory()  : mixed
Create module instance
getAdminPages()  : array<string|int, mixed>
Get list of admin pages
getMenu()  : array<string|int, mixed>
Get Module's Menu
getModule()  : mixed
Get module instance
getModuleName()  : array<string|int, mixed>
Get module name
getNotificationDesign()  : array<string|int, mixed>
Get Notification Design
getOptions()  : array<string|int, mixed>
Get Module Options
getReport()  : array<string|int, mixed>|null
Get Module Report
getReports()  : array<string|int, mixed>
Get Module Reports
getScheduleActions()  : array<string|int, mixed>
Get List of Schedule Actions
getWebhooks()  : array<string|int, mixed>
Get Module Webhooks
install()  : self
Install module
setMenu()  : self
Set Module's Menu
setOptions()  : array<string|int, mixed>
Set Module Options
uninstall()  : self
Uninstall module
_addAdminForm()  : Admin_Form_Model
Add Admin Form
_addAdminFormAction()  : Admin_Form_Action_Model
Add Admin Form Action
_addAdminFormField()  : Admin_Form_Field_Model
Add Admin Form Filed
_addAdminWord()  : mixed
Add Admin Form Words
_addAdminWordValue()  : Admin_Word_Value_Model
Add Admin_Word_Value

Properties

$date

Module date

public date $date = '2023-07-17'

$version

Module version

public string $version = '7.0'

$_adminForms

Description of Admin Forms

protected array<string|int, mixed> $_adminForms = array()

array( 'form1' => array( //-- Форма 'guid' => 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', //-- guid формы 'key_field' => 'id', //-- Наименование ключевого поля из БД 'default_order_field' => 'id', //-- Поле сортировки по умолчанию 'on_page' => 30, //-- Количество строк на странице 'show_operations' => 0, //-- Показывать операции 'show_group_operations' => 0, //-- Показывать групповые операции 'default_order_direction' => 0, //-- Направление сортировки: 1 - по возрастанию, 0 - по убыванию 'name' => array( //-- название формы 1 => 'Наименование модуля', //-- по-русски - 1=идентификатор языка 2 => 'Module name' //-- по-английски - 2=идентификатор языка ), 'fields' => array( //-- поля на отображаемой форме 'id' => array( //-- наименование поля из сущности БД(название столбца) 'name' => array( //-- название поля в админке 1 => 'Код', //-- по-русски - 1=идентификатор языка 2 => 'ID' //-- по-английски - 2=идентификатор языка ), 'sorting' => 10, //-- поле сортировки 'ico' => '', //-- иконка поля 'type' => 1, //-- тип поля 'format' => '', //-- формат поля 'allow_sorting' => 1, //-- разрешить сортировку по полю 0-нет, 1-да 'allow_filter' => 1, //-- разрешить фильтрацию по полю 0-нет, 1-да 'editable' => 1, //-- разрешить inline-редактирование по полю 0-нет, 1-да 'filter_type' => 0, //-- тип фильтрации 'class' => '', //-- класс для поля 'width' => '', //-- ширина поля, например '55px' 'image' => '', //-- картинка для поля 'link' => '', //-- ссылка для поля 'onclick' => '', //-- событие нажатия на поле 'list' => '', //-- ), 'field2' => array( 'name' => array( //-- название поля в админке 1 => 'Наименование кампании', //-- по-русски - 1=идентификатор языка 2 => 'Campaign name' //-- по-английски - 2=идентификатор языка ), 'sorting' => 20, ..... ), ), 'actions' => array( 'edit' => array( //-- ключевое наименование действия для формы 'name' => array( //-- название действия в админке 1 => 'Редактировать', //-- по-русски - 1=идентификатор языка 2 => 'Edit' //-- по-английски - 2=идентификатор языка ), 'sorting' => 10, //-- сортировка для действий 'picture' => '', 'icon' => 'fa fa-pencil', 'color' => 'palegreen', 'single' => 1, 'group' => 0, 'dataset' => 0, 'confirm' => 0, ), ), ), 'form2' => array( ... ) )

$_adminPages

List of admin pages

protected array<string|int, mixed> $_adminPages = array()

$_instance

The singleton instances.

protected static mixed $_instance = \NULL

$_moduleName

Module name

protected string $_moduleName = 'shortcode'

$_options

Module Options

protected array<string|int, mixed> $_options = array()

$_reports

Report tabs array

protected array<string|int, mixed> $_reports = array()

$_scheduleActions

List of Schedule Actions

protected array<string|int, mixed> $_scheduleActions = array()

$_webhooks

Module's webhooks

protected array<string|int, mixed> $_webhooks = array()

$menu

Module menu

protected array<string|int, mixed> $menu = array()

Methods

__construct()

Constructor.

public __construct() : mixed
Return values
mixed —

addReport()

Add Module Reports

public addReport(string $reportName, callable $callback) : self
Parameters
$reportName : string

Report Name

$callback : callable
Return values
self —

callNotifications()

Call new notifications

public callNotifications() : mixed
Return values
mixed —

callSchedule()

Notify module on the action on schedule

public callSchedule(int $action, int $entityId) : array<string|int, mixed>
Parameters
$action : int

action number

$entityId : int

entity ID

Return values
array<string|int, mixed> —

factory()

Create module instance

public static factory(string $moduleName) : mixed
Parameters
$moduleName : string

module name

Return values
mixed —

getAdminPages()

Get list of admin pages

public getAdminPages() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getMenu()

Get Module's Menu

public getMenu() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getModule()

Get module instance

public static getModule(string $moduleName) : mixed
Parameters
$moduleName : string

module name

Return values
mixed —

getModuleName()

Get module name

public getModuleName() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getNotificationDesign()

Get Notification Design

public getNotificationDesign(int $type, int $entityId) : array<string|int, mixed>
Parameters
$type : int
$entityId : int
Return values
array<string|int, mixed> —

getOptions()

Get Module Options

public getOptions() : array<string|int, mixed>
Tags
hostcms-event

Core_Module.onBeforeGetOptions

Return values
array<string|int, mixed> —

getReport()

Get Module Report

public getReport(string $reportName[, array<string|int, mixed> $aFields = array('caption', 'captionHTML') ][, array<string|int, mixed> $aOptions = array() ]) : array<string|int, mixed>|null
Parameters
$reportName : string

Report Name

$aFields : array<string|int, mixed> = array('caption', 'captionHTML')

default ('caption', 'captionHTML')

$aOptions : array<string|int, mixed> = array()
Return values
array<string|int, mixed>|null —

getReports()

Get Module Reports

public getReports([array<string|int, mixed> $aFields = array('caption', 'captionHTML') ][, array<string|int, mixed> $aOptions = array() ]) : array<string|int, mixed>
Parameters
$aFields : array<string|int, mixed> = array('caption', 'captionHTML')

default ('caption', 'captionHTML')

$aOptions : array<string|int, mixed> = array()
Tags
hostcms-event

Core_Module.onBeforeGetReports

Return values
array<string|int, mixed> —

getScheduleActions()

Get List of Schedule Actions

public getScheduleActions() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getWebhooks()

Get Module Webhooks

public getWebhooks() : array<string|int, mixed>
Tags
hostcms-event

Core_Module.onBeforeGetWebhooks

Return values
array<string|int, mixed> —

install()

Install module

public install() : self
Tags
hostcms-event

Core_Module.onBeforeInstall

Return values
self —

setMenu()

Set Module's Menu

public setMenu(array<string|int, mixed> $array) : self
Parameters
$array : array<string|int, mixed>
Return values
self —

setOptions()

Set Module Options

public setOptions(mixed $data) : array<string|int, mixed>
Parameters
$data : mixed
Tags
hostcms-event

Core_Module.onBeforeSetOptions

Return values
array<string|int, mixed> —

uninstall()

Uninstall module

public uninstall() : self
Tags
hostcms-event

Core_Module.onBeforeUninstall

Return values
self —

_addAdminForm()

Add Admin Form

protected _addAdminForm(array<string|int, mixed> $name, array<string|int, mixed> $aForm) : Admin_Form_Model
Parameters
$name : array<string|int, mixed>
$aForm : array<string|int, mixed>

Array of attributes

Return values
Admin_Form_Model —

_addAdminFormAction()

Add Admin Form Action

protected _addAdminFormAction(string $functionName, array<string|int, mixed> $aAction) : Admin_Form_Action_Model
Parameters
$functionName : string
$aAction : array<string|int, mixed>

Array of attributes

Return values
Admin_Form_Action_Model —

_addAdminFormField()

Add Admin Form Filed

protected _addAdminFormField(string $name, array<string|int, mixed> $aField) : Admin_Form_Field_Model
Parameters
$name : string
$aField : array<string|int, mixed>

Array of attributes

Return values
Admin_Form_Field_Model —

_addAdminWord()

Add Admin Form Words

protected _addAdminWord(array<string|int, mixed> $aWords) : mixed
Parameters
$aWords : array<string|int, mixed>

Array of words ($lngId => $word)

Tags
retun

Admin_Word_Model

Return values
mixed —

Search results