Signal.php

Go to the documentation of this file.

<?php
 
namespace PlanetTeamSpeak\TeamSpeak3Framework\Helper;
 
use PlanetTeamSpeak\TeamSpeak3Framework\Exception\HelperException;
use PlanetTeamSpeak\TeamSpeak3Framework\Exception\SignalException;
use PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\Handler;

class Signal
{
    protected static ?Signal $instance = null;

    protected array $sigslots = [];

    public function emit(string $signal, mixed $params = null): mixed
    {
        if (!$this->hasHandlers($signal)) {
            return null;
        }
 
        if (!is_array($params)) {
            $params = func_get_args();
            $params = array_slice($params, 1);
        }
 
        foreach ($this->sigslots[$signal] as $slot) {
            $return = $slot->call($params);
        }
 
        return $return;
    }

    public function getCallbackHash(mixed $callback): string
    {
        if (!is_callable($callback, true, $callable_name)) {
            throw new SignalException("invalid callback specified");
        }
 
        return md5($callable_name);
    }

    public function subscribe(string $signal, mixed $callback): Handler
    {
        if (empty($this->sigslots[$signal])) {
            $this->sigslots[$signal] = [];
        }
 
        $index = $this->getCallbackHash($callback);
 
        if (!array_key_exists($index, $this->sigslots[$signal])) {
            $this->sigslots[$signal][$index] = new Handler($signal, $callback);
        }
 
        return $this->sigslots[$signal][$index];
    }

    public function unsubscribe(string $signal, mixed $callback = null): void
    {
        if (!$this->hasHandlers($signal)) {
            return;
        }
 
        if ($callback !== null) {
            $index = $this->getCallbackHash($callback);
 
            if (!array_key_exists($index, $this->sigslots[$signal])) {
                return;
            }
 
            unset($this->sigslots[$signal][$index]);
        } else {
            unset($this->sigslots[$signal]);
        }
    }

    public function getSignals(): array
    {
        return array_keys($this->sigslots);
    }

    public function hasHandlers(string $signal): bool
    {
        return !empty($this->sigslots[$signal]);
    }

    public function getHandlers(string $signal): array
    {
        if ($this->hasHandlers($signal)) {
            return $this->sigslots[$signal];
        }
 
        return [];
    }

    public function clearHandlers(string $signal): void
    {
        if ($this->hasHandlers($signal)) {
            unset($this->sigslots[$signal]);
        }
    }

    public static function getInstance(): ?Signal
    {
        if (self::$instance === null) {
            self::$instance = new self();
        }
 
        return self::$instance;
    }
}