Collection Class Reference

Public Member Functions
	__construct (array $events=[], Observer\Collection $observerCollection=null)
	getAllEvents ()
	getGlobalObservers ()
	getEventByName ($eventName)
	addEvent (Event $event)
	addObserver (Observer $observer)
	dispatch ($eventName, array $data=[])

Protected Attributes
	$events
	$globalObservers

Detailed Description

Definition at line 16 of file Collection.php.

Constructor & Destructor Documentation

__construct()

__construct	(	array	$events = [],
		Observer\Collection	$observerCollection = null
	)

Initializes global observers collection

Parameters

array	$events
Observer\Collection	$observerCollection

Definition at line 40 of file Collection.php.

    {
        $this->events = $events;
        $this->globalObservers = !$observerCollection ? new Observer\Collection() : $observerCollection;
    }

Member Function Documentation

addEvent()

addEvent

(

Event

$event

)

Register an event for this collection

Parameters

Event

$event

Returns

$this

Definition at line 88 of file Collection.php.

    {
        $this->events[$event->getName()] = $event;
        return $this;
    }

addObserver()

addObserver

(

Observer

$observer

)

Register an observer

If observer has event_name property it will be registered for this specific event. If not it will be registered as global observer

Parameters

Observer

$observer

Returns

$this

Definition at line 103 of file Collection.php.

    {
        $eventName = $observer->getEventName();
        if ($eventName) {
            $this->getEventByName($eventName)->addObserver($observer);
        } else {
            $this->getGlobalObservers()->addObserver($observer);
        }
        return $this;
    }

dispatch()

dispatch	(		$eventName,
		array	$data = []
	)

Dispatch event name with optional data

Will dispatch specific event and will try all global observers

Parameters

string	$eventName
array	$data

Returns

$this

Definition at line 123 of file Collection.php.

    {
        $event = $this->getEventByName($eventName);
        $event->addData($data)->dispatch();
        $this->getGlobalObservers()->dispatch($event);
        return $this;
    }

getAllEvents()

getAllEvents

(

)

Returns all registered events in collection

Returns

array

Definition at line 51 of file Collection.php.

    {
        return $this->events;
    }

getEventByName()

getEventByName

(

$eventName

)

Returns event by its name

If event doesn't exist creates new one and returns it

Parameters

string

$eventName

Returns

Event

Definition at line 74 of file Collection.php.

    {
        if (!isset($this->events[$eventName])) {
            $this->addEvent(new Event(['name' => $eventName]));
        }
        return $this->events[$eventName];
    }

getGlobalObservers()

getGlobalObservers

(

)

Returns all registered global observers for the collection of events

Returns

Observer\Collection

Definition at line 61 of file Collection.php.

    {
        return $this->globalObservers;
    }

Field Documentation

$events

$events

protected

Definition at line 23 of file Collection.php.

$globalObservers

$globalObservers

protected

Definition at line 32 of file Collection.php.

---

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

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