Collaboration diagram for ilChatroomObjectDefinition:

Public Member Functions
	__construct ($moduleName, $moduleBasePath, $relativeClassPath='classes', $relativeTaskPath='tasks')
	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, $relativeTaskFolder)
	Returns an Instance of ilChatroomObjectDefinition, using given $moduleName and $relativeTaskFolder as parameters. More...

Private Attributes
	$moduleName

	$moduleBasePath

	$relativeClassPath

	$relativeTaskPath

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'`,
		$relativeTaskPath = `'tasks'`
	)

Sets class parameters using given parameters.

Parameters

string	$moduleName
string	$moduleBasePath
string	$relativeClassPath
string	$relativeTaskPath

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

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

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

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 100 of file class.ilChatroomObjectDefinition.php.

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

References 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 50 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,
		$relativeTaskFolder
	)

static

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

Parameters

string	$moduleName
string	$relativeTaskFolder

Returns: ilChatroomObjectDefinition

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

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

References $moduleName.

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 113 of file class.ilChatroomObjectDefinition.php.

        {
                return 'il' . $this->moduleName . ucfirst($task) . '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 123 of file class.ilChatroomObjectDefinition.php.

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

References 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 78 of file class.ilChatroomObjectDefinition.php.

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

References 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 88 of file class.ilChatroomObjectDefinition.php.

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

References getTaskPath().

Here is the call graph for this function:

Field Documentation

◆ $moduleBasePath

ilChatroomObjectDefinition::$moduleBasePath

private

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

Referenced by __construct().

◆ $moduleName

ilChatroomObjectDefinition::$moduleName

private

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

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

◆ $relativeClassPath

ilChatroomObjectDefinition::$relativeClassPath

private

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

Referenced by __construct().

◆ $relativeTaskPath

ilChatroomObjectDefinition::$relativeTaskPath

private

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

Referenced by __construct().

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

Modules/Chatroom/classes/class.ilChatroomObjectDefinition.php

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildTask()

◆ getDefaultDefinition()

◆ getDefaultDefinitionWithCustomTaskPath()

◆ getTaskClassName()

◆ getTaskPath()

◆ hasTask()

◆ loadTask()

Field Documentation

◆ $moduleBasePath

◆ $moduleName

◆ $relativeClassPath

◆ $relativeTaskPath