class.ilDBayObjectDefinition.php

Go to the documentation of this file.

<?php

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */

class ilDBayObjectDefinition
{

        private $moduleName;
        private $moduleBasePath;
        private $relativeClassPath;
        private $relativeTaskPath;

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

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

                return $object;
        }

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

                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, ilDBayObjectGUI $gui)
        {
                $className = $this->getTaskClassName( $task );
                $task = new $className( $gui );

                return $task;
        }

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

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

}

?>