. * * @author Daniil Gentili * @copyright 2016-2025 Daniil Gentili * @license https://opensource.org/licenses/AGPL-3.0 AGPLv3 * @link https://docs.madelineproto.xyz MadelineProto documentation */ namespace danog\MadelineProto\Wrappers; use __PHP_Incomplete_Class; use danog\MadelineProto\EventHandler; use danog\MadelineProto\Exception; use danog\MadelineProto\Ipc\EventHandlerProxy; use danog\MadelineProto\PluginEventHandler; use danog\MadelineProto\Settings; use danog\MadelineProto\UpdateHandlerType; use ReflectionClass; /** * Event handler. * * @property Settings $settings Settings * * @internal */ trait Events { /** * Event handler class name. * * @var class-string */ public ?string $event_handler = null; /** * Event handler instance. * * Can't make it strictly typed or else the IPC server may fail without access to the instance. * * @psalm-var ?EventHandler */ private $event_handler_instance = null; /** * Event handler method list. * * @var array */ private array $eventHandlerMethods = []; private \Closure $rethrowHandler; /** * Event handler handler list. * * @var array */ private array $eventHandlerHandlers = []; /** @var array, EventHandler> */ private array $pluginInstances = []; /** * Set event handler. * * @internal * * @param class-string $eventHandler Event handler */ public function setEventHandler(string $eventHandler): void { if (!is_subclass_of($eventHandler, EventHandler::class)) { throw new Exception('Wrong event handler was defined'); } $this->event_handler = $eventHandler; if (!$this->event_handler_instance instanceof $this->event_handler) { $class_name = $this->event_handler; $refl = new ReflectionClass($class_name); $this->event_handler_instance = $refl->newInstanceWithoutConstructor(); } $pluginsNew = []; $methods = $this->event_handler_instance->internalStart( $this->wrapper, $this->pluginInstances, $pluginsNew ); if ($methods === null) { // Already started event handler return; } $this->rethrowHandler = $this->rethrowUpdateHandler(...); [$this->eventHandlerMethods, $this->eventHandlerHandlers] = $methods; $this->pluginInstances = $pluginsNew; $this->updateHandlerType = UpdateHandlerType::EVENT_HANDLER; foreach ($this->getUpdatesQueue as $update) { $this->handleUpdate($update); } $this->getUpdatesQueue->clear(); $this->getUpdatesQueueKey = 0; } /** * Check if a certain event handler plugin is installed. * * @param class-string $class */ final public function hasPlugin(string $class): bool { return isset($this->pluginInstances[$class]); } /** * Obtain a certain event handler plugin instance. * * @template T as EventHandler * * @param class-string $class * * return T|null */ final public function getPlugin(string $class): PluginEventHandler|EventHandlerProxy|null { return $this->pluginInstances[$class] ?? null; } /** * Unset event handler. * */ public function unsetEventHandler(): void { $this->event_handler = null; $this->event_handler_instance = null; $this->eventHandlerMethods = []; $this->eventHandlerHandlers = []; $this->pluginInstances = []; $this->setNoop(); } /** * Get event handler (or plugin instance). * * @template T as EventHandler * * @param class-string|null $class * * @return T|EventHandlerProxy|__PHP_Incomplete_Class|null */ public function getEventHandler(?string $class = null): EventHandler|EventHandlerProxy|__PHP_Incomplete_Class|null { if ($this->event_handler_instance === null || $this->event_handler_instance instanceof __PHP_Incomplete_Class) { return $this->event_handler_instance; } if ($class !== null && $class !== $this->event_handler_instance::class) { return $this->getPlugin($class); } return $this->event_handler_instance; } /** @internal */ public function getEventHandlerClass(): ?string { return $this->event_handler_instance !== null ? $this->event_handler_instance::class : null; } /** * Check if an event handler instance is present. */ public function hasEventHandler(): bool { return isset($this->event_handler_instance); } /** @internal */ public function callPluginMethod(?string $class, string $method, array $args): mixed { $obj = $class === null ? $this->event_handler_instance : $this->pluginInstances[$class]; return $obj->$method(...$args); } /** @internal */ public function setPluginProperty(?string $class, string $property, mixed $value): void { $obj = $class === null ? $this->event_handler_instance : $this->pluginInstances[$class]; $obj->$property = $value; } /** @internal */ public function getPluginProperty(?string $class, string $property): mixed { $obj = $class === null ? $this->event_handler_instance : $this->pluginInstances[$class]; return $obj->$property; } /** @internal */ public function issetPluginProperty(?string $class, string $property): bool { $obj = $class === null ? $this->event_handler_instance : $this->pluginInstances[$class]; return isset($obj->$property); } /** @internal */ public function unsetPluginProperty(?string $class, string $property): void { $obj = $class === null ? $this->event_handler_instance : $this->pluginInstances[$class]; unset($obj->$property); } }