class.ilChatroomObjectDefinition.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilChatroomObjectDefinition
{
    private $moduleName;

    private $moduleBasePath;

    private $relativeClassPath;

    private $guiScope;

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

    public static function getDefaultDefinition($moduleName)
    {
        $object = new self($moduleName, 'Modules/' . $moduleName . '/');

        return $object;
    }

    public static function getDefaultDefinitionWithCustomGUIPath($moduleName, $guiScope = '')
    {
        $object = new self(
            $moduleName,
            'Modules/' . $moduleName . '/',
            'classes',
            $guiScope
        );

        return $object;
    }

    public function hasGUI($gui)
    {
        return file_exists($this->getGUIPath($gui));
    }

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

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

    public function loadGUI($gui)
    {
        require_once $this->getGUIPath($gui);
    }

    public function buildGUI($gui, ilChatroomObjectGUI $chatroomObjectGUI)
    {
        $className = $this->getGUIClassName($gui);
        $guiInstance = new $className($chatroomObjectGUI);

        return $guiInstance;
    }
}