ilChatroomObjectDefinition Class Reference

Collaboration diagram for ilChatroomObjectDefinition:

Public Member Functions
	__construct ($moduleName, $moduleBasePath, $relativeClassPath='classes', $taskScope='')
	Sets class parameters using given parameters. More...
	hasTask ($task)
	Returns true if file exists. More...
	loadTask ($task)
	Requires file, whereby given $task is used as parameter in getTaskPath method to build the filename of the file to required. More...
	buildTask ($task, ilChatroomObjectGUI $gui)
	Builds and returns new task using given $task and $gui. More...
	getTaskClassName ($task)
	Builds task classname using given $task and returns it. More...
	getTaskPath ($task)
	Builds task path using given $task and returns it. More...

Static Public Member Functions
static	getDefaultDefinition ($moduleName)
	Returns an Instance of ilChatroomObjectDefinition, using given $moduleName as parameter. More...
static	getDefaultDefinitionWithCustomTaskPath ($moduleName, $taskScope='')
	Returns an Instance of ilChatroomObjectDefinition, using given $moduleName and $taskScope as parameters. More...

Private Attributes
	$moduleName
	$moduleBasePath
	$relativeClassPath
	$taskScope

Detailed Description

Author

jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Definition at line 7 of file class.ilChatroomObjectDefinition.php.

Constructor & Destructor Documentation

__construct()

ilChatroomObjectDefinition::__construct	(		$moduleName,
			$moduleBasePath,
			$relativeClassPath = 'classes',
			$taskScope = ''
	)

Sets class parameters using given parameters.

Parameters

string	$moduleName
string	$moduleBasePath
string	$relativeClassPath	Optional.
string	$taskScope	Optional.

Definition at line 41 of file class.ilChatroomObjectDefinition.php.

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

References $moduleBasePath, $moduleName, $relativeClassPath, and $taskScope.

Member Function Documentation

buildTask()

ilChatroomObjectDefinition::buildTask	(		$task,
		ilChatroomObjectGUI	$gui
	)

Builds and returns new task using given $task and $gui.

Parameters

string	$task
ilChatroomObjectGUI	$gui

Returns

ilChatroomTaskHandler

Definition at line 105 of file class.ilChatroomObjectDefinition.php.

        {
                $className = $this->getTaskClassName($task);
                $task      = new $className($gui);
 
                return $task;
        }

References $task, and getTaskClassName().

Here is the call graph for this function:

getDefaultDefinition()

static ilChatroomObjectDefinition::getDefaultDefinition (   $moduleName )

static

Returns an Instance of ilChatroomObjectDefinition, using given $moduleName as parameter.

Parameters

string

$moduleName

Returns

ilChatroomObjectDefinition

Definition at line 55 of file class.ilChatroomObjectDefinition.php.

        {
                $object = new self($moduleName, 'Modules/' . $moduleName . '/');
 
                return $object;
        }

References $moduleName.

Referenced by ilObjChatroomGUI\getObjectDefinition().

Here is the caller graph for this function:

getDefaultDefinitionWithCustomTaskPath()

static ilChatroomObjectDefinition::getDefaultDefinitionWithCustomTaskPath (   $moduleName,   $taskScope = ''  )

static

Returns an Instance of ilChatroomObjectDefinition, using given $moduleName and $taskScope as parameters.

Parameters

string	$moduleName
string	$taskScope	Optional. 'admin' or ''. Default ''

Returns

ilChatroomObjectDefinition

Definition at line 69 of file class.ilChatroomObjectDefinition.php.

        {
                $object = new self(
                        $moduleName, 'Modules/' . $moduleName . '/', 'classes', $taskScope
                );
 
                return $object;
        }

References $moduleName, and $taskScope.

Referenced by ilObjChatroomAdminGUI\getObjectDefinition().

Here is the caller graph for this function:

getTaskClassName()

ilChatroomObjectDefinition::getTaskClassName

(

$task

)

Builds task classname using given $task and returns it.

Parameters

string

$task

Returns

string

Definition at line 118 of file class.ilChatroomObjectDefinition.php.

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

References $task.

Referenced by buildTask(), and getTaskPath().

Here is the caller graph for this function:

getTaskPath()

ilChatroomObjectDefinition::getTaskPath

(

$task

)

Builds task path using given $task and returns it.

Parameters

string

$task

Returns

string

Definition at line 128 of file class.ilChatroomObjectDefinition.php.

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

References $task, and getTaskClassName().

Referenced by hasTask(), and loadTask().

Here is the call graph for this function:

Here is the caller graph for this function:

hasTask()

ilChatroomObjectDefinition::hasTask

(

$task

)

Returns true if file exists.

Parameters

string

$task

Returns

boolean

Definition at line 83 of file class.ilChatroomObjectDefinition.php.

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

References $task, and getTaskPath().

Here is the call graph for this function:

loadTask()

ilChatroomObjectDefinition::loadTask

(

$task

)

Requires file, whereby given $task is used as parameter in getTaskPath method to build the filename of the file to required.

Parameters

string

$task

Definition at line 93 of file class.ilChatroomObjectDefinition.php.

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

References $task, and getTaskPath().

Here is the call graph for this function:

Field Documentation

$moduleBasePath

ilChatroomObjectDefinition::$moduleBasePath

private

Definition at line 19 of file class.ilChatroomObjectDefinition.php.

Referenced by __construct().

$moduleName

ilChatroomObjectDefinition::$moduleName

private

Definition at line 13 of file class.ilChatroomObjectDefinition.php.

Referenced by __construct(), getDefaultDefinition(), and getDefaultDefinitionWithCustomTaskPath().

$relativeClassPath

ilChatroomObjectDefinition::$relativeClassPath

private

Definition at line 25 of file class.ilChatroomObjectDefinition.php.

Referenced by __construct().

$taskScope

ilChatroomObjectDefinition::$taskScope

private

Definition at line 32 of file class.ilChatroomObjectDefinition.php.

Referenced by __construct(), and getDefaultDefinitionWithCustomTaskPath().

---

The documentation for this class was generated from the following file:

• Modules/Chatroom/classes/class.ilChatroomObjectDefinition.php