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 $taskScope;

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

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

                return $object;
        }

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

                return $object;
        }

        public function hasTask($task)
        {
                return file_exists($this->getTaskPath($task));
        }

        public function loadTask($task)
        {
                require_once $this->getTaskPath($task);
        }


        public function buildTask($task, ilChatroomObjectGUI $gui)
        {
                $className = $this->getTaskClassName($task);
                $task      = new $className($gui);

                return $task;
        }

        public function getTaskClassName($task)
        {
                return 'il' . $this->moduleName . ucfirst($this->taskScope) . ucfirst($task) . 'Task';
        }

        public function getTaskPath($task)
        {
                return $this->moduleBasePath . '/' . $this->relativeClassPath . '/' .
                        $this->taskScope . 'tasks/class.' . $this->getTaskClassName($task) . '.php';
        }
}