Bitrix-D7  20.0.0
Класс Event
Граф наследования:Event:
Event Event

Открытые члены

 __construct ($moduleId, $type, $parameters=array(), $filter=null)
 
 getModuleId ()
 
 getEventType ()
 
 setParameters ($parameters)
 
 getParameters ()
 
 setParameter ($key, $value)
 
 getParameter ($key)
 
 setFilter ($filter)
 
 getFilter ()
 
 getResults ()
 
 addResult (EventResult $result)
 
 getSender ()
 
 send ($sender=null)
 
 addException (\Exception $exception)
 
 getExceptions ()
 
 turnDebugOn ()
 
 isDebugOn ()
 
 addDebugInfo ($ar)
 
 getDebugInfo ()
 

Защищенные члены

 loadParameters ()
 

Защищенные данные

 $moduleId
 
 $type
 
 $parameters = array()
 
 $parametersLoader = null
 
 $filter = null
 
 $sender = null
 
 $debugMode = false
 
 $debugInfo = array()
 
 $results = array()
 
 $exceptions = array()
 

Подробное описание

См. определение в файле main/lib/event.php строка 4

Конструктор(ы)

◆ __construct()

__construct (   $moduleId,
  $type,
  $parameters = array(),
  $filter = null 
)
Аргументы
$moduleId
$type
array$parameters
null | string | string[]$filterFilter of module names, mail event names and component names of the event handlers

См. определение в файле main/lib/event.php строка 29

30  {
31  $this->moduleId = $moduleId;
32  $this->type = $type;
33  $this->setParameters($parameters);
34  $this->setFilter($filter);
35 
36  $this->debugMode = false;
37  }

Методы

◆ addDebugInfo()

addDebugInfo (   $ar)

См. определение в файле main/lib/event.php строка 165

166  {
167  if (!$this->debugMode)
168  return;
169 
170  $this->debugInfo[] = $ar;
171  }

◆ addException()

addException ( \Exception  $exception)

См. определение в файле main/lib/event.php строка 145

146  {
147  $this->exceptions[] = $exception;
148  }

◆ addResult()

addResult ( EventResult  $result)

См. определение в файле main/lib/event.php строка 129

130  {
131  $this->results[] = $result;
132  }

◆ getDebugInfo()

getDebugInfo ( )

См. определение в файле main/lib/event.php строка 173

174  {
175  return $this->debugInfo;
176  }

◆ getEventType()

getEventType ( )

См. определение в файле main/lib/event.php строка 44

45  {
46  return $this->type;
47  }

◆ getExceptions()

getExceptions ( )

См. определение в файле main/lib/event.php строка 150

151  {
152  return $this->exceptions;
153  }

◆ getFilter()

getFilter ( )

См. определение в файле main/lib/event.php строка 116

117  {
118  return $this->filter;
119  }

◆ getModuleId()

getModuleId ( )

См. определение в файле main/lib/event.php строка 39

40  {
41  return $this->moduleId;
42  }

◆ getParameter()

getParameter (   $key)

См. определение в файле main/lib/event.php строка 80

81  {
82  $this->loadParameters();
83 
84  if (isset($this->parameters[$key]))
85  return $this->parameters[$key];
86 
87  return null;
88  }

◆ getParameters()

getParameters ( )

См. определение в файле main/lib/event.php строка 66

67  {
68  $this->loadParameters();
69 
70  return $this->parameters;
71  }

◆ getResults()

getResults ( )
Возвращает
EventResult[]

См. определение в файле main/lib/event.php строка 124

125  {
126  return $this->results;
127  }

◆ getSender()

getSender ( )

См. определение в файле main/lib/event.php строка 134

135  {
136  return $this->sender;
137  }

◆ isDebugOn()

isDebugOn ( )

См. определение в файле main/lib/event.php строка 160

161  {
162  return $this->debugMode;
163  }

◆ loadParameters()

loadParameters ( )
protected

См. определение в файле main/lib/event.php строка 90

91  {
92  if (!$this->parametersLoader)
93  {
94  return false;
95  }
96 
97  $this->setParameters(call_user_func_array($this->parametersLoader, array()));
98  $this->parametersLoader = null;
99 
100  return true;
101  }

◆ send()

send (   $sender = null)

Переопределяется в Event.

См. определение в файле main/lib/event.php строка 139

140  {
141  $this->sender = $sender;
142  EventManager::getInstance()->send($this);
143  }

◆ setFilter()

setFilter (   $filter)

См. определение в файле main/lib/event.php строка 103

104  {
105  if (!is_array($filter))
106  {
107  if (empty($filter))
108  $filter = null;
109  else
110  $filter = array($filter);
111  }
112 
113  $this->filter = $filter;
114  }

◆ setParameter()

setParameter (   $key,
  $value 
)

См. определение в файле main/lib/event.php строка 73

74  {
75  $this->loadParameters();
76 
77  $this->parameters[$key] = $value;
78  }

◆ setParameters()

setParameters (   $parameters)

См. определение в файле main/lib/event.php строка 49

50  {
51  if (is_array($parameters))
52  {
53  $this->parameters = $parameters;
54  }
55  elseif ($parameters instanceof \Closure)
56  {
57  $this->parameters = null;
58  $this->parametersLoader = $parameters;
59  }
60  else
61  {
62  throw new ArgumentTypeException("parameter", "array or closure, which returns array");
63  }
64  }

◆ turnDebugOn()

turnDebugOn ( )

См. определение в файле main/lib/event.php строка 155

156  {
157  $this->debugMode = true;
158  }

Поля

◆ $debugInfo

$debugInfo = array()
protected

См. определение в файле main/lib/event.php строка 15

◆ $debugMode

$debugMode = false
protected

См. определение в файле main/lib/event.php строка 14

◆ $exceptions

$exceptions = array()
protected

См. определение в файле main/lib/event.php строка 21

◆ $filter

$filter = null
protected

См. определение в файле main/lib/event.php строка 11

◆ $moduleId

$moduleId
protected

См. определение в файле main/lib/event.php строка 6

◆ $parameters

$parameters = array()
protected

См. определение в файле main/lib/event.php строка 8

◆ $parametersLoader

$parametersLoader = null
protected

См. определение в файле main/lib/event.php строка 10

◆ $results

$results = array()
protected

См. определение в файле main/lib/event.php строка 18

◆ $sender

$sender = null
protected

См. определение в файле main/lib/event.php строка 12

◆ $type

$type
protected

См. определение в файле main/lib/event.php строка 7


Объявления и описания членов класса находятся в файле:
Bitrix\Main\Event\$results
$results
Definition: main/lib/event.php:18
Bitrix\Main\Event\$filter
$filter
Definition: main/lib/event.php:11
Bitrix\Main\EventManager\getInstance
static getInstance()
Definition: main/lib/eventmanager.php:34
Bitrix\Main\Event\$exceptions
$exceptions
Definition: main/lib/event.php:21
Bitrix\Main\Event\$debugMode
$debugMode
Definition: main/lib/event.php:14
Bitrix\Main\Event\setFilter
setFilter($filter)
Definition: main/lib/event.php:103
Bitrix\Main\Event\loadParameters
loadParameters()
Definition: main/lib/event.php:90
Bitrix\Main\Event\$sender
$sender
Definition: main/lib/event.php:12
Bitrix\Main\Event\$parameters
$parameters
Definition: main/lib/event.php:8
Bitrix\Main\Event\setParameters
setParameters($parameters)
Definition: main/lib/event.php:49
Bitrix\Main\Event\$moduleId
$moduleId
Definition: main/lib/event.php:6
Bitrix\Main\Event\$debugInfo
$debugInfo
Definition: main/lib/event.php:15
Bitrix\Main\Event\$type
$type
Definition: main/lib/event.php:7