ilChatroomObjectDefinition Class Reference

Collaboration diagram for ilChatroomObjectDefinition:

Public Member Functions
	__construct (private readonly 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
readonly string	$moduleBasePath
readonly string	$relativeClassPath
readonly 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	(	private readonly string	$moduleName,
		string	$moduleBasePath,
		string	$relativeClassPath = 'classes',
		string	$guiScope = ''
	)

Parameters

$moduleName

Module name, defaults to 'Chatroom'

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

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

Member Function Documentation

buildGUI()

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

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

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

References getGUIClassName().

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

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.

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

Referenced by ilObjChatroomGUI\getObjectDefinition().

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

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

$guiScope

Optional. 'admin' or ''. Default ''

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

References $guiScope.

Referenced by ilObjChatroomAdminGUI\getObjectDefinition().

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

Here is the caller graph for this function:

getGUIClassName()

ilChatroomObjectDefinition::getGUIClassName

(

string

$gui

)

Builds gui classname using given $gui and returns it.

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

Referenced by buildGUI(), and getGUIPath().

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

Here is the caller graph for this function:

getGUIPath()

ilChatroomObjectDefinition::getGUIPath

(

string

$gui

)

Builds gui path using given $gui and returns it.

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

References getGUIClassName().

Referenced by hasGUI(), and loadGUI().

                                           : string
    {
        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

(

string

$gui

)

Returns true if file exists.

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

References getGUIPath().

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

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.

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

References getGUIPath().

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

Here is the call graph for this function:

Field Documentation

$guiScope

readonly string ilChatroomObjectDefinition::$guiScope

private

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

Referenced by getDefaultDefinitionWithCustomGUIPath().

$moduleBasePath

readonly string ilChatroomObjectDefinition::$moduleBasePath

private

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

$relativeClassPath

readonly string ilChatroomObjectDefinition::$relativeClassPath

private

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

---

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

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