Page MenuHomePhorge
Diviner Tech Docs PhabricatorAutoEventListener

abstract class PhabricatorAutoEventListener
Phorge Technical Documentation (Events)

Event listener which is registered automatically, without requiring configuration.

Normally, event listeners must be registered via applications. This is appropriate for structured listeners in libraries, but it adds a lot of overhead and is cumbersome for one-off listeners.

All concrete subclasses of this class are automatically registered at startup. This allows it to be used with custom one-offs that can be dropped into phorge/src/extensions/.

Methods

public function __get($name)
Inherited

This method is not documented.
Parameters
$name
Return
wild

public function __set($name, $value)
Inherited

This method is not documented.
Parameters
$name
$value
Return
wild

public function current()
Inherited

This method is not documented.
Return
wild

public function key()
Inherited

This method is not documented.
Return
wild

public function next()
Inherited

This method is not documented.
Return
wild

public function rewind()
Inherited

This method is not documented.
Return
wild

public function valid()
Inherited

This method is not documented.
Return
wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.
Return
wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters
string$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue of the constant.

final public function __construct()
Inherited

This method is not documented.
Return
this//Implicit.//

abstract public function register()
Inherited

This method is not documented.
Return
wild

abstract public function handleEvent($event)
Inherited

This method is not documented.
Parameters
PhutilEvent$event
Return
wild

final public function listen($type)
Inherited

This method is not documented.
Parameters
$type
Return
wild

final public function getListenerID()
Inherited

PhutilEventListener

Return a scalar ID unique to this listener. This is used to deduplicate listeners which match events on multiple rules, so they are invoked only once.

Return
intA scalar unique to this object instance.

public function setApplication($application)
Inherited

This method is not documented.
Parameters
PhabricatorApplication$application
Return
wild

public function getApplication()
Inherited

This method is not documented.
Return
wild

public function hasApplicationCapability($viewer, $capability)
Inherited

This method is not documented.
Parameters
PhabricatorUser$viewer
$capability
Return
wild

public function canUseApplication($viewer)
Inherited

This method is not documented.
Parameters
PhabricatorUser$viewer
Return
wild

protected function addActionMenuItems($event, $items)
Inherited

This method is not documented.
Parameters
PhutilEvent$event
$items
Return
wild