Collaboration diagram for ilChatroomObjectDefinition:

Public Member Functions
	__construct (string $moduleName, string $moduleBasePath, string $relativeClassPath='classes', string $guiScope='')

	hasGUI (string $gui)
	Returns true if file exists. More...

	getGUIPath (string $gui)
	Builds gui path using given $gui and returns it. More...

	getGUIClassName (string $gui)
	Builds gui classname using given $gui and returns it. More...

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

	buildGUI (string $gui, ilChatroomObjectGUI $chatroomObjectGUI)
	Builds and returns new gui using given $gui and $gui. More...

Static Public Member Functions
static	getDefaultDefinition (string $moduleName)
	Returns an Instance of ilChatroomObjectDefinition, using given $moduleName as parameter. More...

static	getDefaultDefinitionWithCustomGUIPath (string $moduleName, string $guiScope='')
	Returns an Instance of ilChatroomObjectDefinition, using given $moduleName and $guiScope as parameters. More...

Private Attributes
string	$moduleName

string	$moduleBasePath

string	$relativeClassPath

string	$guiScope

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ilChatroomObjectDefinition::__construct	(	string	$moduleName,
		string	$moduleBasePath,
		string	$relativeClassPath = `'classes'`,
		string	$guiScope = `''`
	)

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

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

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

Member Function Documentation

◆ buildGUI()

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

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

Parameters

string	$gui
ilChatroomObjectGUI	$chatroomObjectGUI

Returns: ilChatroomGUIHandler

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

                                                                                 : ilChatroomGUIHandler
    {
        $className = $this->getGUIClassName($gui);
        return new $className($chatroomObjectGUI);
    }

References getGUIClassName().

Here is the call graph for this function:

◆ getDefaultDefinition()

static ilChatroomObjectDefinition::getDefaultDefinition ( string $moduleName )

static

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

Parameters

string $moduleName

Returns: ilChatroomObjectDefinition

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

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

References $moduleName.

Referenced by ilObjChatroomGUI\getObjectDefinition().

Here is the caller graph for this function:

◆ getDefaultDefinitionWithCustomGUIPath()

static ilChatroomObjectDefinition::getDefaultDefinitionWithCustomGUIPath	(	string	$moduleName,
		string	$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 81 of file class.ilChatroomObjectDefinition.php.

                                                                                                           : self
    {
        return new self(
            $moduleName,
            'Modules/' . $moduleName . '/',
            'classes',
            $guiScope
        );
    }

References $guiScope, and $moduleName.

Referenced by ilObjChatroomAdminGUI\getObjectDefinition().

Here is the caller graph for this function:

◆ getGUIClassName()

ilChatroomObjectDefinition::getGUIClassName ( string $gui )

Builds gui classname using given $gui and returns it.

Parameters

string $gui

Returns: string

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

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

Referenced by buildGUI(), and getGUIPath().

Here is the caller graph for this function:

◆ getGUIPath()

ilChatroomObjectDefinition::getGUIPath ( string $gui )

Builds gui path using given $gui and returns it.

Parameters

string $gui

Returns: string

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

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

References getGUIClassName().

Referenced by hasGUI(), and loadGUI().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasGUI()

ilChatroomObjectDefinition::hasGUI ( string $gui )

Returns true if file exists.

Parameters

string $gui

Returns: bool

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

                                       : bool
    {
        return is_file($this->getGUIPath($gui));
    }

References getGUIPath().

Here is the call graph for this function:

◆ loadGUI()

ilChatroomObjectDefinition::loadGUI ( string $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 130 of file class.ilChatroomObjectDefinition.php.

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

References getGUIPath().

Here is the call graph for this function:

Field Documentation

◆ $guiScope

string ilChatroomObjectDefinition::$guiScope

private

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

Referenced by __construct(), and getDefaultDefinitionWithCustomGUIPath().

◆ $moduleBasePath

string ilChatroomObjectDefinition::$moduleBasePath

private

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

Referenced by __construct().

◆ $moduleName

string ilChatroomObjectDefinition::$moduleName

private

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

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

◆ $relativeClassPath

string ilChatroomObjectDefinition::$relativeClassPath

private

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

◆ buildGUI()

◆ getDefaultDefinition()

◆ getDefaultDefinitionWithCustomGUIPath()

◆ getGUIClassName()

◆ getGUIPath()

◆ hasGUI()

◆ loadGUI()

Field Documentation

◆ $guiScope

◆ $moduleBasePath

◆ $moduleName

◆ $relativeClassPath