ilPDSelectedItemsBlockGUI Class Reference

BlockGUI class for Selected Items on Personal Desktop. More...

Inheritance diagram for ilPDSelectedItemsBlockGUI:

Collaboration diagram for ilPDSelectedItemsBlockGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	addToDeskObject ()
	removeFromDeskObject ()
	getHTML ()
	getFooterLinks ()
	executeCommand ()
	execute command More...
	getContent ()
	setContent ($a_content)
	fillDataSection ()
	Fill data section. More...
	fillFooter ()
	block footer More...
	setFooterLinks ()
	Set footer links. More...
	getMembershipItemsPerLocation ($tpl)
	Generates the block html string by location ordering. More...
	getMembershipItemsPerType ($tpl)
	Generates the block html string by type ordering. More...
	getMembershipItemsBlockHTML ()
	Gateway method to distinguish between sorting type. More...
	getSelectedItemsBlockHTML ()
	get selected item block More...
	getSelectedItemsPerType (&$tpl)
	get selected items per type More...
	getSelectedItemsPerLocation (&$tpl)
	get selected items per type More...
	resetRowType ()
&	newBlockTemplate ()
	returns a new list block template More...
&	getItemListGUI ($a_type)
	get item list gui class for type More...
	addHeaderRow (&$a_tpl, $a_type, $a_show_image=true)
	adds a header row to a block template More...
	addParentRow (&$a_tpl, $a_ref_id, $a_show_image=true)
	adds a header row to a block template More...
	addStandardRow (&$a_tpl, $a_html, $a_item_ref_id="", $a_item_obj_id="", $a_image_type="", $a_related_header="")
	adds a standard row to a block template More...
	getIntroduction ()
	Get overview. More...
	orderPDItemsByLocation ()
	order desktop items by location More...
	orderPDItemsByType ()
	order desktop items by Type More...
	manageObject ()
	confirmRemoveObject ()
	confirmedRemove ()
	confirmedUnsubscribe ()
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	getScreenMode ()
static	isRepositoryObject ()
	Get block type. More...
Static Public Member Functions inherited from ilBlockGUI
static	getBlockType ()
static	isRepositoryObject ()
static	getScreenMode ()
	Get Screen Mode for current command. More...

Data Fields
const	VIEW_SELECTED_ITEMS = 0
const	VIEW_MY_MEMBERSHIPS = 1
const	VIEW_MY_STUDYPROGRAMME = 2

Static Public Attributes
static	$block_type = "pditems"

Protected Member Functions
	getObjectsByMembership ($types=array())
	Gets all objects the current user is member of. More...
Protected Member Functions inherited from ilBlockGUI
	fillRowColor ($a_placeholder="CSS_ROW")
	preloadData (array $data)
	Can be overwritten in subclasses. More...

Private Attributes
	$view = self::VIEW_SELECTED_ITEMS
	$allowed_views = array()

Additional Inherited Members
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

Detailed Description

BlockGUI class for Selected Items on Personal Desktop.

Author

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

Version

$Id$

ilPDSelectedItemsBlockGUI: ilColumnGUI ilPDSelectedItemsBlockGUI: ilCommonActionDispatcherGUI

Definition at line 18 of file class.ilPDSelectedItemsBlockGUI.php.

Constructor & Destructor Documentation

__construct()

ilPDSelectedItemsBlockGUI::__construct

(

)

Constructor.

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

References $ilCtrl, $ilUser, $lng, ilBlockGUI\fillDetailRow(), ilBlockGUI\setAvailableDetailLevels(), ilBlockGUI\setEnableNumInfo(), and ilBlockGUI\setLimit().

        {
                global $ilCtrl, $lng, $ilUser;
                
                parent::__construct();

                $lng->loadLanguageModule('pd');
                $lng->loadLanguageModule('cntr'); // #14158

                $this->setEnableNumInfo(false);
                $this->setLimit(99999);
//              $this->setColSpan(2);
                $this->setAvailableDetailLevels(3, 1);
//              $this->setBigMode(true);
                $this->lng = $lng;
                $this->allow_moving = false;

                $this->determineViewSettings();
        }

Here is the call graph for this function:

Member Function Documentation

addHeaderRow()

ilPDSelectedItemsBlockGUI::addHeaderRow	(	&	$a_tpl,
			$a_type,
			$a_show_image = true
	)

adds a header row to a block template

Parameters

object	$a_tpl	block template
string	$a_type	object type private

Definition at line 1235 of file class.ilPDSelectedItemsBlockGUI.php.

References $a_type, $title, ilUtil\getImagePath(), and ilObjectPlugin\lookupTxtById().

Referenced by getMembershipItemsPerType(), and getSelectedItemsPerType().

        {
                global $objDefinition;
                
                $icon = ilUtil::getImagePath("icon_".$a_type.".svg");
                if (!$objDefinition->isPlugin($a_type))
                {
                        $title = $this->lng->txt("objs_".$a_type);
                }
                else
                {
                        include_once("./Services/Component/classes/class.ilPlugin.php");
                        $title =
                                ilObjectPlugin::lookupTxtById($a_type, "objs_".$a_type);

                }
                $header_id = "th_".$a_type;

                if ($a_show_image)
                {
                        $a_tpl->setCurrentBlock("container_header_row_image");
                        $a_tpl->setVariable("HEADER_IMG", $icon);
                        $a_tpl->setVariable("HEADER_ALT", $title);
                }
                else
                {
                        $a_tpl->setCurrentBlock("container_header_row");
                }
                
                $a_tpl->setVariable("BLOCK_HEADER_CONTENT", $title);
                $a_tpl->setVariable("BLOCK_HEADER_ID", $header_id);
                $a_tpl->parseCurrentBlock();
                $a_tpl->touchBlock("container_row");
        }

Here is the call graph for this function:

Here is the caller graph for this function:

addParentRow()

ilPDSelectedItemsBlockGUI::addParentRow	(	&	$a_tpl,
			$a_ref_id,
			$a_show_image = true
	)

adds a header row to a block template

Parameters

object	$a_tpl	block template
string	$a_type	object type private

Definition at line 1277 of file class.ilPDSelectedItemsBlockGUI.php.

References $ilSetting, $nd, $path, $title, ilContainer\_lookupIconPath(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), array, and ilUtil\getImagePath().

Referenced by getMembershipItemsPerLocation(), and getSelectedItemsPerLocation().

        {
                global $tree, $ilSetting;
                
                $par_id = ilObject::_lookupObjId($a_ref_id);
                $type = ilObject::_lookupType($par_id);
                if (!in_array($type, array("lm", "sahs", "htlm")))
                {
                        $icon = ilUtil::getImagePath("icon_".$type.".svg");
                }
                else
                {
                        $icon = ilUtil::getImagePath("icon_lm.svg");
                }
                
                // custom icon
                if ($ilSetting->get("custom_icons") &&
                in_array($type, array("cat","grp","crs", "root")))
                {
                        require_once("./Services/Container/classes/class.ilContainer.php");
                        if (($path = ilContainer::_lookupIconPath($par_id, "small")) != "")
                        {
                                $icon = $path;
                        }
                }
                
                if ($tree->getRootId() != $par_id)
                {
                        $title = ilObject::_lookupTitle($par_id);
                }
                else
                {
                        $nd = $tree->getNodeData(ROOT_FOLDER_ID);
                        $title = $nd["title"];
                        if ($title == "ILIAS")
                        {
                                $title = $this->lng->txt("repository");
                        }
                }
                
/*              
                $item_list_gui = $this->getItemListGUI($type);
                
                $item_list_gui->enableIcon(false);
                $item_list_gui->enableDelete(false);
                $item_list_gui->enableCut(false);
                $item_list_gui->enableLink(false);
                $item_list_gui->enableDescription(false);
                $item_list_gui->enableProperties(false);
                $item_list_gui->enablePreconditions(false);
                $item_list_gui->enablePath(true);
                $item_list_gui->enableCommands(false);
                $html = $item_list_gui->getListItemHTML($a_ref_id,
                $par_id, $title, "");
                
                if ($a_show_image)
                {
                        $a_tpl->setCurrentBlock("container_header_row_image");
                        $a_tpl->setVariable("HEADER_IMG", $icon);
                        $a_tpl->setVariable("HEADER_ALT", $title);
                }
*/
//              else
//              {
                        $a_tpl->setCurrentBlock("container_header_row");
//              }

                $a_tpl->setVariable("BLOCK_HEADER_CONTENT", $title);
/*              $a_tpl->setVariable("BLOCK_HEADER_CONTENT", $html);
                $a_tpl->setVariable("BLOCK_HEADER_ID", "th_".$a_ref_id);*/
                $a_tpl->parseCurrentBlock();
                $a_tpl->touchBlock("container_row");
        }

Here is the call graph for this function:

Here is the caller graph for this function:

addStandardRow()

ilPDSelectedItemsBlockGUI::addStandardRow	(	&	$a_tpl,
			$a_html,
			$a_item_ref_id = "",
			$a_item_obj_id = "",
			$a_image_type = "",
			$a_related_header = ""
	)

adds a standard row to a block template

Parameters

object	$a_tpl	block template
string	$a_html	html code private

Definition at line 1358 of file class.ilPDSelectedItemsBlockGUI.php.

References $ilSetting, $path, $title, ilContainer\_lookupIconPath(), array, and ilUtil\getImagePath().

Referenced by getMembershipItemsPerLocation(), getMembershipItemsPerType(), getSelectedItemsPerLocation(), and getSelectedItemsPerType().

        {
                global $ilSetting;
                
                $this->cur_row_type = ($this->cur_row_type == "row_type_1")
                ? "row_type_2"
                : "row_type_1";
                $a_tpl->touchBlock($this->cur_row_type);
                
                if ($a_image_type != "")
                {
                        if (!is_array($a_image_type) && !in_array($a_image_type, array("lm", "htlm", "sahs")))
                        {
                                $icon = ilUtil::getImagePath("icon_".$a_image_type.".svg");
                                $title = $this->lng->txt("obj_".$a_image_type);
                        }
                        else
                        {
                                $icon = ilUtil::getImagePath("icon_lm.svg");
                                $title = $this->lng->txt("learning_resource");
                        }
                        
                        // custom icon
                        if ($ilSetting->get("custom_icons") &&
                        in_array($a_image_type, array("cat","grp","crs")))
                        {
                                require_once("./Services/Container/classes/class.ilContainer.php");
                                if (($path = ilContainer::_lookupIconPath($a_item_obj_id, "small")) != "")
                                {
                                        $icon = $path;
                                }
                        }
                        
                        $a_tpl->setCurrentBlock("block_row_image");
                        $a_tpl->setVariable("ROW_IMG", $icon);
                        $a_tpl->setVariable("ROW_ALT", $title);
                        $a_tpl->parseCurrentBlock();
                }
                else
                {
                        $a_tpl->setVariable("ROW_NBSP", " ");
                }
                $a_tpl->setCurrentBlock("container_standard_row");
                $a_tpl->setVariable("BLOCK_ROW_CONTENT", $a_html);
                $rel_headers = ($a_related_header != "")
                ? "th_selected_items ".$a_related_header
                : "th_selected_items";
                $a_tpl->setVariable("BLOCK_ROW_HEADERS", $rel_headers);
                $a_tpl->parseCurrentBlock();
                $a_tpl->touchBlock("container_row");
        }

Here is the call graph for this function:

Here is the caller graph for this function:

addToDeskObject()

ilPDSelectedItemsBlockGUI::addToDeskObject

(

)

See also

ilDesktopItemHandling::addToDesk()

Implements ilDesktopItemHandling.

Definition at line 70 of file class.ilPDSelectedItemsBlockGUI.php.

References $ilCtrl, $lng, ilDesktopItemGUI\addToDesktop(), and ilUtil\sendSuccess().

    {
                global $ilCtrl, $lng;
                
                include_once './Services/PersonalDesktop/classes/class.ilDesktopItemGUI.php';
                ilDesktopItemGUI::addToDesktop();
                ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
                $ilCtrl->setParameterByClass('ilpersonaldesktopgui', 'view', $this->view);
                $ilCtrl->redirectByClass('ilpersonaldesktopgui', 'show');
    }

Here is the call graph for this function:

confirmedRemove()

ilPDSelectedItemsBlockGUI::confirmedRemove

(

)

Definition at line 1578 of file class.ilPDSelectedItemsBlockGUI.php.

References $_POST, $ilCtrl, $ilUser, $ref_id, ilObjUser\_dropDesktopItem(), ilObject\_lookupType(), and ilUtil\sendSuccess().

        {
                global $ilCtrl, $ilUser;
                
                if(!sizeof($_POST["ref_id"]))
                {
                        $ilCtrl->redirect($this, "manage");
                }
                
                foreach($_POST["ref_id"] as $ref_id)
                {
                        $type = ilObject::_lookupType($ref_id, true);
                        ilObjUser::_dropDesktopItem($ilUser->getId(), $ref_id, $type);                  
                }               
                
                // #12909
                ilUtil::sendSuccess($this->lng->txt("pd_remove_multi_confirm"), true);
                $ilCtrl->setParameterByClass('ilpersonaldesktopgui', 'view', $this->view);
                $ilCtrl->redirectByClass("ilpersonaldesktopgui", "show");
        }

Here is the call graph for this function:

confirmedUnsubscribe()

ilPDSelectedItemsBlockGUI::confirmedUnsubscribe

(

)

Definition at line 1599 of file class.ilPDSelectedItemsBlockGUI.php.

References $_POST, $ilCtrl, $ilUser, $ref_id, ilObject\_lookupObjId(), ilObject\_lookupType(), ilForumNotification\checkForumsExistsDelete(), ilUtil\sendSuccess(), ilGroupMembershipMailNotification\TYPE_NOTIFICATION_UNSUBSCRIBE, and ilGroupMembershipMailNotification\TYPE_UNSUBSCRIBE_MEMBER.

        {
                global $ilCtrl, $ilAccess, $ilUser;
                
                if(!sizeof($_POST["ref_id"]))
                {
                        $ilCtrl->redirect($this, "manage");
                }               
                
                foreach($_POST["ref_id"] as $ref_id)
                {
                        if($ilAccess->checkAccess("leave", "", $ref_id))
                        {
                                switch(ilObject::_lookupType($ref_id, true))
                                {
                                        case "crs":
                                                // see ilObjCourseGUI:performUnsubscribeObject()                
                                                include_once "Modules/Course/classes/class.ilCourseParticipants.php";
                                                $members = new ilCourseParticipants(ilObject::_lookupObjId($ref_id));
                                                $members->delete($ilUser->getId());
                                                
                                                $members->sendUnsubscribeNotificationToAdmins($ilUser->getId());
                                                $members->sendNotification(
                                                        $members->NOTIFY_UNSUBSCRIBE,
                                                        $ilUser->getId()
                                                );
                                                break;
                                        
                                        case "grp":
                                                // see ilObjGroupGUI:performUnsubscribeObject()         
                                                include_once "Modules/Group/classes/class.ilGroupParticipants.php";
                                                $members = new ilGroupParticipants(ilObject::_lookupObjId($ref_id));
                                                $members->delete($ilUser->getId());             
                                                
                                                include_once './Modules/Group/classes/class.ilGroupMembershipMailNotification.php';
                                                $members->sendNotification(
                                                        ilGroupMembershipMailNotification::TYPE_UNSUBSCRIBE_MEMBER,
                                                        $ilUser->getId()
                                                );
                                                $members->sendNotification(
                                                        ilGroupMembershipMailNotification::TYPE_NOTIFICATION_UNSUBSCRIBE,
                                                        $ilUser->getId()
                                                );
                                                break;
                                        
                                        default:
                                                // do nothing
                                                continue;
                                }                                                                                       
                
                                include_once './Modules/Forum/classes/class.ilForumNotification.php';
                                ilForumNotification::checkForumsExistsDelete($ref_id, $ilUser->getId());                                
                        }
                }
                
                
                ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);
                $ilCtrl->setParameterByClass('ilpersonaldesktopgui', 'view', $this->view);
                $ilCtrl->redirectByClass("ilpersonaldesktopgui", "show");
        }

Here is the call graph for this function:

confirmRemoveObject()

ilPDSelectedItemsBlockGUI::confirmRemoveObject

(

)

Definition at line 1534 of file class.ilPDSelectedItemsBlockGUI.php.

References $_POST, $cmd, $ilCtrl, $ref_id, $title, ilObject\_getIcon(), ilObject\_lookupObjectId(), ilObject\_lookupTitle(), ilObject\_lookupType(), and ilUtil\sendFailure().

        {
                global $ilCtrl;

                $ilCtrl->setParameter($this, 'view', $this->view);
                if(!sizeof($_POST["id"]))
                {
                        ilUtil::sendFailure($this->lng->txt("select_one"), true);
                        $ilCtrl->redirect($this, "manage");
                }
                
                if($this->view == self::VIEW_SELECTED_ITEMS)
                {
                        $question = $this->lng->txt("pd_info_delete_sure_remove");
                        $cmd = "confirmedRemove";
                }
                else
                {
                        $question = $this->lng->txt("pd_info_delete_sure_unsubscribe");
                        $cmd = "confirmedUnsubscribe";
                }
                
                include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
                $cgui = new ilConfirmationGUI();
                $cgui->setHeaderText($question);

                $cgui->setFormAction($ilCtrl->getFormAction($this));
                $cgui->setCancel($this->lng->txt("cancel"), "manage");
                $cgui->setConfirm($this->lng->txt("confirm"), $cmd);

                foreach ($_POST["id"] as $ref_id)
                {
                        $obj_id = ilObject::_lookupObjectId($ref_id);
                        $title = ilObject::_lookupTitle($obj_id);
                        $type = ilObject::_lookupType($obj_id);
                        
                        $cgui->addItem("ref_id[]", $ref_id, $title,
                                ilObject::_getIcon($obj_id, "small", $type),
                                $this->lng->txt("icon")." ".$this->lng->txt("obj_".$type));                     
                }
                
                return $cgui->getHTML();
        }

Here is the call graph for this function:

executeCommand()

ilPDSelectedItemsBlockGUI::executeCommand

(

)

execute command

Definition at line 275 of file class.ilPDSelectedItemsBlockGUI.php.

References $cmd, $ilCtrl, and ilCommonActionDispatcherGUI\getInstanceFromAjaxCall().

        {
                global $ilCtrl;

                $next_class = $ilCtrl->getNextClass();
                $cmd = $ilCtrl->getCmd("getHTML");
                
                switch($next_class)
                {
                        case "ilcommonactiondispatchergui":
                                include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
                                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                                $ilCtrl->forwardCommand($gui);
                                break;
                                
                        default:                
                                if(method_exists($this, $cmd))
                                {
                                        return $this->$cmd();
                                }
                                else
                                {
                                        $cmd .= 'Object';
                                        return $this->$cmd();
                                }
                }
        }

Here is the call graph for this function:

fillDataSection()

ilPDSelectedItemsBlockGUI::fillDataSection

(

)

Fill data section.

Definition at line 316 of file class.ilPDSelectedItemsBlockGUI.php.

References $ilUser, getContent(), getIntroduction(), and ilBlockGUI\setDataSection().

        {
                global $ilUser;
                
                if ($this->getContent() != "")
                {
                        $this->tpl->setVariable("BLOCK_ROW", $this->getContent());
                }
                else
                {
                        $this->setDataSection($this->getIntroduction());
                }
        }

Here is the call graph for this function:

fillFooter()

ilPDSelectedItemsBlockGUI::fillFooter

(

)

block footer

Definition at line 334 of file class.ilPDSelectedItemsBlockGUI.php.

References $ilCtrl, $ilUser, $lng, ilBlockGUI\fillFooterLinks(), ilBlockGUI\getColSpan(), and setFooterLinks().

        {
                global $ilCtrl, $lng, $ilUser;

                $this->setFooterLinks();
                $this->fillFooterLinks();
                $this->tpl->setVariable("FCOLSPAN", $this->getColSpan());
                if ($this->tpl->blockExists("block_footer"))
                {
                        $this->tpl->setCurrentBlock("block_footer");
                        $this->tpl->parseCurrentBlock();
                }
        }

Here is the call graph for this function:

getBlockType()

static ilPDSelectedItemsBlockGUI::getBlockType ( )

static

Get block type.

Returns

string Block type.

Definition at line 171 of file class.ilPDSelectedItemsBlockGUI.php.

        {
                return self::$block_type;
        }

getContent()

ilPDSelectedItemsBlockGUI::getContent

(

)

Definition at line 303 of file class.ilPDSelectedItemsBlockGUI.php.

Referenced by fillDataSection(), getHTML(), and setFooterLinks().

        {
                return $this->content;
        }

Here is the caller graph for this function:

getFooterLinks()

ilPDSelectedItemsBlockGUI::getFooterLinks

(

)

Definition at line 264 of file class.ilPDSelectedItemsBlockGUI.php.

References array.

        {
                if((int)$this->view == self::VIEW_MY_STUDYPROGRAMME) {
                        return array();
                }
                return parent::getFooterLinks();
        }

getHTML()

ilPDSelectedItemsBlockGUI::getHTML

(

)

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

References $ilCtrl, $ilDB, $ilSetting, $lng, $tpl, $view, array, getContent(), getMembershipItemsBlockHTML(), getSelectedItemsBlockHTML(), ilHelpGUI\ID_PART_SCREEN, setContent(), ilBlockGUI\setData(), ilBlockGUI\setEnableDetailRow(), and ilBlockGUI\setTitle().

Referenced by orderPDItemsByLocation(), and orderPDItemsByType().

        {
                global $ilCtrl, $ilSetting, $tpl, $lng, $ilHelp, $ilDB;

                $ilDB->useSlave(true);

                // workaround to show details row
                $this->setData(array("dummy"));
                                
                include_once "Services/Object/classes/class.ilObjectListGUI.php";
                ilObjectListGUI::prepareJSLinks("", 
                        $ilCtrl->getLinkTargetByClass(array("ilcommonactiondispatchergui", "ilnotegui"), "", "", true, false),
                        $ilCtrl->getLinkTargetByClass(array("ilcommonactiondispatchergui", "iltagginggui"), "", "", true, false));
                
                switch((int)$this->view)
                {
                        case self::VIEW_MY_MEMBERSHIPS:
                                $ilHelp->setDefaultScreenId(ilHelpGUI::ID_PART_SCREEN, "crs_grp");
                                if ($ilSetting->get('disable_my_offers') == 0)
                                {
                                        $tpl->setTitle($lng->txt("my_courses_groups"));
                                }
                                $this->setTitle($this->lng->txt('pd_my_memberships'));
                                $this->setContent($this->getMembershipItemsBlockHTML());
                                break;
                                                        
                        case self::VIEW_SELECTED_ITEMS:
                        default:
                                $ilHelp->setDefaultScreenId(ilHelpGUI::ID_PART_SCREEN, "sel_items");
                                if(!in_array(self::VIEW_MY_MEMBERSHIPS, $this->allowed_views))
                                {
                                        $this->setTitle($this->lng->txt('selected_items'));
                                }
                                else
                                {
                                        $this->setTitle($this->lng->txt('pd_my_offers'));
                                }
                                
                                $this->setContent($this->getSelectedItemsBlockHTML());
                                break;
                }
                
                if ($this->getContent() == "")
                {
                        $this->setEnableDetailRow(false);
                }
//              $ilCtrl->clearParametersByClass("ilpersonaldesktopgui");
                $ilCtrl->clearParameters($this);
                
                $ilDB->useSlave(false);
                
                return parent::getHTML();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getIntroduction()

ilPDSelectedItemsBlockGUI::getIntroduction

(

)

Get overview.

Definition at line 1414 of file class.ilPDSelectedItemsBlockGUI.php.

References $ilCtrl, $ilUser, $lng, $nd, $title, $tpl, and ilObject\_getIcon().

Referenced by fillDataSection().

        {
                global $ilUser, $lng, $ilCtrl, $tree;
                
                switch((int)$this->view)
                {
                        case self::VIEW_MY_MEMBERSHIPS:
                                $tpl = new ilTemplate('tpl.pd_my_memberships_intro.html', true, true, 'Services/PersonalDesktop');
                                $tpl->setVariable('IMG_PD_LARGE', ilObject::_getIcon("", "big", "pd"));
                                $tpl->setVariable('TXT_WELCOME', $lng->txt('pd_my_memberships_intro'));
                                $tpl->setVariable('TXT_INTRO_1', $lng->txt('pd_my_memberships_intro2'));
                                break;
                                                        
                        case self::VIEW_SELECTED_ITEMS:
                        default:
                                // get repository link
                                $nd = $tree->getNodeData(ROOT_FOLDER_ID);
                                $title = $nd["title"];
                                if ($title == "ILIAS")
                                {
                                        $title = $lng->txt("repository");
                                }
                                
                                $tpl = new ilTemplate("tpl.pd_intro.html", true, true, "Services/PersonalDesktop");
                                $tpl->setVariable('IMG_PD_LARGE', ilObject::_getIcon("", "big", "pd"));
                                $tpl->setVariable("TXT_WELCOME", $lng->txt("pdesk_intro"));
                                $tpl->setVariable("TXT_INTRO_1", sprintf($lng->txt("pdesk_intro2"), $lng->txt("to_desktop")));
                                include_once("./Services/Link/classes/class.ilLink.php");
                                $tpl->setVariable("TXT_INTRO_2", sprintf($lng->txt("pdesk_intro3"),
                                        '<a href="'.ilLink::_getStaticLink(1,'root',true).'">'.$title.'</a>'));
                                $tpl->setVariable("TXT_INTRO_3", $lng->txt("pdesk_intro4"));
                                break;
                }
                
                return $tpl->get();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getItemListGUI()

& ilPDSelectedItemsBlockGUI::getItemListGUI

(

$a_type

)

get item list gui class for type

Definition at line 1189 of file class.ilPDSelectedItemsBlockGUI.php.

References $a_type, and $location.

Referenced by getMembershipItemsPerLocation(), and getSelectedItemsPerLocation().

        {
                global $objDefinition;
                //echo "<br>+$a_type+";
                if (!isset($this->item_list_guis[$a_type]))
                {
                        $class = $objDefinition->getClassName($a_type);
                        // Fixed problem with deactivated plugins and existing repo. object plugin objects on the user's desktop
                        if(!$class)
                        {
                                return NULL;
                        }
                        // Fixed problem with deactivated plugins and existing repo. object plugin objects on the user's desktop
                        $location = $objDefinition->getLocation($a_type);
                        if(!$location)
                        {
                                return NULL;
                        }
                        
                        $full_class = "ilObj".$class."ListGUI";
                        //echo "<br>-".$location."/class.".$full_class.".php"."-";
                        include_once($location."/class.".$full_class.".php");
                        $item_list_gui = new $full_class();
                        $this->item_list_guis[$a_type] = $item_list_gui;
                }
                else
                {
                        $item_list_gui = $this->item_list_guis[$a_type];
                }

                if ($this->manage)
                {
                        $item_list_gui->enableCheckbox(true);
                }
                
                
                return $item_list_gui;
        }

Here is the caller graph for this function:

getMembershipItemsBlockHTML()

ilPDSelectedItemsBlockGUI::getMembershipItemsBlockHTML

(

)

Gateway method to distinguish between sorting type.

public

Returns

string the generated block html string

Definition at line 820 of file class.ilPDSelectedItemsBlockGUI.php.

References $ilUser, $ok, $tpl, getMembershipItemsPerLocation(), getMembershipItemsPerType(), and newBlockTemplate().

Referenced by getHTML().

        {
                global $ilUser;

                $tpl = $this->newBlockTemplate();
                
                switch($ilUser->getPref('pd_order_items'))
                {
                        case 'location':
                        $ok = $this->getMembershipItemsPerLocation($tpl);
                        break;
                        
                        default:
                        $ok = $this->getMembershipItemsPerType($tpl);
                        break;
                }
                
                return $tpl->get();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getMembershipItemsPerLocation()

ilPDSelectedItemsBlockGUI::getMembershipItemsPerLocation

(

$tpl

)

Generates the block html string by location ordering.

public

Parameters

ilTemplate

$tpl

the current template instance

Definition at line 478 of file class.ilPDSelectedItemsBlockGUI.php.

References $html, $ilBench, $ilSetting, $ilUser, $output, $tpl, ilObjectActivation\addListGUIActivationProperty(), addParentRow(), addStandardRow(), array, ilObjectListGUI\CONTEXT_PERSONAL_DESKTOP, ilBlockGUI\getCurrentDetailLevel(), getItemListGUI(), getObjectsByMembership(), and resetRowType().

Referenced by getMembershipItemsBlockHTML().

        {
                global $ilUser, $rbacsystem, $objDefinition, $ilBench, $ilSetting, $ilObjDataCache, $rbacreview;
                        
                $output = false;
                $items = $this->getObjectsByMembership();
                $item_html = array();           
                if(count($items) > 0)
                {
                        include_once("./Services/Object/classes/class.ilObjectListGUIPreloader.php");
                        $preloader = new ilObjectListGUIPreloader(ilObjectListGUI::CONTEXT_PERSONAL_DESKTOP);
                        foreach($items as $item)
                        {
                                $preloader->addItem($item["obj_id"], $item["type"], $item["ref_id"]);                           
                        }
                        $preloader->preload();
                        unset($preloader);
                        
                        reset($items);
                        foreach($items as $item)
                        {
                                //echo "1";
                                // get list gui class for each object type
                                if ($cur_obj_type != $item["type"])
                                {
                                        $item_list_gui = $this->getItemListGUI($item["type"]);
                                        if(!$item_list_gui)
                                        {
                                                continue;
                                        }                                       
                                                                                
                                        // notes, comment currently do not work properly
                                        $item_list_gui->enableNotes(false);
                                        $item_list_gui->enableComments(false);
                                        $item_list_gui->enableTags(false);
                                        
                                        $item_list_gui->enableIcon(true);
                                        $item_list_gui->enableDelete(false);
                                        $item_list_gui->enableCut(false);
                                        $item_list_gui->enableCopy(false);
                                        $item_list_gui->enableLink(false);
                                        $item_list_gui->enableInfoScreen(true);
                                        if ($ilSetting->get('disable_my_offers') == 1)
                                        {
                                                $item_list_gui->enableSubscribe(false);
                                        }
                                        else
                                        {
                                                $item_list_gui->enableSubscribe(true);
                                        }
                                        $item_list_gui->setContainerObject($this);
                                        if ($this->getCurrentDetailLevel() < 3 || $this->manage)
                                        {
                                                //echo "3";
                                                $item_list_gui->enableDescription(false);
                                                $item_list_gui->enableProperties(false);
                                                $item_list_gui->enablePreconditions(false);
                                        }
                                        if ($this->getCurrentDetailLevel() < 2 || $this->manage)
                                        {
                                                $item_list_gui->enableCommands(true, true);
                                        }
                                }
                                // render item row
                                $ilBench->start("ilPersonalDesktopGUI", "getListHTML");
                                
                                if (is_object($item_list_gui))
                                {                                       
                                        ilObjectActivation::addListGUIActivationProperty($item_list_gui, $item);                                                        
                                        
                                        // #15232
                                        if($this->manage)
                                        {
                                                if(!$rbacsystem->checkAccess("leave", $item["ref_id"]))
                                                {
                                                        $item_list_gui->enableCheckbox(false);
                                                }
                                                else
                                                {
                                                        $item_list_gui->enableCheckbox(true);
                                                }
                                        }
                                        
                                        $html = $item_list_gui->getListItemHTML($item["ref_id"],
                                        $item["obj_id"], $item["title"], $item["description"]);
                                        $ilBench->stop("ilPersonalDesktopGUI", "getListHTML");
                                        if ($html != "")
                                        {
                                                // BEGIN WebDAV: Use $item_list_gui to determine icon image type
                                                $item_html[] = array(
                                                        "html" => $html, 
                                                        "item_ref_id" => $item["ref_id"],
                                                        "item_obj_id" => $item["obj_id"],
                                                        "parent_ref" => $item["parent_ref"],
                                                        "type" => $item["type"],
                                                        'item_icon_image_type' => $item_list_gui->getIconImageType()
                                                        );
                                                // END WebDAV: Use $item_list_gui to determine icon image type
                                        }
                                }
                        }
                        
                        // output block for resource type
                        if (count($item_html) > 0)
                        {
                                $cur_parent_ref = 0;
                                
                                // content row
                                foreach($item_html as $item)
                                {
                                        // add a parent header row for each new parent
                                        if ($cur_parent_ref != $item["parent_ref"])
                                        {
                                                if ($ilSetting->get("icon_position_in_lists") == "item_rows")
                                                {
                                                        $this->addParentRow($tpl, $item["parent_ref"], false);
                                                }
                                                else
                                                {
                                                        $this->addParentRow($tpl, $item["parent_ref"]);
                                                }
                                                $this->resetRowType();
                                                $cur_parent_ref = $item["parent_ref"];
                                        }
                                        
                                        // BEGIN WebDAV: Use $item_list_gui to determine icon image type.
                                        $this->addStandardRow($tpl, $item["html"], $item["item_ref_id"], $item["item_obj_id"], 
                                                $item['item_icon_image_type'], 
                                                "th_".$cur_parent_ref);
                                        // END WebDAV: Use $item_list_gui to determine icon image type.
                                        $output = true;
                                }
                        }
                }
                
                return $output;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getMembershipItemsPerType()

ilPDSelectedItemsBlockGUI::getMembershipItemsPerType

(

$tpl

)

Generates the block html string by type ordering.

public

Parameters

ilTemplate

$tpl

the current template instance

Definition at line 622 of file class.ilPDSelectedItemsBlockGUI.php.

References $a_type, $html, $ilBench, $ilSetting, $ilUser, $location, $output, $t, $title, $tpl, addHeaderRow(), ilObjectActivation\addListGUIActivationProperty(), addStandardRow(), array, ilObjectListGUI\CONTEXT_PERSONAL_DESKTOP, ilBlockGUI\getCurrentDetailLevel(), getObjectsByMembership(), and resetRowType().

Referenced by getMembershipItemsBlockHTML().

        {
                global $ilUser, $rbacsystem, $objDefinition, $ilBench, $ilSetting, $ilObjDataCache;

                $output = false;
                
                $objtype_groups = $objDefinition->getGroupedRepositoryObjectTypes(
                        array("cat", "crs", "grp", "fold"));

                $types = array();
                foreach($objtype_groups as $grp => $grpdata)
                {
                        $types[] = array(
                                "grp" => $grp,
                                "title" => $this->lng->txt("objs_".$grp),
                                "types" => $grpdata["objs"]);
                }

                include_once("./Services/Object/classes/class.ilObjectListGUIPreloader.php");
                
                foreach ($types as $t)
                {                       
                        $type = $t["types"];
                        $title = $t["title"];
                        $grp = $t["grp"];

                        $items = $this->getObjectsByMembership($type);
                
                        if (count($items) > 0)
                        {                                                               
                                $preloader = new ilObjectListGUIPreloader(ilObjectListGUI::CONTEXT_PERSONAL_DESKTOP);
                                foreach($items as $item)
                                {
                                        $preloader->addItem($item["obj_id"], $item["type"], $item["ref_id"]);                           
                                }
                                $preloader->preload();
                                unset($preloader);

                                reset($items);                          

                                
                                $item_html = array();

                                if ($this->getCurrentDetailLevel() == 3)
                                {
                                        $rel_header = "th_".$grp;
                                }
                                                        
                                $tstCount = 0;
                                $unsetCount = 0;
                                $progressCount = 0;
                                $unsetFlag = 0;
                                $progressFlag = 0;
                                $completedFlag = 0;
                                if (strcmp($a_type, "tst") == 0) {
                                        $items = $this->multiarray_sort($items, "used_tries; title");
                                        foreach ($items as $tst_item) {
                                                if (!isset($tst_item["used_tries"])) {
                                                        $unsetCount++;
                                                }
                                                elseif ($tst_item["used_tries"] == 0) {
                                                        $progressCount++;
                                                }
                                        }
                                }
                                
                                foreach($items as $item)
                                {
                                        // get list gui class for each object type
                                        if ($cur_obj_type != $item["type"])
                                        {
                                                $class = $objDefinition->getClassName($item["type"]);
                                                $location = $objDefinition->getLocation($item["type"]);
                                                $full_class = "ilObj".$class."ListGUI";
                                                include_once($location."/class.".$full_class.".php");
                                                $item_list_gui = new $full_class();
                                                
                                                // notes, comment currently do not work properly
                                                $item_list_gui->enableNotes(false);
                                                $item_list_gui->enableComments(false);
                                                $item_list_gui->enableTags(false);
                                                
                                                $item_list_gui->enableIcon(true);
                                                $item_list_gui->enableDelete(false);
                                                $item_list_gui->enableCut(false);
                                                $item_list_gui->enableCopy(false);
                                                $item_list_gui->enableLink(false);
                                                $item_list_gui->enableInfoScreen(true);
                                                if ($ilSetting->get('disable_my_offers') == 1)
                                                {
                                                        $item_list_gui->enableSubscribe(false);
                                                }
                                                else
                                                {
                                                        $item_list_gui->enableSubscribe(true);
                                                }

                                                $item_list_gui->setContainerObject($this);
                                                if ($this->manage)
                                                {
                                                        $item_list_gui->enableCheckbox(true);
                                                }
                                                if ($this->getCurrentDetailLevel() < 3 || $this->manage)
                                                {
                                                        $item_list_gui->enableDescription(false);
                                                        $item_list_gui->enableProperties(false);
                                                        $item_list_gui->enablePreconditions(false);
                                                        $item_list_gui->enableNoticeProperties(false);
                                                }
                                                if ($this->getCurrentDetailLevel() < 2 || $this->manage)
                                                {
                                                        $item_list_gui->enableCommands(true, true);
                                                }
                                        }
                                        // render item row
                                        $ilBench->start("ilPersonalDesktopGUI", "getListHTML");
                                                                                
                                        ilObjectActivation::addListGUIActivationProperty($item_list_gui, $item);                                                        
                                                
                                        // #15232
                                        if($this->manage)
                                        {
                                                if(!$rbacsystem->checkAccess("leave", $item["ref_id"]))
                                                {
                                                        $item_list_gui->enableCheckbox(false);
                                                }
                                                else
                                                {
                                                        $item_list_gui->enableCheckbox(true);
                                                }
                                        }
                                        
                                        $html = $item_list_gui->getListItemHTML($item["ref_id"],
                                        $item["obj_id"], $item["title"], $item["description"]);
                                        $ilBench->stop("ilPersonalDesktopGUI", "getListHTML");
                                        if ($html != "")
                                        {
                                                // BEGIN WebDAV: Use $item_list_gui to determine icon image type
                                                $item_html[] = array(
                                                        "html" => $html, 
                                                        "item_ref_id" => $item["ref_id"],
                                                        "item_obj_id" => $item["obj_id"],
                                                        'item_icon_image_type' => (method_exists($item_list_gui, 'getIconImageType')) ?
                                                                        $item_list_gui->getIconImageType() :
                                                                        $item['type']
                                                        );
                                                // END WebDAV: Use $item_list_gui to determine icon image type
                                        }
                                }
                                
                                // output block for resource type
                                if (count($item_html) > 0)
                                {
                                        // add a header for each resource type
                                        if ($this->getCurrentDetailLevel() == 3)
                                        {
                                                if ($ilSetting->get("icon_position_in_lists") == "item_rows")
                                                {
                                                        $this->addHeaderRow($tpl, $grp, false);
                                                }
                                                else
                                                {
                                                        $this->addHeaderRow($tpl, $grp);
                                                }
                                                $this->resetRowType();
                                        }
                                        
                                        // content row
                                        foreach($item_html as $item)
                                        {
                                                if ($this->getCurrentDetailLevel() < 3 ||
                                                $ilSetting->get("icon_position_in_lists") == "item_rows")
                                                {
                                                        // BEGIN WebDAV: Use $item_list_gui to determine icon image type
                                                                $this->addStandardRow($tpl, $item["html"], $item["item_ref_id"], $item["item_obj_id"], 
                                                                        $item['item_icon_image_type'], 
                                                                        $rel_header);
                                                        // END WebDAV: Use $item_list_gui to determine icon image type
                                                }
                                                else
                                                {
                                                        $this->addStandardRow($tpl, $item["html"], $item["item_ref_id"], $item["item_obj_id"], "", $rel_header);
                                                }
                                                $output = true;
                                        }
                                }
                        }
                }
                
                return $output;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getObjectsByMembership()

ilPDSelectedItemsBlockGUI::getObjectsByMembership (   $types = array() )

protected

Gets all objects the current user is member of.

protected

Returns

Array $items array of objects

Definition at line 411 of file class.ilPDSelectedItemsBlockGUI.php.

References $ilUser, $ref_id, $title, ilObject\_getAllReferences(), ilParticipants\_getMembershipByType(), and array.

Referenced by getMembershipItemsPerLocation(), and getMembershipItemsPerType().

        {       
                global $tree, $ilUser, $ilObjDataCache;
                
                include_once 'Services/Membership/classes/class.ilParticipants.php';
                $items = array();
                
                if(is_array($types) && count($types))
                {
                        foreach($types as $type)
                        {
                                switch($type)
                                {
                                        case 'grp':
                                                $items = array_merge(ilParticipants::_getMembershipByType($ilUser->getId(), 'grp'), $items);
                                                break;
                                        case 'crs':
                                                $items = array_merge(ilParticipants::_getMembershipByType($ilUser->getId(), 'crs'), $items);
                                                break;
                                        default:                                
                                                break;                  
                                }       
                        }
                }
                else
                {
                        $crs_mbs = ilParticipants::_getMembershipByType($ilUser->getId(), 'crs');
                        $grp_mbs = ilParticipants::_getMembershipByType($ilUser->getId(), 'grp');
                        $items = array_merge($crs_mbs, $grp_mbs);
                }

                $references = array();
                foreach($items as $key => $obj_id)
                {
                        $item_references = ilObject::_getAllReferences($obj_id);
                        foreach($item_references as $ref_id)
                        {
                                if($tree->isInTree($ref_id))
                                {
                                        $title = $ilObjDataCache->lookupTitle($obj_id);
                                        $type  = $ilObjDataCache->lookupType($obj_id);

                                        $parent_ref_id = $tree->getParentId($ref_id);
                                        $par_left      = $tree->getLeftValue($parent_ref_id);
                                        $par_left      = sprintf("%010d", $par_left);

                                        $references[$par_left . $title . $ref_id] =     array(
                                                'ref_id'      => $ref_id,
                                                'obj_id'      => $obj_id,
                                                'type'        => $type,
                                                'title'       => $title,
                                                'description' => $ilObjDataCache->lookupDescription($obj_id),
                                                'parent_ref'  => $parent_ref_id
                                        );
                                }
                        }
                }
                ksort($references);
                return is_array($references) ? $references : array();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getScreenMode()

static ilPDSelectedItemsBlockGUI::getScreenMode ( )

static

Definition at line 176 of file class.ilPDSelectedItemsBlockGUI.php.

References $_GET, $_POST, $cmd, IL_SCREEN_FULL, and IL_SCREEN_SIDE.

        {       
                $cmd = $_GET["cmd"];
                if($cmd == "post")
                {
                        $cmd = $_POST["cmd"];
                        $cmd = array_shift(array_keys($cmd));
                }
                
                switch($cmd)
                {
                        case "confirmRemove":
                        case "manage":                          
                                return IL_SCREEN_FULL;
                                
                        default:
                                return IL_SCREEN_SIDE;
                }
        }

getSelectedItemsBlockHTML()

ilPDSelectedItemsBlockGUI::getSelectedItemsBlockHTML

(

)

get selected item block

Definition at line 843 of file class.ilPDSelectedItemsBlockGUI.php.

References $ilBench, $ilUser, $ok, $tpl, getSelectedItemsPerLocation(), getSelectedItemsPerType(), and newBlockTemplate().

Referenced by getHTML().

        {
                global $ilUser, $rbacsystem, $objDefinition, $ilBench;

                $tpl = $this->newBlockTemplate();
                
                switch ($ilUser->getPref("pd_order_items"))
                {
                        case "location":
                        $ok = $this->getSelectedItemsPerLocation($tpl);
                        break;
                        
                        default:
                        $ok = $this->getSelectedItemsPerType($tpl);
                        break;
                }
                
                if($this->manage)
                {
                        // #11355 - see ContainerContentGUI::renderSelectAllBlock()                     
                        $tpl->setCurrentBlock("select_all_row");
                        $tpl->setVariable("CHECKBOXNAME", "ilToolbarSelectAll");
                        $tpl->setVariable("SEL_ALL_PARENT", "ilToolbar");
                        $tpl->setVariable("SEL_ALL_CB_NAME", "id");
                        $tpl->setVariable("TXT_SELECT_ALL", $this->lng->txt("select_all"));
                        $tpl->parseCurrentBlock();                      
                }
                
                return $tpl->get();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getSelectedItemsPerLocation()

ilPDSelectedItemsBlockGUI::getSelectedItemsPerLocation

(

&

$tpl

)

get selected items per type

Definition at line 1055 of file class.ilPDSelectedItemsBlockGUI.php.

References $html, $ilBench, $ilSetting, $ilUser, $output, $tpl, ilObjectActivation\addListGUIActivationProperty(), addParentRow(), addStandardRow(), array, ilObjectListGUI\CONTEXT_PERSONAL_DESKTOP, ilBlockGUI\getCurrentDetailLevel(), getItemListGUI(), and resetRowType().

Referenced by getSelectedItemsBlockHTML().

        {
                global $ilUser, $rbacsystem, $objDefinition, $ilBench, $ilSetting, $ilObjDataCache, $tree;

                $output = false;

                $items = $ilUser->getDesktopItems();
                $item_html = array();
                $cur_obj_type = "";

                if (count($items) > 0)
                {
                        include_once("./Services/Object/classes/class.ilObjectListGUIPreloader.php");
                        $preloader = new ilObjectListGUIPreloader(ilObjectListGUI::CONTEXT_PERSONAL_DESKTOP);
                        foreach($items as $item)
                        {
                                $preloader->addItem($item["obj_id"], $item["type"], $item["ref_id"]);                           
                        }
                        $preloader->preload();
                        unset($preloader);
                        
                        reset($items);
                        foreach($items as $item)
                        {
                                //echo "1";
                                // get list gui class for each object type
                                if ($cur_obj_type != $item["type"])
                                {
                                        $item_list_gui = $this->getItemListGUI($item["type"]);
                                        if(!$item_list_gui)
                                        {
                                                continue;
                                        }
                                        
                                        // notes, comment currently do not work properly
                                        $item_list_gui->enableNotes(false);
                                        $item_list_gui->enableComments(false);
                                        $item_list_gui->enableTags(false);
                                        
                                        $item_list_gui->enableIcon(true);
                                        $item_list_gui->enableDelete(false);
                                        $item_list_gui->enableCut(false);
                                        $item_list_gui->enableCopy(false);
                                        $item_list_gui->enableLink(false);
                                        $item_list_gui->enableInfoScreen(true);
                                        if ($this->getCurrentDetailLevel() < 3 || $this->manage)
                                        {
                                                //echo "3";
                                                $item_list_gui->enableDescription(false);
                                                $item_list_gui->enableProperties(false);
                                                $item_list_gui->enablePreconditions(false);
                                        }
                                        if ($this->getCurrentDetailLevel() < 2 || $this->manage)
                                        {
                                                $item_list_gui->enableCommands(true, true);
                                        }
                                }
                                // render item row
                                $ilBench->start("ilPersonalDesktopGUI", "getListHTML");
                                                                                                        
                                ilObjectActivation::addListGUIActivationProperty($item_list_gui, $item);                                                                                                
                                
                                $item_list_gui->setContainerObject($this);
                                $html = $item_list_gui->getListItemHTML($item["ref_id"],
                                $item["obj_id"], $item["title"], $item["description"]);
                                $ilBench->stop("ilPersonalDesktopGUI", "getListHTML");
                                if ($html != "")
                                {
                                        $item_html[] = array(
                                                "html" => $html, 
                                                "item_ref_id" => $item["ref_id"],
                                                "item_obj_id" => $item["obj_id"],
                                                "parent_ref" => $item["parent_ref"],
                                                "type" => $item["type"],
                                                'item_icon_image_type' => $item_list_gui->getIconImageType()
                                                );
                                }
                        }
                        
                        // output block for resource type
                        if (count($item_html) > 0)
                        {
                                $cur_parent_ref = 0;
                                
                                // content row
                                foreach($item_html as $item)
                                {
                                        // add a parent header row for each new parent
                                        if ($cur_parent_ref != $item["parent_ref"])
                                        {
                                                if ($ilSetting->get("icon_position_in_lists") == "item_rows")
                                                {
                                                        $this->addParentRow($tpl, $item["parent_ref"], false);
                                                }
                                                else
                                                {
                                                        $this->addParentRow($tpl, $item["parent_ref"]);
                                                }
                                                $this->resetRowType();
                                                $cur_parent_ref = $item["parent_ref"];
                                        }
                                        
                                        $this->addStandardRow($tpl, $item["html"], $item["item_ref_id"], $item["item_obj_id"],
                                                $item['item_icon_image_type'], 
                                                "th_".$cur_parent_ref);
                                        $output = true;
                                }
                        }
                }
                
                return $output;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getSelectedItemsPerType()

ilPDSelectedItemsBlockGUI::getSelectedItemsPerType

(

&

$tpl

)

get selected items per type

Definition at line 877 of file class.ilPDSelectedItemsBlockGUI.php.

References $a_type, $html, $ilBench, $ilCtrl, $ilSetting, $ilUser, $location, $output, $t, $title, $tpl, addHeaderRow(), ilObjectActivation\addListGUIActivationProperty(), addStandardRow(), array, ilObjectListGUI\CONTEXT_PERSONAL_DESKTOP, ilBlockGUI\getCurrentDetailLevel(), and resetRowType().

Referenced by getSelectedItemsBlockHTML().

        {
                global $ilUser, $rbacsystem, $objDefinition, $ilBench, $ilSetting, $ilObjDataCache, $tree, $ilCtrl;
                
                $items = $ilUser->getDesktopItems();
                if (count($items) > 0)
                {                       
                        include_once("./Services/Object/classes/class.ilObjectListGUIPreloader.php");
                        $preloader = new ilObjectListGUIPreloader(ilObjectListGUI::CONTEXT_PERSONAL_DESKTOP);
                        foreach($items as $item)
                        {
                                $preloader->addItem($item["obj_id"], $item["type"], $item["ref_id"]);                           
                        }
                        $preloader->preload();
                        unset($preloader);
                        
                        reset($items);          
                }
                
                $output = false;
                
                $objtype_groups = $objDefinition->getGroupedRepositoryObjectTypes(
                        array("cat", "crs", "grp", "fold"));

                $types = array();
                foreach($objtype_groups as $grp => $grpdata)
                {
                        $types[] = array(
                                "grp" => $grp,
                                "title" => $this->lng->txt("objs_".$grp),
                                "types" => $grpdata["objs"]);
                }
                
                foreach ($types as $t)
                {
                        
                        $type = $t["types"];
                        $title = $t["title"];
                        $grp = $t["grp"];

                        $items = $ilUser->getDesktopItems($type);
                        $item_html = array();
                        
                        if ($this->getCurrentDetailLevel() == 3)
                        {
                                $rel_header = "th_".$grp;
                        }
                        
                        if (count($items) > 0)
                        {
                                $tstCount = 0;
                                $unsetCount = 0;
                                $progressCount = 0;
                                $unsetFlag = 0;
                                $progressFlag = 0;
                                $completedFlag = 0;
                                if (strcmp($a_type, "tst") == 0) {
                                        $items = $this->multiarray_sort($items, "used_tries; title");
                                        foreach ($items as $tst_item) {
                                                if (!isset($tst_item["used_tries"])) {
                                                        $unsetCount++;
                                                }
                                                elseif ($tst_item["used_tries"] == 0) {
                                                        $progressCount++;
                                                }
                                        }
                                }
                                
                                foreach($items as $item)
                                {
                                        // get list gui class for each object type
                                        if ($cur_obj_type != $item["type"])
                                        {
                                                $class = $objDefinition->getClassName($item["type"]);
                                                $location = $objDefinition->getLocation($item["type"]);
                                                $full_class = "ilObj".$class."ListGUI";
                                                include_once($location."/class.".$full_class.".php");
                                                $item_list_gui = new $full_class();
                                                
                                                // notes, comment currently do not work properly
                                                $item_list_gui->enableNotes(false);
                                                $item_list_gui->enableComments(false);
                                                $item_list_gui->enableTags(false);
                                                
                                                $item_list_gui->enableIcon(true);
                                                $item_list_gui->enableDelete(false);
                                                $item_list_gui->enableCut(false);
                                                $item_list_gui->enableCopy(false);
                                                $item_list_gui->enableLink(false);
                                                $item_list_gui->enableInfoScreen(true);
                                                $item_list_gui->setContainerObject($this);
                                                
                                                if ($this->manage)
                                                {
                                                        $item_list_gui->enableCheckbox(true);
                                                }
                                                
                                                if ($this->getCurrentDetailLevel() < 3 || $this->manage)
                                                {
                                                        $item_list_gui->enableDescription(false);
                                                        $item_list_gui->enableProperties(false);
                                                        $item_list_gui->enablePreconditions(false);
                                                        $item_list_gui->enableNoticeProperties(false);
                                                }
                                                if ($this->getCurrentDetailLevel() < 2 || $this->manage)
                                                {
                                                        $item_list_gui->enableCommands(true, true);
                                                }
                                        }
                                        // render item row
                                        $ilBench->start("ilPersonalDesktopGUI", "getListHTML");
                                                
                                        include_once './Services/Object/classes/class.ilObjectActivation.php';
                                        ilObjectActivation::addListGUIActivationProperty($item_list_gui, $item);                                                        
                                                
                                        $html = $item_list_gui->getListItemHTML($item["ref_id"],
                                        $item["obj_id"], $item["title"], $item["description"]);
                                        $ilBench->stop("ilPersonalDesktopGUI", "getListHTML");
                                        if ($html != "")
                                        {
                                                // BEGIN WebDAV: Use $item_list_gui to determine icon image type
                                                $item_html[] = array(
                                                        "html" => $html, 
                                                        "item_ref_id" => $item["ref_id"],
                                                        "item_obj_id" => $item["obj_id"],
                                                        'item_icon_image_type' => (method_exists($item_list_gui, 'getIconImageType')) ?
                                                                        $item_list_gui->getIconImageType() :
                                                                        $item['type']
                                                        );
                                                // END WebDAV: Use $item_list_gui to determine icon image type
                                        }
                                }
                                
                                // output block for resource type
                                if (count($item_html) > 0)
                                {
                                        // add a header for each resource type
                                        if ($this->getCurrentDetailLevel() == 3)
                                        {
                                                if ($ilSetting->get("icon_position_in_lists") == "item_rows")
                                                {
                                                        $this->addHeaderRow($tpl, $grp, false);
                                                }
                                                else
                                                {
                                                        $this->addHeaderRow($tpl, $grp);
                                                }
                                                $this->resetRowType();
                                        }
                                        
                                        // content row
                                        foreach($item_html as $item)
                                        {
                                                if ($this->getCurrentDetailLevel() < 3 ||
                                                $ilSetting->get("icon_position_in_lists") == "item_rows")
                                                {
                                                        // BEGIN WebDAV: Use $item_list_gui to determine icon image type
                                                                $this->addStandardRow($tpl, $item["html"], $item["item_ref_id"], $item["item_obj_id"], 
                                                                        $item['item_icon_image_type'], 
                                                                        $rel_header);
                                                        // END WebDAV: Use $item_list_gui to determine icon image type
                                                }
                                                else
                                                {
                                                        $this->addStandardRow($tpl, $item["html"], $item["item_ref_id"], $item["item_obj_id"], "", $rel_header);
                                                }
                                                $output = true;
                                        }
                                }
                        }
                }
                
                return $output;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

isRepositoryObject()

static ilPDSelectedItemsBlockGUI::isRepositoryObject ( )

static

Get block type.

Returns

string Block type.

Definition at line 201 of file class.ilPDSelectedItemsBlockGUI.php.

        {
                return false;
        }

manageObject()

ilPDSelectedItemsBlockGUI::manageObject

(

)

Definition at line 1493 of file class.ilPDSelectedItemsBlockGUI.php.

References $ilCtrl, $ilUser, $lng, array, ilUtil\getImagePath(), ilSubmitButton\getInstance(), and ilBlockGUI\setAvailableDetailLevels().

        {       
                global $ilUser, $objDefinition, $ilCtrl, $lng;
                
                $objects = array();
                
                $this->manage = true;
                $this->setAvailableDetailLevels(1, 1);
                
                $top_tb = new ilToolbarGUI();
                $top_tb->setFormAction($ilCtrl->getFormAction($this));
                $top_tb->setLeadingImage(ilUtil::getImagePath("arrow_upright.svg"), $lng->txt("actions"));

                $button = ilSubmitButton::getInstance();
                if($this->view == self::VIEW_SELECTED_ITEMS)
                {
                        $button->setCaption("remove");
                }
                else
                {
                        $button->setCaption("pd_unsubscribe_memberships");
                }
                $button->setCommand("confirmRemove");
                $top_tb->addStickyItem($button);

                $button2 = ilSubmitButton::getInstance();
                $button2->setCaption("cancel");
                $button2->setCommand("getHTML");
                $top_tb->addStickyItem($button2);

                $top_tb->setCloseFormTag(false);

                $bot_tb = new ilToolbarGUI();
                $bot_tb->setLeadingImage(ilUtil::getImagePath("arrow_downright.svg"), $lng->txt("actions"));
                $bot_tb->addStickyItem($button);
                $bot_tb->addStickyItem($button2);
                $bot_tb->setOpenFormTag(false);
                
                return $top_tb->getHTML().$this->getHTML().$bot_tb->getHTML();
        }

Here is the call graph for this function:

newBlockTemplate()

& ilPDSelectedItemsBlockGUI::newBlockTemplate

(

)

returns a new list block template

private

Returns

object block template

Definition at line 1179 of file class.ilPDSelectedItemsBlockGUI.php.

References $tpl.

Referenced by getMembershipItemsBlockHTML(), and getSelectedItemsBlockHTML().

        {
                $tpl = new ilTemplate("tpl.pd_list_block.html", true, true, "Services/PersonalDesktop");
                $this->cur_row_type = "";
                return $tpl;
        }

Here is the caller graph for this function:

orderPDItemsByLocation()

ilPDSelectedItemsBlockGUI::orderPDItemsByLocation

(

)

order desktop items by location

Definition at line 1454 of file class.ilPDSelectedItemsBlockGUI.php.

References $ilCtrl, $ilUser, exit, and getHTML().

        {
                global $ilUser, $ilCtrl;
                
                $ilUser->writePref("pd_order_items", "location");
                
                if ($ilCtrl->isAsynch())
                {
                        echo $this->getHTML();
                        exit;
                }
                else
                {
                        $ilCtrl->setParameterByClass('ilpersonaldesktopgui', 'view', $this->view);
                        $ilCtrl->redirectByClass("ilpersonaldesktopgui", "show");
                }
        }

Here is the call graph for this function:

orderPDItemsByType()

ilPDSelectedItemsBlockGUI::orderPDItemsByType

(

)

order desktop items by Type

Definition at line 1475 of file class.ilPDSelectedItemsBlockGUI.php.

References $ilCtrl, $ilUser, exit, and getHTML().

        {
                global $ilUser, $ilCtrl;
                
                $ilUser->writePref("pd_order_items", "type");
                
                if ($ilCtrl->isAsynch())
                {
                        echo $this->getHTML();
                        exit;
                }
                else
                {
                        $ilCtrl->setParameterByClass('ilpersonaldesktopgui', 'view', $this->view);
                        $ilCtrl->redirectByClass("ilpersonaldesktopgui", "show");
                }
        }

Here is the call graph for this function:

removeFromDeskObject()

ilPDSelectedItemsBlockGUI::removeFromDeskObject

(

)

See also

ilDesktopItemHandling::removeFromDesk()

Implements ilDesktopItemHandling.

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

References $_GET, $allowed_views, $ilCtrl, $ilSetting, $lng, $view, array, ilDesktopItemGUI\removeFromDesktop(), and ilUtil\sendSuccess().

    {
                global $ilCtrl, $lng;
                
                include_once './Services/PersonalDesktop/classes/class.ilDesktopItemGUI.php';
                ilDesktopItemGUI::removeFromDesktop();
                ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
                $ilCtrl->setParameterByClass('ilpersonaldesktopgui', 'view', $this->view);
                $ilCtrl->redirectByClass('ilpersonaldesktopgui', 'show');
    }

Here is the call graph for this function:

resetRowType()

ilPDSelectedItemsBlockGUI::resetRowType

(

)

Definition at line 1168 of file class.ilPDSelectedItemsBlockGUI.php.

Referenced by getMembershipItemsPerLocation(), getMembershipItemsPerType(), getSelectedItemsPerLocation(), and getSelectedItemsPerType().

        {
                $this->cur_row_type = "";
        }

Here is the caller graph for this function:

setContent()

ilPDSelectedItemsBlockGUI::setContent

(

$a_content

)

Definition at line 308 of file class.ilPDSelectedItemsBlockGUI.php.

References $a_content.

Referenced by getHTML().

        {
                $this->content = $a_content;
        }

Here is the caller graph for this function:

setFooterLinks()

ilPDSelectedItemsBlockGUI::setFooterLinks

(

)

Set footer links.

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

References ilBlockGUI\$block_id, $ilCtrl, $ilUser, $lng, ilBlockGUI\addFooterLink(), getContent(), and ilBlockGUI\setEnableNumInfo().

Referenced by fillFooter().

        {
                global $ilUser, $ilCtrl, $lng;
                
                if ($this->getContent() == "")
                {
                        $this->setEnableNumInfo(false);
                        return "";
                }
                
                if ($this->manage)
                {
                        return;
                }
                
                // by type
//              if ($ilUser->getPref("pd_order_items") == 'location')
//              {
                        $this->addFooterLink( $lng->txt("by_type"),
                                $ilCtrl->getLinkTarget($this, "orderPDItemsByType"),
                                $ilCtrl->getLinkTarget($this, "orderPDItemsByType", "", true),
                                "block_".$this->getBlockType()."_".$this->block_id,
                                false, false, ($ilUser->getPref("pd_order_items") != 'location')
                                );
//              }
//              else
//              {
//                      $this->addFooterLink($lng->txt("by_type"));
//              }

//              // by location
//              if ($ilUser->getPref("pd_order_items") == 'location')
//              {
//                      $this->addFooterLink($lng->txt("by_location"));
//              }
//              else
//              {
                        $this->addFooterLink( $lng->txt("by_location"),
                                $ilCtrl->getLinkTarget($this, "orderPDItemsByLocation"),
                                $ilCtrl->getLinkTarget($this, "orderPDItemsByLocation", "", true),
                                "block_".$this->getBlockType()."_".$this->block_id,
                                false, false, ($ilUser->getPref("pd_order_items") == 'location')
                                );
//              }
                
                $this->addFooterLink(($this->view == self::VIEW_SELECTED_ITEMS) ?
                                $lng->txt("pd_remove_multiple") :
                                $lng->txt("pd_unsubscribe_multiple_memberships"),                       
                        $ilCtrl->getLinkTarget($this, "manage"),
                        null,
                        "block_".$this->getBlockType()."_".$this->block_id
                        );
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$allowed_views

ilPDSelectedItemsBlockGUI::$allowed_views = array()

private

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

Referenced by removeFromDeskObject().

$block_type

ilPDSelectedItemsBlockGUI::$block_type = "pditems"

static

Definition at line 24 of file class.ilPDSelectedItemsBlockGUI.php.

$view

ilPDSelectedItemsBlockGUI::$view = self::VIEW_SELECTED_ITEMS

private

Definition at line 26 of file class.ilPDSelectedItemsBlockGUI.php.

Referenced by getHTML(), and removeFromDeskObject().

VIEW_MY_MEMBERSHIPS

const ilPDSelectedItemsBlockGUI::VIEW_MY_MEMBERSHIPS = 1

Definition at line 21 of file class.ilPDSelectedItemsBlockGUI.php.

Referenced by ilPersonalDesktopGUI\setTabs().

VIEW_MY_STUDYPROGRAMME

const ilPDSelectedItemsBlockGUI::VIEW_MY_STUDYPROGRAMME = 2

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

Referenced by ilPDStudyProgrammeSimpleListGUI\readToShowInfoMessage().

VIEW_SELECTED_ITEMS

const ilPDSelectedItemsBlockGUI::VIEW_SELECTED_ITEMS = 0

Definition at line 20 of file class.ilPDSelectedItemsBlockGUI.php.

Referenced by ilPersonalDesktopGUI\setTabs().

---

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

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