Class Core_Module

Abstract module. Use _adminForms to create forms with modules.

Direct known subclasses

Admin_Form_Module, Advertisement_Module, Comment_Module, Company_Module, Compression_Module, Constant_Module, Counter_Module, Crm_Module, Crm_Project_Module, Deal_Module, Document_Module, Event_Module, Antispam_Module, Eventlog_Module, Field_Module, Filemanager_Module, Form_Module, Forum_Module, Helpdesk_Module, Informationsystem_Module, Install_Module, Ipaddress_Module, Lead_Module, Backup_Module, Lib_Module, List_Module, Maillist_Module, Market_Module, Message_Module, Messenger_Module, Module_Module, Notification_Module, Poll_Module, Printlayout_Module, Benchmark_Module, Property_Module, Report_Module, Restapi_Module, Revision_Module, Schedule_Module, Search_Module, Seo_Module, Shop_Module, Shortcode_Module, Shortlink_Module, Bot_Module, Site_Module, Siteuser_Module, Skin_Bootstrap_Module_Core_Module, Sql_Module, Structure_Module, Support_Module, Tag_Module, Template_Module, Tpl_Module, Trash_Module, Cache_Module, Typograph_Module, Update_Module, User_Module, Wysiwyg_Module, Xsl_Module, Calendar_Module, Cdn_Module, Cloud_Module

Indirect known subclasses

Abstract
Package: HostCMS\Core
Copyright: © 2005-2021 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru
Author: Hostmake LLC
Version: 6.x
Located at core/module.php

Methods summary

`public array`	# `getMenu( )` Get Module's Menu Get Module's Menu Returns array Hostcms-event Core_Module.onBeforeGetMenu, e.g. Skin_Bootstrap_Module_Xxx_Module or Xxx_Module
`public Core_Module`	# `setMenu( array $array )` Set Module's Menu Set Module's Menu Returns `Core_Module`
`public static mixed`	# `factory( string $moduleName )` Create module instance Create module instance Parameters `$moduleName` module name Returns mixed
`public static mixed`	# `getModule( string $moduleName )` Get module instance Get module instance Parameters `$moduleName` module name Returns mixed
`public array`	# `getModuleName( )` Get module name Get module name Returns array
`public array`	# `getAdminPages( )` Get list of admin pages Get list of admin pages Returns array
`public`	# `__construct( )` Constructor. Constructor.
`public array`	# `getScheduleActions( )` Get List of Schedule Actions Get List of Schedule Actions Returns array
`public array`	# `getNotificationDesign( integer $type, integer $entityId )` Get Notification Design Get Notification Design Parameters `$type` `$entityId` Returns array
`public array`	# `callSchedule( integer $action, integer $entityId )` Notify module on the action on schedule Notify module on the action on schedule Parameters `$action` action number `$entityId` entity ID Returns array
`public`	# `callNotifications( )` Call new notifications Call new notifications
`public Core_Module`	# `install( )` Install module Install module Returns `Core_Module` Hostcms-event Core_Module.onBeforeInstall
`public Core_Module`	# `uninstall( )` Uninstall module Uninstall module Returns `Core_Module` Hostcms-event Core_Module.onBeforeUninstall
`protected Admin_Form_Model`	# `_addAdminForm( array $name, array $aForm )` Add Admin Form Add Admin Form Parameters `$name` `$aForm` Array of attributes Returns `Admin_Form_Model`
`protected Admin_Form_Field_Model`	# `_addAdminFormField( string $name, array $aField )` Add Admin Form Filed Add Admin Form Filed Parameters `$name` `$aField` Array of attributes Returns `Admin_Form_Field_Model`
`protected Admin_Form_Action_Model`	# `_addAdminFormAction( string $functionName, array $aAction )` Add Admin Form Action Add Admin Form Action Parameters `$functionName` `$aAction` Array of attributes Returns `Admin_Form_Action_Model`
`protected`	# `_addAdminWord( array $aWords )` Add Admin Form Words Add Admin Form Words Parameters `$aWords` Array of words ($lngId => $word) Retun Admin_Word_Model
`protected Admin_Word_Value_Model`	# `_addAdminWordValue( integer $admin_language_id, string $value )` Add Admin_Word_Value Add Admin_Word_Value Parameters `$admin_language_id` Language ID `$value` value Returns `Admin_Word_Value_Model`
`public array`	# `getReports( array $aFields = array('caption', 'captionHTML'), array $aOptions = array() )` Get Module Reports Get Module Reports Parameters `$aFields` default ('caption', 'captionHTML') `$aOptions` Returns array Hostcms-event Core_Module.onBeforeGetReports
`public Core_Module`	# `addReport( string $reportName, callable $callback )` Add Module Reports Add Module Reports Parameters `$reportName` Report Name `$callback` Returns `Core_Module`
`public array\|null`	# `getReport( string $reportName, array $aFields = array('caption', 'captionHTML'), array $aOptions = array() )` Get Module Report Get Module Report Parameters `$reportName` Report Name `$aFields` default ('caption', 'captionHTML') `$aOptions` Returns array\|null
`public array`	# `getOptions( )` Get Module Options Get Module Options Returns array Hostcms-event Core_Module.onBeforeGetOptions
`public array`	# `setOptions( $data )` Set Module Options Set Module Options Returns array Hostcms-event Core_Module.onBeforeSetOptions

Properties summary

`public string`	`$version` Module version Module version	# `NULL`
`public Core_Module::$date`	`$date` Module date Module date	# `NULL`
`protected array`	`$menu` Module menu Module menu	# `array()`
`protected string`	`$_moduleName` Module name Module name	# `NULL`
`protected static mixed`	`$_instance` The singleton instances. The singleton instances.	# `NULL`
`protected array`	`$_adminForms` Description of Admin Forms Description of Admin Forms 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( ... ) )	# `array()`
`protected array`	`$_adminPages` List of admin pages List of admin pages	# `array()`
`protected array`	`$_scheduleActions` List of Schedule Actions List of Schedule Actions	# `array()`
`protected array`	`$_reports` Report tabs array Report tabs array	# `array()`
`protected array`	`$_options` Module Options Module Options	# `array()`

Classes

Exceptions

Functions

Class Core_Module

Direct known subclasses

Indirect known subclasses

Methods summary

Returns

Hostcms-event

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Hostcms-event

Returns

Hostcms-event

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Retun

Parameters

Returns

Parameters

Returns

Hostcms-event

Parameters

Returns

Parameters

Returns

Returns

Hostcms-event

Returns

Hostcms-event

Properties summary