Observer Class Reference

Inheritance diagram for Observer:

Public Member Functions
	isValidFor (Event $event)
	dispatch (Event $event)
	getName ()
	setName ($data)
	getEventName ()
	setEventName ($data)
	getCallback ()
	setCallback ($data)
	getEvent ()
	setEvent ($data)
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)

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

Detailed Description

@api

Since

100.0.2

Definition at line 14 of file Observer.php.

Member Function Documentation

dispatch()

dispatch

(

Event

$event

)

Dispatches an event to observer's callback

Parameters

Event

$event

Returns

$this

Definition at line 33 of file Observer.php.

    {
        if (!$this->isValidFor($event)) {
            return $this;
        }

        $callback = $this->getCallback();
        $this->setEvent($event);

        $_profilerKey = 'OBSERVER: ';
        if (is_object($callback[0])) {
            $_profilerKey .= get_class($callback[0]);
        } else {
            $_profilerKey .= (string)$callback[0];
        }
        $_profilerKey .= ' -> ' . $callback[1];

        \Magento\Framework\Profiler::start($_profilerKey);
        call_user_func($callback, $this);
        \Magento\Framework\Profiler::stop($_profilerKey);

        return $this;
    }

getCallback()

getCallback

(

)

Returns

string

Definition at line 94 of file Observer.php.

    {
        return $this->getData('callback');
    }

getEvent()

getEvent

(

)

Get observer event object

Returns

Event

Definition at line 113 of file Observer.php.

    {
        return $this->getData('event');
    }

getEventName()

getEventName

(

)

Returns

string

Definition at line 77 of file Observer.php.

    {
        return $this->getData('event_name');
    }

getName()

getName

(

)

Returns

string

Definition at line 60 of file Observer.php.

    {
        return $this->getData('name');
    }

isValidFor()

isValidFor

(

Event

$event

)

Checks the observer's event_regex against event's name

Parameters

Event

$event

Returns

boolean

Definition at line 22 of file Observer.php.

    {
        return $this->getEventName() === $event->getName();
    }

setCallback()

setCallback

(

$data

)

Parameters

string

$data

Returns

\Magento\Framework\DataObject

Definition at line 103 of file Observer.php.

    {
        return $this->setData('callback', $data);
    }

setEvent()

setEvent

(

$data

)

Parameters

mixed

$data

Returns

\Magento\Framework\DataObject

Definition at line 122 of file Observer.php.

    {
        return $this->setData('event', $data);
    }

setEventName()

setEventName

(

$data

)

Parameters

string

$data

Returns

\Magento\Framework\DataObject

Definition at line 86 of file Observer.php.

    {
        return $this->setData('event_name', $data);
    }

setName()

setName

(

$data

)

Parameters

string

$data

Returns

\Magento\Framework\DataObject

Definition at line 69 of file Observer.php.

    {
        return $this->setData('name', $data);
    }

---

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

• vendor/magento/framework/Event/Observer.php