Documentation

rfidModule extends Module
in package
implements IModule

Class rfidModule

Interfaces, Classes and Traits

IModule
Interface IModule

Table of Contents

COL_RFID  = 'rfid'
NAME  = 'rfid'
PERMISSIONS_TABLE  = 'permissions'
TITLE  = 'RFID'
VERSION  = '0.1'
COMPANY  = 'kuzbass-cot'
$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
getCompany()  : string
getDefaults()  : array<string|int, mixed>
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
onDestroy()  : bool
onInitialize()  : bool
onInstall()  : bool
onUninstall()  : bool
onUpdate()  : bool
registerNotification()  : void
registerPermission()  : bool
Зарегистрировать разрешение
unregisterPermission()  : int
Удалить разрешение
updateValue()  : mixed
Обновление настройки
updateValues()  : mixed
Обновление настроек
doUpdateScripts()  : bool
Производит выполнение скриптов обновления, если есть
addServices()  : mixed
modificateMetaCols()  : mixed
registerHooks()  : mixed
registerMeta()  : mixed
unregisteredMeta()  : mixed
unregisterServices()  : mixed

Constants

PERMISSIONS_TABLE

public mixed PERMISSIONS_TABLE = 'permissions'

Properties

$container

public Container $container

$databaseContext

public Context $databaseContext

$tagManager

public mixed $tagManager

$defaultSettings

protected array<string|int, mixed> $defaultSettings

$linkGenerator

protected LinkGenerator $linkGenerator

$updatesScripts

private mixed $updatesScripts

Methods

__construct()

public __construct(Container $container) : mixed
Parameters
$container : Container
Return values
mixed —

__invoke()

public __invoke() : mixed
Return values
mixed —

getCompany()

public getCompany() : string
Return values
string —

getDefaults()

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

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 —

onDestroy()

public onDestroy() : bool
Return values
bool —

onInstall()

public onInstall() : bool
Return values
bool —

onUninstall()

public onUninstall() : bool
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
deprecated

Удалить в ближайшем рефакторинге

throws
PermissionExists
Return values
bool —

unregisterPermission()

Удалить разрешение

public final unregisterPermission([string $resource = '' ][, string $privilege = '' ]) : int
Parameters
$resource : string = ''

Ресурс

$privilege : string = ''

Дейсвие

Tags
deprecated

Удалить в ближайшем рефакторинге

Return values
int —

updateValue()

Обновление настройки

public final updateValue( $key,  $value) : mixed
Parameters
$key :
$value :
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
throws
Exception
Return values
bool —

addServices()

private addServices() : mixed
Return values
mixed —

modificateMetaCols()

private modificateMetaCols() : mixed
Return values
mixed —

registerHooks()

private registerHooks() : mixed
Return values
mixed —

unregisteredMeta()

private unregisteredMeta() : mixed
Return values
mixed —

unregisterServices()

private unregisterServices() : mixed
Return values
mixed —

Search results