class.ilArtifactEventHandlingData.php

Go to the documentation of this file.

<?php

class ilArtifactEventHandlingData
{
    public const EVENT_HANDLING_DATA_PATH = "./Services/EventHandling/artifacts/event_handling_data.php";

    protected array $event_handling_data;

    public function __construct()
    {
        $this->event_handling_data = $this->readEventHandlingData();
    }

    protected function readEventHandlingData(): array
    {
        return require self::EVENT_HANDLING_DATA_PATH;
    }

    public function hasEvent(string $component, string $type, string $type_specification): bool
    {
        return in_array(
            [
                "component"             => $component,
                "type"                  => $type,
                "type_specification"    => $type_specification
            ],
            $this->event_handling_data,
            true
        );
    }

    public function getEvent(string $component, string $type, string $type_specification): array
    {
        if ($this->hasEvent($component, $type, $type_specification)) {
            return [
                "component"             => $component,
                "type"                  => $type,
                "type_specification"    => $type_specification
            ];
        }

        throw new \InvalidArgumentException(
            "There is no event with the component \"" . $component . "\", type \"" . $type
            . "\" and type specification \"" . $type_specification . "\"."
        );
    }

    public function getEventsByType(string $type): Iterator
    {
        foreach ($this->event_handling_data as $event_key => $event_values) {
            if ($event_values["type"] == $type) {
                yield $this->event_handling_data[$event_key];
            }
        }
    }
}