class.ilChatroomObjectDefinition.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilChatroomObjectDefinition
{
    private readonly string $moduleBasePath;

    private readonly string $relativeClassPath;

    private readonly string $guiScope;

    public function __construct(
        private readonly string $moduleName,
        string $moduleBasePath,
        string $relativeClassPath = 'classes',
        string $guiScope = ''
    ) {
        $this->moduleBasePath = rtrim($moduleBasePath, '/\\');
        $this->relativeClassPath = rtrim($relativeClassPath);
        $this->guiScope = rtrim($guiScope);
    }

    public static function getDefaultDefinition(string $moduleName): self
    {
        return new self($moduleName, '../components/ILIAS/' . $moduleName . '/');
    }

    public static function getDefaultDefinitionWithCustomGUIPath(string $moduleName, string $guiScope = ''): self
    {
        return new self(
            $moduleName,
            '../components/ILIAS/' . $moduleName . '/',
            'classes',
            $guiScope
        );
    }

    public function hasGUI(string $gui): bool
    {
        $path = $this->getGUIPath($gui);

        return class_exists($this->getGUIClassName($gui)) && file_exists($path);
    }

    public function getGUIPath(string $gui): string
    {
        return (
            $this->moduleBasePath . '/' .
            $this->relativeClassPath . '/' .
            $this->guiScope . 'gui/class.' . $this->getGUIClassName($gui) . '.php'
        );
    }

    public function getGUIClassName(string $gui): string
    {
        return 'il' . $this->moduleName . ucfirst($this->guiScope) . ucfirst($gui) . 'GUI';
    }

    public function buildGUI(string $gui, ilChatroomObjectGUI $chatroomObjectGUI): ilChatroomGUIHandler
    {
        $className = $this->getGUIClassName($gui);
        return new $className($chatroomObjectGUI);
    }
}