DevicesModule
extends Module
in package
implements
IModule, IConfigurableModule
Class DeviceModule
Tags
Interfaces, Classes and Traits
- IModule
- Interface IModule
- IConfigurableModule
- Interface IConfigurableModule
Table of Contents
- CAMERA_IMAGE_CAPTURE_PATH_TEMPLATE = "http://<username>:<password>@<host>:<port></path>"
- NAME = 'devices'
- PERMISSIONS_TABLE = 'permissions'
- USE_FOR_ALL_OPTION = 'use_for_all'
- COMPANY = 'kuzbass-cot'
- TITLE = 'Devices'
- VERSION = '1.2'
- $assets : Assets
- $container : Container
- $databaseContext : Context
- $hooks : TemplateHooks
- $modelHooks : ModelHooks
- $permissionsManager : PermissionsManager
- $tagManager : mixed
- $translator : Translator
- $user : mixed
- $defaultSettings : array<string|int, mixed>
- $linkGenerator : LinkGenerator
- $systemNotificationsManager : SystemNotificationsManager
- $updatesScripts : mixed
- __construct() : mixed
- __invoke() : mixed
- CanViewPhoto() : bool
- Возвращает true если есть разрешение на просмотр модуля
- configurationForm() : Form
- getCompany() : string
- getDependencies() : array<string|int, mixed>
- getInstalledInfo() : ModuleInstalledInfo
- Краткая информация о установленом модуле
- getName() : string
- getPath() : string
- getTitle() : string
- getValue() : mixed|ActiveRow
- Возвращает значение найстройки модуля
- getValues() : array<string|int, mixed>
- Возвращает все значения настроек модулыя
- getVersion() : string
- HasRuleEnableModule() : bool
- Возвращает true если есть разрешение на просмотр модуля
- isSystem() : bool
- onConfigurationChange() : mixed
- onDestroy() : bool
- onInitialize() : bool
- onInstall() : bool
- onUninstall() : bool
- onUpdate() : bool
- registerNotification() : void
- registerPermission() : bool
- Зарегистрировать разрешение
- unregisterPermission() : int
- Удалить разрешение
- updateValue() : mixed
- Обновление настройки
- updateValues() : mixed
- Обновление настроек
- doUpdateScripts() : bool
- Производит выполнение скриптов обновления, если есть
- addMenuItem() : void
- addMetaColumns() : void
- addModuleServices() : void
- createMetaTable() : void
- dropMetaTable() : void
- getPermissions() : array<string|int, mixed>
- registerFlowHook() : void
- registerHookToSimpleCheckReport() : void
- registerHookToSimpleCheckReportPresenterGrid() : void
- registerPermissions() : void
- unregisterMetaColumns() : void
- unregisterPermissions() : void
Constants
CAMERA_IMAGE_CAPTURE_PATH_TEMPLATE
public
mixed
CAMERA_IMAGE_CAPTURE_PATH_TEMPLATE
= "http://<username>:<password>@<host>:<port></path>"
NAME
public
mixed
NAME
= 'devices'
PERMISSIONS_TABLE
public
mixed
PERMISSIONS_TABLE
= 'permissions'
USE_FOR_ALL_OPTION
public
mixed
USE_FOR_ALL_OPTION
= 'use_for_all'
COMPANY
private
mixed
COMPANY
= 'kuzbass-cot'
TITLE
private
mixed
TITLE
= 'Devices'
VERSION
private
mixed
VERSION
= '1.2'
Properties
$assets
public
Assets
$assets
$container
public
Container
$container
$databaseContext
public
Context
$databaseContext
$hooks
public
TemplateHooks
$hooks
$modelHooks
public
ModelHooks
$modelHooks
$permissionsManager
public
PermissionsManager
$permissionsManager
$tagManager
public
mixed
$tagManager
$translator
public
Translator
$translator
$user
public
mixed
$user
$defaultSettings
protected
array<string|int, mixed>
$defaultSettings
= ['use_for_all' => false]
$linkGenerator
protected
LinkGenerator
$linkGenerator
$systemNotificationsManager
protected
SystemNotificationsManager
$systemNotificationsManager
$updatesScripts
private
mixed
$updatesScripts
Methods
__construct()
public
__construct(Container $container) : mixed
Parameters
- $container : Container
Return values
mixed —__invoke()
public
__invoke() : mixed
Return values
mixed —CanViewPhoto()
Возвращает true если есть разрешение на просмотр модуля
public
CanViewPhoto() : bool
Return values
bool —configurationForm()
public
configurationForm([mixed $parent = null ][, mixed $name = null ]) : Form
Parameters
- $parent : mixed = null
- $name : mixed = null
Return values
Form —getCompany()
public
getCompany() : string
Return values
string —getDependencies()
public
getDependencies() : array<string|int, mixed>
Return values
array<string|int, mixed> —getInstalledInfo()
Краткая информация о установленом модуле
public
getInstalledInfo() : ModuleInstalledInfo
Требуется для определения зависимостей перед установкой
Return values
ModuleInstalledInfo —getName()
public
getName() : string
Return values
string —getPath()
public
getPath() : string
Return values
string —getTitle()
public
getTitle() : string
Return values
string —getValue()
Возвращает значение найстройки модуля
public
final getValue(string $key) : mixed|ActiveRow
Parameters
- $key : string
-
Название настройки модуля
Return values
mixed|ActiveRow —getValues()
Возвращает все значения настроек модулыя
public
getValues() : array<string|int, mixed>
Return values
array<string|int, mixed> —getVersion()
public
getVersion() : string
Return values
string —HasRuleEnableModule()
Возвращает true если есть разрешение на просмотр модуля
public
HasRuleEnableModule() : bool
Return values
bool —isSystem()
public
isSystem() : bool
Return values
bool —onConfigurationChange()
public
onConfigurationChange(Form $form, stdClass $values) : mixed
Parameters
- $form : Form
- $values : stdClass
Return values
mixed —onDestroy()
public
onDestroy() : bool
Return values
bool —onInitialize()
public
onInitialize(ModulesManager $modulesManager) : bool
Parameters
- $modulesManager : ModulesManager
Return values
bool —onInstall()
public
onInstall() : bool
Tags
Return values
bool —onUninstall()
public
onUninstall() : bool
Tags
Return values
bool —onUpdate()
public
onUpdate(string $pathToScriptsFolder) : bool
Parameters
- $pathToScriptsFolder : string
Return values
bool —registerNotification()
public
registerNotification(mixed $message[, mixed $status = 'info' ][, mixed $link = null ][, mixed $linkText = '' ]) : void
Parameters
- $message : mixed
- $status : mixed = 'info'
- $link : mixed = null
- $linkText : mixed = ''
Return values
void —registerPermission()
Зарегистрировать разрешение
public
final registerPermission(string $resource, string $privilege, string $title) : bool
Parameters
- $resource : string
-
Ресурс на который будет распростроняться разрешение
- $privilege : string
-
Действие на которое распространяется разрешение
- $title : string
-
Название разрешения
Tags
Return values
bool —unregisterPermission()
Удалить разрешение
public
final unregisterPermission([string $resource = '' ][, string $privilege = '' ]) : int
Parameters
- $resource : string = ''
-
Ресурс
- $privilege : string = ''
-
Дейсвие
Tags
Return values
int —updateValue()
Обновление настройки
public
final updateValue( $key, $value) : mixed
Parameters
Return values
mixed —updateValues()
Обновление настроек
public
final updateValues(array<string|int, mixed> $values) : mixed
Parameters
- $values : array<string|int, mixed>
-
значение настроек
Return values
mixed —doUpdateScripts()
Производит выполнение скриптов обновления, если есть
protected
doUpdateScripts(string $scriptsDir) : bool
Parameters
- $scriptsDir : string
Tags
Return values
bool —addMenuItem()
private
addMenuItem() : void
Return values
void —addMetaColumns()
private
addMetaColumns() : void
Tags
Return values
void —addModuleServices()
private
addModuleServices() : void
Return values
void —createMetaTable()
private
createMetaTable() : void
Return values
void —dropMetaTable()
private
dropMetaTable() : void
Return values
void —getPermissions()
private
getPermissions() : array<string|int, mixed>
Return values
array<string|int, mixed> —registerFlowHook()
private
registerFlowHook() : void
Return values
void —registerHookToSimpleCheckReport()
private
registerHookToSimpleCheckReport() : void
Return values
void —registerHookToSimpleCheckReportPresenterGrid()
private
registerHookToSimpleCheckReportPresenterGrid() : void
Return values
void —registerPermissions()
private
registerPermissions() : void
Return values
void —unregisterMetaColumns()
private
unregisterMetaColumns() : void
Return values
void —unregisterPermissions()
private
unregisterPermissions() : void