HandlerList Class Reference

Public Member Functions
	__construct ()
	register (RegisteredListener $listener)
	registerAll (array $listeners)
	unregister ($object)
	bake ()
	getRegisteredListeners ($plugin=null)

Static Public Member Functions
static	bakeAll ()
static	unregisterAll ($object=null)
static	getHandlerLists ()

Constructor & Destructor Documentation

__construct()

__construct

(

)

HandlerList constructor.

                                 {
        $this->handlerSlots = [
            EventPriority::LOWEST => [],
            EventPriority::LOW => [],
            EventPriority::NORMAL => [],
            EventPriority::HIGH => [],
            EventPriority::HIGHEST => [],
            EventPriority::MONITOR => []
        ];
        self::$allLists[] = $this;
    }

Member Function Documentation

bake()

bake

(

)

                          {
        if($this->handlers !== null){
            return;
        }
        $entries = [];
        foreach($this->handlerSlots as $list){
            foreach($list as $hash => $listener){
                $entries[$hash] = $listener;
            }
        }
        $this->handlers = $entries;
    }

bakeAll()

static bakeAll ( )

static

                                    {
        foreach(self::$allLists as $h){
            $h->bake();
        }
    }

getHandlerLists()

static getHandlerLists ( )

static

Returns

HandlerList[]

                                            {
        return self::$allLists;
    }

getRegisteredListeners()

getRegisteredListeners

(

$plugin = null

)

Parameters

null | Plugin

$plugin

Returns

RegisteredListener[]

                                                          {
        if($plugin !== null){
            $listeners = [];
            foreach($this->getRegisteredListeners(null) as $hash => $listener){
                if($listener->getPlugin() === $plugin){
                    $listeners[$hash] = $plugin;
                }
            }

            return $listeners;
        }else{
            while(($handlers = $this->handlers) === null){
                $this->bake();
            }

            return $handlers;
        }
    }

register()

register

(

RegisteredListener

$listener

)

Parameters

RegisteredListener

$listener

Exceptions

                                                          {
        if($listener->getPriority() < EventPriority::MONITOR or $listener->getPriority() > EventPriority::LOWEST){
            return;
        }
        if(isset($this->handlerSlots[$listener->getPriority()][spl_object_hash($listener)])){
            throw new \InvalidStateException("This listener is already registered to priority " . $listener->getPriority());
        }
        $this->handlers = null;
        $this->handlerSlots[$listener->getPriority()][spl_object_hash($listener)] = $listener;
    }

registerAll()

registerAll

(

array

$listeners

)

Parameters

RegisteredListener[]

$listeners

                                                 {
        foreach($listeners as $listener){
            $this->register($listener);
        }
    }

unregister()

unregister

(

$object

)

Parameters

RegisteredListener | Listener | Plugin

$object

                                       {
        if($object instanceof Plugin or $object instanceof Listener){
            $changed = false;
            foreach($this->handlerSlots as $priority => $list){
                foreach($list as $hash => $listener){
                    if(($object instanceof Plugin and $listener->getPlugin() === $object)
                        or ($object instanceof Listener and $listener->getListener() === $object)
                    ){
                        unset($this->handlerSlots[$priority][$hash]);
                        $changed = true;
                    }
                }
            }
            if($changed === true){
                $this->handlers = null;
            }
        }elseif($object instanceof RegisteredListener){
            if(isset($this->handlerSlots[$object->getPriority()][spl_object_hash($object)])){
                unset($this->handlerSlots[$object->getPriority()][spl_object_hash($object)]);
                $this->handlers = null;
            }
        }
    }

unregisterAll()

static unregisterAll (   $object = null )

static

Unregisters all the listeners If a Plugin or Listener is passed, all the listeners with that object will be removed

Parameters

Plugin | Listener | null

$object

                                                        {
        if($object instanceof Listener or $object instanceof Plugin){
            foreach(self::$allLists as $h){
                $h->unregister($object);
            }
        }else{
            foreach(self::$allLists as $h){
                foreach($h->handlerSlots as $key => $list){
                    $h->handlerSlots[$key] = [];
                }
                $h->handlers = null;
            }
        }
    }

---

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

• src/pocketmine/event/HandlerList.php