ilChatroomTabGUIFactory Class Reference

Class ilChatroomTabGUIFactory. More...

Collaboration diagram for ilChatroomTabGUIFactory:

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

Static Public Member Functions
static	convertUnderscoreCaseToLowerCamelCaseConversion ($value, $upper_case_first=false)
	Convert a value given in underscore case conversion to lower camel case conversion (e.g. More...
static	convertLowerCamelCaseToUnderscoreCaseConversion ($value)
	Convert a value given in lower camel case conversion to underscore case conversion (e.g. More...

Private Member Functions
	buildTabs (ilTabsGUI $tabs, $config, $command, $inRoom=true)
	Builds tabs and subtabs using given $tabs, $config and $command parameters. More...
	getLabel ($tabDefinition, $id)
	Returns label for tab by $tabDefinition or $id. More...
	activateTab (array $commandParts, $config)
	Activates tab or subtab if existing. More...

Private Attributes
	$gui
	$lng

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 11 of file class.ilChatroomTabGUIFactory.php.

Constructor & Destructor Documentation

__construct()

ilChatroomTabGUIFactory::__construct

(

ilObjectGUI

$gui

)

Parameters

ilObjectGUI

$gui

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

References $DIC, and $gui.

    {
        global $DIC;

        $this->gui = $gui;
        $this->lng = $DIC->language();
    }

Member Function Documentation

activateTab()

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

private

Activates tab or subtab if existing.

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

Parameters

array

$commandParts

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

References $config, and $DIC.

Referenced by getAdminTabsForCommand(), and getTabsForCommand().

    {
        global $DIC;

        if (count($commandParts) > 1) {
            if (isset($config[$commandParts[0]])) {
                $DIC->tabs()->activateTab($commandParts[0]);

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

Here is the caller graph for this function:

buildTabs()

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

private

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

Parameters

ilTabsGUI	$tabs
array	$config
array	$command
bool	$inRoom

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

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

Referenced by getAdminTabsForCommand(), and getTabsForCommand().

    {
        global $DIC;

        require_once 'Modules/Chatroom/classes/class.ilChatroom.php';
        foreach ($config as $id => $tabDefinition) {
            if (!$inRoom && !$DIC->rbac()->system()->checkAccess($tabDefinition['permission'], $this->gui->getRefId())) {
                continue;
            } elseif ($inRoom && !ilChatroom::checkUserPermissions($tabDefinition['permission'], $this->gui->getRefId(), false)) {
                continue;
            } elseif (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 && !$DIC->rbac()->system()->checkAccess($tabDefinition['permission'], $this->gui->getRefId())) {
                        continue;
                    } elseif ($inRoom && !ilChatroom::checkUserPermissions($subTabDefinition['permission'], $this->gui->getRefId())) {
                        continue;
                    } elseif (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 (   $value )

static

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 164 of file class.ilChatroomTabGUIFactory.php.

Referenced by getAdminTabsForCommand(), and getTabsForCommand().

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

Here is the caller graph for this function:

convertUnderscoreCaseToLowerCamelCaseConversion()

static ilChatroomTabGUIFactory::convertUnderscoreCaseToLowerCamelCaseConversion (   $value,   $upper_case_first = false  )

static

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

my_class to MyClass)

Parameters

string	$value	Value in underscore case conversion
boolean	$upper_case_first	If TRUE first character in upper case, lower case if FALSE

Returns

string The value in lower camel case conversion

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

References $token.

    {
        $tokens = (array) explode('_', $value);
        $value = '';

        foreach ($tokens as $token) {
            $value .= ucfirst($token);
        }

        if ($upper_case_first === false) {
            $value = strtolower(substr($value, 0, 1)) . substr($value, 1);
        }

        return $value;
    }

getAdminTabsForCommand()

ilChatroomTabGUIFactory::getAdminTabsForCommand

(

$command

)

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

Parameters

string

$command

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

References $config, $DIC, ilObject\_getAllReferences(), ilObject\_getObjectsByType(), activateTab(), buildTabs(), and convertLowerCamelCaseToUnderscoreCaseConversion().

    {
        global $DIC;

        $command = $this->convertLowerCamelCaseToUnderscoreCaseConversion($command);
        $stopCommands = array('create');

        if (in_array($command, $stopCommands)) {
            return;
        }

        $settings = new ilSetting('chatroom');
        $public_room_ref = $settings->get('public_room_ref');

        $objIds = ilObject::_getObjectsByType('chta');
        $firstObjId = current(array_keys($objIds));
        $refIds = ilObject::_getAllReferences($firstObjId);
        $admin_ref = current($refIds);

        $DIC->ctrl()->setParameterByClass('ilObjChatroomAdminGUI', 'ref_id', $admin_ref);

        $config = array(
            'view' => array(
                'lng' => 'settings',
                'link' => $DIC->ctrl()->getLinkTargetByClass('ilObjChatroomAdminGUI', 'view-clientsettings'),
                'permission' => 'read',
                'subtabs' => array(
                    'clientsettings' => array(
                        'lng' => 'client_settings',
                        'link' => $DIC->ctrl()->getLinkTargetByClass('ilObjChatroomAdminGUI', 'view-clientsettings'),
                        'permission' => 'read'
                    )
                )
            ),
            'smiley' => array(
                'lng' => 'smiley',
                'link' => $DIC->ctrl()->getLinkTargetByClass('ilObjChatroomAdminGUI', 'smiley'),
                'permission' => 'read'
            )
        );
        $DIC->ctrl()->setParameterByClass('ilObjChatroomGUI', 'ref_id', $public_room_ref);

        $config['settings'] = array(
            'lng' => 'public_chat_settings',
            'link' => $DIC->ctrl()->getLinkTargetByClass('ilObjChatroomGUI', 'settings-general'),
            'permission' => 'read',
            'subtabs' => array(
                'settings' => array(
                    'lng' => 'settings',
                    'link' => $DIC->ctrl()->getLinkTarget($this->gui, 'settings-general'),
                    'permission' => 'read'
                ),
                'ban' => array(
                    'lng' => 'bans',
                    'link' => $DIC->ctrl()->getLinkTargetByClass('ilObjChatroomGUI', 'ban-show'),
                    'permission' => 'read'
                )
            )
        );

        $DIC->ctrl()->setParameterByClass('ilPermissionGUI', 'ref_id', $public_room_ref);
        $config['perm'] = array(
            'lng' => 'public_chat_permissions',
            'link' => $DIC->ctrl()->getLinkTargetByClass('ilPermissionGUI', 'perm'),
            'permission' => 'read',
        );
        $DIC->ctrl()->clearParametersByClass('ilPermissionGUI');

        $DIC->ctrl()->setParameterByClass('ilPermissionGUI', 'ref_id', $admin_ref);
        $config['perm_settings'] = array(
            'lng' => 'perm_settings',
            'link' => $DIC->ctrl()->getLinkTargetByClass('ilpermissiongui', 'perm'),
            'permission' => 'edit_permission',
        );
        $DIC->ctrl()->clearParametersByClass('ilPermissionGUI');

        $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 ($DIC->ctrl()->getCmdClass() == 'ilpermissiongui' && $_REQUEST['ref_id'] == $public_room_ref) {
            $commandParts[0] = 'perm';
            $DIC->ctrl()->setParameterByClass('ilPermissionGUI', 'ref_id', $public_room_ref);
        } elseif ($DIC->ctrl()->getCmdClass() == 'ilpermissiongui' && $_REQUEST['ref_id'] == $admin_ref) {
            $commandParts[0] = 'perm_settings';
            $DIC->ctrl()->setParameterByClass('ilPermissionGUI', '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 (   $tabDefinition,   $id  )

private

Returns label for tab by $tabDefinition or $id.

Parameters

array	$tabDefinition
string	$id

Returns

string

Todo:

: $tabDefinition sollte doch stets ein array und $id stets ein string sein, oder? Dann sollte man auch hier typehinten. (array $tabDefinition, string $id)

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

Referenced by buildTabs().

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

Here is the caller graph for this function:

getTabsForCommand()

ilChatroomTabGUIFactory::getTabsForCommand

(

$command

)

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

Parameters

string

$command

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

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

    {
        global $DIC;

        $command = $this->convertLowerCamelCaseToUnderscoreCaseConversion($command);
        $stopCommands = array('create');

        if (in_array($command, $stopCommands)) {
            return;
        }

        require_once 'Modules/Chatroom/classes/class.ilChatroom.php';
        $room = ilChatroom::byObjectId($this->gui->object->getId());

        $config = array(
            'view' => array(
                'lng' => 'view',
                'link' => $DIC->ctrl()->getLinkTarget($this->gui, 'view'),
                'permission' => 'read'
            ),
            'history' => array(
                'lng' => 'history',
                'link' => $DIC->ctrl()->getLinkTarget($this->gui, 'history-byday'),
                'permission' => 'read',
                'enabled' => $room ? $room->getSetting('enable_history') : false,
                'subtabs' => array(
                    'byday' => array(
                        'lng' => 'history_by_day',
                        'link' => $DIC->ctrl()->getLinkTarget($this->gui, 'history-byday'),
                        'permission' => 'read'
                    ),
                    'bysession' => array(
                        'lng' => 'history_by_session',
                        'link' => $DIC->ctrl()->getLinkTarget($this->gui, 'history-bysession'),
                        'permission' => 'read'
                    )
                )
            ),
            'info' => array(
                'lng' => 'info_short',
                'link' => $DIC->ctrl()->getLinkTargetByClass(array(get_class($this->gui), 'ilinfoscreengui'), 'info'),
                'permission' => 'read'
            ),
            'settings' => array(
                'lng' => 'settings',
                'link' => $DIC->ctrl()->getLinkTarget($this->gui, 'settings-general'),
                'permission' => 'write',
                'subtabs' => array(
                    'general' => array(
                        'lng' => 'settings_general',
                        'link' => $DIC->ctrl()->getLinkTarget($this->gui, 'settings-general'),
                        'permission' => 'write'
                    )
                )
            ),
            'ban' => array(
                'lng' => 'bans',
                'link' => $DIC->ctrl()->getLinkTarget($this->gui, 'ban-show'),
                'permission' => 'moderate',
                'subtabs' => array(
                    'show' => array(
                        'lng' => 'bans_table',
                        'link' => $DIC->ctrl()->getLinkTarget($this->gui, 'ban-show'),
                        'permission' => 'moderate'
                    )
                )
            ),
            'export' => array(
                'lng' => 'export',
                'link' => $DIC->ctrl()->getLinkTargetByClass('ilexportgui', ''),
                'permission' => 'write'
            ),
            'perm' => array(
                'lng' => 'permissions',
                'link' => $DIC->ctrl()->getLinkTargetByClass('ilpermissiongui', 'perm'),
                'permission' => 'edit_permission'
            )
        );

        $commandParts = explode('_', $command, 2);

        if ($DIC->ctrl()->getCmdClass() == 'ilpermissiongui') {
            $commandParts[0] = 'perm';
        }

        $this->buildTabs($DIC->tabs(), $config, $commandParts);
        $this->activateTab($commandParts, $config);
    }

Here is the call graph for this function:

Field Documentation

$gui

ilChatroomTabGUIFactory::$gui

private

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

Referenced by __construct().

$lng

ilChatroomTabGUIFactory::$lng

private

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

---

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

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