ilChatroomAdminSmileyGUI Class Reference

Class ilChatroomSmileyGUI 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 ($requestedMethod)
	{} More...
	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 ()
	Initializes smilies form and returns it. More...
	showEditSmileyEntryFormObject ()
	Shows EditSmileyEntryForm Prepares EditSmileyEntryForm and displays it. More...
	initSmiliesEditForm ($form_data)
	Initializes SmiliesEditForm and returns it. More...
	showDeleteSmileyFormObject ()
	Shows DeleteSmileyForm Prepares DeleteSmileyForm and displays it. More...
	deleteSmileyObject ()
	Deletes a smiley by $_REQUEST["chatroom_smiley_id"]. More...
	deleteMultipleObject ()
	Shows confirmation view for deleting multiple smilies Prepares confirmation view for deleting multiple smilies and displays it. More...
	confirmedDeleteMultipleObject ()
	Deletes multiple smilies by $_REQUEST["sel_ids"]. More...
Public Member Functions inherited from ilChatroomGUIHandler
	__construct (ilChatroomObjectGUI $gui)
	sendResponse ($response)
	Sends a json encoded response and exits the php process. More...
	hasPermission ($permission)
	Checks for access with ilRbacSystem. More...
	execute ($method)
	Executes given $method if existing, otherwise executes executeDefault() method. More...
	executeDefault ($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...

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

Protected Member Functions
	getSmileyFormDataById ($smileyId)
Protected Member Functions inherited from ilChatroomGUIHandler
	getRoomByObjectId ($objectId)
	exitIfNoRoomExists ($room)
	Checks if a ilChatroom exists. More...
	exitIfNoRoomPermission ($room, $subRoom, $chat_user)
	Check if user can moderate a chatroom. More...
	canModerate ($room, $subRoom, $user_id)
	Checks if the user has permission to moderate a ilChatroom. More...
	isMainRoom ($subRoomId)

Protected Attributes
	$form_gui
Protected Attributes inherited from ilChatroomGUIHandler
	$gui
	$ilUser
	$ilCtrl
	$ilLng
	$webDirectory
	$upload
	$rbacsystem
	$mainTpl
	$ilias
	$navigationHistory
	$tree
	$tabs

Static Private Member Functions
static	_insertDefaultValues ()

Detailed Description

Class ilChatroomSmileyGUI 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 12 of file class.ilChatroomAdminSmileyGUI.php.

Member Function Documentation

_checkSetup()

static ilChatroomAdminSmileyGUI::_checkSetup ( )

static

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

References $DIC, $path, ilUtil\makeDirParents(), ilUtil\sendFailure(), and ilUtil\sendInfo().

    {
        global $DIC;

        $path = self::_getSmileyDir();

        if (!is_dir($path)) {
            ilUtil::sendInfo($DIC->language()->txt('chat_smilies_dir_not_exists'));
            ilUtil::makeDirParents($path);

            if (!is_dir($path)) {
                ilUtil::sendFailure($DIC->language()->txt('chat_smilies_dir_not_available'));
                return false;
            } else {
                $smilies = array(
                    "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();

                ilUtil::sendSuccess($DIC->language()->txt('chat_smilies_initialized'));
            }
        }

        if (!is_writable($path)) {
            ilUtil::sendInfo($DIC->language()->txt('chat_smilies_dir_not_writable'));
        }

        return true;
    }

Here is the call graph for this function:

_getSmileyDir()

static ilChatroomAdminSmileyGUI::_getSmileyDir (   $withBaseDir = true )

static

Parameters

bool

$withBaseDir

Returns

string

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

References $path, and ilUtil\getWebspaceDir().

    {
        $path = 'chatroom/smilies';

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

        return $path;
    }

Here is the call graph for this function:

_insertDefaultValues()

static ilChatroomAdminSmileyGUI::_insertDefaultValues ( )

staticprivate

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

References $values.

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

        require_once 'Modules/Chatroom/classes/class.ilChatroomSmilies.php';
        foreach ($values as $val) {
            ilChatroomSmilies::_storeSmiley($val[1], $val[0]);
        }
    }

confirmedDeleteMultipleObject()

ilChatroomAdminSmileyGUI::confirmedDeleteMultipleObject

(

)

Deletes multiple smilies by $_REQUEST["sel_ids"].

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

References $_POST, $result, ilChatroomSmilies\_prepareKeywords(), ilChatroomSmilies\getSmiliesBasePath(), initSmiliesForm(), ILIAS\FileUpload\DTO\ProcessingStatus\OK, ilCtrl\redirect(), ilUtil\sendFailure(), ilUtil\stripSlashes(), and view().

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

        $parts = $_POST["sel_ids"];
        if (count($parts) == 0) {
            $this->ilCtrl->redirect($this->gui, "smiley");
        }

        include_once "Modules/Chatroom/classes/class.ilChatroomSmilies.php";
        ilChatroomSmilies::_deleteMultipleSmilies($parts);

        $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 $s, ilCtrl\getFormAction(), ilUtil\img(), ilCtrl\redirect(), and ilUtil\sendInfo().

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

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

        $items = (array) $_REQUEST['smiley_id'];
        if (count($items) == 0) {
            ilUtil::sendInfo($this->ilLng->txt('select_one'), true);
            $this->ilCtrl->redirect($this->gui, 'smiley');
        }

        include_once 'Modules/Chatroom/classes/class.ilChatroomSmilies.php';
        $smilies = ilChatroomSmilies::_getSmiliesById($items);
        if (count($smilies) == 0) {
            ilUtil::sendInfo($this->ilLng->txt('select_one'), true);
            $this->ilCtrl->redirect($this->gui, 'smiley');
        }

        require_once 'Services/Utilities/classes/class.ilConfirmationGUI.php';
        $confirmation = new ilConfirmationGUI();
        $confirmation->setFormAction($this->ilCtrl->getFormAction($this->gui, 'smiley'));
        $confirmation->setHeaderText($this->ilLng->txt('chatroom_confirm_delete_smiley'));
        $confirmation->addButton($this->ilLng->txt('confirm'), 'smiley-confirmedDeleteMultipleObject');
        $confirmation->addButton($this->ilLng->txt('cancel'), 'smiley');

        foreach ($smilies as $s) {
            $confirmation->addItem('sel_ids[]', $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

(

)

Deletes a smiley by $_REQUEST["chatroom_smiley_id"].

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

References $data, $result, ilChatroomSmilies\_prepareKeywords(), getSmileyFormDataById(), ilChatroomSmilies\getSmiliesBasePath(), initSmiliesEditForm(), ILIAS\FileUpload\DTO\ProcessingStatus\OK, ilCtrl\redirect(), ilUtil\sendFailure(), showEditSmileyEntryFormObject(), and ilUtil\stripSlashes().

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

        include_once 'Modules/Chatroom/classes/class.ilChatroomSmilies.php';

        ilChatroomSmilies::_deleteSmiley($_REQUEST["chatroom_smiley_id"]);

        $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 134 of file class.ilChatroomAdminSmileyGUI.php.

References $form, $form_gui, $table, ilChatroomSmiliesGUI\_getExistingSmiliesTable(), and initSmiliesForm().

Referenced by view().

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

        include_once 'Modules/Chatroom/classes/class.ilChatroomSmilies.php';

        ilChatroomSmilies::_checkSetup();

        if (!$this->form_gui) {
            $form = $this->initSmiliesForm();
        } else {
            $form = $this->form_gui;
        }

        include_once "Modules/Chatroom/classes/class.ilChatroomSmiliesGUI.php";

        $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", $form->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

(

$requestedMethod

)

{}

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

References view().

    {
        $this->view();
    }

Here is the call graph for this function:

getSmileyFormDataById()

ilChatroomAdminSmileyGUI::getSmileyFormDataById (   $smileyId )

protected

Parameters

$smileyId

Returns

array

Exceptions

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

Referenced by deleteSmileyObject(), and showEditSmileyEntryFormObject().

    {
        require_once 'Modules/Chatroom/classes/class.ilChatroomSmilies.php';
        $smiley = ilChatroomSmilies::_getSmiley($smileyId);

        $form_data = array(
            'chatroom_smiley_id' => $smiley['smiley_id'],
            'chatroom_smiley_keywords' => $smiley['smiley_keywords'],
            'chatroom_current_smiley_image_path' => $smiley['smiley_fullpath'],
        );

        return $form_data;
    }

Here is the caller graph for this function:

initSmiliesEditForm()

ilChatroomAdminSmileyGUI::initSmiliesEditForm

(

$form_data

)

Initializes SmiliesEditForm and returns it.

Returns

ilPropertyFormGUI

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

References $form_gui, ilCtrl\getFormAction(), ilCtrl\saveParameter(), ilFileInputGUI\setSuffixes(), ilChatroomSmiliesCurrentSmileyFormElement\setValue(), and ilTextAreaInputGUI\setValue().

Referenced by deleteSmileyObject(), and showEditSmileyEntryFormObject().

    {
        include_once('./Services/Form/classes/class.ilPropertyFormGUI.php');

        $this->form_gui = new ilPropertyFormGUI();

        $this->form_gui->setValuesByArray($form_data);

        $table_nav = $_REQUEST["_table_nav"] ? "&_table_nav=" . $_REQUEST["_table_nav"] : "";

        $this->ilCtrl->saveParameter($this->gui, 'smiley_id');

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

        $sec_l = new ilFormSectionHeaderGUI();

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

        include_once "Modules/Chatroom/classes/class.ilChatroomSmiliesCurrentSmileyFormElement.php";

        $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(array("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

(

)

Initializes smilies form and returns it.

Returns

ilPropertyFormGUI

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

References $form_gui, ilCtrl\getFormAction(), ilFormPropertyGUI\setRequired(), and ilFileInputGUI\setSuffixes().

Referenced by confirmedDeleteMultipleObject(), and editSmiliesObject().

    {
        include_once('./Services/Form/classes/class.ilPropertyFormGUI.php');

        $this->form_gui = new ilPropertyFormGUI();

        $table_nav = $_REQUEST["_table_nav"] ? "&_table_nav=" . $_REQUEST["_table_nav"] : "";
        $this->form_gui->setFormAction(
            $this->ilCtrl->getFormAction($this->gui, 'smiley-uploadSmileyObject') . $table_nav
        );

        // chat server settings
        $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(array("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);
        $this->form_gui->addCommandButton(
            'smiley-uploadSmileyObject',
            $this->ilLng->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 339 of file class.ilChatroomAdminSmileyGUI.php.

References ilCtrl\getFormAction(), and ilUtil\img().

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

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

        include_once 'Modules/Chatroom/classes/class.ilChatroomSmilies.php';
        $smiley = ilChatroomSmilies::_getSmiley((int) $_REQUEST['smiley_id']);

        require_once 'Services/Utilities/classes/class.ilConfirmationGUI.php';
        $confirmation = new ilConfirmationGUI();
        $confirmation->setFormAction($this->ilCtrl->getFormAction($this->gui, 'smiley'));
        $confirmation->setHeaderText($this->ilLng->txt('chatroom_confirm_delete_smiley'));
        $confirmation->addButton($this->ilLng->txt('confirm'), 'smiley-deleteSmileyObject');
        $confirmation->addButton($this->ilLng->txt('cancel'), 'smiley');
        $confirmation->addItem('chatroom_smiley_id', $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 220 of file class.ilChatroomAdminSmileyGUI.php.

References $form, $form_gui, getSmileyFormDataById(), and initSmiliesEditForm().

Referenced by deleteSmileyObject().

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

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

        if (!$this->form_gui) {
            $form = $this->initSmiliesEditForm($this->getSmileyFormDataById((int) $_REQUEST['smiley_id']));
        } else {
            $form = $this->form_gui;
        }

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

        $tpl_form->setVariable("SMILEY_FORM", $form->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 31 of file class.ilChatroomAdminSmileyGUI.php.

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

Referenced by confirmedDeleteMultipleObject(), and executeDefault().

    {
        include_once 'Modules/Chatroom/classes/class.ilChatroom.php';

        ilChatroom::checkUserPermissions('read', $this->gui->ref_id);

        $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

ilChatroomAdminSmileyGUI::$form_gui

protected

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

Referenced by editSmiliesObject(), initSmiliesEditForm(), initSmiliesForm(), and showEditSmileyEntryFormObject().

---

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

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