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...
	deleteSmileyObject ()
	Deletes a smiley by $_REQUEST["chatroom_smiley_id"] ilRbacSystem $rbacsystem ilCtrl $ilCtrl. More...
	updateSmiliesObject ()
	Updates a smiley and/or its keywords Updates a smiley icon and/or its keywords by $_REQUEST["chatroom_smiley_id"] and gets keywords from $_REQUEST["chatroom_smiley_keywords"]. More...
	uploadSmileyObject ()
	Uploads and stores a new smiley with keywords from $_REQUEST["chatroom_smiley_keywords"] ilRbacSystem $rbacsystem ilCtrl2 $ilCtrl. 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 ()

Static Private Member Functions
static	_setupFolder ()
	setup directory More...
static	_insertDefaultValues ()

Additional Inherited Members
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 inherited from ilChatroomGUIHandler
	$gui
	$ilUser
	$ilCtrl
	$ilLng
	$rbacsystem

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

References $lng, $path, array, ilUtil\makeDirParents(), ilUtil\sendFailure(), ilUtil\sendInfo(), and ilUtil\sendSuccess().

        {
                global $lng;

                $path = self::_getSmileyDir();

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

                        if(!is_dir($path))
                        {
                                ilUtil::sendFailure($lng->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($lng->txt('chat_smilies_initialized'));
                        }

                }

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

                return true;
        }

Here is the call graph for this function:

_getSmileyDir()

static ilChatroomAdminSmileyGUI::_getSmileyDir ( )

static

Returns

string path to smilies

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

References ilUtil\getWebspaceDir().

        {
                return ilUtil::getWebspaceDir() . '/chatroom/smilies';
        }

Here is the call graph for this function:

_insertDefaultValues()

static ilChatroomAdminSmileyGUI::_insertDefaultValues ( )

staticprivate

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

References array.

        {
                $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]);
                }
        }

_setupFolder()

static ilChatroomAdminSmileyGUI::_setupFolder ( )

staticprivate

setup directory

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

References $path.

        {
                $path = self::_getSmileyDir();

                if(!is_dir($path))
                {
                        mkdir($path, 0755, true);
                }
        }

deleteSmileyObject()

ilChatroomAdminSmileyGUI::deleteSmileyObject

(

)

Deletes a smiley by $_REQUEST["chatroom_smiley_id"] ilRbacSystem $rbacsystem ilCtrl $ilCtrl.

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

References ilChatroomGUIHandler\$ilCtrl, $lng, and ilChatroomGUIHandler\$rbacsystem.

        {
                global $rbacsystem, $ilCtrl, $lng;

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

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

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

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

editSmiliesObject()

ilChatroomAdminSmileyGUI::editSmiliesObject

(

)

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

ilRbacSystem $rbacsystem ilLanguage $lng ilTemplate $tpl

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

References $lng, ilChatroomGUIHandler\$rbacsystem, $tpl, ilChatroomSmilies\_checkSetup(), ilChatroomSmiliesGUI\_getExistingSmiliesTable(), and initSmiliesForm().

Referenced by view().

        {
                global $rbacsystem, $lng, $tpl;

                if(!$rbacsystem->checkAccess('read', $this->gui->ref_id))
                {
                        $this->ilias->raiseError(
                                $lng->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());

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

References view().

        {
                $this->view();
        }

Here is the call graph for this function:

initSmiliesEditForm()

ilChatroomAdminSmileyGUI::initSmiliesEditForm

(

$form_data

)

Initializes SmiliesEditForm and returns it.

ilCtrl2 $ilCtrl ilLanguage $lng

Returns

ilPropertyFormGUI

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

References ilChatroomGUIHandler\$ilCtrl, $lng, ilChatroomGUIHandler\$rbacsystem, $tpl, array, ilUtil\img(), ilFileInputGUI\setSuffixes(), ilChatroomSmiliesCurrentSmileyFormElement\setValue(), and ilTextAreaInputGUI\setValue().

Referenced by showEditSmileyEntryFormObject().

        {
                global $ilCtrl, $lng;

                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"] : "";

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

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

                $sec_l = new ilFormSectionHeaderGUI();

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

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

                $inp = new ilChatroomSmiliesCurrentSmileyFormElement(
                        $lng->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(
                        $lng->txt('chatroom_image_path'), 'chatroom_image_path'
                );
                $inp->setSuffixes(array("jpg", "jpeg", "png", "gif", "svg"));

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

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

                $inp->setValue($form_data['chatroom_smiley_keywords']);
                $inp->setUseRte(false);
                $inp->setRequired(true);
                $inp->setInfo($lng->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', $lng->txt('submit')
                );
                $this->form_gui->addCommandButton('smiley', $lng->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.

ilCtrl2 $ilCtrl ilLanguage $lng

Returns

ilPropertyFormGUI

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

References ilChatroomGUIHandler\$ilCtrl, $lng, array, ilFormPropertyGUI\setRequired(), and ilFileInputGUI\setSuffixes().

Referenced by editSmiliesObject(), and uploadSmileyObject().

        {
                global $ilCtrl, $lng;

                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(
                        $ilCtrl->getFormAction($this->gui, 'smiley-uploadSmileyObject') . $table_nav
                );

                // chat server settings
                $sec_l = new ilFormSectionHeaderGUI();

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

                $inp = new ilImageFileInputGUI(
                        $lng->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(
                        $lng->txt('chatroom_smiley_keywords'), 'chatroom_smiley_keywords'
                );

                $inp->setRequired(true);
                $inp->setUseRte(false);
                $inp->setInfo($lng->txt('chatroom_smiley_keywords_one_per_line_note'));
                $this->form_gui->addItem($inp);
                $this->form_gui->addCommandButton(
                        'smiley-uploadSmileyObject', $lng->txt('chatroom_upload_smiley')
                );

                return $this->form_gui;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

showEditSmileyEntryFormObject()

ilChatroomAdminSmileyGUI::showEditSmileyEntryFormObject

(

)

Shows EditSmileyEntryForm Prepares EditSmileyEntryForm and displays it.

ilRbacSystem $rbacsystem ilTemplate $tpl

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

References $lng, ilChatroomGUIHandler\$rbacsystem, $tpl, array, and initSmiliesEditForm().

        {
                global $rbacsystem, $tpl, $lng;

                $this->gui->switchToVisibleMode();

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

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

                $smiley = ilChatroomSmilies::_getSmiley($_REQUEST["smiley_id"]);

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

                $form = $this->initSmiliesEditForm($form_data);

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

                $tpl_form->setVariable("SMILEY_FORM", $form->getHTML());

                $tpl->setContent($tpl_form->get());
        }

Here is the call graph for this function:

updateSmiliesObject()

ilChatroomAdminSmileyGUI::updateSmiliesObject

(

)

Updates a smiley and/or its keywords Updates a smiley icon and/or its keywords by $_REQUEST["chatroom_smiley_id"] and gets keywords from $_REQUEST["chatroom_smiley_keywords"].

ilRbacSystem $rbacsystem ilCtrl2 $ilCtrl

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

References $_POST, $data, ilChatroomGUIHandler\$ilCtrl, $lng, ilChatroomGUIHandler\$rbacsystem, $tpl, ilChatroomSmilies\_deleteMultipleSmilies(), ilChatroomSmilies\_getSmiliesBasePath(), ilChatroomSmilies\_prepareKeywords(), array, ilUtil\img(), ilUtil\moveUploadedFile(), ilUtil\sendFailure(), ilUtil\sendInfo(), ilUtil\stripSlashes(), and view().

        {
                global $rbacsystem, $ilCtrl, $tpl, $lng;

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

                include_once('./Services/Form/classes/class.ilPropertyFormGUI.php');
                $this->form_gui = new ilPropertyFormGUI();

                //      $this->initSmiliesEditForm();

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

                $keywords = ilChatroomSmilies::_prepareKeywords(
                        ilUtil::stripSlashes($_REQUEST["chatroom_smiley_keywords"])
                );

                $keywordscheck = count($keywords) > 0;

                if(!$this->form_gui->checkInput() || !$keywordscheck)
                {
                        $tpl->setContent($this->form_gui->getHtml());
                        ilUtil::sendFailure('test', true);
                        return $this->view();
                }
                else
                {
                        $data                    = array();
                        $data["smiley_keywords"] = join("\n", $keywords);
                        $data["smiley_id"]       = $_REQUEST["smiley_id"];

                        if($_FILES["chatroom_image_path"])
                        {
                                \ilUtil::moveUploadedFile(
                                        $_FILES["chatroom_image_path"]["tmp_name"],
                                        $_FILES["chatroom_image_path"]["name"],
                                        ilChatroomSmilies::_getSmiliesBasePath() . $_FILES["chatroom_image_path"]["name"]
                                );

                                $data["smiley_path"] = $_FILES["chatroom_image_path"]["name"];
                        }

                        ilChatroomSmilies::_updateSmiley($data);
                }

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

Here is the call graph for this function:

uploadSmileyObject()

ilChatroomAdminSmileyGUI::uploadSmileyObject

(

)

Uploads and stores a new smiley with keywords from $_REQUEST["chatroom_smiley_keywords"] ilRbacSystem $rbacsystem ilCtrl2 $ilCtrl.

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

References ilChatroomGUIHandler\$ilCtrl, $lng, ilChatroomGUIHandler\$rbacsystem, $tpl, ilChatroomSmilies\_getSmiliesBasePath(), ilChatroomSmilies\_prepareKeywords(), initSmiliesForm(), ilUtil\moveUploadedFile(), ilUtil\stripSlashes(), time, and view().

        {
                global $rbacsystem, $ilCtrl, $tpl, $lng;

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

                $this->initSmiliesForm();

                include_once "Modules/Chatroom/classes/class.ilChatroomSmilies.php";
                include_once('./Services/Form/classes/class.ilPropertyFormGUI.php');

                //$this->form_gui = new ilPropertyFormGUI();

                $this->form_gui->setValuesByPost();

                $keywords = ilChatroomSmilies::_prepareKeywords(
                        ilUtil::stripSlashes($_REQUEST["chatroom_smiley_keywords"])
                );

                $keywordscheck = count($keywords) > 0;

                if(!$this->form_gui->checkInput())
                {
                        $tpl->setContent($this->form_gui->getHtml());
                        return $this->view();
                }

                $pathinfo    = pathinfo($_FILES["chatroom_image_path"]["name"]);
                $target_file = md5(time() + $pathinfo['basename']) . "." . $pathinfo['extension'];

                \ilUtil::moveUploadedFile(
                        $_FILES["chatroom_image_path"]["tmp_name"],
                        $target_file,
                        ilChatroomSmilies::_getSmiliesBasePath() . $target_file
                );

                ilChatroomSmilies::_storeSmiley(join("\n", $keywords), $target_file);

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

Here is the call 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 39 of file class.ilChatroomAdminSmileyGUI.php.

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

Referenced by executeDefault(), updateSmiliesObject(), and uploadSmileyObject().

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

---

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

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