ilChatroomObjectDefinition Class Reference

Collaboration diagram for ilChatroomObjectDefinition:

Public Member Functions
	__construct ($moduleName, $moduleBasePath, $relativeClassPath='classes', $guiScope='')
	Sets class parameters using given parameters. More...
	hasGUI ($gui)
	Returns true if file exists. More...
	getGUIPath ($gui)
	Builds gui path using given $gui and returns it. More...
	getGUIClassName ($gui)
	Builds gui classname using given $gui and returns it. More...
	loadGUI ($gui)
	Requires file, whereby given $gui is used as parameter in getGUIPath method to build the filename of the file to required. More...
	buildGUI ($gui, ilChatroomObjectGUI $chatroomObjectGUI)
	Builds and returns new gui using given $gui and $gui. More...

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

Private Attributes
	$moduleName
	$moduleBasePath
	$relativeClassPath
	$guiScope

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',
			$guiScope = ''
	)

Sets class parameters using given parameters.

Parameters

string	$moduleName
string	$moduleBasePath
string	$relativeClassPath	Optional.
string	$guiScope	Optional.

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

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

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

Member Function Documentation

buildGUI()

ilChatroomObjectDefinition::buildGUI	(		$gui,
		ilChatroomObjectGUI	$chatroomObjectGUI
	)

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

Parameters

string	$gui
ilChatroomObjectGUI	$chatroomObjectGUI

Returns

ilChatroomGUIHandler

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

References getGUIClassName().

        {
                $className   = $this->getGUIClassName($gui);
                $guiInstance = new $className($chatroomObjectGUI);

                return $guiInstance;
        }

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.

References $moduleName.

Referenced by ilObjChatroomGUI\getObjectDefinition().

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

                return $object;
        }

Here is the caller graph for this function:

getDefaultDefinitionWithCustomGUIPath()

static ilChatroomObjectDefinition::getDefaultDefinitionWithCustomGUIPath (   $moduleName,   $guiScope = ''  )

static

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

Parameters

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

Returns

ilChatroomObjectDefinition

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

References $guiScope, and $moduleName.

Referenced by ilObjChatroomAdminGUI\getObjectDefinition().

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

                return $object;
        }

Here is the caller graph for this function:

getGUIClassName()

ilChatroomObjectDefinition::getGUIClassName

(

$gui

)

Builds gui classname using given $gui and returns it.

Parameters

string

$gui

Returns

string

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

Referenced by buildGUI(), and getGUIPath().

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

Here is the caller graph for this function:

getGUIPath()

ilChatroomObjectDefinition::getGUIPath

(

$gui

)

Builds gui path using given $gui and returns it.

Parameters

string

$gui

Returns

string

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

References getGUIClassName().

Referenced by hasGUI(), and loadGUI().

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

Here is the call graph for this function:

Here is the caller graph for this function:

hasGUI()

ilChatroomObjectDefinition::hasGUI

(

$gui

)

Returns true if file exists.

Parameters

string

$gui

Returns

boolean

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

References getGUIPath().

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

Here is the call graph for this function:

loadGUI()

ilChatroomObjectDefinition::loadGUI

(

$gui

)

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

Parameters

string

$gui

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

References getGUIPath().

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

Here is the call graph for this function:

Field Documentation

$guiScope

ilChatroomObjectDefinition::$guiScope

private

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

Referenced by __construct(), and getDefaultDefinitionWithCustomGUIPath().

$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 getDefaultDefinitionWithCustomGUIPath().

$relativeClassPath

ilChatroomObjectDefinition::$relativeClassPath

private

Definition at line 25 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