ilChatroomSmilies Class Reference

Class ilChatroomSmilies. More...

Collaboration diagram for ilChatroomSmilies:

Static Public Member Functions
static	_checkSetup ()
	Checks if smiley folder is available; if not it will try to create folder and performs actions for an initial smiley set. More...
static	_getSmileyDir ()
	Path to smilies. More...
static	_deleteMultipleSmilies ($ids=array())
	Deletes multiple smilies by given id array. More...
static	getSmiliesBasePath ()
	Returns smilies basepath. More...
static	_prepareKeywords ($words)
	Trims given keywords and returns them in one array. More...

Detailed Description

Class ilChatroomSmilies.

Author

Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

$Id$

Definition at line 10 of file class.ilChatroomSmilies.php.

Member Function Documentation

_checkSetup()

static ilChatroomSmilies::_checkSetup ( )

static

Checks if smiley folder is available; if not it will try to create folder and performs actions for an initial smiley set.

Returns

boolean

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

    {
        global $lng;
 
        $path = self::_getSmileyDir();
 
        if (!is_dir($path)) {
            ilUtil::sendInfo($lng->txt('chatroom_smilies_dir_not_exists'));
            ilUtil::makeDirParents($path);
 
            if (!is_dir($path)) {
                ilUtil::sendFailure($lng->txt('chatroom_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('chatroom_smilies_initialized'));
            }
        }
 
        if (!is_writable($path)) {
            ilUtil::sendInfo($lng->txt('chatroom_smilies_dir_not_writable'));
        }
 
        return true;
    }

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

Referenced by ilChatroomAdminSmileyGUI\editSmiliesObject().

Here is the call graph for this function:

Here is the caller graph for this function:

_deleteMultipleSmilies()

static ilChatroomSmilies::_deleteMultipleSmilies (   $ids = array() )

static

Deletes multiple smilies by given id array.

@global ilDBInterface $ilDB

Parameters

array

$ids

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

    {
        global $ilDB;
 
        $smilies = self::_getSmiliesById($ids);
 
        if (count($smilies) <= 0) {
            return;
        }
 
        $sql_parts = array();
 
        foreach ($smilies as $s) {
            unlink($s["smiley_fullpath"]);
            $sql_parts[] = "smiley_id = " . $ilDB->quote($s["smiley_id"], 'integer');
        }
 
        $ilDB->manipulate("DELETE FROM chatroom_smilies WHERE " . implode(" OR ", $sql_parts));
    }

References $ilDB, and $s.

_getSmileyDir()

static ilChatroomSmilies::_getSmileyDir ( )

static

Path to smilies.

Returns

string

Definition at line 111 of file class.ilChatroomSmilies.php.

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

References ilUtil\getWebspaceDir().

Referenced by _checkSetup().

Here is the call graph for this function:

Here is the caller graph for this function:

_prepareKeywords()

static ilChatroomSmilies::_prepareKeywords (   $words )

static

Trims given keywords and returns them in one array.

Parameters

string

$words

Returns

array

Definition at line 351 of file class.ilChatroomSmilies.php.

    {
        $keywordscheck = true;
 
        // check keywords
        $keywords_unchecked = explode("\n", $words);
        if (count($keywords_unchecked) <= 0) {
            $keywordscheck = false;
        }
 
        if ($keywordscheck) {
            $keywords = array();
 
            foreach ($keywords_unchecked as $word) {
                if (trim($word)) {
                    $keywords[] = trim($word);
                }
            }
        }
 
        if ($keywordscheck && count($keywords) <= 0) {
            $keywordscheck = false;
        }
 
        if ($keywordscheck) {
            return $keywords;
        } else {
            return array();
        }
    }

getSmiliesBasePath()

static ilChatroomSmilies::getSmiliesBasePath ( )

static

Returns smilies basepath.

Returns

string

Definition at line 283 of file class.ilChatroomSmilies.php.

    {
        return 'chatroom/smilies';
    }

---

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

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