Bitrix API

EventManager

EventManager wrapper for ORM entities

Tags
subpackage

main

Table of Contents

Methods

addEventHandler()  : int|mixed
getInstance()  : EventManager
Singleton getter
registerEventHandler()  : mixed
removeEventHandler()  : bool
unRegisterEventHandler()  : mixed

Methods

addEventHandler()

public addEventHandler(string|Entity|DataManager|EntityObject $entity, string $eventType, callable $callback[, bool $includeFile = false ][, int $sort = 100 ]) : int|mixed
Parameters
$entity : string|Entity|DataManager|EntityObject

ORM Entity, or ORM Table class, or ORM Object class

$eventType : string

Constants DataManager::EVENT_ON_BEFORE_ADD etc.

$callback : callable

Callback

$includeFile : bool = false
$sort : int = 100
Tags
throws
ArgumentException
throws
SystemException
Return values
int|mixed

registerEventHandler()

public registerEventHandler(string|Entity|DataManager|EntityObject $entity, string $eventType, string $toModuleId[, string $toClass = "" ][, string $toMethod = "" ][, int $sort = 100 ][, string $toPath = "" ][, array<string|int, mixed> $toMethodArg = [] ]) : mixed
Parameters
$entity : string|Entity|DataManager|EntityObject
$eventType : string
$toModuleId : string
$toClass : string = ""
$toMethod : string = ""
$sort : int = 100
$toPath : string = ""
$toMethodArg : array<string|int, mixed> = []
Tags
throws
ArgumentException
throws
SystemException

unRegisterEventHandler()

public unRegisterEventHandler(string|Entity|DataManager|EntityObject $entity, string $eventType, string $toModuleId[, string $toClass = "" ][, string $toMethod = "" ][, string $toPath = "" ][, array<string|int, mixed> $toMethodArg = [] ]) : mixed
Parameters
$entity : string|Entity|DataManager|EntityObject
$eventType : string
$toModuleId : string
$toClass : string = ""
$toMethod : string = ""
$toPath : string = ""
$toMethodArg : array<string|int, mixed> = []
Tags
throws
ArgumentException
throws
SystemException

        
On this page

Search results