ilPDSelectedItemsBlockGUI Class Reference

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

Inheritance diagram for ilPDSelectedItemsBlockGUI:

Collaboration diagram for ilPDSelectedItemsBlockGUI:

Public Member Functions
	__construct ()
	ilPDSelectedItemsBlockGUI constructor. More...
	getViewSettings ()
	isManagedView ()
	fillDetailRow ()
	addToDeskObject ()
	Add desktop item public. More...
	removeFromDeskObject ()
	Remove from desktop public. More...
	getHTML ()
	getFooterLinks ()
	executeCommand ()
	fillDataSection ()
	fillFooter ()
	newBlockTemplate ()
	returns a new list 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...
	orderPDItemsByLocation ()
	Sort desktop items by location. More...
	orderPDItemsByType ()
	Sort desktop items by Type. More...
	orderPDItemsByStartDate ()
	Sort desktop items by start date. 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 ()
static	getScreenMode ()
static	isRepositoryObject ()
Static Public Member Functions inherited from ilBlockGUI
static	getBlockType ()
static	isRepositoryObject ()
static	getScreenMode ()
	Get Screen Mode for current command. More...

Static Public Attributes
static	$block_type = 'pditems'

Protected Member Functions
	initViewSettings ()
	getContent ()
	setContent ($a_content)
	setFooterLinks ()
	getViewBlockHtml ()
	get selected item block More...
	resetRowType ()
	addSectionHeader (ilTemplate $a_tpl, ilPDSelectedItemsBlockGroup $group)
	changeSortMode ($sort_type)
Protected Member Functions inherited from ilBlockGUI
	fillRowColor ($a_placeholder="CSS_ROW")
	preloadData (array $data)
	Can be overwritten in subclasses. More...

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

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

(

)

ilPDSelectedItemsBlockGUI constructor.

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

References $DIC, initViewSettings(), ilBlockGUI\setAvailableDetailLevels(), ilBlockGUI\setEnableNumInfo(), ilBlockGUI\setLimit(), settings(), and user().

    {
        global $DIC;
        $this->rbacsystem = $DIC->rbac()->system();
        $this->settings = $DIC->settings();
        $this->obj_definition = $DIC["objDefinition"];
        $this->access = $DIC->access();

        parent::__construct();

        $this->lng  = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();

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

        $this->setEnableNumInfo(false);
        $this->setLimit(99999);
        $this->setAvailableDetailLevels(3, 1);
        $this->allow_moving = false;

        $this->initViewSettings();
    }

Here is the call graph for this function:

Member Function Documentation

addSectionHeader()

ilPDSelectedItemsBlockGUI::addSectionHeader ( ilTemplate  $a_tpl, ilPDSelectedItemsBlockGroup  $group  )

protected

Parameters

ilTemplate	$a_tpl
ilPDSelectedItemsBlockGroup	$group

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

References ilPDSelectedItemsBlockGroup\getIconPath(), ilPDSelectedItemsBlockGroup\getLabel(), ilPDSelectedItemsBlockGroup\hasIcon(), ilTemplate\parseCurrentBlock(), resetRowType(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilTemplate\touchBlock().

Referenced by setFooterLinks().

    {
        if ($group->hasIcon()) {
            $a_tpl->setCurrentBlock('container_header_row_image');
            $a_tpl->setVariable('HEADER_IMG', $group->getIconPath());
            $a_tpl->setVariable('HEADER_ALT', $group->getLabel());
        } else {
            $a_tpl->setCurrentBlock('container_header_row');
        }

        $a_tpl->setVariable('BLOCK_HEADER_CONTENT', $group->getLabel());
        $a_tpl->setVariable('BLOCK_HEADER_ID', 'th_' . md5($group->getLabel()));
        $a_tpl->parseCurrentBlock();

        $a_tpl->touchBlock('container_row');

        $this->resetRowType();
    }

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 513 of file class.ilPDSelectedItemsBlockGUI.php.

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

Referenced by setFooterLinks().

      {
        $ilSetting = $this->settings;
        
        $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

(

)

Add desktop item public.

Implements ilDesktopItemHandling.

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

References ilDesktopItemGUI\addToDesktop(), and ilUtil\sendSuccess().

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

Here is the call graph for this function:

changeSortMode()

ilPDSelectedItemsBlockGUI::changeSortMode (   $sort_type )

protected

Parameters

string

$sort_type

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

References exit, getHTML(), initViewSettings(), and user().

Referenced by orderPDItemsByLocation(), orderPDItemsByStartDate(), and orderPDItemsByType().

    {
        $this->user->writePref('pd_order_items', $sort_type);
        $this->initViewSettings();

        if ($this->ctrl->isAsynch()) {
            echo $this->getHTML();
            exit;
        }

        $this->ctrl->setParameterByClass('ilpersonaldesktopgui', 'view', $this->viewSettings->getCurrentView());
        $this->ctrl->redirectByClass('ilpersonaldesktopgui', 'show');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmedRemove()

ilPDSelectedItemsBlockGUI::confirmedRemove

(

)

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

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

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        
        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->viewSettings->getCurrentView());
        $ilCtrl->redirectByClass("ilpersonaldesktopgui", "show");
    }

Here is the call graph for this function:

confirmedUnsubscribe()

ilPDSelectedItemsBlockGUI::confirmedUnsubscribe

(

)

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

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

    {
        $ilCtrl = $this->ctrl;
        $ilAccess = $this->access;
        $ilUser = $this->user;
        
        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->viewSettings->getCurrentView());
        $ilCtrl->redirectByClass("ilpersonaldesktopgui", "show");
    }

Here is the call graph for this function:

confirmRemoveObject()

ilPDSelectedItemsBlockGUI::confirmRemoveObject

(

)

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

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

    {
        $ilCtrl = $this->ctrl;

        $ilCtrl->setParameter($this, 'view', $this->viewSettings->getCurrentView());
        if (!sizeof($_POST["id"])) {
            ilUtil::sendFailure($this->lng->txt("select_one"), true);
            $ilCtrl->redirect($this, "manage");
        }
        
        if ($this->viewSettings->isSelectedItemsViewActive()) {
            $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

(

)

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

References ilCommonActionDispatcherGUI\getInstanceFromAjaxCall().

    {
        $next_class = $this->ctrl->getNextClass();
        $cmd        = $this->ctrl->getCmd('getHTML');

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

Here is the call graph for this function:

fillDataSection()

ilPDSelectedItemsBlockGUI::fillDataSection

(

)

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

References getContent(), and ilBlockGUI\setDataSection().

    {
        if ($this->getContent() == '') {
            $this->setDataSection($this->view->getIntroductionHtml());
        } else {
            $this->tpl->setVariable('BLOCK_ROW', $this->getContent());
        }
    }

Here is the call graph for this function:

fillDetailRow()

ilPDSelectedItemsBlockGUI::fillDetailRow

(

)

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

    {
        //              $this->ctrl->setParameterByClass('ilpersonaldesktopgui', 'view', $this->viewSettings->getCurrentView());
        parent::fillDetailRow();
        //              $this->ctrl->setParameterByClass('ilpersonaldesktopgui', 'view', '');
    }

fillFooter()

ilPDSelectedItemsBlockGUI::fillFooter

(

)

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

References ilBlockGUI\fillFooterLinks(), ilBlockGUI\getColSpan(), and setFooterLinks().

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

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

Referenced by setFooterLinks().

    {
        return self::$block_type;
    }

Here is the caller graph for this function:

getContent()

ilPDSelectedItemsBlockGUI::getContent ( )

protected

Returns

string

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

References $content.

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

    {
        return $this->content;
    }

Here is the caller graph for this function:

getFooterLinks()

ilPDSelectedItemsBlockGUI::getFooterLinks

(

)

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

References array.

    {
        if ($this->viewSettings->isStudyProgrammeViewActive()) {
            return array();
        }

        return parent::getFooterLinks();
    }

getHTML()

ilPDSelectedItemsBlockGUI::getHTML

(

)

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

References $DIC, array, getContent(), getViewBlockHtml(), ilHelpGUI\ID_PART_SCREEN, setContent(), ilBlockGUI\setData(), ilBlockGUI\setEnableDetailRow(), and ilBlockGUI\setTitle().

Referenced by changeSortMode(), and manageObject().

    {
        global $DIC;

        $DIC->database()->useSlave(true);

        // workaround to show details row
        $this->setData(array('dummy'));

        require_once 'Services/Object/classes/class.ilObjectListGUI.php';
        ilObjectListGUI::prepareJSLinks(
            '',
            $this->ctrl->getLinkTargetByClass(array('ilcommonactiondispatchergui', 'ilnotegui'), '', '', true, false),
            $this->ctrl->getLinkTargetByClass(array('ilcommonactiondispatchergui', 'iltagginggui'), '', '', true, false)
        );

        $DIC['ilHelp']->setDefaultScreenId(ilHelpGUI::ID_PART_SCREEN, $this->view->getScreenId());
        $this->setTitle($this->view->getTitle());
        $this->setContent($this->getViewBlockHtml());

        if ($this->getContent() == '') {
            $this->setEnableDetailRow(false);
        }

        //              $this->ctrl->clearParametersByClass('ilpersonaldesktopgui');
        $this->ctrl->clearParameters($this);

        $DIC->database()->useSlave(false);

        return parent::getHTML();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getScreenMode()

static ilPDSelectedItemsBlockGUI::getScreenMode ( )

static

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

References $_GET, $_POST, 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;
        }
    }

getViewBlockHtml()

ilPDSelectedItemsBlockGUI::getViewBlockHtml ( )

protected

get selected item block

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

References ilTemplate\get(), ilBlockGUI\getCurrentDetailLevel(), newBlockTemplate(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by getHTML().

    {
        $tpl = $this->newBlockTemplate();

        $this->renderGroupedItems(
            $tpl,
            $this->view->getItemGroups(),
            ($this->getCurrentDetailLevel() >= $this->view->getMinimumDetailLevelForSection())
        );

        if ($this->manage && $this->view->supportsSelectAll()) {
            // #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:

getViewSettings()

ilPDSelectedItemsBlockGUI::getViewSettings

(

)

Returns

ilPDSelectedItemsBlockViewSettings

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

References $viewSettings.

    {
        return $this->viewSettings;
    }

initViewSettings()

ilPDSelectedItemsBlockGUI::initViewSettings ( )

protected

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

References $_GET, ilPDSelectedItemsBlockViewGUI\bySettings(), and user().

Referenced by __construct(), and changeSortMode().

    {
        require_once 'Services/PersonalDesktop/ItemsBlock/classes/class.ilPDSelectedItemsBlockViewSettings.php';
        $this->viewSettings = new ilPDSelectedItemsBlockViewSettings($this->user, (int) $_GET['view']);
        $this->viewSettings->parse();

        require_once 'Services/PersonalDesktop/ItemsBlock/classes/class.ilPDSelectedItemsBlockViewGUI.php';
        $this->view = ilPDSelectedItemsBlockViewGUI::bySettings($this->viewSettings);

        $_GET['view'] = $this->viewSettings->getCurrentView();
        $this->ctrl->saveParameter($this, 'view');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isManagedView()

ilPDSelectedItemsBlockGUI::isManagedView

(

)

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

References $manage.

    {
        return $this->manage;
    }

isRepositoryObject()

static ilPDSelectedItemsBlockGUI::isRepositoryObject ( )

static

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

    {
        return false;
    }

manageObject()

ilPDSelectedItemsBlockGUI::manageObject

(

)

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

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

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $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->viewSettings->isSelectedItemsViewActive()) {
            $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 476 of file class.ilPDSelectedItemsBlockGUI.php.

References ilBlockGUI\$tpl.

Referenced by getViewBlockHtml().

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

(

)

Sort desktop items by location.

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

References changeSortMode().

    {
        $this->changeSortMode($this->viewSettings->getSortByLocationMode());
    }

Here is the call graph for this function:

orderPDItemsByStartDate()

ilPDSelectedItemsBlockGUI::orderPDItemsByStartDate

(

)

Sort desktop items by start date.

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

References changeSortMode().

    {
        $this->changeSortMode($this->viewSettings->getSortByStartDateMode());
    }

Here is the call graph for this function:

orderPDItemsByType()

ilPDSelectedItemsBlockGUI::orderPDItemsByType

(

)

Sort desktop items by Type.

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

References changeSortMode().

    {
        $this->changeSortMode($this->viewSettings->getSortByTypeMode());
    }

Here is the call graph for this function:

removeFromDeskObject()

ilPDSelectedItemsBlockGUI::removeFromDeskObject

(

)

Remove from desktop public.

Implements ilDesktopItemHandling.

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

References ilDesktopItemGUI\removeFromDesktop(), and ilUtil\sendSuccess().

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

Here is the call graph for this function:

resetRowType()

ilPDSelectedItemsBlockGUI::resetRowType ( )

protected

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

Referenced by addSectionHeader(), and setFooterLinks().

    {
        $this->cur_row_type = "";
    }

Here is the caller graph for this function:

setContent()

ilPDSelectedItemsBlockGUI::setContent (   $a_content )

protected

Parameters

string

$a_content

Definition at line 272 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 ( )

protected

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

References ilBlockGUI\$block_id, $html, $output, $rbacsystem, ilBlockGUI\$tpl, ilBlockGUI\addFooterLink(), ilObjectActivation\addListGUIActivationProperty(), addSectionHeader(), addStandardRow(), array, getBlockType(), getContent(), resetRowType(), and ilBlockGUI\setEnableNumInfo().

Referenced by fillFooter().

    {
        if ($this->getContent() == '') {
            $this->setEnableNumInfo(false);
            return '';
        }

        if ($this->manage) {
            return '';
        }

        $this->addFooterLink(
            $this->lng->txt("pd_sort_by_type"),
            $this->ctrl->getLinkTarget($this, "orderPDItemsByType"),
            $this->ctrl->getLinkTarget($this, "orderPDItemsByType", "", true),
            "block_" . $this->getBlockType() . "_" . $this->block_id,
            false,
            false,
            $this->viewSettings->isSortedByType()
        );

        $this->addFooterLink(
            $this->lng->txt("pd_sort_by_location"),
            $this->ctrl->getLinkTarget($this, "orderPDItemsByLocation"),
            $this->ctrl->getLinkTarget($this, "orderPDItemsByLocation", "", true),
            "block_" . $this->getBlockType() . "_" . $this->block_id,
            false,
            false,
            $this->viewSettings->isSortedByLocation()
        );

        if ($this->viewSettings->isMembershipsViewActive()) {
            $this->addFooterLink(
                $this->lng->txt("pd_sort_by_start_date"),
                $this->ctrl->getLinkTarget($this, "orderPDItemsByStartDate"),
                $this->ctrl->getLinkTarget($this, "orderPDItemsByStartDate", "", true),
                "block_" . $this->getBlockType() . "_" . $this->block_id,
                false,
                false,
                $this->viewSettings->isSortedByStartDate()
            );
        }

        $this->addFooterLink(
            $this->viewSettings->isSelectedItemsViewActive() ?
            $this->lng->txt("pd_remove_multiple") :
            $this->lng->txt("pd_unsubscribe_multiple_memberships"),
            $this->ctrl->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

$block_type

ilPDSelectedItemsBlockGUI::$block_type = 'pditems'

static

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

$content

ilPDSelectedItemsBlockGUI::$content = ''

protected

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

Referenced by getContent().

$ctrl

ilPDSelectedItemsBlockGUI::$ctrl

protected

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

Referenced by confirmedRemove(), confirmedUnsubscribe(), confirmRemoveObject(), and manageObject().

$lng

ilPDSelectedItemsBlockGUI::$lng

protected

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

Referenced by manageObject().

$manage

ilPDSelectedItemsBlockGUI::$manage = false

protected

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

Referenced by isManagedView().

$obj_definition

ilPDSelectedItemsBlockGUI::$obj_definition

protected

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

$rbacsystem

ilPDSelectedItemsBlockGUI::$rbacsystem

protected

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

Referenced by setFooterLinks().

$settings

ilPDSelectedItemsBlockGUI::$settings

protected

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

Referenced by addStandardRow().

$user

ilPDSelectedItemsBlockGUI::$user

protected

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

Referenced by confirmedRemove(), and confirmedUnsubscribe().

$view

ilPDSelectedItemsBlockGUI::$view

protected

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

$viewSettings

ilPDSelectedItemsBlockGUI::$viewSettings

protected

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

Referenced by getViewSettings().

---

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

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