Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Data Structures | Public Member Functions | Protected Attributes
Event Class Reference
Inheritance diagram for Event:
DataObject

Data Structures

class  ManagerStub
 

Public Member Functions

 __construct (array $data=[])
 
 getObservers ()
 
 addObserver (\Magento\Framework\Event\Observer $observer)
 
 removeObserverByName ($observerName)
 
 dispatch ()
 
 getName ()
 
 setName ($data)
 
 getBlock ()
 
- Public Member Functions inherited from DataObject
 __construct (array $data=[])
 
 addData (array $arr)
 
 setData ($key, $value=null)
 
 unsetData ($key=null)
 
 getData ($key='', $index=null)
 
 getDataByPath ($path)
 
 getDataByKey ($key)
 
 setDataUsingMethod ($key, $args=[])
 
 getDataUsingMethod ($key, $args=null)
 
 hasData ($key='')
 
 toArray (array $keys=[])
 
 convertToArray (array $keys=[])
 
 toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
 
 convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
 
 toJson (array $keys=[])
 
 convertToJson (array $keys=[])
 
 toString ($format='')
 
 __call ($method, $args)
 
 isEmpty ()
 
 serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
 
 debug ($data=null, &$objects=[])
 
 offsetSet ($offset, $value)
 
 offsetExists ($offset)
 
 offsetUnset ($offset)
 
 offsetGet ($offset)
 

Protected Attributes

 $_observers
 
- Protected Attributes inherited from DataObject
 $_data = []
 

Additional Inherited Members

- Protected Member Functions inherited from DataObject
 _getData ($key)
 
 _underscore ($name)
 
- Static Protected Attributes inherited from DataObject
static $_underscoreCache = []
 

Detailed Description

@api

Since
100.0.2

Definition at line 18 of file Event.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( array  $data = [])

Constructor

Initializes observers collection

Parameters
array$data

Definition at line 34 of file Event.php.

35  {
36  $this->_observers = new \Magento\Framework\Event\Observer\Collection();
37  parent::__construct($data);
38  }

Member Function Documentation

◆ addObserver()

addObserver ( \Magento\Framework\Event\Observer  $observer)

Register an observer for the event

Parameters
\Magento\Framework\Event\Observer$observer
Returns
$this

Definition at line 56 of file Event.php.

57  {
58  $this->getObservers()->addObserver($observer);
59  return $this;
60  }

◆ dispatch()

dispatch ( )

Dispatches the event to registered observers

Returns
$this

Definition at line 79 of file Event.php.

80  {
81  $this->getObservers()->dispatch($this);
82  return $this;
83  }

◆ getBlock()

getBlock ( )
Returns
mixed

Definition at line 108 of file Event.php.

109  {
110  return $this->_getData('block');
111  }

◆ getName()

getName ( )

Retrieve event name

Returns
string

Definition at line 90 of file Event.php.

91  {
92  return $this->_data['name'] ?? null;
93  }

◆ getObservers()

getObservers ( )

Returns all the registered observers for the event

Returns
\Magento\Framework\Event\Observer\Collection

Definition at line 45 of file Event.php.

46  {
47  return $this->_observers;
48  }

◆ removeObserverByName()

removeObserverByName (   $observerName)

Removes an observer by its name

Parameters
string$observerName
Returns
$this

Definition at line 68 of file Event.php.

69  {
70  $this->getObservers()->removeObserverByName($observerName);
71  return $this;
72  }

◆ setName()

setName (   $data)
Parameters
string$data
Returns
$this

Definition at line 99 of file Event.php.

100  {
101  $this->_data['name'] = $data;
102  return $this;
103  }

Field Documentation

◆ $_observers

$_observers
protected

Definition at line 25 of file Event.php.


The documentation for this class was generated from the following file: