Portfolio repository gui class. More...

Collaboration diagram for ilPortfolioRepositoryGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	setTabs ()

Protected Member Functions
	setLocator ()

	checkAccess ($a_permission, $a_portfolio_id=null)

	show ()

	getPortfolioList ()
	Get portfolio list. More...

	setOnline ()
	Set online. More...

	setOffline ()
	Set offline. More...

	saveTitles ()

	confirmPortfolioDeletion ()

	deletePortfolios ()

	unsetDefault ()

	setDefaultConfirmation ()
	Confirm sharing when setting default. More...

	setDefaultGlobal ()

	setDefaultRegistered ()

	setDefault ($a_prtf_id)

	showOtherFilter ()

	showOther ($a_load_data=true)

	applyShareFilter ()

	resetShareFilter ()

Protected Attributes
	$lng

	$user

	$ctrl

	$tpl

	$tabs

	$help

	$locator

	$toolbar

	$settings

	$user_id

	$access_handler

	$ui

Detailed Description

Portfolio repository gui class.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om ilPortfolioRepositoryGUI: ilObjPortfolioGUI, ilObjExerciseGUI

Definition at line 11 of file class.ilPortfolioRepositoryGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilPortfolioRepositoryGUI::__construct ( )

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

References $DIC, $ilUser, $lng, help(), settings(), ui(), and user().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->user = $DIC->user();
         $this->ctrl = $DIC->ctrl();
         $this->tpl = $DIC["tpl"];
         $this->tabs = $DIC->tabs();
         $this->help = $DIC["ilHelp"];
         $this->locator = $DIC["ilLocator"];
         $this->toolbar = $DIC->toolbar();
         $this->settings = $DIC->settings();
         $this->ui = $DIC->ui();
         $lng = $DIC->language();
         $ilUser = $DIC->user();
 
         $lng->loadLanguageModule("prtf");
         $lng->loadLanguageModule("user");
 
         $this->access_handler = new ilPortfolioAccessHandler();
 
         $this->user_id = $ilUser->getId();
     }

Here is the call graph for this function:

Member Function Documentation

◆ applyShareFilter()

ilPortfolioRepositoryGUI::applyShareFilter ( )

protected

Definition at line 596 of file class.ilPortfolioRepositoryGUI.php.

References showOther().

     {
         $tbl = new ilWorkspaceShareTableGUI($this, "showOther", $this->access_handler);
         $tbl->resetOffset();
         $tbl->writeFilterToSession();
 
         $this->showOther();
     }

Here is the call graph for this function:

◆ checkAccess()

ilPortfolioRepositoryGUI::checkAccess	(	$a_permission,
		$a_portfolio_id = `null`
	)

protected

Definition at line 178 of file class.ilPortfolioRepositoryGUI.php.

Referenced by deletePortfolios(), saveTitles(), setDefault(), setDefaultConfirmation(), setDefaultGlobal(), setDefaultRegistered(), and unsetDefault().

     {
         if ($a_portfolio_id) {
             return $this->access_handler->checkAccess($a_permission, "", $a_portfolio_id);
         }
         // currently only object-based permissions
         return true;
     }

Here is the caller graph for this function:

◆ confirmPortfolioDeletion()

ilPortfolioRepositoryGUI::confirmPortfolioDeletion ( )

protected

Definition at line 414 of file class.ilPortfolioRepositoryGUI.php.

References $ctrl, $lng, $tpl, ilObject2\_lookupTitle(), and ilUtil\sendInfo().

     {
         $ilCtrl = $this->ctrl;
         $tpl = $this->tpl;
         $lng = $this->lng;
 
         $prtfs = $_REQUEST["prtfs"];
 
         if (!is_array($prtfs) || count($prtfs) == 0) {
             ilUtil::sendInfo($lng->txt("no_checkbox"), true);
             $ilCtrl->redirect($this, "show");
         } else {
             $cgui = new ilConfirmationGUI();
             $cgui->setFormAction($ilCtrl->getFormAction($this));
             $cgui->setHeaderText($lng->txt("prtf_sure_delete_portfolios"));
             $cgui->setCancel($lng->txt("cancel"), "show");
             $cgui->setConfirm($lng->txt("delete"), "deletePortfolios");
 
             foreach ($prtfs as $id) {
                 $cgui->addItem("prtfs[]", $id, ilObjPortfolio::_lookupTitle($id));
             }
 
             $tpl->setContent($cgui->getHTML());
         }
     }

Here is the call graph for this function:

◆ deletePortfolios()

ilPortfolioRepositoryGUI::deletePortfolios ( )

protected

Definition at line 440 of file class.ilPortfolioRepositoryGUI.php.

References $_POST, $ctrl, $lng, $user_id, and checkAccess().

     {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         if (is_array($_POST["prtfs"])) {
             foreach ($_POST["prtfs"] as $id) {
                 if ($this->checkAccess("write", $id)) {
                     $portfolio = new ilObjPortfolio($id, false);
                     if ($portfolio->getOwner() == $this->user_id) {
                         $this->access_handler->removePermission($id);
                         $portfolio->delete();
                     }
                 }
             }
         }
         ilUtil::sendSuccess($lng->txt("prtf_portfolio_deleted"), true);
         $ilCtrl->redirect($this, "show");
     }

Here is the call graph for this function:

◆ executeCommand()

ilPortfolioRepositoryGUI::executeCommand ( )

Definition at line 91 of file class.ilPortfolioRepositoryGUI.php.

References $_GET, $ctrl, $lng, $tabs, $tpl, ilLink\_getLink(), ilUtil\getImagePath(), setLocator(), and setTabs().

     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $tpl = $this->tpl;
         $ilTabs = $this->tabs;
 
         if (!$this->access_handler->editPortfolios()) {
             throw new ilException($this->lng->txt("no_permission"));
         }
 
         $next_class = $ilCtrl->getNextClass($this);
         $cmd = $ilCtrl->getCmd("show");
 
         $tpl->setTitle($lng->txt("portfolio"));
         $tpl->setTitleIcon(
             ilUtil::getImagePath("icon_prtf.svg"),
             $lng->txt("portfolio")
         );
 
         switch ($next_class) {
             case "ilobjportfoliogui":
 
                 $gui = new ilObjPortfolioGUI((int) $_REQUEST["prt_id"]);
 
                 if ($cmd != "preview") {
                     $this->setLocator();
 
                     if ((int) $_GET["exc_back_ref_id"] > 0) {
                         $ilTabs->setBack2Target($lng->txt("obj_exc"), ilLink::_getLink((int) $_GET["exc_back_ref_id"]));
                     } else {
                         $ilTabs->setBack2Target($lng->txt("prtf_tab_portfolios"), $ilCtrl->getLinkTarget($this, "show"));
                     }
                 }
 
                 $ilCtrl->forwardCommand($gui);
                 break;
 
             default:
                 $this->setLocator();
                 $this->setTabs();
                 $this->$cmd();
                 break;
         }
 
         return true;
     }

Here is the call graph for this function:

◆ getPortfolioList()

ilPortfolioRepositoryGUI::getPortfolioList ( )

protected

Get portfolio list.

Parameters

Definition at line 214 of file class.ilPortfolioRepositoryGUI.php.

References $access_handler, $ctrl, Vendor\Package\$f, $lng, $ui, ilPortfolioExerciseGUI\checkExercise(), ilUtil\getImagePath(), and ilObjPortfolio\getPortfoliosOfUser().

Referenced by show().

     {
         $ui = $this->ui;
         $f = $ui->factory();
         $renderer = $ui->renderer();
         $lng = $this->lng;
         $ctrl = $this->ctrl;
 
         $access_handler = new ilPortfolioAccessHandler();
 
         $shared_objects = $access_handler->getObjectsIShare(false);
 
         $items = [];
 
         foreach (ilObjPortfolio::getPortfoliosOfUser($this->user_id) as $port) {
             // icon
             $icon = $f->symbol()->icon()->custom(
                 ilUtil::getImagePath("icon_prtf.svg"),
                 $lng->txt("obj_portfolio"),
                 "medium"
             );
             if (!$port["is_online"] || !in_array($port["id"], $shared_objects)) {
                 $icon = $icon->withDisabled(true);
             }
 
             // actions
             $prtf_path = array(get_class($this), "ilobjportfoliogui");
             $action = [];
             //  ... preview
             $ctrl->setParameterByClass("ilobjportfoliogui", "prt_id", $port["id"]);
             $preview_action = $ctrl->getLinkTargetByClass($prtf_path, "preview");
             $action[] = $f->button()->shy($lng->txt("preview"), $preview_action);
             //  ... edit content
             $action[] = $f->button()->shy(
                 $lng->txt("prtf_edit_content"),
                 $ctrl->getLinkTargetByClass($prtf_path, "view")
             );
             $ctrl->setParameter($this, "prt_id", $port["id"]);
             if ($port["is_online"]) {
                 //      ... set offline
                 $action[] = $f->button()->shy(
                     $lng->txt("prtf_set_offline"),
                     $ctrl->getLinkTarget($this, "setOffline")
                 );
             } else {
                 //      ... set online
                 $action[] = $f->button()->shy(
                     $lng->txt("prtf_set_online"),
                     $ctrl->getLinkTarget($this, "setOnline")
                 );
             }
             $ctrl->setParameter($this, "prt_id", "");
             //  ... settings
             $action[] = $f->button()->shy(
                 $lng->txt("settings"),
                 $ctrl->getLinkTargetByClass($prtf_path, "edit")
             );
             //  ... sharing
             $action[] = $f->button()->shy(
                 $lng->txt("wsp_permissions"),
                 $ctrl->getLinkTargetByClass(array(get_class($this), "ilobjportfoliogui", "ilWorkspaceAccessGUI"), "share")
             );
             $ctrl->setParameterByClass("ilobjportfoliogui", "prt_id", "");
 
             if ($port["is_online"]) {
                 if (!$port["is_default"]) {
                     //  ... set as default
                     $ctrl->setParameter($this, "prt_id", $port["id"]);
 
                     $action[] = $f->button()->shy(
                         $lng->txt("prtf_set_as_default"),
                         $ctrl->getLinkTarget($this, "setDefaultConfirmation")
                     );
 
                     $ctrl->setParameter($this, "prt_id", "");
                 } else {
                     //  ... unset as default
                     $action[] = $f->button()->shy(
                         $lng->txt("prtf_unset_as_default"),
                         $ctrl->getLinkTarget($this, "unsetDefault")
                     );
                 }
             }
             // ... delete
             $ctrl->setParameter($this, "prtfs[]", $port["id"]);
             $action[] = $f->button()->shy(
                 $lng->txt("delete"),
                 $ctrl->getLinkTarget($this, "confirmPortfolioDeletion")
             );
             $ctrl->setParameter($this, "prtfs[]", "");
             $actions = $f->dropdown()->standard($action);
 
 
             // properties
             $props = [];
             // ... online
             $props[$lng->txt("online")] = ($port["is_online"])
                 ? $lng->txt("yes")
                 : "<span class='il_ItemAlertProperty'>" . $lng->txt("no") . "</span>";
             // ... shared
             $props[$lng->txt("wsp_status_shared")] = (in_array($port["id"], $shared_objects))
                 ? $lng->txt("yes")
                 : "<span class='il_ItemAlertProperty'>" . $lng->txt("no") . "</span>";
             // ... default (my profile)
             if ($port["is_default"]) {
                 $props[$lng->txt("prtf_default_portfolio")] = $lng->txt("yes");
             }
             // ... handed in
             // exercise portfolio?
             $exercises = ilPortfolioExerciseGUI::checkExercise($this->user_id, $port["id"], false, true);
             foreach ($exercises as $exinfo) {
                 if ($exinfo["submitted"]) {
                     $props[$exinfo["ass_title"]] =
                         str_replace("$1", $exinfo["submitted_date"], $lng->txt("prtf_submission_on"));
                 } else {
                     $props[$exinfo["ass_title"]] = "<span class='il_ItemAlertProperty'>" . $lng->txt("prtf_no_submission") . "</span>";
                 }
             }
 
 
             $items[] = $f->item()->standard($f->button()->shy($port["title"], $preview_action))
                 ->withActions($actions)
                 ->withProperties($props)
                 ->withLeadIcon($icon);
         }
 
 
         $std_list = $f->panel()->listing()->standard($lng->txt("prtf_portfolios"), array(
             $f->item()->group("", $items)
         ));
 
         return $renderer->render($std_list);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetShareFilter()

ilPortfolioRepositoryGUI::resetShareFilter ( )

protected

Definition at line 605 of file class.ilPortfolioRepositoryGUI.php.

References showOther().

     {
         $tbl = new ilWorkspaceShareTableGUI($this, "showOther", $this->access_handler);
         $tbl->resetOffset();
         $tbl->resetFilter();
 
         $this->showOther();
     }

Here is the call graph for this function:

◆ saveTitles()

ilPortfolioRepositoryGUI::saveTitles ( )

protected

Definition at line 388 of file class.ilPortfolioRepositoryGUI.php.

References $_POST, $ctrl, $lng, checkAccess(), and ilUtil\stripSlashes().

     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         foreach ($_POST["title"] as $id => $title) {
             if (trim($title)) {
                 if ($this->checkAccess("write", $id)) {
                     $portfolio = new ilObjPortfolio($id, false);
                     $portfolio->setTitle(ilUtil::stripSlashes($title));
 
                     if (is_array($_POST["online"]) && in_array($id, $_POST["online"])) {
                         $portfolio->setOnline(true);
                     } else {
                         $portfolio->setOnline(false);
                     }
 
                     $portfolio->update();
                 }
             }
         }
 
         ilUtil::sendSuccess($lng->txt("saved_successfully"), true);
         $ilCtrl->redirect($this, "show");
     }

Here is the call graph for this function:

◆ setDefault()

ilPortfolioRepositoryGUI::setDefault ( $a_prtf_id )

protected

Definition at line 552 of file class.ilPortfolioRepositoryGUI.php.

References $ctrl, $ilUser, $lng, $user, checkAccess(), and ilObjPortfolio\setUserDefault().

Referenced by setDefaultConfirmation(), setDefaultGlobal(), and setDefaultRegistered().

     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $ilUser = $this->user;
 
         if ($a_prtf_id && $this->checkAccess("write")) {
             // #12845
             if ($this->access_handler->hasGlobalPermission($a_prtf_id)) {
                 $ilUser->setPref("public_profile", "g");
                 $ilUser->writePrefs();
             } elseif ($this->access_handler->hasRegisteredPermission($a_prtf_id)) {
                 $ilUser->setPref("public_profile", "y");
                 $ilUser->writePrefs();
             } else {
                 return;
             }
             ilObjPortfolio::setUserDefault($this->user_id, $a_prtf_id);
             ilUtil::sendSuccess($lng->txt("settings_saved"), true);
         }
         $ilCtrl->redirect($this, "show");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultConfirmation()

ilPortfolioRepositoryGUI::setDefaultConfirmation ( )

protected

Confirm sharing when setting default.

Definition at line 485 of file class.ilPortfolioRepositoryGUI.php.

References $ctrl, $ilSetting, $lng, $settings, $tabs, $tpl, checkAccess(), and setDefault().

     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $tpl = $this->tpl;
         $ilTabs = $this->tabs;
         $ilSetting = $this->settings;
 
         $prtf_id = (int) $_REQUEST["prt_id"];
 
         if ($prtf_id && $this->checkAccess("write")) {
             // if already shared, no need to ask again
             if ($this->access_handler->hasRegisteredPermission($prtf_id) ||
                 $this->access_handler->hasGlobalPermission($prtf_id)) {
                 return $this->setDefault($prtf_id);
             }
 
             $ilTabs->clearTargets();
             $ilTabs->setBackTarget(
                 $lng->txt("cancel"),
                 $ilCtrl->getLinkTarget($this, "show")
             );
 
             $ilCtrl->setParameter($this, "prt_id", $prtf_id);
 
             // #20310
             if (!$ilSetting->get("enable_global_profiles")) {
                 $ilCtrl->redirect($this, "setDefaultRegistered");
             }
 
             $cgui = new ilConfirmationGUI();
             $cgui->setFormAction($ilCtrl->getFormAction($this));
             $cgui->setHeaderText($lng->txt("prtf_set_default_publish_confirmation"));
             $cgui->setCancel($lng->txt("prtf_set_default_publish_global"), "setDefaultGlobal");
             $cgui->setConfirm($lng->txt("prtf_set_default_publish_registered"), "setDefaultRegistered");
             $tpl->setContent($cgui->getHTML());
 
             return;
         }
 
         $ilCtrl->redirect($this, "show");
     }

Here is the call graph for this function:

◆ setDefaultGlobal()

ilPortfolioRepositoryGUI::setDefaultGlobal ( )

protected

Definition at line 528 of file class.ilPortfolioRepositoryGUI.php.

References $ctrl, checkAccess(), ilWorkspaceAccessGUI\PERMISSION_ALL, and setDefault().

     {
         $ilCtrl = $this->ctrl;
 
         $prtf_id = (int) $_REQUEST["prt_id"];
         if ($prtf_id && $this->checkAccess("write")) {
             $this->access_handler->addPermission($prtf_id, ilWorkspaceAccessGUI::PERMISSION_ALL);
             $this->setDefault($prtf_id);
         }
         $ilCtrl->redirect($this, "show");
     }

Here is the call graph for this function:

◆ setDefaultRegistered()

ilPortfolioRepositoryGUI::setDefaultRegistered ( )

protected

Definition at line 540 of file class.ilPortfolioRepositoryGUI.php.

References $ctrl, checkAccess(), ilWorkspaceAccessGUI\PERMISSION_REGISTERED, and setDefault().

     {
         $ilCtrl = $this->ctrl;
 
         $prtf_id = (int) $_REQUEST["prt_id"];
         if ($prtf_id && $this->checkAccess("write")) {
             $this->access_handler->addPermission($prtf_id, ilWorkspaceAccessGUI::PERMISSION_REGISTERED);
             $this->setDefault($prtf_id);
         }
         $ilCtrl->redirect($this, "show");
     }

Here is the call graph for this function:

◆ setLocator()

ilPortfolioRepositoryGUI::setLocator ( )

protected

Definition at line 163 of file class.ilPortfolioRepositoryGUI.php.

References $ctrl, $lng, $locator, and $tpl.

Referenced by executeCommand().

     {
         $ilLocator = $this->locator;
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
         $tpl = $this->tpl;
 
         $ilLocator->addItem(
             $lng->txt("portfolio"),
             $ilCtrl->getLinkTarget($this, "show")
         );
 
         $tpl->setLocator();
     }

Here is the caller graph for this function:

◆ setOffline()

ilPortfolioRepositoryGUI::setOffline ( )

protected

Set offline.

Definition at line 371 of file class.ilPortfolioRepositoryGUI.php.

References $_GET, $ctrl, $lng, $user_id, and ilObject2\_lookupOwner().

     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $prt_id = (int) $_GET["prt_id"];
         if (ilObjPortfolio::_lookupOwner($prt_id) == $this->user_id) {
             $portfolio = new ilObjPortfolio($prt_id, false);
             $portfolio->setOnline(false);
             $portfolio->update();
             ilUtil::sendSuccess($lng->txt("saved_successfully"), true);
             $ilCtrl->redirect($this, "show");
         }
         $ilCtrl->redirect($this, "show");
     }

Here is the call graph for this function:

◆ setOnline()

ilPortfolioRepositoryGUI::setOnline ( )

protected

Set online.

Definition at line 352 of file class.ilPortfolioRepositoryGUI.php.

References $_GET, $ctrl, $lng, $user_id, and ilObject2\_lookupOwner().

     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $prt_id = (int) $_GET["prt_id"];
         if (ilObjPortfolio::_lookupOwner($prt_id) == $this->user_id) {
             $portfolio = new ilObjPortfolio($prt_id, false);
             $portfolio->setOnline(true);
             $portfolio->update();
             ilUtil::sendSuccess($lng->txt("saved_successfully"), true);
             $ilCtrl->redirect($this, "show");
         }
         $ilCtrl->redirect($this, "show");
     }

Here is the call graph for this function:

◆ setTabs()

ilPortfolioRepositoryGUI::setTabs ( )

Definition at line 139 of file class.ilPortfolioRepositoryGUI.php.

References $ctrl, $help, $lng, and $tabs.

Referenced by executeCommand().

     {
         $ilTabs = $this->tabs;
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
         $ilHelp = $this->help;
 
         $ilHelp->setScreenIdComponent("prtf");
 
         $ilTabs->addTab(
             "mypf",
             $lng->txt("prtf_tab_portfolios"),
             $ilCtrl->getLinkTarget($this)
         );
 
         $ilTabs->addTab(
             "otpf",
             $lng->txt("prtf_tab_other_users"),
             $ilCtrl->getLinkTarget($this, "showotherFilter")
         );
 
         $ilTabs->activateTab("mypf");
     }

Here is the caller graph for this function:

◆ show()

ilPortfolioRepositoryGUI::show ( )

protected

Definition at line 192 of file class.ilPortfolioRepositoryGUI.php.

References $ctrl, $lng, $toolbar, $tpl, ilLinkButton\getInstance(), and getPortfolioList().

     {
         $tpl = $this->tpl;
         $lng = $this->lng;
         $ilToolbar = $this->toolbar;
         $ilCtrl = $this->ctrl;
 
         $button = ilLinkButton::getInstance();
         $button->setCaption("prtf_add_portfolio");
         $button->setUrl($ilCtrl->getLinkTargetByClass("ilObjPortfolioGUI", "create"));
         $ilToolbar->addButtonInstance($button);
         $portfolio_list = $this->getPortfolioList();
 
         $tpl->setContent($portfolio_list);
     }

Here is the call graph for this function:

◆ showOther()

ilPortfolioRepositoryGUI::showOther ( $a_load_data = true )

protected

Definition at line 585 of file class.ilPortfolioRepositoryGUI.php.

References $tabs, and $tpl.

Referenced by applyShareFilter(), resetShareFilter(), and showOtherFilter().

     {
         $tpl = $this->tpl;
         $ilTabs = $this->tabs;
 
         $ilTabs->activateTab("otpf");
 
         $tbl = new ilWorkspaceShareTableGUI($this, "showOther", $this->access_handler, null, $a_load_data);
         $tpl->setContent($tbl->getHTML());
     }

Here is the caller graph for this function:

◆ showOtherFilter()

ilPortfolioRepositoryGUI::showOtherFilter ( )

protected

Definition at line 580 of file class.ilPortfolioRepositoryGUI.php.

References showOther().

     {
         $this->showOther(false);
     }

Here is the call graph for this function:

◆ unsetDefault()

ilPortfolioRepositoryGUI::unsetDefault ( )

protected

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

References $ctrl, $ilUser, $lng, $user, checkAccess(), and ilObjPortfolio\setUserDefault().

     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $ilUser = $this->user;
 
         if ($this->checkAccess("write")) {
             // #12845
             $ilUser->setPref("public_profile", "n");
             $ilUser->writePrefs();
 
             ilObjPortfolio::setUserDefault($this->user_id);
             ilUtil::sendSuccess($lng->txt("prtf_unset_default_share_info"), true);
         }
         $ilCtrl->redirect($this, "show");
     }