@manuth/woltlab-compiler/lib/Events/EventListener.d.ts

A compiler for generating WoltLab-Package `.tar` Archives and other WoltLab-Package Components

import { IEventListenerOptions } from "./IEventListenerOptions.js";
import { Listener } from "./Listener.js";
/**
 * Represents the declaration of a PHP-class that should be executed when a specific event occurs.
 *
 * Please note that you have to provide your PHP-files using a {@link ApplicationFileSystemInstruction `ApplicationFileSystemInstruction`}.
 */
export declare class EventListener extends Listener {
    /**
     * The name of the class to listen to.
     */
    private className;
    /**
     * A value indicating whether listening to the event thrown by a class inheriting from {@link EventListener.className `className`} is allowed.
     */
    private allowInherited;
    /**
     * The name of the event-handler class which is triggered when the event has been executed.
     *
     * Please consider that the event-handler class **must** inherit the `wcf\system\event\listener\IParameterizedEventListener`-class.
     */
    private eventHandlerClassName;
    /**
     * Initializes a new instance of the {@link EventListener `EventListener`} class.
     *
     * @param options
     * The options of the event-listener.
     */
    constructor(options: IEventListenerOptions);
    /**
     * Gets or sets the name of the class to listen to.
     */
    get ClassName(): string;
    /**
     * @inheritdoc
     */
    set ClassName(value: string);
    /**
     * Gets or sets a value indicating whether listening to the event thrown by a class inheriting from {@link EventListener.ClassName `ClassName`} is allowed.
     */
    get AllowInherited(): boolean;
    /**
     * @inheritdoc
     */
    set AllowInherited(value: boolean);
    /**
     * Gets or sets the name of the event-handler class which is triggered when the event has been executed.
     *
     * Please consider that the event-handler class **must** inherit the `wcf\system\event\listener\IParameterizedEventListener`-class.
     */
    get EventHandlerClassName(): string;
    /**
     * @inheritdoc
     */
    set EventHandlerClassName(value: string);
}