ilDashboardRecommendedContentGUI Class Reference

Inheritance diagram for ilDashboardRecommendedContentGUI:

Collaboration diagram for ilDashboardRecommendedContentGUI:

Public Member Functions
	__construct ()
	initViewSettings ()
	emptyHandling ()
	initData ()
	getBlockType ()
	addCustomCommandsToActionMenu (ilObjectListGUI $itemListGui, int $ref_id)
	confirmedRemove (array $ids)
	removeMultipleEnabled ()
	getRemoveMultipleActionText ()
Public Member Functions inherited from ilDashboardBlockGUI
	__construct ()
	initViewSettings ()
	initData ()
	emptyHandling ()
	addCustomCommandsToActionMenu (ilObjectListGUI $itemListGui, int $ref_id)
	getNoItemFoundContent ()
	getViewSettings ()
	init ()
	getHTML ()
	setData (array $a_data)
	getData ()
	addCommandActions ()
	getRemoveModal ()
	executeCommand ()
	manually ()
	getViewControlsForPanel ()
	viewDashboardObject ()
	changePDItemSortingObject ()
	changePDItemPresentationObject ()
	getItemGroups ()
	addToDeskObject ()
	removeFromDeskObject ()
	removeMultipleEnabled ()
	getRemoveMultipleActionText ()
	confirmedRemove (array $ids)
	byType (string $a_type)
Public Member Functions inherited from ilBlockGUI
	__construct ()
	getBlockType ()
	setData (array $a_data)
	getData ()
	setPresentation (int $type)
	getPresentation ()
	setBlockId (string $a_block_id="0")
	getBlockId ()
	setGuiObject (object $a_gui_object)
	Set GuiObject. More...
	getGuiObject ()
	setTitle (string $a_title)
	getTitle ()
	setOffset (int $a_offset)
	getOffset ()
	checkOffset (int $offset)
	setLimit (int $a_limit)
	getLimit ()
	setEnableEdit (bool $a_enableedit)
	getEnableEdit ()
	setRepositoryMode (bool $a_repositorymode)
	getRepositoryMode ()
	setSubtitle (string $a_subtitle)
	getSubtitle ()
	setRefId (int $a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...
	getRefId ()
	setAdminCommands (bool $a_admincommands)
	getAdminCommands ()
	setEnableNumInfo (bool $a_enablenuminfo)
	getEnableNumInfo ()
	setProperties (array $a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...
	getProperty (string $a_property)
	setProperty (string $a_property, string $a_value)
	setRowTemplate (string $a_rowtemplatename, string $a_rowtemplatedir="")
	Set Row Template Name. More...
	getNavParameter ()
	getConfigParameter ()
	getMoveParameter ()
	getRowTemplateName ()
	getRowTemplateDir ()
	addBlockCommand (string $a_href, string $a_text, string $a_onclick="", ?RoundTrip $modal=null)
	getBlockCommands ()
	getHTML ()
	getAsynch ()
	Use this for final get before sending asynchronous output (ajax) per echo to output. More...
	getPaginationViewControl ()
	Fill previous/next row. More...
	getViewControlsForPanel ()
	sortObject ()
	addSortOption (string $option, string $label, bool $active)
	setSortTarget (string $target)
	addPresentation (string $label, string $target, bool $active)
	getNoItemFoundContent ()
	addToDeskObject ()
	removeFromDeskObject ()

Protected Member Functions
	removeRecommendationObject ()
Protected Member Functions inherited from ilDashboardBlockGUI
	getCardForData (BlockDTO $data)
	getListItemGroups ()
	Get items. More...
	getListItemForDataDTO (BlockDTO $data)
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...
	getLegacyContent ()
	Get legacy content. More...
	preloadData (array $data)
	Can be overwritten in subclasses. More...
	initAndShow ()
	isRootNode (int $refId)
	getRepositoryTitle ()
	getManageFields ()
Protected Member Functions inherited from ilBlockGUI
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...
	specialCharsAsEntities (string $string)
	initCommands ()
	preloadData (array $data)
	Can be overwritten in subclasses. More...
	getLegacyContent ()
	Get legacy content. More...
	getListItemForData (array $data)
	Get list item for data array. More...
	handleNavigation ()
	Handle navigation. More...
	loadData ()
	Load data for current page. More...
	getListItemGroups ()
	Get items. More...
	addRepoCommands ()
	Add repo commands. More...
	getActionsForPanel ()
	send (string $output)
	Send. More...

Additional Inherited Members
Static Public Member Functions inherited from ilBlockGUI
static	getScreenMode ()
Data Fields inherited from ilBlockGUI
const	PRES_MAIN_LEG = 0
const	PRES_SEC_LEG = 1
const	PRES_SEC_LIST = 2
const	PRES_MAIN_LIST = 3
const	PRES_MAIN_TILE = 4
Protected Attributes inherited from ilDashboardBlockGUI
ilFavouritesManager	$favourites_manager
int	$requested_item_ref_id
ilSetting	$settings
ilLogger	$logging
Services	$http
ilPDSelectedItemsBlockViewSettings	$viewSettings
array	$data
Protected Attributes inherited from ilBlockGUI
ILIAS UI Renderer	$renderer
Factory	$factory
object	$gui_object
ILIAS Container Block StandardGUIRequest	$request
ILIAS Container Block BlockManager	$block_manager
bool	$repositorymode = false
ILIAS DI UIServices	$ui
array	$data = array()
bool	$enablenuminfo = true
array	$footer_links = array()
string	$block_id = "0"
bool	$allow_moving = true
array	$move = array("left" => false, "right" => false, "up" => false, "down" => false)
array	$block_commands = array()
int	$max_count = 0
bool	$close_command = false
bool	$image = false
array	$property = []
string	$nav_value = ""
string	$css_row = ""
string	$title = ""
bool	$admincommands = false
array	$dropdown
ilTemplate	$tpl
ilGlobalTemplateInterface	$main_tpl
ilObjUser	$user
ilCtrl	$ctrl
ilAccessHandler	$access
ilLanguage	$lng
ilObjectDefinition	$obj_def
int	$presentation
int	$requested_ref_id

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilDashboardRecommendedContentGUI::__construct

(

)

Reimplemented from ilDashboardBlockGUI.

Definition at line 25 of file class.ilDashboardRecommendedContentGUI.php.

    {
        global $DIC;
        parent::__construct();
        $request = $DIC->repository()->internal()->gui()->standardRequest();
    }

References $DIC, ilBlockGUI\$request, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

addCustomCommandsToActionMenu()

ilDashboardRecommendedContentGUI::addCustomCommandsToActionMenu	(	ilObjectListGUI	$itemListGui,
		int	$ref_id
	)

Reimplemented from ilDashboardBlockGUI.

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

                                                                                            : void
    {
        $this->ctrl->setParameter($this, "item_ref_id", $ref_id);
        $itemListGui->addCustomCommand(
            $this->ctrl->getLinkTarget($this, "removeRecommendation"),
            "dash_remove_from_list"
        );
    }

References $ref_id, ilObjectListGUI\addCustomCommand(), and ILIAS\Repository\ctrl().

Here is the call graph for this function:

confirmedRemove()

ilDashboardRecommendedContentGUI::confirmedRemove

(

array

$ids

)

Parameters

int[]

$ids

Reimplemented from ilDashboardBlockGUI.

Definition at line 117 of file class.ilDashboardRecommendedContentGUI.php.

                                               : void
    {
        $rec_manager = new ilRecommendedContentManager();
        foreach ($ids as $ref_id) {
            $rec_manager->declineObjectRecommendation($this->user->getId(), $ref_id);
        }
        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('pd_remove_multi_confirm'), true);
        $this->ctrl->returnToParent($this);
    }

References $ref_id, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

emptyHandling()

ilDashboardRecommendedContentGUI::emptyHandling

(

)

Reimplemented from ilDashboardBlockGUI.

Definition at line 50 of file class.ilDashboardRecommendedContentGUI.php.

                                   : string
    {
        return '';
    }

getBlockType()

ilDashboardRecommendedContentGUI::getBlockType

(

)

Reimplemented from ilBlockGUI.

Definition at line 103 of file class.ilDashboardRecommendedContentGUI.php.

                                  : string
    {
        return 'pdrecc';
    }

getRemoveMultipleActionText()

ilDashboardRecommendedContentGUI::getRemoveMultipleActionText

(

)

Reimplemented from ilDashboardBlockGUI.

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

                                                 : string
    {
        return $this->lng->txt('pd_remove_multiple');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

initData()

ilDashboardRecommendedContentGUI::initData

(

)

Reimplemented from ilDashboardBlockGUI.

Definition at line 55 of file class.ilDashboardRecommendedContentGUI.php.

                              : void
    {
        $rec_manager = new ilRecommendedContentManager();
        $recommendations = $rec_manager->getOpenRecommendationsOfUser($this->user->getId());
 
        $short_desc = $this->settings->get("rep_shorten_description");
        $short_desc_max_length = (int) $this->settings->get("rep_shorten_description_length");
        $ctrl = $this->ctrl;
 
        $recommendations = array_map(static function (int $ref_id) use ($short_desc, $short_desc_max_length): BlockDTO {
            $obj_id = ilObject::_lookupObjectId($ref_id);
            $desc = ilObject::_lookupDescription($obj_id);
            if ($short_desc && $short_desc_max_length !== 0) {
                $desc = ilStr::shortenTextExtended($desc, $short_desc_max_length, true);
            }
            $obj = ilObjectFactory::getInstanceByRefId($ref_id);
            $start = null;
            $end = null;
            if ($obj) {
                switch (get_class($obj)) {
                    case ilObjGroup::class:
                        $start = new ilDateTime($obj->getStart());
                        $end = new ilDateTime($obj->getEnd());
                        break;
                    case ilObjCourse::class:
                        $start = new ilDateTime($obj->getActivationStart());
                        $end = new ilDateTime($obj->getActivationEnd());
                        break;
                    case ilObjTest::class:
                        $start = new ilDateTime($obj->getStartingTime());
                        $end = new ilDateTime($obj->getEndingTime());
                        break;
                }
            }
            return new BlockDTO(
                ilObject::_lookupType($obj_id),
                $ref_id,
                $obj_id,
                ilObject::_lookupTitle($obj_id),
                $desc,
                $start,
                $end,
            );
        }, $recommendations);
 
        $this->setData(['' => $recommendations]);
    }

References ilBlockGUI\$ctrl, $ref_id, ilObject\_lookupDescription(), ilObject\_lookupObjectId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilObjectFactory\getInstanceByRefId(), ILIAS\Repository\int(), ilDashboardBlockGUI\setData(), ILIAS\Repository\settings(), ilStr\shortenTextExtended(), and ILIAS\Repository\user().

Here is the call graph for this function:

initViewSettings()

ilDashboardRecommendedContentGUI::initViewSettings

(

)

Reimplemented from ilDashboardBlockGUI.

Definition at line 40 of file class.ilDashboardRecommendedContentGUI.php.

                                      : void
    {
        $this->viewSettings = new ilPDSelectedItemsBlockViewSettings(
            $this->user,
            ilPDSelectedItemsBlockConstants::VIEW_RECOMMENDED_CONTENT
        );
 
        $this->ctrl->setParameter($this, 'view', $this->viewSettings->getCurrentView());
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\user(), and ilPDSelectedItemsBlockConstants\VIEW_RECOMMENDED_CONTENT.

Here is the call graph for this function:

removeMultipleEnabled()

ilDashboardRecommendedContentGUI::removeMultipleEnabled

(

)

Reimplemented from ilDashboardBlockGUI.

Definition at line 127 of file class.ilDashboardRecommendedContentGUI.php.

                                           : bool
    {
        return true;
    }

removeRecommendationObject()

ilDashboardRecommendedContentGUI::removeRecommendationObject ( )

protected

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

                                                   : void
    {
        $rec_manager = new ilRecommendedContentManager();
        $rec_manager->declineObjectRecommendation($this->user->getId(), $this->requested_item_ref_id);
        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt("dash_item_removed"), true);
        $this->ctrl->returnToParent($this);
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

---

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

• components/ILIAS/Repository/RecommendedContent/classes/class.ilDashboardRecommendedContentGUI.php