Collaboration diagram for ilChatroomTabGUIFactory:

Public Member Functions
	getAdminTabsForCommand (string $command)
	Builds $config and $commandparts arrays to assign them as parameters when calling $this->buildTabs and $this->activateTab. More...

	getActivatedTab ()

	getActivatedSubTab ()

	getTabsForCommand (string $command)
	Builds $config and $commandparts arrays to assign them as parameters when calling $this->buildTabs and $this->activateTab. More...

Private Member Functions
	buildTabs (ilTabsGUI $tabs, array $config, array $command, bool $inRoom=true)
	Builds tabs and subtabs using given $tabs, $config and $command parameters. More...

	getLabel (array $tabDefinition, string $id)
	Returns label for tab by $tabDefinition or $id. More...

	activateTab (array $commandParts, array $config)
	Activates tab or subtab if existing. More...

Static Private Member Functions
static	convertLowerCamelCaseToUnderscoreCaseConversion (string $value)
	Convert a value given in lower camel case conversion to underscore case conversion (e.g. More...

Private Attributes
readonly ilLanguage	$lng

readonly ilRbacSystem	$rbacSystem

readonly GlobalHttpState	$http

readonly Refinery	$refinery

string	$activated_tab = null

string	$activated_sub_tab = null

Detailed Description

Class ilChatroomTabGUIFactory.

Author: Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e; Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Version: $Id$ \

Definition at line 31 of file class.ilChatroomTabGUIFactory.php.

Member Function Documentation

◆ activateTab()

ilChatroomTabGUIFactory::activateTab	(	array	$commandParts,
		array	$config
	)

private

Activates tab or subtab if existing.

Calls $ilTabs->activateTab() or $ilTabs->activateSubTab() method to set current tab active.

Definition at line 247 of file class.ilChatroomTabGUIFactory.php.

References $DIC.

Referenced by getAdminTabsForCommand(), and getTabsForCommand().

                                                                     : void
     {
         global $DIC;
 
         if (count($commandParts) > 1) {
             if (isset($config[$commandParts[0]])) {
                 $DIC->tabs()->activateTab($commandParts[0]);
                 $this->activated_tab = $commandParts[0];
 
                 if (isset($config[$commandParts[0]]['subtabs'][$commandParts[1]])) {
                     $DIC->tabs()->activateSubTab($commandParts[1]);
                     $this->activated_sub_tab = $commandParts[1];
                 }
             }
         } elseif (count($commandParts) === 1) {
             $DIC->tabs()->activateTab($commandParts[0]);
             $this->activated_tab = $commandParts[0];
         }
     }

Here is the caller graph for this function:

◆ buildTabs()

ilChatroomTabGUIFactory::buildTabs	(	ilTabsGUI	$tabs,
		array	$config,
		array	$command,
		bool	$inRoom = `true`
	)

private

Builds tabs and subtabs using given $tabs, $config and $command parameters.

Definition at line 177 of file class.ilChatroomTabGUIFactory.php.

References $id, ilTabsGUI\addSubTab(), ilTabsGUI\addTab(), ilChatroom\checkUserPermissions(), and getLabel().

Referenced by getAdminTabsForCommand(), and getTabsForCommand().

                                                                                                    : void
     {
         foreach ($config as $id => $tabDefinition) {
             if (!$inRoom && !$this->rbacSystem->checkAccess($tabDefinition['permission'], $this->gui->getRefId())) {
                 continue;
             }
 
             if (
                 $inRoom &&
                 !ilChatroom::checkUserPermissions($tabDefinition['permission'], $this->gui->getRefId(), false)
             ) {
                 continue;
             }
 
             if (isset($tabDefinition['enabled']) && !$tabDefinition['enabled']) {
                 continue;
             }
 
             $tabs->addTab($id, $this->getLabel($tabDefinition, $id), $tabDefinition['link']);
 
             if (
                 $command[0] === $id && isset($tabDefinition['subtabs']) &&
                 is_array($tabDefinition['subtabs'])
             ) {
                 foreach ($tabDefinition['subtabs'] as $subid => $subTabDefinition) {
                     if (
                         !$inRoom &&
                         $this->rbacSystem->checkAccess($tabDefinition['permission'], $this->gui->getRefId())
                     ) {
                         continue;
                     }
 
                     if (
                         $inRoom &&
                         !ilChatroom::checkUserPermissions($subTabDefinition['permission'], $this->gui->getRefId())
                     ) {
                         continue;
                     }
 
                     if (isset($subTabDefinition['enabled']) && !$subTabDefinition['enabled']) {
                         continue;
                     }
 
                     $tabs->addSubTab(
                         $subid,
                         $this->getLabel($subTabDefinition, $subid),
                         $subTabDefinition['link']
                     );
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ convertLowerCamelCaseToUnderscoreCaseConversion()

static ilChatroomTabGUIFactory::convertLowerCamelCaseToUnderscoreCaseConversion ( string $value )

staticprivate

Convert a value given in lower camel case conversion to underscore case conversion (e.g.

MyClass to my_class)

Parameters

string $value Value in lower camel case conversion

Returns: string The value in underscore case conversion

Definition at line 168 of file class.ilChatroomTabGUIFactory.php.

                                                                                           : string
     {
         return strtolower(preg_replace('/(.*?)-(.*?)/', '$1_$2', $value));
     }

◆ getActivatedSubTab()

ilChatroomTabGUIFactory::getActivatedSubTab ( )

Definition at line 272 of file class.ilChatroomTabGUIFactory.php.

References $activated_sub_tab.

                                         : ?string
     {
         return $this->activated_sub_tab;
     }

◆ getActivatedTab()

ilChatroomTabGUIFactory::getActivatedTab ( )

Definition at line 267 of file class.ilChatroomTabGUIFactory.php.

References $activated_tab.

                                      : ?string
     {
         return $this->activated_tab;
     }

◆ getAdminTabsForCommand()

ilChatroomTabGUIFactory::getAdminTabsForCommand ( string $command )

Builds $config and $commandparts arrays to assign them as parameters when calling $this->buildTabs and $this->activateTab.

Definition at line 54 of file class.ilChatroomTabGUIFactory.php.

References $DIC, ilObject\_getAllReferences(), ilObject\_getObjectsByType(), activateTab(), buildTabs(), ILIAS\FileDelivery\http(), ILIAS\Repository\int(), and ILIAS\Repository\refinery().

                                                            : void
     {
         global $DIC;
 
         $command = self::convertLowerCamelCaseToUnderscoreCaseConversion($command);
         $stopCommands = ['create'];
 
         if (in_array($command, $stopCommands, true)) {
             return;
         }
 
         $settings = new ilSetting('chatroom');
         $public_room_ref = (int) $settings->get('public_room_ref', '0');
 
         $objIds = ilObject::_getObjectsByType('chta');
         $firstObjId = (int) current(array_keys($objIds));
         $refIds = ilObject::_getAllReferences($firstObjId);
         $admin_ref = (int) current($refIds);
 
         $DIC->ctrl()->setParameterByClass(ilObjChatroomAdminGUI::class, 'ref_id', $admin_ref);
 
         $config = [
             'view' => [
                 'lng' => 'settings',
                 'link' => $DIC->ctrl()->getLinkTargetByClass(ilObjChatroomAdminGUI::class, 'view-clientsettings'),
                 'permission' => 'read',
                 'subtabs' => [
                     'clientsettings' => [
                         'lng' => 'client_settings',
                         'link' => $DIC->ctrl()->getLinkTargetByClass(
                             ilObjChatroomAdminGUI::class,
                             'view-clientsettings'
                         ),
                         'permission' => 'read'
                     ]
                 ]
             ],
         ];
         $DIC->ctrl()->setParameterByClass(ilObjChatroomGUI::class, 'ref_id', $public_room_ref);
 
         $config['settings'] = [
             'lng' => 'public_chat_settings',
             'link' => $DIC->ctrl()->getLinkTargetByClass(ilObjChatroomGUI::class, 'settings-general'),
             'permission' => 'read',
             'subtabs' => [
                 'settings' => [
                     'lng' => 'settings',
                     'link' => $DIC->ctrl()->getLinkTarget($this->gui, 'settings-general'),
                     'permission' => 'read'
                 ],
                 'ban' => [
                     'lng' => 'bans',
                     'link' => $DIC->ctrl()->getLinkTargetByClass(ilObjChatroomGUI::class, 'ban-show'),
                     'permission' => 'read'
                 ]
             ]
         ];
 
         $DIC->ctrl()->setParameterByClass(ilPermissionGUI::class, 'ref_id', $public_room_ref);
         $config['perm'] = [
             'lng' => 'public_chat_permissions',
             'link' => $DIC->ctrl()->getLinkTargetByClass(ilPermissionGUI::class, 'perm'),
             'permission' => 'read',
         ];
         $DIC->ctrl()->clearParametersByClass(ilPermissionGUI::class);
 
         $DIC->ctrl()->setParameterByClass(ilPermissionGUI::class, 'ref_id', $admin_ref);
         $config['perm_settings'] = [
             'lng' => 'perm_settings',
             'link' => $DIC->ctrl()->getLinkTargetByClass(ilPermissionGUI::class, 'perm'),
             'permission' => 'edit_permission',
         ];
         $DIC->ctrl()->clearParametersByClass(ilPermissionGUI::class);
 
         $is_in_permission_gui = (
             strtolower($DIC->ctrl()->getCmdClass() ?? '') === strtolower(ilPermissionGUI::class) ||
             strtolower($DIC->ctrl()->getCmdClass() ?? '') === strtolower(ilObjectPermissionStatusGUI::class)
         );
 
         $commandParts = explode('_', $command, 2);
         if ($command === 'ban_show') {
             $commandParts[0] = 'settings';
             $commandParts[1] = 'ban';
         } elseif ($command === 'settings_general') {
             $commandParts[0] = 'settings';
             $commandParts[1] = 'settings';
         } elseif ($command === 'view_saveclientsettings') {
             $commandParts[0] = 'view';
             $commandParts[1] = 'clientsettings';
         } elseif (
             $is_in_permission_gui &&
             $this->http->wrapper()->query()->has('ref_id') &&
             $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int()) === $public_room_ref
         ) {
             $commandParts[0] = 'perm';
             $DIC->ctrl()->setParameterByClass(ilPermissionGUI::class, 'ref_id', $public_room_ref);
         } elseif (
             $is_in_permission_gui &&
             $this->http->wrapper()->query()->has('ref_id') &&
             $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int()) === $admin_ref
         ) {
             $commandParts[0] = 'perm_settings';
             $DIC->ctrl()->setParameterByClass(ilPermissionGUI::class, 'ref_id', $admin_ref);
         }
 
         $this->buildTabs($DIC->tabs(), $config, $commandParts, false);
         $this->activateTab($commandParts, $config);
     }

Here is the call graph for this function:

◆ getLabel()

ilChatroomTabGUIFactory::getLabel	(	array	$tabDefinition,
		string	$id
	)

private

Returns label for tab by $tabDefinition or $id.

Definition at line 233 of file class.ilChatroomTabGUIFactory.php.

References ILIAS\Repository\lng().

Referenced by buildTabs().

                                                                : string
     {
         if (isset($tabDefinition['lng'])) {
             return $this->lng->txt($tabDefinition['lng']);
         }
 
         return $this->lng->txt($id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTabsForCommand()

ilChatroomTabGUIFactory::getTabsForCommand ( string $command )

Builds $config and $commandparts arrays to assign them as parameters when calling $this->buildTabs and $this->activateTab.

Definition at line 281 of file class.ilChatroomTabGUIFactory.php.

References $DIC, activateTab(), buildTabs(), and ilChatroom\byObjectId().

                                                       : void
     {
         global $DIC;
 
         $command = self::convertLowerCamelCaseToUnderscoreCaseConversion($command);
         $stopCommands = ['create'];
 
         if (in_array($command, $stopCommands, true)) {
             return;
         }
 
         $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
 
         $config = [
             'view' => [
                 'lng' => 'obj_chtr',
                 'link' => $DIC->ctrl()->getLinkTarget($this->gui, 'view'),
                 'permission' => 'read'
             ],
             'history' => [
                 'lng' => 'history',
                 'link' => $DIC->ctrl()->getLinkTarget($this->gui, 'history-byday'),
                 'permission' => 'read',
                 'enabled' => $room ? $room->getSetting('enable_history') : false,
             ],
             'info' => [
                 'lng' => 'info_short',
                 'link' => $DIC->ctrl()->getLinkTargetByClass([$this->gui::class, ilInfoScreenGUI::class], 'showSummary'),
                 'permission' => 'read'
             ],
             'settings' => [
                 'lng' => 'settings',
                 'link' => $DIC->ctrl()->getLinkTarget($this->gui, 'settings-general'),
                 'permission' => 'write',
                 'subtabs' => [
                     'general' => [
                         'lng' => 'settings_general',
                         'link' => $DIC->ctrl()->getLinkTarget($this->gui, 'settings-general'),
                         'permission' => 'write'
                     ]
                 ]
             ],
             'ban' => [
                 'lng' => 'bans',
                 'link' => $DIC->ctrl()->getLinkTarget($this->gui, 'ban-show'),
                 'permission' => 'moderate',
                 'subtabs' => [
                     'show' => [
                         'lng' => 'bans_table',
                         'link' => $DIC->ctrl()->getLinkTarget($this->gui, 'ban-show'),
                         'permission' => 'moderate'
                     ]
                 ]
             ],
             'export' => [
                 'lng' => 'export',
                 'link' => $DIC->ctrl()->getLinkTargetByClass(ilExportGUI::class, ''),
                 'permission' => 'write'
             ],
             'perm' => [
                 'lng' => 'permissions',
                 'link' => $DIC->ctrl()->getLinkTargetByClass(ilPermissionGUI::class, 'perm'),
                 'permission' => 'edit_permission'
             ]
         ];
 
         $commandParts = explode('_', $command, 2);
         if (strtolower($DIC->ctrl()->getCmdClass() ?? '') === strtolower(ilPermissionGUI::class)) {
             $commandParts[0] = 'perm';
         }
         if (strtolower($DIC->ctrl()->getCmdClass() ?? '') === strtolower(ilInfoScreenGUI::class)) {
             $commandParts[0] = 'info';
         }
 
         $this->buildTabs($DIC->tabs(), $config, $commandParts);
         $this->activateTab($commandParts, $config);
     }