Documentation

EmployeesModule extends Module
in package
implements IModule

Class EmployeesModule

Tags
category

ExternalModules

Interfaces, Classes and Traits

IModule
Interface IModule

Table of Contents

META_FIRED_DT  = 'fired_dt'
META_IS_FIRED  = 'is_fired'
META_NUMBER  = 'number'
NAME  = 'employees'
PERMISSIONS_TABLE  = 'permissions'
POSITION_TAG  = array('name' => 'position', 'title' => 'Positions')
SYSTEM_TAGS  = [self::POSITION_TAG]
VERSION  = '1.4'
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
$metaManager  : MetaManager
$updatesScripts  : mixed
__construct()  : mixed
__invoke()  : mixed
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
Производит выполнение скриптов обновления, если есть
addAdminMenuItem()  : void
addServices()  : mixed
addTemplateHookFilter()  : mixed
createHtmlElementBackButton()  : Html
isPageTagsPositions()  : bool
registerMetaCellFiredDate()  : mixed
registerMetaCellIsFired()  : mixed
registerMetaCellNumber()  : mixed
registerMetaDate()  : bool
registerPermissions()  : mixed
unregisterMeta()  : void
unregisterPermissions()  : void

Constants

PERMISSIONS_TABLE

public mixed PERMISSIONS_TABLE = 'permissions'

POSITION_TAG

public mixed POSITION_TAG = array('name' => 'position', 'title' => 'Positions')

Properties

$container

public Container $container

$databaseContext

public Context $databaseContext

$tagManager

public mixed $tagManager

$defaultSettings

protected array<string|int, mixed> $defaultSettings = ['view_fired_employees' => false]

$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 —

configurationForm()

public configurationForm() : Form
Return values
Form —

getDependencies()

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

getInstalledInfo()

Краткая информация о установленом модуле

public getInstalledInfo() : ModuleInstalledInfo

Требуется для определения зависимостей перед установкой

Return values
ModuleInstalledInfo —

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> —

HasRuleEnableModule()

Возвращает true если есть разрешение на просмотр модуля

public HasRuleEnableModule() : bool
Return values
bool —

onConfigurationChange()

public onConfigurationChange(Form $form, stdClass $values) : mixed
Parameters
$form : Form
$values : stdClass
Return values
mixed —

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 —

addAdminMenuItem()

private addAdminMenuItem() : void
Return values
void —

addServices()

private addServices() : mixed
Return values
mixed —

addTemplateHookFilter()

private addTemplateHookFilter() : mixed
Return values
mixed —

createHtmlElementBackButton()

private createHtmlElementBackButton(mixed $container) : Html
Parameters
$container : mixed
Return values
Html —

isPageTagsPositions()

private isPageTagsPositions(mixed $tag_name) : bool
Parameters
$tag_name : mixed
Return values
bool —

registerMetaCellFiredDate()

private registerMetaCellFiredDate() : mixed
Return values
mixed —

registerMetaCellIsFired()

private registerMetaCellIsFired() : mixed
Return values
mixed —

registerMetaCellNumber()

private registerMetaCellNumber() : mixed
Return values
mixed —

registerMetaDate()

private registerMetaDate() : bool
Return values
bool —

unregisterMeta()

private unregisterMeta() : void
Return values
void —

unregisterPermissions()

private unregisterPermissions() : void
Return values
void —

Search results