Class Phalcon\Events\Event¶

implements Phalcon\Events\EventInterface

Source on GitHub

This class offers contextual information of a fired event in the EventsManager

Methods¶

public getType ()

Event type

public getSource ()

Event source

public getData ()

Event data

public __construct (string $type, object $source, [mixed $data], [boolean $cancelable])

Phalcon\Events\Event constructor

public setData ([mixed $data])

Sets event data.

public setType (mixed $type)

Sets event type.

public stop ()

Stops the event preventing propagation.

<?php

if ($event->isCancelable()) {
    $event->stop();
}

public isStopped ()

Check whether the event is currently stopped.

public isCancelable ()

Check whether the event is cancelable.

<?php

if ($event->isCancelable()) {
    $event->stop();
}

Interface Phalcon\Events\EventInterface¶

Source on GitHub

Methods¶

abstract public getData ()

...

abstract public setData ([mixed $data])

...

abstract public getType ()

...

abstract public setType (mixed $type)

...

abstract public stop ()

...

abstract public isStopped ()

...

abstract public isCancelable ()

...

Interface Phalcon\Events\EventsAwareInterface¶

Source on GitHub

Methods¶

abstract public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager)

...

abstract public getEventsManager ()

...

Class Phalcon\Events\Exception¶

extends class Phalcon\Exception

implements Throwable

Source on GitHub

Methods¶

final private Exception __clone () inherited from Exception

Clone the exception

public __construct ([mixed $message], [mixed $code], [mixed $previous]) inherited from Exception

Exception constructor

public __wakeup () inherited from Exception

...

final public string getMessage () inherited from Exception

Gets the Exception message

final public int getCode () inherited from Exception

Gets the Exception code

final public string getFile () inherited from Exception

Gets the file in which the exception occurred

final public int getLine () inherited from Exception

Gets the line in which the exception occurred

final public array getTrace () inherited from Exception

Gets the stack trace

final public Exception getPrevious () inherited from Exception

Returns previous Exception

final public Exception getTraceAsString () inherited from Exception

Gets the stack trace as a string

public string __toString () inherited from Exception

String representation of the exception

Class Phalcon\Events\Manager¶

implements Phalcon\Events\ManagerInterface

Source on GitHub

Phalcon Events Manager, offers an easy way to intercept and manipulate, if needed, the normal flow of operation. With the EventsManager the developer can create hooks or plugins that will offer monitoring of data, manipulation, conditional execution and much more.

Methods¶

public attach (string $eventType, object | callable $handler, [int $priority])

Attach a listener to the events manager

public detach (string $eventType, object $handler)

Detach the listener from the events manager

public enablePriorities (mixed $enablePriorities)

Set if priorities are enabled in the EventsManager

public arePrioritiesEnabled ()

Returns if priorities are enabled

public collectResponses (mixed $collect)

Tells the event manager if it needs to collect all the responses returned by every registered listener in a single fire

public isCollecting ()

Check if the events manager is collecting all all the responses returned by every registered listener in a single fire

public array getResponses ()

Returns all the responses returned by every handler executed by the last 'fire' executed

public detachAll ([mixed $type])

Removes all events from the EventsManager

final public mixed fireQueue (SplPriorityQueue | array $queue, Phalcon\Events\Event $event)

Internal handler to call a queue of events

public mixed fire (string $eventType, object $source, [mixed $data], [boolean $cancelable])

Fires an event in the events manager causing the active listeners to be notified about it

<?php

$eventsManager->fire("db", $connection);

public hasListeners (mixed $type)

Check whether certain type of event has listeners

public array getListeners (string $type)

Returns all the attached listeners of a certain type

Interface Phalcon\Events\ManagerInterface¶

Source on GitHub

Methods¶

abstract public attach (mixed $eventType, mixed $handler)

...

abstract public detach (mixed $eventType, mixed $handler)

...

abstract public detachAll ([mixed $type])

...

abstract public fire (mixed $eventType, mixed $source, [mixed $data])

...

abstract public getListeners (mixed $type)

...