Class - XPSPL\Event

Event

Represents an executed/executable XPSPL event signal.

As of v0.3.0 the event now inherits the State and Storage traits.

Methods

__construct

__construct([$ttl = false])

Construction allow for setting the event TTL.

Parameters:integer – TTL in milliseconds for the event.
Return type:object XPSPLEvent

has_expired

has_expired()

Returns if the event’s TTL has passed.

Return type:boolean

get_signal

get_signal()

Returns the event signal.

Return type:int|string|object

set_result

set_result($result)

Sets the result of the event.

Parameters:mixed

get_result

get_result()

Returns the result of the event.

Return type:mixed

halt

halt()

Halts the event execution.

Return type:void

is_child

is_child()

Determines if the event is a child of another event.

Return type:boolean

set_parent

set_parent($event)

Sets the parent event.

Parameters:object – XPSPLEvent
Return type:void

get_parent

get_parent()

Retrieves this event’s parent.

Return type:null|object

__get

__get($key)

Get a variable in the event.

Parameters:mixed – Variable name.
Return type:mixed|null

__isset

__isset($key)

Checks for a variable in the event.

Parameters:mixed – Variable name.
Return type:boolean

__set

__set($key, $value)

Set a variable in the event.

Parameters:
  • string – Name of variable
  • mixed – Value to variable
Return type:

boolean True

__unset

__unset($key)

Deletes a variable in the event.

Parameters:mixed – Variable name.
Return type:boolean

Constants

EVENT_SELF_PARENT

Last updated on 02/01/13 07:27am

Project Versions

Table Of Contents

Previous topic

Constants

Next topic

Class - XPSPL\Handle

This Page