Event Class Reference

Inheritance diagram for Event:

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.

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

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.

    {
        $this->getObservers()->addObserver($observer);
        return $this;
    }

dispatch()

dispatch

(

)

Dispatches the event to registered observers

Returns

$this

Definition at line 79 of file Event.php.

    {
        $this->getObservers()->dispatch($this);
        return $this;
    }

getBlock()

getBlock

(

)

Returns

mixed

Definition at line 108 of file Event.php.

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

getName()

getName

(

)

Retrieve event name

Returns

string

Definition at line 90 of file Event.php.

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

getObservers()

getObservers

(

)

Returns all the registered observers for the event

Returns

\Magento\Framework\Event\Observer\Collection

Definition at line 45 of file Event.php.

    {
        return $this->_observers;
    }

removeObserverByName()

removeObserverByName

(

$observerName

)

Removes an observer by its name

Parameters

string

$observerName

Returns

$this

Definition at line 68 of file Event.php.

    {
        $this->getObservers()->removeObserverByName($observerName);
        return $this;
    }

setName()

setName

(

$data

)

Parameters

string

$data

Returns

$this

Definition at line 99 of file Event.php.

    {
        $this->_data['name'] = $data;
        return $this;
    }

Field Documentation

$_observers

$_observers

protected

Definition at line 25 of file Event.php.

---

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

• vendor/magento/framework/Event.php