ilUsersOnlineBlockGUI Class Reference

BlockGUI class for Personal Desktop Users Online block. More...

Inheritance diagram for ilUsersOnlineBlockGUI:

Collaboration diagram for ilUsersOnlineBlockGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	executeCommand ()
	execute command More...
	getHTML ()
	Handle config status. More...
	getUsers ()
	Get online users. More...
	fillDataSection ()
	Fill data section. More...
	getListRowData ()
	Get list data. More...
	fillRow ($a_set)
	get flat bookmark list for personal desktop More...
	getOverview ()
	Get overview. More...
	__showActiveChatsOfUser ($a_usr_id)
	__showChatInvitation ($a_usr_id)
Public Member Functions inherited from ilBlockGUI
	__construct ()
	Constructor. More...
	addHeaderLink ($a_href, $a_text, $status=true)
	getHeaderLinks ()
	setData ($a_data)
	Set Data. More...
	getData ()
	Get Data. More...
	setBigMode ($a_bigmode)
	Set Big Mode. More...
	getBigMode ()
	Get Big Mode. More...
	setBlockId ($a_block_id=0)
	Set Block Id. More...
	getBlockId ()
	Get Block Id. More...
	setAvailableDetailLevels ($a_max, $a_min=0)
	Set Available Detail Levels. More...
	setCurrentDetailLevel ($a_currentdetaillevel)
	Set Current Detail Level. More...
	setGuiObject (&$a_gui_object)
	Set GuiObject. More...
	getGuiObject ()
	Get GuiObject. More...
	getCurrentDetailLevel ()
	Get Current Detail Level. More...
	setTitle ($a_title)
	Set Title. More...
	getTitle ()
	Get Title. More...
	setImage ($a_image)
	Set Image. More...
	getImage ()
	Get Image. More...
	setOffset ($a_offset)
	Set Offset. More...
	getOffset ()
	Get Offset. More...
	correctOffset ()
	setLimit ($a_limit)
	Set Limit. More...
	getLimit ()
	Get Limit. More...
	setEnableEdit ($a_enableedit)
	Set EnableEdit. More...
	getEnableEdit ()
	Get EnableEdit. More...
	setRepositoryMode ($a_repositorymode)
	Set RepositoryMode. More...
	getRepositoryMode ()
	Get RepositoryMode. More...
	setFooterInfo ($a_footerinfo, $a_hide_and_icon=false)
	Set Footer Info. More...
	getFooterInfo ($a_hide_and_icon=false)
	Get Footer Info. More...
	setSubtitle ($a_subtitle)
	Set Subtitle. More...
	getSubtitle ()
	Get Subtitle. More...
	setRefId ($a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...
	getRefId ()
	Get Ref Id (only used if isRepositoryObject() is true). More...
	setAdminCommands ($a_admincommands)
	Set Administration Commmands. More...
	getAdminCommands ()
	Get Administration Commmands. More...
	setColSpan ($a_colspan)
	Set Columns Span. More...
	getColSpan ()
	Get Columns Span. More...
	setEnableDetailRow ($a_enabledetailrow)
	Set EnableDetailRow. More...
	getEnableDetailRow ()
	Get EnableDetailRow. More...
	setEnableNumInfo ($a_enablenuminfo)
	Set Enable Item Number Info. More...
	getEnableNumInfo ()
	Get Enable Item Number Info. More...
	setProperties ($a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...
	getProperty ($a_property)
	setProperty ($a_property, $a_value)
	setRowTemplate ($a_rowtemplatename, $a_rowtemplatedir="")
	Set Row Template Name. More...
	getNavParameter ()
	getDetailParameter ()
	getConfigParameter ()
	getMoveParameter ()
	getRowTemplateName ()
	Get Row Template Name. More...
	getRowTemplateDir ()
	Get Row Template Directory. More...
	addBlockCommand ( $a_href, $a_text, $a_target="", $a_img="", $a_right_aligned=false, $a_checked=false, $a_html="")
	Add Block Command. More...
	getBlockCommands ()
	Get Block commands. More...
	addHeaderCommand ($a_href, $a_text, $a_as_close=false)
	Add Header Block Command. More...
	getHeaderCommands ()
	Get Header Block commands. More...
	addFooterLink ( $a_text, $a_href="", $a_onclick="", $a_block_id="", $a_top=false, $a_omit_separator=false, $a_checked=false)
	Add a footer text/link. More...
	getFooterLinks ()
	Get footer links. More...
	clearFooterLinks ()
	Clear footer links. More...
	handleDetailLevel ()
	Handle read/write current detail level. More...
	getHTML ()
	Handle config status. More...
	fillHeaderCommands ()
	Fill header commands block. More...
	fillHeaderTitleBlock ()
	Fill header title block (title and. More...
	setDataSection ($a_content)
	Call this from overwritten fillDataSection(), if standard row based data is not used. More...
	fillDataSection ()
	Standard implementation for row based data. More...
	fillRow ($a_set)
	fillFooter ()
	fillPreviousNext ()
	Fill previous/next row. More...
	setPreviousNextLinks ()
	Get previous/next linkbar. More...
	fillFooterLinks ($a_top=false, $a_numinfo="")
	Fill footer links. More...
	fillDetailRow ()
	Fill Detail Setting Row. More...

Static Public Member Functions
static	getBlockType ()
	Get block type. More...
static	isRepositoryObject ()
	Is block used in repository object? More...
static	getScreenMode ()
	Get Screen Mode for current command. More...
static	getBlockType ()
static	isRepositoryObject ()
static	getScreenMode ()
	Get Screen Mode for current command. More...

Static Public Attributes
static	$block_type = "pdusers"

Protected Attributes
	$settings
	$db
	$rbacsystem
Protected Attributes inherited from ilBlockGUI
	$data = array()
	$colspan = 1
	$enablenuminfo = true
	$detail_min = 0
	$detail_max = 0
	$bigmode = false
	$footer_links = array()
	$block_id = 0
	$header_commands = array()
	$allow_moving = true
	$move = array("left" => false, "right" => false, "up" => false, "down" => false)
	$enabledetailrow = true
	$header_links = array()
	$footerinfo = false
	$footerinfo_icon = false
	$block_commands = array()
	$max_count = false
	$close_command = false
	$image = false
	$property = false
	$nav_value = ""
	$css_row = ""
	$dropdown
	$tpl
	$main_tpl
	$user
	$ctrl
	$access
	$lng
	$obj_def

Additional Inherited Members
Protected Member Functions inherited from ilBlockGUI
	fillRowColor ($a_placeholder="CSS_ROW")
	preloadData (array $data)
	Can be overwritten in subclasses. More...

Detailed Description

BlockGUI class for Personal Desktop Users Online block.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

@ilCtrl_IsCalledBy ilUsersOnlineBlockGUI: ilColumnGUI @ilCtrl_Calls ilUsersOnlineBlockGUI: ilPublicUserProfileGUI

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

Constructor & Destructor Documentation

__construct()

ilUsersOnlineBlockGUI::__construct

(

)

Constructor.

Reimplemented from ilBlockGUI.

Definition at line 39 of file class.ilUsersOnlineBlockGUI.php.

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->settings = $DIC->settings();
        $this->db = $DIC->database();
        $this->rbacsystem = $DIC->rbac()->system();
        $lng = $DIC->language();
 
        parent::__construct();
        
        $this->setLimit(10);
        $this->setTitle($lng->txt("users_online"));
        $this->setAvailableDetailLevels(3);
 
        // mjansen: Used for mail referer link (@see fillRow). I don't want to create a new instance in each fillRow call.
        $this->topGuiObj = new ilPersonalDesktopGUI();
    }

References $DIC, ilBlockGUI\$lng, ilBlockGUI\setAvailableDetailLevels(), ilBlockGUI\setLimit(), settings(), ilBlockGUI\setTitle(), and user().

Here is the call graph for this function:

Member Function Documentation

__showActiveChatsOfUser()

ilUsersOnlineBlockGUI::__showActiveChatsOfUser

(

$a_usr_id

)

Definition at line 376 of file class.ilUsersOnlineBlockGUI.php.

    {
        return false;
    }

Referenced by fillRow().

Here is the caller graph for this function:

__showChatInvitation()

ilUsersOnlineBlockGUI::__showChatInvitation

(

$a_usr_id

)

Definition at line 381 of file class.ilUsersOnlineBlockGUI.php.

    {
        $rbacsystem = $this->rbacsystem;
        $ilUser = $this->user;
        $lng = $this->lng;
        
        include_once './Modules/Chatroom/classes/class.ilObjChatroom.php';
        
        if ($a_usr_id == $ilUser->getId()) {
            return false;
        }
 
        if ($rbacsystem->checkAccess('read', ilObjChatroom::_getPublicRefId())
        and $rbacsystem->checkAccessOfUser($a_usr_id, 'read', ilObjChatroom::_getPublicRefId())) {
            $this->tpl->setCurrentBlock("chat_link");
            $this->tpl->setVariable("TXT_CHAT_INVITE", $lng->txt('chat_invite_public_room'));
            $this->tpl->setVariable("CHAT_LINK", './ilias.php?baseClass=ilRepositoryGUI&ref_id=' . ilObjChatroom::_getPublicRefId() . '&usr_id=' . $a_usr_id . '&cmd=view-invitePD');
            $this->tpl->setVariable('TXT_CHAT_INVITE_TOOLTIP', $lng->txt('chat_invite_public_room_tooltip'));
            $this->tpl->parseCurrentBlock();
            
            return true;
        }
        return false;
    }

References $ilUser, ilBlockGUI\$lng, $rbacsystem, ilBlockGUI\$user, and ilObjChatroom\_getPublicRefId().

Referenced by fillRow().

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilUsersOnlineBlockGUI::executeCommand

(

)

execute command

Definition at line 108 of file class.ilUsersOnlineBlockGUI.php.

    {
        $ilCtrl = $this->ctrl;
 
        $next_class = $ilCtrl->getNextClass();
        $cmd = $ilCtrl->getCmd("getHTML");
        
        switch ($next_class) {
            // profile
            case "ilpublicuserprofilegui":
                include_once('./Services/User/classes/class.ilPublicUserProfileGUI.php');
                $profile_gui = new ilPublicUserProfileGUI($_GET["user"]);
                $profile_gui->setBackUrl($ilCtrl->getParentReturn($this));
                return $ilCtrl->forwardCommand($profile_gui);
                break;
                
            default:
                return $this->$cmd();
        }
    }

References $_GET, ilBlockGUI\$ctrl, and $ilCtrl.

fillDataSection()

ilUsersOnlineBlockGUI::fillDataSection

(

)

Fill data section.

Reimplemented from ilBlockGUI.

Definition at line 186 of file class.ilUsersOnlineBlockGUI.php.

    {
        include_once("Services/Notes/classes/class.ilNote.php");
        
        if ($this->getCurrentDetailLevel() > 1 && $this->num_users > 0) {
            $this->setRowTemplate("tpl.users_online_row.html", "Services/PersonalDesktop");
            $this->getListRowData();
            if ($this->getCurrentDetailLevel() > 2) {
                $this->setColSpan(2);
            }
            parent::fillDataSection();
        } else {
            $this->setEnableNumInfo(false);
            $this->setDataSection($this->getOverview());
        }
    }

References ilBlockGUI\getCurrentDetailLevel(), getListRowData(), getOverview(), ilBlockGUI\setColSpan(), ilBlockGUI\setDataSection(), ilBlockGUI\setEnableNumInfo(), and ilBlockGUI\setRowTemplate().

Here is the call graph for this function:

fillRow()

ilUsersOnlineBlockGUI::fillRow

(

$a_set

)

get flat bookmark list for personal desktop

Reimplemented from ilBlockGUI.

Definition at line 237 of file class.ilUsersOnlineBlockGUI.php.

    {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilSetting = $this->settings;
        $rbacsystem = $this->rbacsystem;
 
        // mail link
        $a_set["mail_to"] = "";
        if ($this->mail_allowed &&
           $rbacsystem->checkAccessOfUser($a_set['id'], 'internal_mail', ilMailGlobalServices::getMailObjectRefId())) {
            $a_set['mail_url'] = ilMailFormCall::getLinkTarget($this->topGuiObj, '', array(), array('type' => 'new', 'rcp_to' => urlencode($a_set['login'])));
        }
        
        // check for profile
        $a_set["profile"] = in_array(
            ilObjUser::_lookupPref($a_set["id"], "public_profile"),
            array("y", "g")
        );
 
        // user image
        if ($this->getCurrentDetailLevel() > 2) {
            if ($a_set["mail_url"] != "") {
                $this->tpl->setCurrentBlock("mailto_link");
                $this->tpl->setVariable("TXT_MAIL", $lng->txt("mail"));
                $this->tpl->setVariable("MAIL_URL", $a_set["mail_url"]);
                $this->tpl->parseCurrentBlock();
            }
    
            $chatSettings = new ilSetting('chatroom');
            if (/*ilChatServerConfig::_isActive() && */$chatSettings->get('chat_enabled')) {
                if (!$this->__showActiveChatsOfUser($a_set["id"])) {
                    // Show invite to chat
                    $this->__showChatInvitation($a_set["id"]);
                }
 
                include_once './Modules/Chatroom/classes/class.ilObjChatroom.php';
                if ($a_set["id"] == $ilUser->getId() &&
                    $rbacsystem->checkAccess('read', ilObjChatroom::_getPublicRefId())) {
                    $this->tpl->setCurrentBlock('chat_link');
                    $this->tpl->setVariable('TXT_CHAT_INVITE', $lng->txt('chat_enter_public_room'));
                    $this->tpl->setVariable('TXT_CHAT_INVITE_TOOLTIP', $lng->txt('chat_enter_public_room_tooltip'));
                    $this->tpl->setVariable('CHAT_LINK', './ilias.php?baseClass=ilRepositoryGUI&cmd=view&ref_id=' . ilObjChatroom::_getPublicRefId());
                    $this->tpl->parseCurrentBlock();
                }
            }
            
            // user image
            $this->tpl->setCurrentBlock("usr_image");
            $this->tpl->setVariable(
                "USR_IMAGE",
                ilObjUser::_getPersonalPicturePath($a_set["id"], "xxsmall")
            );
            $this->tpl->setVariable("USR_ALT", $lng->txt("personal_picture"));
            $this->tpl->parseCurrentBlock();
            $this->tpl->touchBlock("usr_image_space");
        }
                    
        // username
        if (!$a_set["profile"]) {
            $this->tpl->setVariable("USR_LOGIN", $a_set["login"]);
        } elseif ($this->getCurrentDetailLevel() > 2) {
            $this->tpl->setVariable("USR_LOGIN", "<br />" . $a_set["login"]);
        } else {
            $this->tpl->setVariable("USR_LOGIN", " [" . $a_set["login"] . "]");
        }
        
        // profile link
        if ($a_set["profile"]) {
            include_once "Services/User/classes/class.ilUserUtil.php";
            $user_name = ilUserUtil::getNamePresentation($a_set["id"], false, false, "", false, true, false);
            
            $this->tpl->setCurrentBlock("profile_link");
            $this->tpl->setVariable("TXT_VIEW", $lng->txt("profile"));
            
            // see ilPersonalProfileGUI::getProfilePortfolio()
            $has_prtf = false;
            if ($ilSetting->get('user_portfolios')) {
                include_once "Modules/Portfolio/classes/class.ilObjPortfolio.php";
                $has_prtf = ilObjPortfolio::getDefaultPortfolio($a_set["id"]);
            }
            if (!$has_prtf) {
                // (simple) profile: center column
                $ilCtrl->setParameter($this, "user", $a_set["id"]);
                $this->tpl->setVariable(
                    "LINK_PROFILE",
                    $ilCtrl->getLinkTargetByClass("ilpublicuserprofilegui", "getHTML")
                );
            } else {
                // portfolio: fullscreen
                include_once "Services/Link/classes/class.ilLink.php";
                $this->tpl->setVariable("LINK_PROFILE", ilLink::_getLink($a_set["id"], "usr"));
                $this->tpl->setVariable("LINK_TARGET", "_blank");
            }
            
            $this->tpl->setVariable("USR_ID", $a_set["id"]);
            $this->tpl->setVariable("LINK_FULLNAME", $user_name);
            $this->tpl->parseCurrentBlock();
        } else {
            $this->tpl->setVariable("USR_FULLNAME", "");
        }
    }

References ilBlockGUI\$ctrl, $ilCtrl, $ilSetting, $ilUser, ilBlockGUI\$lng, $rbacsystem, $settings, ilBlockGUI\$user, __showActiveChatsOfUser(), __showChatInvitation(), ilLink\_getLink(), ilObjChatroom\_getPublicRefId(), ilObjUser\_lookupPref(), ilBlockGUI\getCurrentDetailLevel(), ilObjPortfolio\getDefaultPortfolio(), ilMailFormCall\getLinkTarget(), ilMailGlobalServices\getMailObjectRefId(), and ilUserUtil\getNamePresentation().

Here is the call graph for this function:

getBlockType()

static ilUsersOnlineBlockGUI::getBlockType ( )

static

Get block type.

Returns

string Block type.

Reimplemented from ilBlockGUI.

Definition at line 66 of file class.ilUsersOnlineBlockGUI.php.

    {
        return self::$block_type;
    }

References $block_type.

getHTML()

ilUsersOnlineBlockGUI::getHTML

(

)

Handle config status.

Get HTML.

Reimplemented from ilBlockGUI.

Definition at line 129 of file class.ilUsersOnlineBlockGUI.php.

    {
        $ilUser = $this->user;
        
        $this->users_online_pref = $ilUser->getPref("show_users_online");
        
        if ($this->users_online_pref != "y" && $this->users_online_pref != "associated") {
            return "";
        }
        
        $this->getUsers();
        
        if ($this->getCurrentDetailLevel() == 0) {
            return "";
        } else {
            return parent::getHTML();
        }
    }

References $ilUser, ilBlockGUI\$user, ilBlockGUI\getCurrentDetailLevel(), and getUsers().

Here is the call graph for this function:

getListRowData()

ilUsersOnlineBlockGUI::getListRowData

(

)

Get list data.

Definition at line 207 of file class.ilUsersOnlineBlockGUI.php.

    {
        $ilUser = $this->user;
        $rbacsystem = $this->rbacsystem;
 
        $data = array();
        
        $this->mail_allowed = ($ilUser->getId() != ANONYMOUS_USER_ID &&
                               $rbacsystem->checkAccess('internal_mail', ilMailGlobalServices::getMailObjectRefId()));
        
        foreach ($this->users as $user_id => $user) {
            $data[] = array(
                "id" => $user_id,
                "login" => $user["login"]
                );
        }
        $this->setData($data);
        
        // we do not have at least one (non hidden) active user
        if (count($data) == 0) {
            $this->setEnableNumInfo(false);
            $this->setCurrentDetailLevel(1);
            $this->enabledetailrow = false;
            $this->setDataSection($this->getOverview());
        }
    }

References ilBlockGUI\$data, $ilUser, $rbacsystem, ilBlockGUI\$user, ilMailGlobalServices\getMailObjectRefId(), getOverview(), ilBlockGUI\setCurrentDetailLevel(), ilBlockGUI\setData(), ilBlockGUI\setDataSection(), and ilBlockGUI\setEnableNumInfo().

Referenced by fillDataSection().

Here is the call graph for this function:

Here is the caller graph for this function:

getOverview()

ilUsersOnlineBlockGUI::getOverview

(

)

Get overview.

Definition at line 344 of file class.ilUsersOnlineBlockGUI.php.

    {
        $lng = $this->lng;
 
        // parse visitors text
        if (empty($this->visitors) || $this->users_online_pref == "associated") {
            $visitor_text = "";
        } elseif ($this->visitors == "1") {
            $visitor_text = "1 " . $lng->txt("visitor");
        } else {
            $visitor_text = $visitors . " " . $lng->txt("visitors");
        }
        
        // parse registered users text
        if ($this->num_users > 0) {
            $user_kind = ($this->users_online_pref == "associated") ? "associated_user" : "registered_user";
            if ($this->num_users == 1) {
                $user_list = $this->num_users . " " . $lng->txt($user_kind);
            } else {
                $user_list = $this->num_users . " " . $lng->txt($user_kind . "s");
            }
                        
            if (!empty($visitor_text)) {
                $user_list .= " " . $lng->txt("and") . " " . $visitor_text;
            }
        } else {
            $user_list = $visitor_text;
        }
        
        return '<div class="small">' . $user_list . "</div>";
    }

References ilBlockGUI\$lng.

Referenced by fillDataSection(), and getListRowData().

Here is the caller graph for this function:

getScreenMode()

static ilUsersOnlineBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Reimplemented from ilBlockGUI.

Definition at line 84 of file class.ilUsersOnlineBlockGUI.php.

    {
        global $DIC;
 
        $ilCtrl = $DIC->ctrl();
 
        if ($ilCtrl->getCmdClass() == "ilpublicuserprofilegui") {
            return IL_SCREEN_FULL;
        }
 
        switch ($ilCtrl->getCmd()) {
            case "showUserProfile":
                return IL_SCREEN_FULL;
                break;
                
            default:
                return IL_SCREEN_SIDE;
                break;
        }
    }

References $DIC, $ilCtrl, IL_SCREEN_FULL, and IL_SCREEN_SIDE.

getUsers()

ilUsersOnlineBlockGUI::getUsers

(

)

Get online users.

Definition at line 151 of file class.ilUsersOnlineBlockGUI.php.

    {
        $ilUser = $this->user;
        
        if ($this->users_online_pref == "associated") {
            $this->users = ilUtil::getAssociatedUsersOnline($ilUser->getId(), true);
        } else {
            $this->users = ilObjUser::_getUsersOnline(0, true);
        }
        
        $this->num_users = 0;
        
        // add current user always to list
        if ($ilUser->getId() != ANONYMOUS_USER_ID &&
            ilObjUser::_lookupPref($ilUser->getId(), "hide_own_online_status") != "y") {
            $this->users[$ilUser->getId()] =
                array("user_id" => $ilUser->getId(),
                    "firstname" => $ilUser->getFirstname(),
                    "lastname" => $ilUser->getLastname(),
                    "title" => $ilUser->getUTitle(),
                    "login" => $ilUser->getLogin());
        }
 
        foreach ($this->users as $user_id => $user) {
            if ($user_id != ANONYMOUS_USER_ID) {
                $this->num_users++;
            } else {
                $this->visitors = $user["num"];
            }
        }
    }

References $ilUser, ilBlockGUI\$user, ilObjUser\_lookupPref(), and ilUtil\getAssociatedUsersOnline().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

isRepositoryObject()

static ilUsersOnlineBlockGUI::isRepositoryObject ( )

static

Is block used in repository object?

Returns

string Block type.

Reimplemented from ilBlockGUI.

Definition at line 76 of file class.ilUsersOnlineBlockGUI.php.

    {
        return false;
    }

Field Documentation

$block_type

ilUsersOnlineBlockGUI::$block_type = "pdusers"

static

Definition at line 34 of file class.ilUsersOnlineBlockGUI.php.

Referenced by getBlockType().

$db

ilUsersOnlineBlockGUI::$db

protected

Definition at line 27 of file class.ilUsersOnlineBlockGUI.php.

$rbacsystem

ilUsersOnlineBlockGUI::$rbacsystem

protected

Definition at line 32 of file class.ilUsersOnlineBlockGUI.php.

Referenced by __showChatInvitation(), fillRow(), and getListRowData().

$settings

ilUsersOnlineBlockGUI::$settings

protected

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

Referenced by fillRow().

---

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

• Services/PersonalDesktop/classes/class.ilUsersOnlineBlockGUI.php