woltlab-compiler/lib/System/Events/EventListener.d.ts

A compiler for WoltLab-Package Archives and WoltLab-Package Components

import { IEventListenerOptions } from "./IEventListenerOptions";
import { Listener } from "./Listener";
/**
 * 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 `FilesInstruction`.
 */
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 `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 `EventListener` class.
     */
    constructor(options: IEventListenerOptions);
    /**
     * Gets or sets the name of the class to listen to.
     */
    ClassName: string;
    /**
     * Gets or sets a value indicating whether listening to the event thrown by a class inheriting from `className` is allowed.
     */
    AllowInherited: 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.
     */
    EventHandlerClassName: string;
}