Portfolio view gui class. More...

Inheritance diagram for ilObjPortfolioGUI:

Collaboration diagram for ilObjPortfolioGUI:

Public Member Functions
	__construct (int $a_id=0)

	getType ()

	executeCommand ()

	create ()

	createFromTemplate ()

	save ()

	saveFromTemplate ()

	getPageGUIClassName ()

	createPortfolioFromAssignment ()

	linkPortfolioToAssignment (int $a_target_id)

	getSkillsToPortfolioAssignment (array $a_pskills, array $a_skill_ids, ilPortfolioTemplatePage $a_source_page)

	printSelection ()

	showPrintView ()

Public Member Functions inherited from ilObjPortfolioBaseGUI
	__construct (int $a_id=0, int $a_id_type=self::REPOSITORY_NODE_ID, int $a_parent_node_id=0)

	setAdditional (array $a_additional)
	Set Additonal Information (used in public profile?) More...

	getAdditional ()

	setPermaLink (int $a_obj_id, string $a_type)
	Set custom perma link (used in public profile?) More...

	getPageGUIClassName ()

	view ()
	Show list of portfolio pages. More...

	initPageForm (string $a_mode="create")
	Init portfolio page form. More...

	savePage ()
	Create new portfolio page. More...

	savePortfolioPagesOrdering ()
	Save ordering of portfolio pages. More...

	confirmPortfolioPageDeletion ()

	deletePortfolioPages ()

	export (bool $a_with_comments=false)

	exportWithComments ()

	copyPageForm (ilPropertyFormGUI $a_form=null)
	Select target portfolio for page(s) copy. More...

	copyPage ()

	initCopyPageForm ()

	setContentStyleSheet (ilGlobalTemplateInterface $a_tpl=null)

Public Member Functions inherited from ilObject2GUI
	__construct (int $id=0, int $id_type=self::REPOSITORY_NODE_ID, int $parent_node_id=0)

	executeCommand ()
	execute command More...

	getIdType ()

	delete ()
	Display delete confirmation form (repository/workspace switch) More...

	confirmedDelete ()
	Delete objects (repository/workspace switch) More...

	getHTML ()

	withReferences ()
	Final/Private declaration of unchanged parent methods. More...

	setCreationMode (bool $mode=true)

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	isVisible (int $ref_id, string $type)

	setColumnSettings (ilColumnGUI $column_gui)

	view ()
	view object content (repository/workspace switch) More...

	getType ()
	Functions that must be overwritten. More...

	create ()
	CRUD. More...

	save ()

	edit ()

	update ()

	cancel ()

	importFile ()

	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...

Public Member Functions inherited from ilObjectGUI
	__construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true)

	getRefId ()

	setAdminMode (string $mode)

	getAdminMode ()

	getObject ()

	executeCommand ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelObject ()
	cancel action and go back to previous page More...

	createObject ()
	create new object form More...

	editAvailabilityPeriodObject ()

	saveAvailabilityPeriodObject ()

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()

	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()

	addExternalEditFormCustom (ilPropertyFormGUI $form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...

	isVisible (int $ref_id, string $type)

	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...

	setColumnSettings (ilColumnGUI $column_gui)

	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More...

	addToDeskObject ()

	removeFromDeskObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Static Public Member Functions
static	_goto (string $a_target)

Static Public Member Functions inherited from ilObjPortfolioBaseGUI
static	renderFullscreenHeader (ilObjPortfolioBase $a_portfolio, ilGlobalTemplateInterface $a_tpl, int $a_user_id, bool $a_export=false)
	Render banner, user name. More...

Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $obj, ?int $callback_ref_id)
	After creation callback. More...

Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode (int $ref_id, string $cmd="")

static	_gotoSharedWorkspaceNode (int $wsp_id)

Protected Member Functions
	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $node_id=null)

	triggerAssignmentTool ()

	setTabs ()

	addLocator ()

	setTitleAndDescription ()

	getCreateInfoMessage ()

	initCreationForms (string $new_type)

	initCreateForm (string $new_type)

	initCreateFromTemplateForm ()

	afterSave (ilObject $new_object)

	toRepository ()

	initEditForm ()

	getEditFormCustomValues (array &$a_values)

	updateCustom (ilPropertyFormGUI $form)

	getPageInstance (?int $a_page_id=null, ?int $a_portfolio_id=null)
	Get portfolio template page instance. More...

	getPageGUIInstance (int $a_page_id)
	Get portfolio template page gui instance. More...

	initCopyPageFormOptions (ilPropertyFormGUI $a_form)

	initBlogForm ()

	saveBlog ()
	Create new portfolio blog page. More...

	createPortfolioFromTemplate (ilPropertyFormGUI $a_form=null)

	initCreatePortfolioFromTemplateForm (int $a_prtt_id, string $a_title)

	createPortfolioFromTemplateProcess (bool $a_process_form=true)

	createFromTemplateDirect (string $title="", int $prtt_id=0)
	Create portfolio template direct. More...

	getOfflineMessage ()
	Get offline message for sharing tab. More...

	setOnlineAndShare ()
	Set online and switch to share screen. More...

Protected Member Functions inherited from ilObjPortfolioBaseGUI
	addLocatorItems ()

	determinePageCall ()

	handlePageCall (string $a_cmd)

	setSettingsSubTabs (string $a_active)

	initEditCustomForm (ilPropertyFormGUI $a_form)

	getEditFormCustomValues (array &$a_values)

	updateCustom (ilPropertyFormGUI $form)

	getPageInstance (?int $a_page_id=null, ?int $a_portfolio_id=null)

	getPageGUIInstance (int $a_page_id)

	addPage ()
	Show portfolio page creation form. More...

	addBlog ()
	Show portfolio blog page creation form. More...

	initBlogForm ()

	saveBlog ()

	getCurrentPage ()

	getCommentGUI ()

	showEditButton (int $page_id)

	initCopyPageFormOptions (ilPropertyFormGUI $a_form)

Protected Member Functions inherited from ilObject2GUI
	afterConstructor ()
	Do anything that should be done after constructor in here. More...

	assignObject ()
	create object instance as internal property (repository/workspace switch) More...

	getAccessHandler ()

	setLocator ()
	set Locator More...

	deleteConfirmedObjects ()
	Delete objects (workspace specific) This should probably be moved elsewhere as done with RepUtil. More...

	setTitleAndDescription ()

	omitLocator (bool $omit=true)

	getTargetFrame (string $cmd, string $target_frame="")

	setTargetFrame (string $cmd, string $target_frame)

	getCenterColumnHTML ()

	getRightColumnHTML ()

	checkPermission (string $perm, string $cmd="", string $type="", int $ref_id=null)

	showPossibleSubObjects ()

	redirectToRefId (int $ref_id, string $cmd="")

	addAdminLocatorItems (bool $do_not_add_object=false)

	setTabs ()
	create tabs (repository/workspace switch) More...

	getReturnLocation (string $cmd, string $location="")
	Deprecated functions. More...

	setReturnLocation (string $cmd, string $location)

	showActions ()

	getTabs ()

	addLocatorItems ()
	Functions to be overwritten. More...

	initCreationForms (string $new_type)
	Init creation forms. More...

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $node_id=null)

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	redrawHeaderAction ()
	Updating icons after ajax call. More...

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	createActionDispatcherGUI ()

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...

	addHeaderAction ()
	Add header action menu. More...

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	setTabs ()
	set admin tabs More...

	setAdminTabs ()
	set admin tabs More...

	setLocator ()

	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...

	omitLocator (bool $omit=true)

	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	initCreationForms (string $new_type)
	Init creation forms. More...

	getCreationFormsHTML (array $forms)
	Get HTML for creation forms (accordion) More...

	initCreateForm (string $new_type)

	initDidacticTemplate (ilPropertyFormGUI $form)

	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...

	addAdoptContentLinkToToolbar ()

	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)

	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...

	initEditForm ()

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	initImportForm (string $new_type)

	importFileObject (int $parent_id=null)

	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...

	setFormAction (string $cmd, string $form_action)

	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	getTabs ()
	overwrite in derived GUI class of your object type More...

	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

Protected Attributes
ILIAS Notes GUIService	$notes_gui

ilWorkspaceAccessHandler	$ws_access

ContextServices	$tool_context

ilPortfolioDeclarationOfAuthorship	$declaration_authorship

ILIAS Skill Service SkillPersonalService	$skill_personal_service

Protected Attributes inherited from ilObjPortfolioBaseGUI
ILIAS Notes Service	$notes

ILIAS Portfolio InternalGUIService	$gui

StandardGUIRequest	$port_request

ilHelpGUI	$help

int	$user_id = 0

array	$additional = array()

array	$perma_link = []

int	$page_id = 0

string	$page_mode

int	$requested_ppage

int	$requested_user_page

string	$requested_back_url = ""

ILIAS DI UIServices	$ui

ILIAS HTTP Services	$http

ILIAS Style Content GUIService	$content_style_gui

ILIAS Style Content Object ObjectFacade	$content_style_domain

Protected Attributes inherited from ilObject2GUI
ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ilFavouritesManager	$favourites

ilErrorHandling	$error

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilToolbarGUI	$toolbar

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Factory	$refinery

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

int	$request_ref_id

int	$id_type

int	$parent_id

string	$type

string	$html

int	$object_id

int	$node_id = null

array	$creation_forms = []

	$access_handler

Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service

ServerRequestInterface	$request

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilSetting	$settings

ilToolbarGUI	$toolbar

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

ilObjectService	$object_service

ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilCtrl	$ctrl

ilErrorHandling	$error

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ILIAS	$ilias

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Factory	$refinery

ilFavouritesManager	$favourites

ilObjectCustomIconFactory	$custom_icon_factory

UIFactory	$ui_factory

UIRenderer	$ui_renderer

ilObject	$object = null

bool	$creation_mode = false

	$data

int	$id

bool	$call_by_reference = false

bool	$prepare_output

int	$ref_id

int	$obj_id

int	$maxcount

array	$form_action = []

array	$return_location = []

array	$target_frame = []

string	$tmp_import_dir

string	$sub_objects = ""

bool	$omit_locator = false

string	$type = ""

string	$admin_mode = self::ADMIN_MODE_NONE

int	$requested_ref_id = 0

int	$requested_crtptrefid = 0

int	$requested_crtcb = 0

string	$requested_new_type = ""

string	$link_params

string	$html = ""

Additional Inherited Members
Data Fields inherited from ilObject2GUI
const	OBJECT_ID = 0

const	REPOSITORY_NODE_ID = 1

const	WORKSPACE_NODE_ID = 2

const	REPOSITORY_OBJECT_ID = 3

const	WORKSPACE_OBJECT_ID = 4

const	PORTFOLIO_OBJECT_ID = 5

Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION

const	ADMIN_MODE_NONE = ""

const	ADMIN_MODE_SETTINGS = "settings"

const	ADMIN_MODE_REPOSITORY = "repository"

const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

Detailed Description

Portfolio view gui class.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om ilObjPortfolioGUI: ilPortfolioPageGUI, ilPageObjectGUI ilObjPortfolioGUI: ilWorkspaceAccessGUI, ilCommentGUI, ilCommonActionDispatcherGUI ilObjPortfolioGUI: ilObjectContentStyleSettingsGUI, ilPortfolioExerciseGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjPortfolioGUI::__construct ( int $a_id = 0 )

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

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->help = $DIC["ilHelp"];
         $this->settings = $DIC->settings();
         $this->access = $DIC->access();
         $this->user = $DIC->user();
         $this->ctrl = $DIC->ctrl();
         $this->ui = $DIC->ui();
 
         $this->tool_context = $DIC->globalScreen()->tool()->context();
 
         parent::__construct($a_id, self::PORTFOLIO_OBJECT_ID, 0);
         $this->declaration_authorship = new ilPortfolioDeclarationOfAuthorship();
 
         $this->ctrl->saveParameter($this, "exc_back_ref_id");
         $this->notes_gui = $DIC->notes()->gui();
         $this->skill_personal_service = $DIC->skills()->personal();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _goto()

static ilObjPortfolioGUI::_goto ( string $a_target )

static

Definition at line 965 of file class.ilObjPortfolioGUI.php.

References ilObject2GUI\$ctrl, $DIC, ilObjectGUI\$id, ilCtrl\redirectByClass(), and ilCtrl\setParameterByClass().

                                                   : void
     {
         global $DIC;
 
         $ctrl = $DIC->ctrl();
 
         $id = explode("_", $a_target);
 
         $ctrl->setParameterByClass("ilobjportfoliogui", "prt_id", $id[0]);
         if (count($id) === 2) {
             $ctrl->setParameterByClass("ilobjportfoliogui", "user_page", $id[1]);
         }
         $ctrl->redirectByClass(["ilsharedresourceGUI", "ilobjportfoliogui"], "preview");
     }

Here is the call graph for this function:

◆ addLocator()

ilObjPortfolioGUI::addLocator ( )

protected

Definition at line 241 of file class.ilObjPortfolioGUI.php.

References ilObjPortfolioBaseGUI\addLocatorItems(), ILIAS\Repository\ctrl(), and ILIAS\Repository\object().

Referenced by executeCommand().

                                    : void
     {
         if (!$this->creation_mode) {
             $this->ctrl->setParameter($this, "prt_id", $this->object->getId());
         }
 
         $this->addLocatorItems();
 
         $this->tpl->setLocator();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ afterSave()

ilObjPortfolioGUI::afterSave ( ilObject $new_object )

protected

Definition at line 462 of file class.ilObjPortfolioGUI.php.

References ILIAS\Repository\ctrl(), ilObject\getId(), and ILIAS\Repository\lng().

                                                       : void
     {
         $this->tpl->setOnScreenMessage('success', $this->lng->txt("prtf_portfolio_created"), true);
         $this->ctrl->setParameter($this, "prt_id", $new_object->getId());
         $this->ctrl->redirect($this, "view");
     }

Here is the call graph for this function:

◆ checkPermissionBool()

ilObjPortfolioGUI::checkPermissionBool	(	string	$perm,
		string	$cmd = `""`,
		string	$type = `""`,
		?int	$node_id = `null`
	)

protected

Definition at line 63 of file class.ilObjPortfolioGUI.php.

References ilObject2GUI\$node_id, and ilObjectGUI\$obj_id.

Referenced by create(), createFromTemplate(), executeCommand(), saveBlog(), and setTabs().

      : bool {
         if ($perm === "create") {
             return true;
         }
         if (!$node_id) {
             $node_id = $this->obj_id;
         }
         return $this->access_handler->checkAccess($perm, "", $node_id);
     }

Here is the caller graph for this function:

◆ create()

ilObjPortfolioGUI::create ( )

Definition at line 281 of file class.ilObjPortfolioGUI.php.

References ilObject2GUI\$error, $ilErr, ilObject2GUI\$tpl, checkPermissionBool(), ILIAS\Repository\ctrl(), ilObjectGUI\getCreationFormsHTML(), initCreationForms(), ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setContent().

                             : void
     {
         $tpl = $this->tpl;
         $ilErr = $this->error;
 
         $new_type = $this->port_request->getNewType();
 
         // add new object to custom parent container
         $this->ctrl->saveParameter($this, "crtptrefid");
         // use forced callback after object creation
         $this->ctrl->saveParameter($this, "crtcb");
 
         if (!$this->checkPermissionBool("create", "", $new_type)) {
             $ilErr->raiseError($this->lng->txt("permission_denied"), $ilErr->MESSAGE);
         } else {
             $this->lng->loadLanguageModule($new_type);
             $this->ctrl->setParameter($this, "new_type", $new_type);
 
             $forms = $this->initCreationForms($new_type);
 
             // copy form validation error: do not show other creation forms
             if ($this->port_request->getCopyFormProcess() && isset($forms[self::CFORM_CLONE])) {
                 $forms = array(self::CFORM_CLONE => $forms[self::CFORM_CLONE]);
             }
             $tpl->setContent($this->getCreationFormsHTML($forms));
         }
     }

Here is the call graph for this function:

◆ createFromTemplate()

ilObjPortfolioGUI::createFromTemplate ( )

Definition at line 309 of file class.ilObjPortfolioGUI.php.

References ilObject2GUI\$error, $ilErr, ilObject2GUI\$tpl, checkPermissionBool(), ILIAS\Repository\ctrl(), initCreateFromTemplateForm(), ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setContent().

                                         : void
     {
         $tpl = $this->tpl;
         $ilErr = $this->error;
 
         $new_type = $this->port_request->getNewType();
 
         // add new object to custom parent container
         $this->ctrl->saveParameter($this, "crtptrefid");
         // use forced callback after object creation
         $this->ctrl->saveParameter($this, "crtcb");
 
         if (!$this->checkPermissionBool("create", "", $new_type)) {
             $ilErr->raiseError($this->lng->txt("permission_denied"), $ilErr->MESSAGE);
         } else {
             $this->lng->loadLanguageModule($new_type);
             $this->ctrl->setParameter($this, "new_type", $new_type);
             $form = $this->initCreateFromTemplateForm();
             $tpl->setContent($form->getHTML());
         }
     }

Here is the call graph for this function:

◆ createFromTemplateDirect()

ilObjPortfolioGUI::createFromTemplateDirect	(	string	$title = `""`,
		int	$prtt_id = `0`
	)

protected

Create portfolio template direct.

Definition at line 928 of file class.ilObjPortfolioGUI.php.

References ilObject\_lookupTitle(), ilObjPortfolioBase\clonePagesAndSettings(), ILIAS\Repository\ctrl(), ilObjPortfolioTemplate\getAvailablePortfolioTemplates(), ILIAS\Repository\lng(), and toRepository().

Referenced by saveFromTemplate().

      : void {
         if ($prtt_id === 0) {
             $prtt_id = $this->port_request->getPortfolioTemplateId();
         }
         if ($title === "") {
             $title = ilObject::_lookupTitle($prtt_id);
         }
 
         // valid template?
         $templates = array_keys(ilObjPortfolioTemplate::getAvailablePortfolioTemplates());
         if (!count($templates) || !in_array($prtt_id, $templates)) {
             $this->toRepository();
         }
         unset($templates);
 
         $source = new ilObjPortfolioTemplate($prtt_id, false);
 
         // create portfolio
         $target = new ilObjPortfolio();
         $target->setTitle($title);
         $target->create();
         $target_id = $target->getId();
 
         ilObjPortfolioTemplate::clonePagesAndSettings($source, $target, null, true);
 
         // link portfolio to exercise assignment
         //$this->linkPortfolioToAssignment($target_id);
 
         $this->tpl->setOnScreenMessage('success', $this->lng->txt("prtf_portfolio_created_from_template"), true);
         $this->ctrl->setParameter($this, "prt_id", $target_id);
         $this->ctrl->redirect($this, "preview");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createPortfolioFromAssignment()

ilObjPortfolioGUI::createPortfolioFromAssignment ( )

Definition at line 980 of file class.ilObjPortfolioGUI.php.

References $ilSetting, ilObjectGUI\$settings, ilObject2GUI\$user, ilObject\_lookupObjectId(), ilObjPortfolioBase\clonePagesAndSettings(), ILIAS\Repository\ctrl(), ilPortfolioPage\getAllPortfolioPages(), ilObjPortfolioTemplate\getAvailablePortfolioTemplates(), getSkillsToPortfolioAssignment(), linkPortfolioToAssignment(), ILIAS\Repository\lng(), toRepository(), ilPortfolioTemplatePage\TYPE_BLOG_TEMPLATE, and ilPortfolioPage\TYPE_PAGE.

                                                    : void
     {
         $ilUser = $this->user;
         $ilSetting = $this->settings;
 
         $recipe = [];
 
         $title = $this->port_request->getPortfolioTitle();
         $prtt_id = $this->port_request->getPortfolioTemplate();
 
         // get assignment template
         $ass_template_id = 0;
         $ass_id = $this->port_request->getExcAssId();
         if ($ass_id > 0) {
             $ass = new ilExAssignment($ass_id);
             $ass_template_id = ilObject::_lookupObjectId($ass->getPortfolioTemplateId());
         }
 
         if ($prtt_id > 0) {
             $templates = array_keys(ilObjPortfolioTemplate::getAvailablePortfolioTemplates());
             if (!count($templates) || !in_array($prtt_id, $templates)) {
                 if ($ass_template_id !== $prtt_id) {
                     $this->toRepository();
                 }
             }
 
             //skills manipulation
             $pskills = array_keys($this->skill_personal_service->getSelectedUserSkills($ilUser->getId()));
             $skill_ids = array();
 
             $recipe = array();
             foreach (ilPortfolioTemplatePage::getAllPortfolioPages($prtt_id) as $page) {
                 switch ($page["type"]) {
                     case ilPortfolioTemplatePage::TYPE_BLOG_TEMPLATE:
                         if (!$ilSetting->get('disable_wsp_blogs')) {
                             $recipe[$page["id"]] = array("blog", "create", $page['title']);
                         }
                         break;
                     case ilPortfolioPage::TYPE_PAGE:
                         $source_page = new ilPortfolioTemplatePage($page["id"]);
                         $source_page->buildDom(true);
                         $skill_ids = $this->getSkillsToPortfolioAssignment($pskills, $skill_ids, $source_page);
                         break;
                 }
             }
 
             if ($skill_ids) {
                 $recipe["skills"] = $skill_ids;
             }
         }
 
         // create portfolio
         $target = new ilObjPortfolio();
         $target->setTitle($title);
         $target->create();
         $target_id = $target->getId();
 
         if ($prtt_id) {
             $source = new ilObjPortfolioTemplate($prtt_id, false);
             ilObjPortfolioTemplate::clonePagesAndSettings($source, $target, $recipe);
         }
 
         // link portfolio to exercise assignment
         $this->linkPortfolioToAssignment($target_id);
 
         $this->ctrl->setParameter($this, "prt_id", $target_id);
         if ($prtt_id) {
             $this->tpl->setOnScreenMessage('success', $this->lng->txt("prtf_portfolio_created_from_template"), true);
             $this->ctrl->redirect($this, "preview");
         } else {
             $this->tpl->setOnScreenMessage('success', $this->lng->txt("prtf_portfolio_created"), true);
             $this->ctrl->redirect($this, "view");
         }
     }

Here is the call graph for this function:

◆ createPortfolioFromTemplate()

ilObjPortfolioGUI::createPortfolioFromTemplate ( ilPropertyFormGUI $a_form = null )

protected

Definition at line 712 of file class.ilObjPortfolioGUI.php.

References createPortfolioFromTemplateProcess(), ILIAS\Repository\ctrl(), ilObjPortfolioTemplate\getAvailablePortfolioTemplates(), initCreatePortfolioFromTemplateForm(), and toRepository().

Referenced by createPortfolioFromTemplateProcess().

      : void {
         $title = $this->port_request->getPortfolioTitle();
         $prtt_id = $this->port_request->getPortfolioTemplate();
 
         // valid template?
         $templates = array_keys(ilObjPortfolioTemplate::getAvailablePortfolioTemplates());
         if (!count($templates) || !in_array($prtt_id, $templates)) {
             $this->toRepository();
         }
         unset($templates);
 
         $this->ctrl->setParameter($this, "prtt", $prtt_id);
 
         if (!$a_form) {
             $a_form = $this->initCreatePortfolioFromTemplateForm($prtt_id, $title);
         }
         if ($a_form) {
             $this->tpl->setContent($a_form->getHTML());
         } else {
             $this->createPortfolioFromTemplateProcess(false);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createPortfolioFromTemplateProcess()

ilObjPortfolioGUI::createPortfolioFromTemplateProcess ( bool $a_process_form = true )

protected

Definition at line 852 of file class.ilObjPortfolioGUI.php.

References $ilSetting, ilObjectGUI\$settings, ilObjPortfolioBase\clonePagesAndSettings(), createPortfolioFromTemplate(), ILIAS\Repository\ctrl(), ilPortfolioPage\getAllPortfolioPages(), ilObjPortfolioTemplate\getAvailablePortfolioTemplates(), initCreatePortfolioFromTemplateForm(), linkPortfolioToAssignment(), ILIAS\Repository\lng(), toRepository(), and ilPortfolioTemplatePage\TYPE_BLOG_TEMPLATE.

Referenced by createPortfolioFromTemplate().

      : void {
         $ilSetting = $this->settings;
 
         $title = $this->port_request->getPortfolioTitle();
         $prtt_id = $this->port_request->getPortfolioTemplate();
 
         // valid template?
         $templates = array_keys(ilObjPortfolioTemplate::getAvailablePortfolioTemplates());
         if (!count($templates) || !in_array($prtt_id, $templates)) {
             $this->toRepository();
         }
         unset($templates);
 
         // build page recipe (aka import form values)
         $recipe = null;
         if ($a_process_form) {
             $this->ctrl->setParameter($this, "prtt", $prtt_id);
 
             $form = $this->initCreatePortfolioFromTemplateForm($prtt_id, $title);
             if ($form->checkInput()) {
                 foreach (ilPortfolioTemplatePage::getAllPortfolioPages($prtt_id) as $page) {
                     if (($page["type"] == ilPortfolioTemplatePage::TYPE_BLOG_TEMPLATE) && !$ilSetting->get('disable_wsp_blogs')) {
                         $field_id = "blog_" . $page["id"];
                         switch ($form->getInput($field_id)) {
                             case "blog_create":
                                 $recipe[$page["id"]] = array("blog",
                                                              "create",
                                                              trim($form->getInput($field_id . "_create_title"))
                                 );
                                 break;
 
                             case "blog_resuse":
                                 $recipe[$page["id"]] = array("blog",
                                                              "reuse",
                                                              (int) $form->getInput($field_id . "_reuse_blog")
                                 );
                                 break;
 
                             case "blog_ignore":
                                 $recipe[$page["id"]] = array("blog", "ignore");
                                 break;
                         }
                     }
                 }
 
                 $recipe["skills"] = (array) $form->getInput("skill_ids");
             } else {
                 $form->setValuesByPost();
                 $this->createPortfolioFromTemplate($form);
                 return;
             }
         }
 
         $source = new ilObjPortfolioTemplate($prtt_id, false);
 
         // create portfolio
         $target = new ilObjPortfolio();
         $target->setTitle($title);
         $target->create();
         $target_id = $target->getId();
 
         ilObjPortfolioTemplate::clonePagesAndSettings($source, $target, $recipe);
 
         // link portfolio to exercise assignment
         $this->linkPortfolioToAssignment($target_id);
 
         $this->tpl->setOnScreenMessage('success', $this->lng->txt("prtf_portfolio_created_from_template"), true);
         $this->ctrl->setParameter($this, "prt_id", $target_id);
         $this->ctrl->redirect($this, "preview");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjPortfolioGUI::executeCommand ( )

Definition at line 78 of file class.ilObjPortfolioGUI.php.

References ilObject2GUI\$access_handler, ilObjPortfolioBaseGUI\$gui, addLocator(), ilObject2GUI\checkPermission(), checkPermissionBool(), ILIAS\Repository\ctrl(), ilObjPortfolioBaseGUI\determinePageCall(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getOfflineMessage(), ilObjPortfolioBaseGUI\handlePageCall(), ILIAS\Repository\object(), ilWorkspaceAccessGUI\setBlockingMessage(), ilObjPortfolioBaseGUI\setSettingsSubTabs(), setTabs(), setTitleAndDescription(), and triggerAssignmentTool().

                                     : void
     {
         $this->checkPermission("read");
         $this->setTitleAndDescription();
 
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd("view");
 
         // we have to init the note js handling here, might go to
         // a better place in the future
         /*
         $this->notes_gui->initJavascript(
             $this->ctrl->getLinkTargetByClass(
                 array("ilnotegui"),
                 "",
                 "",
                 true,
                 false
             )
         );*/
 
         // trigger assignment tool
         $this->triggerAssignmentTool();
         switch ($next_class) {
             case "ilworkspaceaccessgui":
                 if ($this->checkPermissionBool("write")) {
                     $this->setTabs();
                     $this->tabs_gui->activateTab("share");
 
                     $this->tpl->setPermanentLink("prtf", $this->object->getId());
 
                     $wspacc = new ilWorkspaceAccessGUI($this->object->getId(), $this->access_handler, true);
                     $wspacc->setBlockingMessage($this->getOfflineMessage());
                     $this->ctrl->forwardCommand($wspacc);
                 }
                 break;
 
             case 'ilportfoliopagegui':
                 if ($this->determinePageCall()) {
                     // only in edit mode
                     $this->addLocator();
                 }
                 $this->handlePageCall($cmd);
                 break;
 
             case "ilcommentgui":
                 $this->preview();
                 break;
 
             case "ilcommonactiondispatchergui":
                 //$this->prepareOutput();
                 $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                 $this->ctrl->forwardCommand($gui);
                 break;
 
                 /*
         case "ilobjstylesheetgui":
                 $this->ctrl->setReturn($this, "editStyleProperties");
                 $style_gui = new ilObjStyleSheetGUI("", $this->object->getStyleSheetId(), false, false);
                 $style_gui->enableWrite(true);
                 $style_gui->omitLocator();
                 if ($cmd == "create" || $this->port_request->getNewType() == "sty") {
                     $style_gui->setCreationMode(true);
                 }
 
                 if ($cmd == "confirmedDelete") {
                     $this->object->setStyleSheetId(0);
                     $this->object->update();
                 }
 
                 $ret = $this->ctrl->forwardCommand($style_gui);
 
                 if ($cmd == "save" || $cmd == "copyStyle" || $cmd == "importStyle") {
                     $style_id = $ret;
                     $this->object->setStyleSheetId($style_id);
                     $this->object->update();
                     $this->ctrl->redirectByClass("ilobjstylesheetgui", "edit");
                 }
                 break;*/
 
             case "ilobjectcontentstylesettingsgui":
                 $this->checkPermission("write");
                 $this->addLocator();
                 $this->setTabs();
                 $this->tabs_gui->activateTab("settings");
                 $this->setSettingsSubTabs("style");
                 $settings_gui = $this->content_style_gui
                     ->objectSettingsGUIForObjId(
                         null,
                         $this->object->getId()
                     );
                 $this->ctrl->forwardCommand($settings_gui);
                 break;
 
             case "ilportfolioexercisegui":
                 $this->ctrl->setReturn($this, "view");
                 $gui = new ilPortfolioExerciseGUI($this->user_id, $this->object->getId());
                 $this->ctrl->forwardCommand($gui);
                 break;
 
             default:
 
                 if ($cmd !== "preview") {
                     $this->addLocator();
                     $this->setTabs();
                 }
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ getCreateInfoMessage()

ilObjPortfolioGUI::getCreateInfoMessage ( )

protected

Definition at line 331 of file class.ilObjPortfolioGUI.php.

References $DIC, $ilSetting, $message, ilObjectGUI\$tree, ilObjPortfolioBaseGUI\$ui, $url, ILIAS\Repository\ctrl(), ilTree\getNodeData(), ilTree\getSubTree(), ILIAS\Repository\lng(), and ilTree\readRootId().

                                              : string
     {
         global $DIC;
 
         $ui = $DIC->ui();
         $ilSetting = $DIC->settings();
 
         $message = "";
         // page type: blog
         if (!$ilSetting->get('disable_wsp_blogs')) {
             $options = array();
             $tree = new ilWorkspaceTree($this->user_id);
             $root = $tree->readRootId();
             if ($root) {
                 $root = $tree->getNodeData($root);
                 foreach ($tree->getSubTree($root) as $node) {
                     if ($node["type"] == "blog") {
                         $options[$node["obj_id"]] = $node["title"];
                     }
                 }
                 asort($options);
             }
             if (!count($options)) {
                 // #18147
                 $this->lng->loadLanguageModule('pd');
                 $url = $this->ctrl->getLinkTargetByClass("ilDashboardGUI", "jumpToWorkspace");
                 $text = $this->lng->txt("mm_personal_and_shared_r");
 
                 $text = sprintf($this->lng->txt("prtf_no_blogs_info"), $text);
 
                 $mbox = $ui->factory()->messageBox()->info($text)
                     ->withLinks([$ui->factory()->link()->standard(
                         $this->lng->txt("mm_personal_and_shared_r"),
                         $url
                     )]);
 
                 $message = $ui->renderer()->render($mbox);
             }
         }
         return $message;
     }

Here is the call graph for this function:

◆ getEditFormCustomValues()

ilObjPortfolioGUI::getEditFormCustomValues ( array & $a_values )

protected

Definition at line 510 of file class.ilObjPortfolioGUI.php.

                                                                 : void
     {
         $a_values["online"] = $this->object->isOnline();
 
         parent::getEditFormCustomValues($a_values);
     }

◆ getOfflineMessage()

ilObjPortfolioGUI::getOfflineMessage ( )

protected

Get offline message for sharing tab.

Definition at line 1118 of file class.ilObjPortfolioGUI.php.

References ilObject2GUI\$ctrl, Vendor\Package\$f, ilObject2GUI\$lng, ilObjPortfolioBaseGUI\$ui, ilCtrl\getLinkTarget(), ILIAS\Repository\object(), and ilLanguage\txt().

Referenced by executeCommand().

                                           : string
     {
         $ui = $this->ui;
         $lng = $this->lng;
         $ctrl = $this->ctrl;
 
         if (!$this->object->isOnline()) {
             $f = $ui->factory();
             $renderer = $ui->renderer();
 
             $buttons = [$f->button()->standard(
                 $lng->txt("prtf_set_online"),
                 $ctrl->getLinkTarget($this, "setOnlineAndShare")
             )];
 
             return $renderer->render($f->messageBox()->info($lng->txt("prtf_no_offline_share_info"))
                 ->withButtons($buttons));
         }
         return "";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPageGUIClassName()

ilObjPortfolioGUI::getPageGUIClassName ( )

Definition at line 567 of file class.ilObjPortfolioGUI.php.

                                          : string
     {
         return "ilportfoliopagegui";
     }

◆ getPageGUIInstance()

ilObjPortfolioGUI::getPageGUIInstance ( int $a_page_id )

protected

Get portfolio template page gui instance.

Definition at line 553 of file class.ilObjPortfolioGUI.php.

References ilObjPortfolioBaseGUI\getAdditional(), ILIAS\Repository\object(), and ilPageObjectGUI\setStyleId().

      : ilPortfolioPageGUI {
         $page_gui = new ilPortfolioPageGUI(
             $this->object->getId(),
             $a_page_id,
             0,
             $this->object->hasPublicComments()
         );
         $page_gui->setStyleId($this->content_style_domain->getEffectiveStyleId());
         $page_gui->setAdditional($this->getAdditional());
         return $page_gui;
     }

Here is the call graph for this function:

◆ getPageInstance()

ilObjPortfolioGUI::getPageInstance	(	?int	$a_page_id = `null`,
		?int	$a_portfolio_id = `null`
	)

protected

Get portfolio template page instance.

Definition at line 537 of file class.ilObjPortfolioGUI.php.

References ilPageObject\getId().

Referenced by saveBlog().

      : ilPortfolioPage {
         // #11531
         if (!$a_portfolio_id && $this->object) {
             $a_portfolio_id = $this->object->getId();
         }
         $page = new ilPortfolioPage((int) $a_page_id);
         $page->setPortfolioId($a_portfolio_id);
         return $page;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSkillsToPortfolioAssignment()

ilObjPortfolioGUI::getSkillsToPortfolioAssignment	(	array	$a_pskills,
		array	$a_skill_ids,
		ilPortfolioTemplatePage	$a_source_page
	)

Definition at line 1077 of file class.ilObjPortfolioGUI.php.

References ilPageObject\getDomDoc().

Referenced by createPortfolioFromAssignment(), and initCreatePortfolioFromTemplateForm().

      : array {
         $dom = $a_source_page->getDomDoc();
         $xpath = new DOMXPath($dom);
         $nodes = $xpath->query("//PageContent/Skills");
         foreach ($nodes as $node) {
             $skill_id = $node->getAttribute("Id");
             if (!in_array($skill_id, $a_pskills)) {
                 $a_skill_ids[] = $skill_id;
             }
         }
         unset($nodes, $xpath, $dom);
 
         return $a_skill_ids;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

ilObjPortfolioGUI::getType ( )

Definition at line 58 of file class.ilObjPortfolioGUI.php.

Referenced by initCreateForm(), and initCreateFromTemplateForm().

                              : string
     {
         return "prtf";
     }

Here is the caller graph for this function:

◆ initBlogForm()

ilObjPortfolioGUI::initBlogForm ( )

protected

Definition at line 606 of file class.ilObjPortfolioGUI.php.

References ilObjectGUI\$tree, ILIAS\Repository\ctrl(), ilTree\getNodeData(), ilTree\getSubTree(), ILIAS\Repository\lng(), ilTree\readRootId(), ilFormPropertyGUI\setInfo(), and ilSelectInputGUI\setOptions().

Referenced by saveBlog().

                                      : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this));
 
         $options = array();
         $tree = new ilWorkspaceTree($this->user_id);
         $root = $tree->readRootId();
         if ($root) {
             $root = $tree->getNodeData($root);
             foreach ($tree->getSubTree($root, true, ["blog"]) as $node) {
                 $options[$node["obj_id"]] = $node["title"];
             }
             asort($options);
         }
 
         // add blog
         $radg = new ilRadioGroupInputGUI($this->lng->txt("obj_blog"), "creation_mode");
         $radg->setInfo($this->lng->txt(""));
         $radg->setValue("new");
         $radg->setInfo($this->lng->txt(""));
 
         $op1 = new ilRadioOption($this->lng->txt("prtf_add_new_blog"), "new", $this->lng->txt("prtf_add_new_blog_info"));
         $radg->addOption($op1);
         $form->addItem($radg);
 
         // Blog title
         $ti = new ilTextInputGUI($this->lng->txt("title"), "title");
         $ti->setRequired(true);
         $op1->addSubItem($ti);
 
 
         if (count($options)) {
             $op2 = new ilRadioOption($this->lng->txt("prtf_add_existing_blog"), "existing");
             $radg->addOption($op2);
 
             $obj = new ilSelectInputGUI($this->lng->txt("obj_blog"), "blog");
             $obj->setOptions($options);
             $op2->addSubItem($obj);
         }
 
         $form->setTitle($this->lng->txt("prtf_add_blog") . ": " .
             $this->object->getTitle());
         $form->addCommandButton("saveBlog", $this->lng->txt("save"));
         $form->addCommandButton("view", $this->lng->txt("cancel"));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCopyPageFormOptions()

ilObjPortfolioGUI::initCopyPageFormOptions ( ilPropertyFormGUI $a_form )

protected

Definition at line 572 of file class.ilObjPortfolioGUI.php.

References ilPropertyFormGUI\addItem(), ilObjPortfolio\getPortfoliosOfUser(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setRequired().

                                                                          : void
     {
         $a_tgt = new ilRadioGroupInputGUI($this->lng->txt("target"), "target");
         $a_tgt->setRequired(true);
         $a_form->addItem($a_tgt);
 
         $old = new ilRadioOption($this->lng->txt("prtf_existing_portfolio"), "old");
         $a_tgt->addOption($old);
 
         $options = array();
         $all = ilObjPortfolio::getPortfoliosOfUser($this->user_id);
         foreach ($all as $item) {
             $options[$item["id"]] = $item["title"];
         }
         $prtf = new ilSelectInputGUI($this->lng->txt("portfolio"), "prtf");
         $prtf->setRequired(true);
         $prtf->setOptions($options);
         $old->addSubItem($prtf);
 
         $new = new ilRadioOption($this->lng->txt("prtf_new_portfolio"), "new");
         $a_tgt->addOption($new);
 
         $tf = new ilTextInputGUI($this->lng->txt("title"), "title");
         $tf->setMaxLength(128);
         $tf->setSize(40);
         $tf->setRequired(true);
         $new->addSubItem($tf);
     }

Here is the call graph for this function:

◆ initCreateForm()

ilObjPortfolioGUI::initCreateForm ( string $new_type )

protected

Definition at line 379 of file class.ilObjPortfolioGUI.php.

References $ilSetting, ilObjectGUI\$settings, ILIAS\Repository\ctrl(), getType(), ILIAS\Repository\lng(), and ilObject\TITLE_LENGTH.

Referenced by initCreationForms(), and save().

                                                        : ilPropertyFormGUI
     {
         $ilSetting = $this->settings;
 
         $this->ctrl->setParameter($this, "new_type", $this->getType());
 
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this));
 
         // title
         $ti = new ilTextInputGUI($this->lng->txt("title"), "title");
         $ti->setSize(min(40, ilObject::TITLE_LENGTH));
         $ti->setMaxLength(ilObject::TITLE_LENGTH);
         $ti->setRequired(true);
         $form->addItem($ti);
 
         $form->setTitle($this->lng->txt("prtf_create_portfolio"));
         $form->addCommandButton("save", $this->lng->txt("create"));
         $form->addCommandButton("toRepository", $this->lng->txt("cancel"));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreateFromTemplateForm()

ilObjPortfolioGUI::initCreateFromTemplateForm ( )

protected

Definition at line 402 of file class.ilObjPortfolioGUI.php.

References $ilSetting, ilObjectGUI\$settings, ILIAS\Repository\ctrl(), ilObjPortfolioTemplate\getAvailablePortfolioTemplates(), getType(), ILIAS\Repository\lng(), ilFormPropertyGUI\setRequired(), and ilObject\TITLE_LENGTH.

Referenced by createFromTemplate(), and saveFromTemplate().

                                                    : ilPropertyFormGUI
     {
         $ilSetting = $this->settings;
 
         $this->ctrl->setParameter($this, "new_type", $this->getType());
 
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this));
 
         // title
         $ti = new ilTextInputGUI($this->lng->txt("title"), "title");
         $ti->setSize(min(40, ilObject::TITLE_LENGTH));
         $ti->setMaxLength(ilObject::TITLE_LENGTH);
         $ti->setRequired(true);
         $form->addItem($ti);
 
         // portfolio templates
         $templates = ilObjPortfolioTemplate::getAvailablePortfolioTemplates();
         if (count($templates)) {
             $tmpl = new ilSelectInputGUI($this->lng->txt("obj_prtt"), "prtt");
             $tmpl->setRequired(true);
             $tmpl->setOptions(array("" => $this->lng->txt("please_select")) + $templates);
             $form->addItem($tmpl);
 
             // incoming from repository
             $template_id = $this->port_request->getPortfolioTemplateId();
             if ($template_id > 0) {
                 $tmpl->setValue($template_id);
             }
         }
 
         $form->setTitle($this->lng->txt("prtf_add_portfolio_from_template"));
         $form->addCommandButton("saveFromTemplate", $this->lng->txt("create"));
         $form->addCommandButton("toRepository", $this->lng->txt("cancel"));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreatePortfolioFromTemplateForm()

ilObjPortfolioGUI::initCreatePortfolioFromTemplateForm	(	int	$a_prtt_id,
		string	$a_title
	)

protected

Definition at line 737 of file class.ilObjPortfolioGUI.php.

References $ilSetting, ilObjectGUI\$settings, ilObjectGUI\$tree, ilObject2GUI\$user, ilSkillTreeNode\_lookupTitle(), ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), ilPortfolioPage\getAllPortfolioPages(), ilTree\getNodeData(), getSkillsToPortfolioAssignment(), ilTree\getSubTree(), ILIAS\Repository\lng(), ilTree\readRootId(), ilFormPropertyGUI\setInfo(), ilFormPropertyGUI\setRequired(), ilPortfolioTemplatePage\TYPE_BLOG_TEMPLATE, and ilPortfolioPage\TYPE_PAGE.

Referenced by createPortfolioFromTemplate(), and createPortfolioFromTemplateProcess().

      : ?ilPropertyFormGUI {
         $ilSetting = $this->settings;
         $ilUser = $this->user;
 
         $blog_options = [];
 
         $exc_id = $this->port_request->getExerciseRefId();
         $ass_id = $this->port_request->getExcAssId();
         if ($exc_id > 0) {
             $this->ctrl->setParameter($this, "exc_id", $exc_id);
             $this->ctrl->setParameter($this, "ass_id", $ass_id);
         }
 
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this));
 
         $tmpl = new ilNonEditableValueGUI($this->lng->txt("obj_prtt"));
         $tmpl->setValue(ilObject::_lookupTitle($a_prtt_id));
         $form->addItem($tmpl);
 
         $title = new ilNonEditableValueGUI($this->lng->txt("title"), "pt");
         $title->setValue($a_title);
         $form->addItem($title);
 
         // gather user blogs
         if (!$ilSetting->get('disable_wsp_blogs')) {
             $blog_options = array();
             $tree = new ilWorkspaceTree($this->user_id);
             $root = $tree->readRootId();
             if ($root) {
                 $root = $tree->getNodeData($root);
                 foreach ($tree->getSubTree($root, true, ["blog"]) as $node) {
                     $blog_options[$node["obj_id"]] = $node["title"];
                 }
                 asort($blog_options);
             }
         }
 
         $has_form_content = false;
 
         $pskills = array_keys($this->skill_personal_service->getSelectedUserSkills($ilUser->getId()));
         $skill_ids = array();
 
         foreach (ilPortfolioTemplatePage::getAllPortfolioPages($a_prtt_id) as $page) {
             switch ($page["type"]) {
                 case ilPortfolioPage::TYPE_PAGE:
                     // skills
                     $source_page = new ilPortfolioTemplatePage($page["id"]);
                     $source_page->buildDom(true);
                     $skill_ids = $this->getSkillsToPortfolioAssignment($pskills, $skill_ids, $source_page);
 
                     if (count($skill_ids)) {
                         $has_form_content = true;
                     }
                     break;
 
                 case ilPortfolioTemplatePage::TYPE_BLOG_TEMPLATE:
                     if (!$ilSetting->get('disable_wsp_blogs')) {
                         $has_form_content = true;
 
                         $field_id = "blog_" . $page["id"];
 
                         $blog = new ilRadioGroupInputGUI($this->lng->txt("obj_blog") . ": " .
                             $page["title"], $field_id);
                         $blog->setRequired(true);
                         $blog->setValue("blog_create");
                         $form->addItem($blog);
 
                         $new_blog = new ilRadioOption($this->lng->txt("prtf_template_import_blog_create"), "blog_create");
                         $blog->addOption($new_blog);
 
                         $title = new ilTextInputGUI($this->lng->txt("title"), $field_id . "_create_title");
                         $title->setRequired(true);
                         $new_blog->addSubItem($title);
 
                         if (count($blog_options)) {
                             $reuse_blog = new ilRadioOption($this->lng->txt("prtf_template_import_blog_reuse"), "blog_resuse");
                             $blog->addOption($reuse_blog);
 
                             $obj = new ilSelectInputGUI($this->lng->txt("obj_blog"), $field_id . "_reuse_blog");
                             $obj->setRequired(true);
                             $obj->setOptions(array("" => $this->lng->txt("please_select")) + $blog_options);
                             $reuse_blog->addSubItem($obj);
                         }
 
                         $blog->addOption(new ilRadioOption($this->lng->txt("prtf_template_import_blog_ignore"), "blog_ignore"));
                     }
                     break;
             }
         }
 
         if ($skill_ids) {
             $skills = new ilCheckboxGroupInputGUI($this->lng->txt("skills"), "skill_ids");
             $skills->setInfo($this->lng->txt("prtf_template_import_new_skills"));
             $skills->setValue($skill_ids);
             foreach ($skill_ids as $skill_id) {
                 $skills->addOption(new ilCheckboxOption(ilSkillTreeNode::_lookupTitle($skill_id), $skill_id));
             }
             $form->addItem($skills);
         }
         // no dialog needed, go ahead
         if (!$has_form_content) {
             return null;
         }
 
         $form->setTitle($this->lng->txt("prtf_creation_mode") . ": " . $this->lng->txt("prtf_creation_mode_template"));
         $form->addCommandButton("createPortfolioFromTemplateProcess", $this->lng->txt("continue"));
         $form->addCommandButton("toRepository", $this->lng->txt("cancel"));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreationForms()

ilObjPortfolioGUI::initCreationForms ( string $new_type )

protected

Definition at line 374 of file class.ilObjPortfolioGUI.php.

References initCreateForm().

Referenced by create().

                                                           : array
     {
         return array(self::CFORM_NEW => $this->initCreateForm($new_type));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initEditForm()

ilObjPortfolioGUI::initEditForm ( )

protected

Definition at line 483 of file class.ilObjPortfolioGUI.php.

References ILIAS\Repository\ctrl(), ilObjPortfolioBaseGUI\initEditCustomForm(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilObject\TITLE_LENGTH.

                                      : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this));
 
         // title
         $ti = new ilTextInputGUI($this->lng->txt("title"), "title");
         $ti->setSize(min(40, ilObject::TITLE_LENGTH));
         $ti->setMaxLength(ilObject::TITLE_LENGTH);
         $ti->setRequired(true);
         $ti->setValue($this->object->getTitle());
         $form->addItem($ti);
 
         // :TODO: online
         $online = new ilCheckboxInputGUI($this->lng->txt("online"), "online");
         $online->setChecked($this->object->isOnline());
         $form->addItem($online);
 
         $this->initEditCustomForm($form);
 
         $form->setTitle($this->lng->txt("prtf_edit_portfolio"));
         $form->addCommandButton("update", $this->lng->txt("save"));
         $form->addCommandButton("view", $this->lng->txt("cancel"));
 
         return $form;
     }

Here is the call graph for this function:

◆ linkPortfolioToAssignment()

ilObjPortfolioGUI::linkPortfolioToAssignment ( int $a_target_id )

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

References ilObject2GUI\$access, ilObject2GUI\$user, ilExSubmission\addResourceObject(), and ilExAssignment\TYPE_PORTFOLIO.

Referenced by createPortfolioFromAssignment(), and createPortfolioFromTemplateProcess().

                                                                : void
     {
         $ilAccess = $this->access;
         $ilUser = $this->user;
 
         $exc_ref_id = $this->port_request->getExerciseRefId();
         $ass_id = $this->port_request->getExcAssId();
 
         if ($exc_ref_id &&
             $ass_id &&
             $ilAccess->checkAccess("read", "", $exc_ref_id)) {
             $exc = new ilObjExercise($exc_ref_id);
             $ass = new ilExAssignment($ass_id);
             if ($ass->getExerciseId() === $exc->getId() &&
                 $ass->getType() === ilExAssignment::TYPE_PORTFOLIO) {
                 // #16205
                 $sub = new ilExSubmission($ass, $ilUser->getId());
                 $sub->addResourceObject($a_target_id);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ printSelection()

ilObjPortfolioGUI::printSelection ( )

Exceptions

Definition at line 1099 of file class.ilObjPortfolioGUI.php.

                                     : void
     {
         $view = $this->getPrintView();
         $view->sendForm();
     }

◆ save()

ilObjPortfolioGUI::save ( )

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

References initCreateForm().

                           : void
     {
         $form = $this->initCreateForm("prtf");
         parent::save();
     }

Here is the call graph for this function:

◆ saveBlog()

ilObjPortfolioGUI::saveBlog ( )

protected

Create new portfolio blog page.

Definition at line 658 of file class.ilObjPortfolioGUI.php.

References ilObject2GUI\$access_handler, $DIC, ilObject2GUI\$node_id, ilObjectGUI\$tree, checkPermissionBool(), ILIAS\Repository\ctrl(), getPageInstance(), ilTree\getRootId(), initBlogForm(), ILIAS\Repository\lng(), ilTree\readRootId(), and ilPortfolioPage\TYPE_BLOG.

                                  : void
     {
         global $DIC;
 
         $ilUser = $DIC->user();
 
         $form = $this->initBlogForm();
         if ($form->checkInput() && $this->checkPermissionBool("write")) {
             if ($form->getInput("creation_mode") == "existing") {
                 $page = $this->getPageInstance();
                 $page->setType(ilPortfolioPage::TYPE_BLOG);
                 $page->setTitle($form->getInput("blog"));
             } else {
                 $blog = new ilObjBlog();
                 $blog->setTitle($form->getInput("title"));
                 $blog->create();
 
                 $tree = new ilWorkspaceTree($ilUser->getId());
 
                 // @todo: see also e.g. ilExSubmissionObjectGUI->getOverviewContentBlog, this needs refactoring, consumer should not
                 // be responsibel to handle this
                 if (!$tree->getRootId()) {
                     $tree->createTreeForUser($ilUser->getId());
                 }
 
                 $access_handler = new ilWorkspaceAccessHandler($tree);
                 $node_id = $tree->insertObject($tree->readRootId(), $blog->getId());
                 $access_handler->setPermissions($tree->readRootId(), $node_id);
 
                 $page = $this->getPageInstance();
                 $page->setType(ilPortfolioPage::TYPE_BLOG);
                 $page->setTitle($blog->getId());
             }
             $page->create(false);
 
             $this->tpl->setOnScreenMessage('success', $this->lng->txt("prtf_blog_page_created"), true);
             $this->ctrl->redirect($this, "view");
         }
 
         $this->tabs_gui->clearTargets();
         $this->tabs_gui->setBackTarget(
             $this->lng->txt("back"),
             $this->ctrl->getLinkTarget($this, "view")
         );
 
         $form->setValuesByPost();
         $this->tpl->setContent($form->getHTML());
     }

Here is the call graph for this function:

◆ saveFromTemplate()

ilObjPortfolioGUI::saveFromTemplate ( )

Definition at line 446 of file class.ilObjPortfolioGUI.php.

References createFromTemplateDirect(), and initCreateFromTemplateForm().

                                       : void
     {
         $form = $this->initCreateFromTemplateForm();
         // trigger portfolio template "import" process
         if ($form->checkInput()) {
             $this->createFromTemplateDirect(
                 $form->getInput("title"),
                 $this->port_request->getPortfolioTemplate()
             );
             return;
         } else {
             $form->setValuesByPost();
             $this->tpl->setContent($form->getHTML());
         }
     }

Here is the call graph for this function:

◆ setOnlineAndShare()

ilObjPortfolioGUI::setOnlineAndShare ( )

protected

Set online and switch to share screen.

Definition at line 1142 of file class.ilObjPortfolioGUI.php.

References ilObject2GUI\$ctrl, ilObject2GUI\$lng, ilObject\_lookupOwner(), ILIAS\Repository\object(), and ilLanguage\txt().

                                           : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         if (ilObjPortfolio::_lookupOwner($this->object->getId()) === $this->user_id) {
             $this->object->setOnline(true);
             $this->object->update();
             $this->tpl->setOnScreenMessage('success', $lng->txt("prtf_has_been_set_online"), true);
         }
         $ilCtrl->redirectByClass("ilworkspaceaccessgui", "");
     }

Here is the call graph for this function:

◆ setTabs()

ilObjPortfolioGUI::setTabs ( )

protected

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

References ilObjPortfolioBaseGUI\$help, checkPermissionBool(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilHelpGUI\setScreenIdComponent().

Referenced by executeCommand().

                                 : void
     {
         $ilHelp = $this->help;
 
         $ilHelp->setScreenIdComponent("prtf");
 
         if ($this->checkPermissionBool("write")) {
             $this->tabs_gui->addTab(
                 "pages",
                 $this->lng->txt("content"),
                 $this->ctrl->getLinkTarget($this, "view")
             );
 
             $this->tabs_gui->addTab(
                 "settings",
                 $this->lng->txt("settings"),
                 $this->ctrl->getLinkTarget($this, "edit")
             );
 
             $this->tabs_gui->addNonTabbedLink(
                 "preview",
                 $this->lng->txt("preview"),
                 $this->ctrl->getLinkTarget($this, "preview")
             );
 
             $this->lng->loadLanguageModule("wsp");
             $this->tabs_gui->addTab(
                 "share",
                 $this->lng->txt("wsp_permissions"),
                 $this->ctrl->getLinkTargetByClass("ilworkspaceaccessgui", "share")
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTitleAndDescription()

ilObjPortfolioGUI::setTitleAndDescription ( )

protected

Definition at line 252 of file class.ilObjPortfolioGUI.php.

References ilUtil\getImagePath(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by executeCommand().

                                                : void
     {
         // parent::setTitleAndDescription();
 
         $title = $this->lng->txt("portfolio");
         if ($this->object) {
             $title .= ": " . $this->object->getTitle();
         }
         $this->tpl->setTitle($title);
         $this->tpl->setTitleIcon(
             ilUtil::getImagePath("standard/icon_prtf.svg"),
             $this->lng->txt("portfolio")
         );
 
         if ($this->object &&
             !$this->object->isOnline()) {
             $this->tpl->setAlertProperties(array(
                 array("alert" => true,
                     "property" => $this->lng->txt("status"),
                     "value" => $this->lng->txt("offline"))
             ));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showPrintView()

ilObjPortfolioGUI::showPrintView ( )

Parameters

bool $a_dev_mode

Exceptions

Definition at line 1109 of file class.ilObjPortfolioGUI.php.

      : void {
         $printview = $this->getPrintView();
         $printview->sendPrintView();
     }

◆ toRepository()

ilObjPortfolioGUI::toRepository ( )

protected

Definition at line 469 of file class.ilObjPortfolioGUI.php.

References ilObject2GUI\$access, ILIAS\Repository\ctrl(), and ilUtil\redirect().

Referenced by createFromTemplateDirect(), createPortfolioFromAssignment(), createPortfolioFromTemplate(), and createPortfolioFromTemplateProcess().

                                      : void
     {
         $ilAccess = $this->access;
 
         // return to exercise (portfolio assignment)
         $exc_ref_id = $this->port_request->getExerciseRefId();
         if ($exc_ref_id &&
             $ilAccess->checkAccess("read", "", $exc_ref_id)) {
             ilUtil::redirect(ilLink::_getLink($exc_ref_id, "exc"));
         }
 
         $this->ctrl->redirectByClass("ilportfoliorepositorygui", "show");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ triggerAssignmentTool()

ilObjPortfolioGUI::triggerAssignmentTool ( )

protected

Definition at line 189 of file class.ilObjPortfolioGUI.php.

References ilExerciseGSToolProvider\EXC_ASS_BUTTONS, ilExerciseGSToolProvider\EXC_ASS_IDS, ILIAS\Repository\object(), and ilExerciseGSToolProvider\SHOW_EXC_ASSIGNMENT_INFO.

Referenced by executeCommand().

                                               : void
     {
         if (!is_object($this->object) || $this->object->getId() <= 0) {
             return;
         }
         $pe = new ilPortfolioExercise($this->user_id, $this->object->getId());
         $pe_gui = new ilPortfolioExerciseGUI($this->user_id, $this->object->getId());
         $assignments = $pe->getAssignmentsOfPortfolio();
         if (count($assignments) > 0) {
             $ass_ids = array_map(static function ($i) {
                 return $i["ass_id"];
             }, $assignments);
             $this->tool_context->current()->addAdditionalData(ilExerciseGSToolProvider::SHOW_EXC_ASSIGNMENT_INFO, true);
             $this->tool_context->current()->addAdditionalData(ilExerciseGSToolProvider::EXC_ASS_IDS, $ass_ids);
             $this->tool_context->current()->addAdditionalData(ilExerciseGSToolProvider::EXC_ASS_BUTTONS, $pe_gui->getActionButtons());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateCustom()

ilObjPortfolioGUI::updateCustom ( ilPropertyFormGUI $form )

protected

Definition at line 517 of file class.ilObjPortfolioGUI.php.

References ilPropertyFormGUI\getInput(), and ilObjPortfolio\setUserDefault().

                                                             : void
     {
         $this->object->setOnline($form->getInput("online"));
 
         // if portfolio is not online, it cannot be default
         if (!$form->getInput("online")) {
             ilObjPortfolio::setUserDefault($this->user_id, 0);
         }
 
         parent::updateCustom($form);
     }

Here is the call graph for this function:

Field Documentation

◆ $declaration_authorship

ilPortfolioDeclarationOfAuthorship ilObjPortfolioGUI::$declaration_authorship

protected

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

◆ $notes_gui

ILIAS Notes GUIService ilObjPortfolioGUI::$notes_gui

protected

Definition at line 30 of file class.ilObjPortfolioGUI.php.

◆ $skill_personal_service

ILIAS Skill Service SkillPersonalService ilObjPortfolioGUI::$skill_personal_service

protected

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

◆ $tool_context

ContextServices ilObjPortfolioGUI::$tool_context

protected

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

◆ $ws_access

ilWorkspaceAccessHandler ilObjPortfolioGUI::$ws_access

protected

Definition at line 31 of file class.ilObjPortfolioGUI.php.

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

Modules/Portfolio/classes/class.ilObjPortfolioGUI.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _goto()

◆ addLocator()

◆ afterSave()

◆ checkPermissionBool()

◆ create()

◆ createFromTemplate()

◆ createFromTemplateDirect()

◆ createPortfolioFromAssignment()

◆ createPortfolioFromTemplate()

◆ createPortfolioFromTemplateProcess()

◆ executeCommand()

◆ getCreateInfoMessage()

◆ getEditFormCustomValues()

◆ getOfflineMessage()

◆ getPageGUIClassName()

◆ getPageGUIInstance()

◆ getPageInstance()

◆ getSkillsToPortfolioAssignment()

◆ getType()

◆ initBlogForm()

◆ initCopyPageFormOptions()

◆ initCreateForm()

◆ initCreateFromTemplateForm()

◆ initCreatePortfolioFromTemplateForm()

◆ initCreationForms()

◆ initEditForm()

◆ linkPortfolioToAssignment()

◆ printSelection()

◆ save()

◆ saveBlog()

◆ saveFromTemplate()

◆ setOnlineAndShare()

◆ setTabs()

◆ setTitleAndDescription()

◆ showPrintView()

◆ toRepository()

◆ triggerAssignmentTool()

◆ updateCustom()

Field Documentation

◆ $declaration_authorship

◆ $notes_gui

◆ $skill_personal_service

◆ $tool_context

◆ $ws_access