ilChatroomAdminSmileyGUI Class Reference

Class ilChatroomAdminSmileyGUI Provides methods to show, add, edit and delete smilies consisting of icon and keywords. More...

Inheritance diagram for ilChatroomAdminSmileyGUI:

Collaboration diagram for ilChatroomAdminSmileyGUI:

Public Member Functions
	executeDefault (string $requestedMethod)
	view ()
	Switches GUI to visible mode and calls editSmiliesObject method which prepares and displays the table of existing smilies. More...
	editSmiliesObject ()
	Shows existing smilies table Prepares existing smilies table and displays it. More...
	initSmiliesForm ()
	showEditSmileyEntryFormObject ()
	Shows EditSmileyEntryForm Prepares EditSmileyEntryForm and displays it. More...
	initSmiliesEditForm (array $form_data)
	showDeleteSmileyFormObject ()
	Shows DeleteSmileyForm Prepares DeleteSmileyForm and displays it. More...
	deleteSmileyObject ()
	deleteMultipleObject ()
	Shows confirmation view for deleting multiple smilies Prepares confirmation view for deleting multiple smilies and displays it. More...
	confirmedDeleteMultipleObject ()
Public Member Functions inherited from ilChatroomGUIHandler
	execute (string $method)
	executeDefault (string $requestedMethod)
	redirectIfNoPermission ($permission)
	Checks for requested permissions and redirects if the permission check failed. More...
	isSuccessful ($response)
	Checks for success param in an json decoded response. More...
	sendResponse ($response, bool $isJson=false)
	Sends a json encoded response and exits the php process. More...
	hasPermission (string $permission)

Static Public Member Functions
static	_checkSetup ()
static	_getSmileyDir (bool $withBaseDir=true)

Protected Member Functions
	getSmileyFormDataById (int $smileyId)
Protected Member Functions inherited from ilChatroomGUIHandler
	getRequestValue (string $key, Transformation $trafo, $default=null)
	hasRequestValue (string $key)
	getRoomByObjectId (int $objectId)
	exitIfNoRoomExists (?ilChatroom $room)
	Checks if a ilChatroom exists. More...
	exitIfNoRoomModeratePermission (ilChatroom $room, int $subRoom, ilChatroomUser $chatUser)
	Check if user can moderate a chatroom. More...
	canModerate (ilChatroom $room, int $subRoom, int $usrId)
	isMainRoom (int $subRoomId)

Protected Attributes
ilPropertyFormGUI	$form_gui = null
Protected Attributes inherited from ilChatroomGUIHandler
ilChatroomObjectGUI	$gui
ilObjUser	$ilUser
ilCtrlInterface	$ilCtrl
ilLanguage	$ilLng
Filesystem	$webDirectory
ilObjectService	$obj_service
FileUpload	$upload
ilRbacSystem	$rbacsystem
ilGlobalTemplateInterface	$mainTpl
ILIAS	$ilias
ilNavigationHistory	$navigationHistory
ilTree	$tree
ilTabsGUI	$tabs
UIFactory	$uiFactory
UIRenderer	$uiRenderer
GlobalHttpState	$http
Refinery	$refinery

Static Private Member Functions
static	_insertDefaultValues ()

Detailed Description

Class ilChatroomAdminSmileyGUI Provides methods to show, add, edit and delete smilies consisting of icon and keywords.

Author

Andreas Kordosz akord.nosp@m.osz@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

$Id$

Definition at line 29 of file class.ilChatroomAdminSmileyGUI.php.

Member Function Documentation

_checkSetup()

static ilChatroomAdminSmileyGUI::_checkSetup ( )

static

Definition at line 53 of file class.ilChatroomAdminSmileyGUI.php.

References $DIC, $path, and ilFileUtils\makeDirParents().

                                        : bool
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();

        $path = self::_getSmileyDir();

        if (!is_dir($path)) {
            $main_tpl->setOnScreenMessage('info', $DIC->language()->txt('chat_smilies_dir_not_exists'));
            ilFileUtils::makeDirParents($path);

            if (!is_dir($path)) {
                $main_tpl->setOnScreenMessage('failure', $DIC->language()->txt('chat_smilies_dir_not_available'));
                return false;
            }

            $smilies = [
                'icon_smile.gif',
                'icon_wink.gif',
                'icon_laugh.gif',
                'icon_sad.gif',
                'icon_shocked.gif',
                'icon_tongue.gif',
                'icon_cool.gif',
                'icon_eek.gif',
                'icon_angry.gif',
                'icon_flush.gif',
                'icon_idea.gif',
                'icon_thumbup.gif',
                'icon_thumbdown.gif',
            ];

            foreach ($smilies as $smiley) {
                copy("templates/default/images/emoticons/$smiley", $path . "/$smiley");
            }

            self::_insertDefaultValues();

            $main_tpl->setOnScreenMessage('success', $DIC->language()->txt('chat_smilies_initialized'));
        }

        if (!is_writable($path)) {
            $main_tpl->setOnScreenMessage('info', $DIC->language()->txt('chat_smilies_dir_not_writable'));
        }

        return true;
    }

Here is the call graph for this function:

_getSmileyDir()

static ilChatroomAdminSmileyGUI::_getSmileyDir ( bool  $withBaseDir = true )

static

Definition at line 101 of file class.ilChatroomAdminSmileyGUI.php.

References $path, and ilFileUtils\getWebspaceDir().

                                                                  : string
    {
        $path = 'chatroom/smilies';

        if ($withBaseDir) {
            $path = ilFileUtils::getWebspaceDir() . '/' . $path;
        }

        return $path;
    }

Here is the call graph for this function:

_insertDefaultValues()

static ilChatroomAdminSmileyGUI::_insertDefaultValues ( )

staticprivate

Definition at line 112 of file class.ilChatroomAdminSmileyGUI.php.

                                                  : void
    {
        $values = [
            ["icon_smile.gif", ":)\n:-)\n:smile:"],
            ["icon_wink.gif", ";)\n;-)\n:wink:"],
            ["icon_laugh.gif", ":D\n:-D\n:laugh:\n:grin:\n:biggrin:"],
            ["icon_sad.gif", ":(\n:-(\n:sad:"],
            ["icon_shocked.gif", ":o\n:-o\n:shocked:"],
            ["icon_tongue.gif", ":p\n:-p\n:tongue:"],
            ["icon_cool.gif", ":cool:"],
            ["icon_eek.gif", ":eek:"],
            ["icon_angry.gif", ":||\n:-||\n:angry:"],
            ["icon_flush.gif", ":flush:"],
            ["icon_idea.gif", ":idea:"],
            ["icon_thumbup.gif", ":thumbup:"],
            ["icon_thumbdown.gif", ":thumbdown:"],
        ];

        foreach ($values as $val) {
            ilChatroomSmilies::_storeSmiley($val[1], $val[0]);
        }
    }

confirmedDeleteMultipleObject()

ilChatroomAdminSmileyGUI::confirmedDeleteMultipleObject

(

)

Definition at line 494 of file class.ilChatroomAdminSmileyGUI.php.

References ilChatroomSmilies\_prepareKeywords(), ilChatroomGUIHandler\getRequestValue(), ilChatroomSmilies\getSmiliesBasePath(), initSmiliesForm(), ILIAS\Repository\refinery(), ilUtil\stripSlashes(), ILIAS\Repository\upload(), and view().

                                                   : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->gui->getRefId())) {
            $this->ilias->raiseError(
                $this->ilLng->txt('msg_no_perm_write'),
                $this->ilias->error_obj->MESSAGE
            );
        }

        $ids = $this->getRequestValue(
            'sel_ids',
            $this->refinery->kindlyTo()->listOf(
                $this->refinery->kindlyTo()->int()
            ),
            []
        );

        if ($ids === []) {
            $this->ilCtrl->redirect($this->gui, 'smiley');
        }

        ilChatroomSmilies::_deleteMultipleSmilies($ids);

        $this->ilCtrl->redirect($this->gui, 'smiley');
    }

Here is the call graph for this function:

deleteMultipleObject()

ilChatroomAdminSmileyGUI::deleteMultipleObject

(

)

Shows confirmation view for deleting multiple smilies Prepares confirmation view for deleting multiple smilies and displays it.

Definition at line 448 of file class.ilChatroomAdminSmileyGUI.php.

References ilChatroomGUIHandler\getRequestValue(), ilUtil\img(), and ILIAS\Repository\refinery().

                                          : void
    {
        $this->gui->switchToVisibleMode();

        if (!$this->rbacsystem->checkAccess('write', $this->gui->getRefId())) {
            $this->ilias->raiseError(
                $this->ilLng->txt('msg_no_perm_write'),
                $this->ilias->error_obj->MESSAGE
            );
        }

        $ids = $this->getRequestValue(
            'smiley_id',
            $this->refinery->kindlyTo()->listOf(
                $this->refinery->kindlyTo()->int()
            ),
            []
        );
        if ($ids === []) {
            $this->mainTpl->setOnScreenMessage('info', $this->ilLng->txt('select_one'), true);
            $this->ilCtrl->redirect($this->gui, 'smiley');
        }

        $smilies = ilChatroomSmilies::_getSmiliesById($ids);
        if ($smilies === []) {
            $this->mainTpl->setOnScreenMessage('info', $this->ilLng->txt('select_one'), true);
            $this->ilCtrl->redirect($this->gui, 'smiley');
        }

        $confirmation = new ilConfirmationGUI();
        $confirmation->setFormAction($this->ilCtrl->getFormAction($this->gui, 'smiley'));
        $confirmation->setHeaderText($this->ilLng->txt('chatroom_confirm_delete_smiley'));
        $confirmation->setConfirm($this->ilLng->txt('confirm'), 'smiley-confirmedDeleteMultipleObject');
        $confirmation->setCancel($this->ilLng->txt('cancel'), 'smiley');

        foreach ($smilies as $s) {
            $confirmation->addItem(
                'sel_ids[]',
                (string) $s['smiley_id'],
                ilUtil::img($s['smiley_fullpath'], $s['smiley_keywords']) . ' ' . $s['smiley_keywords']
            );
        }

        $this->mainTpl->setContent($confirmation->getHTML());
    }

Here is the call graph for this function:

deleteSmileyObject()

ilChatroomAdminSmileyGUI::deleteSmileyObject

(

)

Definition at line 365 of file class.ilChatroomAdminSmileyGUI.php.

References $data, ilChatroomSmilies\_prepareKeywords(), ilChatroomGUIHandler\getRequestValue(), getSmileyFormDataById(), ilChatroomSmilies\getSmiliesBasePath(), initSmiliesEditForm(), ILIAS\Repository\refinery(), showEditSmileyEntryFormObject(), ilUtil\stripSlashes(), and ILIAS\Repository\upload().

                                        : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->gui->getRefId())) {
            $this->ilias->raiseError(
                $this->ilLng->txt('msg_no_perm_write'),
                $this->ilias->error_obj->MESSAGE
            );
        }

        $smileyId = $this->getRequestValue(
            'chatroom_smiley_id',
            $this->refinery->kindlyTo()->int()
        );

        ilChatroomSmilies::_deleteSmiley($smileyId);

        $this->ilCtrl->redirect($this->gui, 'smiley');
    }

Here is the call graph for this function:

editSmiliesObject()

ilChatroomAdminSmileyGUI::editSmiliesObject

(

)

Shows existing smilies table Prepares existing smilies table and displays it.

Definition at line 139 of file class.ilChatroomAdminSmileyGUI.php.

References ilChatroomSmiliesGUI\_getExistingSmiliesTable(), and initSmiliesForm().

Referenced by view().

                                       : void
    {
        if (!$this->rbacsystem->checkAccess('read', $this->gui->getRefId())) {
            $this->ilias->raiseError(
                $this->ilLng->txt('msg_no_perm_read'),
                $this->ilias->error_obj->MESSAGE
            );
        }

        ilChatroomSmilies::_checkSetup();

        if (null === $this->form_gui) {
            $this->form_gui = $this->initSmiliesForm();
        }

        $table = ilChatroomSmiliesGUI::_getExistingSmiliesTable($this->gui);

        $tpl_smilies = new ilTemplate(
            'tpl.chatroom_edit_smilies.html',
            true,
            true,
            'Modules/Chatroom'
        );
        $tpl_smilies->setVariable('SMILEY_TABLE', $table);
        $tpl_smilies->setVariable('SMILEY_FORM', $this->form_gui->getHTML());

        $this->mainTpl->setContent($tpl_smilies->get());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeDefault()

ilChatroomAdminSmileyGUI::executeDefault

(

string

$requestedMethod

)

Definition at line 33 of file class.ilChatroomAdminSmileyGUI.php.

References view().

                                                           : void
    {
        $this->view();
    }

Here is the call graph for this function:

getSmileyFormDataById()

ilChatroomAdminSmileyGUI::getSmileyFormDataById ( int  $smileyId )

protected

Parameters

int

$smileyId

Returns

array{chatroom_smiley_id: int, chatroom_smiley_keywords: string, chatroom_current_smiley_image_path: string}

Definition at line 255 of file class.ilChatroomAdminSmileyGUI.php.

Referenced by deleteSmileyObject(), and showEditSmileyEntryFormObject().

                                                           : array
    {
        $smiley = ilChatroomSmilies::_getSmiley($smileyId);

        return [
            'chatroom_smiley_id' => $smiley['smiley_id'],
            'chatroom_smiley_keywords' => $smiley['smiley_keywords'],
            'chatroom_current_smiley_image_path' => $smiley['smiley_fullpath'],
        ];
    }

Here is the caller graph for this function:

initSmiliesEditForm()

ilChatroomAdminSmileyGUI::initSmiliesEditForm

(

array

$form_data

)

Parameters

array<string,mixed>

$form_data

Returns

ilPropertyFormGUI

Definition at line 270 of file class.ilChatroomAdminSmileyGUI.php.

References $form_gui, ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), ilFileInputGUI\setSuffixes(), ilChatroomSmiliesCurrentSmileyFormElement\setValue(), and ilTextAreaInputGUI\setValue().

Referenced by deleteSmileyObject(), and showEditSmileyEntryFormObject().

                                                         : ilPropertyFormGUI
    {
        $this->form_gui = new ilPropertyFormGUI();
        $this->form_gui->setValuesByArray($form_data);

        if ($this->http->wrapper()->query()->has('_table_nav')) {
            $this->ilCtrl->setParameter(
                $this->gui,
                '_table_nav',
                $this->http->wrapper()->query()->retrieve('_table_nav', $this->refinery->kindlyTo()->string())
            );
        }

        $this->ilCtrl->saveParameter($this->gui, 'smiley_id');
        $this->form_gui->setFormAction($this->ilCtrl->getFormAction($this->gui, 'smiley-updateSmiliesObject'));

        $sec_l = new ilFormSectionHeaderGUI();

        $sec_l->setTitle($this->ilLng->txt('chatroom_edit_smiley'));
        $this->form_gui->addItem($sec_l);

        $inp = new ilChatroomSmiliesCurrentSmileyFormElement(
            $this->ilLng->txt('chatroom_current_smiley_image_path'),
            'chatroom_current_smiley_image_path'
        );

        $inp->setValue($form_data['chatroom_current_smiley_image_path']);
        $this->form_gui->addItem($inp);

        $inp = new ilImageFileInputGUI(
            $this->ilLng->txt('chatroom_image_path'),
            'chatroom_image_path'
        );
        $inp->setSuffixes(['jpg', 'jpeg', 'png', 'gif', 'svg']);

        $inp->setRequired(false);
        $inp->setInfo($this->ilLng->txt('chatroom_smiley_image_only_if_changed'));
        $this->form_gui->addItem($inp);

        $inp = new ilTextAreaInputGUI(
            $this->ilLng->txt('chatroom_smiley_keywords'),
            'chatroom_smiley_keywords'
        );

        $inp->setValue($form_data['chatroom_smiley_keywords']);
        $inp->setUseRte(false);
        $inp->setRequired(true);
        $inp->setInfo($this->ilLng->txt('chatroom_smiley_keywords_one_per_line_note'));
        $this->form_gui->addItem($inp);

        $inp = new ilHiddenInputGUI('chatroom_smiley_id');

        $this->form_gui->addItem($inp);
        $this->form_gui->addCommandButton(
            'smiley-updateSmiliesObject',
            $this->ilLng->txt('submit')
        );
        $this->form_gui->addCommandButton('smiley', $this->ilLng->txt('cancel'));

        return $this->form_gui;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initSmiliesForm()

ilChatroomAdminSmileyGUI::initSmiliesForm

(

)

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

References $DIC, $form_gui, ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), ilFormPropertyGUI\setRequired(), and ilFileInputGUI\setSuffixes().

Referenced by confirmedDeleteMultipleObject(), and editSmiliesObject().

                                     : ilPropertyFormGUI
    {
        global $DIC;

        $this->form_gui = new ilPropertyFormGUI();

        if ($this->http->wrapper()->query()->has('_table_nav')) {
            $this->ilCtrl->setParameter(
                $this->gui,
                '_table_nav',
                $this->http->wrapper()->query()->retrieve('_table_nav', $this->refinery->kindlyTo()->string())
            );
        }
        $this->form_gui->setFormAction($this->ilCtrl->getFormAction($this->gui, 'smiley-uploadSmileyObject'));

        $sec_l = new ilFormSectionHeaderGUI();

        $sec_l->setTitle($this->ilLng->txt('chatroom_add_smiley'));
        $this->form_gui->addItem($sec_l);

        $inp = new ilImageFileInputGUI(
            $this->ilLng->txt('chatroom_image_path'),
            'chatroom_image_path'
        );
        $inp->setSuffixes(['jpg', 'jpeg', 'png', 'gif', 'svg']);

        $inp->setRequired(true);
        $this->form_gui->addItem($inp);

        $inp = new ilTextAreaInputGUI(
            $this->ilLng->txt('chatroom_smiley_keywords'),
            'chatroom_smiley_keywords'
        );

        $inp->setRequired(true);
        $inp->setUseRte(false);
        $inp->setInfo($this->ilLng->txt('chatroom_smiley_keywords_one_per_line_note'));
        $this->form_gui->addItem($inp);


        if ($this->rbacsystem->checkAccess('write', $this->gui->getRefId())) {
            $this->form_gui->addCommandButton(
                'smiley-uploadSmileyObject',
                $DIC->language()->txt('chatroom_upload_smiley')
            );
        }

        return $this->form_gui;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showDeleteSmileyFormObject()

ilChatroomAdminSmileyGUI::showDeleteSmileyFormObject

(

)

Shows DeleteSmileyForm Prepares DeleteSmileyForm and displays it.

Definition at line 336 of file class.ilChatroomAdminSmileyGUI.php.

References ilChatroomGUIHandler\getRequestValue(), ilUtil\img(), and ILIAS\Repository\refinery().

                                                : void
    {
        $this->gui->switchToVisibleMode();

        if (!$this->rbacsystem->checkAccess('write', $this->gui->getRefId())) {
            $this->ilias->raiseError(
                $this->ilLng->txt('msg_no_perm_write'),
                $this->ilias->error_obj->MESSAGE
            );
        }

        $smileyId = $this->getRequestValue('smiley_id', $this->refinery->kindlyTo()->int());

        $smiley = ilChatroomSmilies::_getSmiley($smileyId);

        $confirmation = new ilConfirmationGUI();
        $confirmation->setFormAction($this->ilCtrl->getFormAction($this->gui, 'smiley'));
        $confirmation->setHeaderText($this->ilLng->txt('chatroom_confirm_delete_smiley'));
        $confirmation->setConfirm($this->ilLng->txt('confirm'), 'smiley-deleteSmileyObject');
        $confirmation->setCancel($this->ilLng->txt('cancel'), 'smiley');
        $confirmation->addItem(
            'chatroom_smiley_id',
            (string) $smiley['smiley_id'],
            ilUtil::img($smiley['smiley_fullpath'], $smiley['smiley_keywords']) . ' ' . $smiley['smiley_keywords']
        );

        $this->mainTpl->setContent($confirmation->getHTML());
    }

Here is the call graph for this function:

showEditSmileyEntryFormObject()

ilChatroomAdminSmileyGUI::showEditSmileyEntryFormObject

(

)

Shows EditSmileyEntryForm Prepares EditSmileyEntryForm and displays it.

Definition at line 222 of file class.ilChatroomAdminSmileyGUI.php.

References ilChatroomGUIHandler\getRequestValue(), getSmileyFormDataById(), initSmiliesEditForm(), and ILIAS\Repository\refinery().

Referenced by deleteSmileyObject().

                                                   : void
    {
        $this->gui->switchToVisibleMode();

        if (!$this->rbacsystem->checkAccess('read', $this->gui->getRefId())) {
            $this->ilias->raiseError(
                $this->ilLng->txt('msg_no_perm_read'),
                $this->ilias->error_obj->MESSAGE
            );
        }

        $smileyId = $this->getRequestValue('smiley_id', $this->refinery->kindlyTo()->int());

        if (null === $this->form_gui) {
            $this->form_gui = $this->initSmiliesEditForm($this->getSmileyFormDataById($smileyId));
        }

        $tpl_form = new ilTemplate(
            'tpl.chatroom_edit_smilies.html',
            true,
            true,
            'Modules/Chatroom'
        );

        $tpl_form->setVariable('SMILEY_FORM', $this->form_gui->getHTML());

        $this->mainTpl->setContent($tpl_form->get());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

view()

ilChatroomAdminSmileyGUI::view

(

)

Switches GUI to visible mode and calls editSmiliesObject method which prepares and displays the table of existing smilies.

Definition at line 42 of file class.ilChatroomAdminSmileyGUI.php.

References ilChatroom\checkUserPermissions(), and editSmiliesObject().

Referenced by confirmedDeleteMultipleObject(), and executeDefault().

                          : void
    {
        ilChatroom::checkUserPermissions('read', $this->gui->getRefId());

        $this->gui->switchToVisibleMode();

        self::_checkSetup();

        $this->editSmiliesObject();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$form_gui

ilPropertyFormGUI ilChatroomAdminSmileyGUI::$form_gui = null

protected

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

Referenced by initSmiliesEditForm(), and initSmiliesForm().

---

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

• Modules/Chatroom/classes/admingui/class.ilChatroomAdminSmileyGUI.php