This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjPortfolioTemplateGUI:

Collaboration diagram for ilObjPortfolioTemplateGUI:

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

	getType ()

	executeCommand ()

	infoScreen ()
	this one is called from the info button in the repository More...

	infoScreenForward ()

	getPageGUIClassName ()

	preview (bool $a_return=false, $a_content=false, bool $a_show_notes=true)

	createFromTemplateOld ()

	createFromTemplate ()

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)

	cancelDelete ()

	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] don't belong to the current 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...

	cancelDeleteObject ()
	cancel deletion of object More...

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

	createObject ()
	create new object form More...

	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)

Protected Member Functions
	setTabs ()

	initDidacticTemplate (ilPropertyFormGUI $form)

	initEditCustomForm (ilPropertyFormGUI $a_form)

	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 ()
	Init blog template page form. More...

	saveBlog ()

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 ()

	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="")

	fillCloneTemplate (?string $tpl_varname, string $type)

	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...

	getPermanentLinkWidget (string $append=null, bool $center=false)

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	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...

	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...

	fillCloneTemplate (?string $tpl_name, string $type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. 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...

	showCustomIconsEditing ( $input_colspan=1, ilPropertyFormGUI $form=null, $as_section=true)
	show edit section of custom icons for container More...

Protected Attributes
ilNavigationHistory	$nav_history

ilHelpGUI	$help

ilTabsGUI	$tabs

Protected Attributes inherited from ilObjPortfolioBaseGUI
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

ilObjectService	$object_service

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 = array()

	$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

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
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)

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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Portfolio template 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

ilObjPortfolioTemplateGUI: ilPortfolioTemplatePageGUI, ilPageObjectGUI, ilNoteGUI ilObjPortfolioTemplateGUI: ilObjectCopyGUI, ilInfoScreenGUI, ilCommonActionDispatcherGUI ilObjPortfolioTemplateGUI: ilPermissionGUI, ilExportGUI, ilObjectContentStyleSettingsGUI ilObjPortfolioTemplateGUI: ilObjectMetaDataGUI .php

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

Constructor & Destructor Documentation

◆ __construct()

ilObjPortfolioTemplateGUI::__construct	(	int	$a_id = `0`,
		int	$a_id_type = `self::REPOSITORY_NODE_ID`,
		int	$a_parent_node_id = `0`
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\help(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

       {
         parent::__construct($a_id, $a_id_type, $a_parent_node_id);
         global $DIC;
 
         $this->nav_history = $DIC["ilNavigationHistory"];
         $this->help = $DIC["ilHelp"];
         $this->tabs = $DIC->tabs();
         $this->toolbar = $DIC->toolbar();
         $this->user = $DIC->user();
     }

Here is the call graph for this function:

Member Function Documentation

◆ createFromTemplate()

ilObjPortfolioTemplateGUI::createFromTemplate ( )

Definition at line 536 of file class.ilObjPortfolioTemplateGUI.php.

References ilObject2GUI\$access, ilObject2GUI\$ctrl, $DIC, ilObjectGUI\$id, ilObjectGUI\$ref_id, ilRBACAccessHandler\checkAccess(), ILIAS\Repository\ctrl(), ILIAS\Repository\object(), ilCtrl\redirectByClass(), and ilCtrl\setParameterByClass().

                                         : void
     {
         $this->ctrl->setParameterByClass("ilobjportfoliogui", "prtt_pre", $this->object->getId());
         $this->ctrl->redirectByClass(array("ilDashboardGUI", "ilportfoliorepositorygui", "ilobjportfoliogui"), "createFromTemplateDirect");
     }

Here is the call graph for this function:

◆ createFromTemplateOld()

ilObjPortfolioTemplateGUI::createFromTemplateOld ( )

Definition at line 530 of file class.ilObjPortfolioTemplateGUI.php.

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

                                            : void
     {
         $this->ctrl->setParameterByClass("ilobjportfoliogui", "prtt_pre", $this->object->getId());
         $this->ctrl->redirectByClass(array("ilDashboardGUI", "ilportfoliorepositorygui", "ilobjportfoliogui"), "create");
     }

Here is the call graph for this function:

◆ executeCommand()

ilObjPortfolioTemplateGUI::executeCommand ( )

Definition at line 56 of file class.ilObjPortfolioTemplateGUI.php.

References $nav_history, ilObjectGUI\addHeaderAction(), ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), ilObjPortfolioBaseGUI\determinePageCall(), ilObject2GUI\executeCommand(), ilObject2GUI\getAccessHandler(), ilObject2GUI\getCreationMode(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), ilObjPortfolioBaseGUI\handlePageCall(), infoScreenForward(), ILIAS\Repository\object(), ilObject2GUI\prepareOutput(), preview(), and ilObjPortfolioBaseGUI\setSettingsSubTabs().

                                     : void
     {
         $ilNavigationHistory = $this->nav_history;
 
         // add entry to navigation history
         if (!$this->getCreationMode() &&
             $this->getAccessHandler()->checkAccess("read", "", $this->node_id)) {
             $link = $this->ctrl->getLinkTarget($this, "view");
             $ilNavigationHistory->addItem($this->node_id, $link, "prtt");
         }
 
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd("view");
         switch ($next_class) {
             case 'ilportfoliotemplatepagegui':
                 $this->determinePageCall(); // has to be done before locator!
                 $this->prepareOutput();
                 $this->handlePageCall($cmd);
                 break;
 
             case "ilnotegui":
                 $this->preview();
                 break;
 
             case "ilinfoscreengui":
                 $this->prepareOutput();
                 $this->addHeaderAction();
                 $this->infoScreenForward();
                 break;
 
             case "ilcommonactiondispatchergui":
                 $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                 $this->prepareOutput();
                 $this->ctrl->forwardCommand($gui);
                 break;
 
             case "ilpermissiongui":
                 $this->prepareOutput();
                 $this->tabs_gui->activateTab("id_permissions");
                 $perm_gui = new ilPermissionGUI($this);
                 $this->ctrl->forwardCommand($perm_gui);
                 break;
 
             case "ilobjectcopygui":
                 $this->prepareOutput();
                 $cp = new ilObjectCopyGUI($this);
                 $cp->setType("prtt");
                 $this->ctrl->forwardCommand($cp);
                 break;
 
             case 'ilexportgui':
                 $this->prepareOutput();
                 $this->tabs_gui->activateTab("export");
                 $exp_gui = new ilExportGUI($this);
                 $exp_gui->addFormat("xml");
                 $this->ctrl->forwardCommand($exp_gui);
                 break;
 
             case "ilobjectcontentstylesettingsgui":
                 $this->checkPermission("write");
                 $this->prepareOutput();
                 $this->addHeaderAction();
                 $this->tabs_gui->activateTab("settings");
                 $this->setSettingsSubTabs("style");
                 $settings_gui = $this->content_style_gui
                     ->objectSettingsGUIForRefId(
                         null,
                         $this->object->getRefId()
                     );
                 $this->ctrl->forwardCommand($settings_gui);
                 break;
 
             case "ilobjectmetadatagui":
                 $this->checkPermission("write");
                 $this->prepareOutput();
                 $this->addHeaderAction();
                 $this->tabs_gui->activateTab("advmd");
                 $md_gui = new ilObjectMetaDataGUI($this->object, "pfpg");
                 $this->ctrl->forwardCommand($md_gui);
                 break;
 
             default:
                 $this->addHeaderAction();
                 ilObject2GUI::executeCommand();
         }
     }

Here is the call graph for this function:

◆ getEditFormCustomValues()

ilObjPortfolioTemplateGUI::getEditFormCustomValues ( array & $a_values )

protected

Definition at line 348 of file class.ilObjPortfolioTemplateGUI.php.

References ilContainer\_lookupContainerSetting(), ilObjectServiceSettingsGUI\CUSTOM_METADATA, IL_CAL_UNIX, and ILIAS\Repository\object().

                                                                 : void
     {
         $a_values["online"] = $this->object->isOnline();
         $a_values["access_period"]["start"] = $this->object->getActivationStartDate()
             ? new ilDateTime($this->object->getActivationStartDate(), IL_CAL_UNIX)
             : null;
         $a_values["access_period"]["end"] = $this->object->getActivationEndDate()
             ? new ilDateTime($this->object->getActivationEndDate(), IL_CAL_UNIX)
             : null;
         $a_values["access_visiblity"] = $this->object->getActivationVisibility();
 
         $a_values['cont_custom_md'] = ilContainer::_lookupContainerSetting(
             $this->object->getId(),
             ilObjectServiceSettingsGUI::CUSTOM_METADATA,
             false
         );
 
         parent::getEditFormCustomValues($a_values);
     }

Here is the call graph for this function:

◆ getPageGUIClassName()

ilObjPortfolioTemplateGUI::getPageGUIClassName ( )

Definition at line 434 of file class.ilObjPortfolioTemplateGUI.php.

                                          : string
     {
         return "ilportfoliotemplatepagegui";
     }

◆ getPageGUIInstance()

ilObjPortfolioTemplateGUI::getPageGUIInstance ( int $a_page_id )

protected

Get portfolio template page gui instance.

Definition at line 421 of file class.ilObjPortfolioTemplateGUI.php.

References ilObjPortfolioBaseGUI\getAdditional(), ILIAS\Repository\object(), and ilPortfolioPageGUI\setAdditional().

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

Here is the call graph for this function:

◆ getPageInstance()

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

protected

Get portfolio template page instance.

Definition at line 406 of file class.ilObjPortfolioTemplateGUI.php.

References ilPageObject\getId().

Referenced by saveBlog().

      : ilPortfolioTemplatePage {
         if (!$a_portfolio_id && $this->object) {
             $a_portfolio_id = $this->object->getId();
         }
         $page = new ilPortfolioTemplatePage((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:

◆ getType()

ilObjPortfolioTemplateGUI::getType ( )

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

                              : string
     {
         return "prtt";
     }

◆ infoScreen()

ilObjPortfolioTemplateGUI::infoScreen ( )

this one is called from the info button in the repository

Definition at line 204 of file class.ilObjPortfolioTemplateGUI.php.

References ILIAS\Repository\ctrl(), and infoScreenForward().

                                 : void
     {
         $this->ctrl->setCmd("showSummary");
         $this->ctrl->setCmdClass("ilinfoscreengui");
         $this->infoScreenForward();
     }

Here is the call graph for this function:

◆ infoScreenForward()

ilObjPortfolioTemplateGUI::infoScreenForward ( )

Definition at line 211 of file class.ilObjPortfolioTemplateGUI.php.

References $tabs, ilObject2GUI\$toolbar, ilObject2GUI\checkPermission(), ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ilLinkButton\getInstance(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by executeCommand(), and infoScreen().

                                        : void
     {
         $ilTabs = $this->tabs;
         $ilToolbar = $this->toolbar;
 
         $ilTabs->activateTab("id_info");
 
         $this->checkPermission("visible");
 
         if ($this->checkPermissionBool("read")) {
             $this->lng->loadLanguageModule("cntr");
 
             $button = ilLinkButton::getInstance();
             $button->setPrimary(true);
             $button->setCaption("prtf_create_portfolio_from_template");
             $button->setUrl($this->ctrl->getLinkTarget($this, "createfromtemplate"));
             $ilToolbar->addButtonInstance($button);
         }
 
         $info = new ilInfoScreenGUI($this);
 
         $info->enablePrivateNotes();
 
         if ($this->checkPermissionBool("read")) {
             $info->enableNews();
         }
 
         // no news editing for files, just notifications
         $info->enableNewsEditing(false);
         if ($this->checkPermissionBool("write")) {
             $news_set = new ilSetting("news");
             $enable_internal_rss = $news_set->get("enable_rss_for_internal");
 
             if ($enable_internal_rss) {
                 $info->setBlockProperty("news", "settings", true);
                 $info->setBlockProperty("news", "public_notifications_option", true);
             }
         }
 
         // standard meta data
         $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());
 
         $this->ctrl->forwardCommand($info);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initBlogForm()

ilObjPortfolioTemplateGUI::initBlogForm ( )

protected

Init blog template page form.

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

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

Referenced by saveBlog().

                                      : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this));
 
         $obj = new ilTextInputGUI($this->lng->txt("title"), "blog");
         $obj->setRequired(true);
         $form->addItem($obj);
 
         // save and cancel commands
         $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()

ilObjPortfolioTemplateGUI::initCopyPageFormOptions ( ilPropertyFormGUI $a_form )

protected

Definition at line 439 of file class.ilObjPortfolioTemplateGUI.php.

References ilObjectGUI\$id, ilPropertyFormGUI\addItem(), ilObjPortfolioTemplate\getAvailablePortfolioTemplates(), and ILIAS\Repository\lng().

                                                                          : void
     {
         // always existing prtft
         $hi = new ilHiddenInputGUI("target");
         $hi->setValue("old");
         $a_form->addItem($hi);
 
         $options = array();
         $all = ilObjPortfolioTemplate::getAvailablePortfolioTemplates("write");
         foreach ($all as $id => $title) {
             $options[$id] = $title;
         }
         $prtf = new ilSelectInputGUI($this->lng->txt("obj_prtt"), "prtf");
         $prtf->setRequired(true);
         $prtf->setOptions($options);
         $a_form->addItem($prtf);
     }

Here is the call graph for this function:

◆ initDidacticTemplate()

ilObjPortfolioTemplateGUI::initDidacticTemplate ( ilPropertyFormGUI $form )

protected

Definition at line 261 of file class.ilObjPortfolioTemplateGUI.php.

References $ilUser, $source, ilObject2GUI\$user, ilPropertyFormGUI\addItem(), ilObjectGUI\afterSave(), ilObjPortfolioBase\clonePagesAndSettings(), ILIAS\Repository\ctrl(), ilObject\getId(), ilObjPortfolio\getPortfoliosOfUser(), and ILIAS\Repository\lng().

                                                                     : ilPropertyFormGUI
     {
         $ilUser = $this->user;
 
         $all = ilObjPortfolio::getPortfoliosOfUser($ilUser->getId());
         if (count($all)) {
             $opts = array("" => $this->lng->txt("please_select"));
             foreach ($all as $item) {
                 $opts[$item["id"]] = $item["title"];
             }
             $prtf = new ilSelectInputGUI($this->lng->txt("prtf_create_template_from_portfolio"), "prtf");
             $prtf->setInfo($this->lng->txt("prtf_create_template_from_portfolio_info"));
             $prtf->setOptions($opts);
             $form->addItem($prtf);
         }
 
         return $form;
     }

Here is the call graph for this function:

◆ initEditCustomForm()

ilObjPortfolioTemplateGUI::initEditCustomForm ( ilPropertyFormGUI $a_form )

protected

Definition at line 295 of file class.ilObjPortfolioTemplateGUI.php.

References ilObject2GUI\$object_service, ilObject\_getAllReferences(), ilPropertyFormGUI\addItem(), ilObjectServiceSettingsGUI\CUSTOM_METADATA, ilPropertyFormGUI\getItemByPostVar(), ilObjectServiceSettingsGUI\initServiceSettingsForm(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilFormPropertyGUI\setInfo(), and ilDateDurationInputGUI\setShowTime().

                                                                     : void
     {
         $obj_service = $this->object_service;
         // activation/availability
 
         $this->lng->loadLanguageModule('rep');
 
         $section = new ilFormSectionHeaderGUI();
         $section->setTitle($this->lng->txt('rep_activation_availability'));
         $a_form->addItem($section);
 
         // additional info only with multiple references
         $act_obj_info = $act_ref_info = "";
         if (count(ilObject::_getAllReferences($this->object->getId())) > 1) {
             $act_obj_info = ' ' . $this->lng->txt('rep_activation_online_object_info');
             $act_ref_info = $this->lng->txt('rep_activation_access_ref_info');
         }
 
         $online = new ilCheckboxInputGUI($this->lng->txt('rep_activation_online'), 'online');
         $online->setInfo($this->lng->txt('prtt_activation_online_info') . $act_obj_info);
         $a_form->addItem($online);
 
         $dur = new ilDateDurationInputGUI($this->lng->txt("rep_visibility_until"), "access_period");
         $dur->setShowTime(true);
         $dur->setEndText($this->lng->txt('rep_activation_limited_end'));
         $a_form->addItem($dur);
 
         $visible = new ilCheckboxInputGUI($this->lng->txt('rep_activation_limited_visibility'), 'access_visiblity');
         $visible->setInfo($this->lng->txt('prtt_activation_limited_visibility_info'));
         $dur->addSubItem($visible);
 
         $section = new ilFormSectionHeaderGUI();
         $section->setTitle($this->lng->txt('obj_presentation'));
         $a_form->addItem($section);
 
         // tile image
         $obj_service->commonSettings()->legacyForm($a_form, $this->object)->addTileImage();
 
 
         parent::initEditCustomForm($a_form);
 
         ilObjectServiceSettingsGUI::initServiceSettingsForm(
             $this->object->getId(),
             $a_form,
             array(
                 ilObjectServiceSettingsGUI::CUSTOM_METADATA
             )
         );
 
         $tit = $a_form->getItemByPostVar("title");
         $tit->setInfo($this->lng->txt('prtt_title_info'));
     }

Here is the call graph for this function:

◆ preview()

ilObjPortfolioTemplateGUI::preview	(	bool	$a_return = `false`,
			$a_content = `false`,
		bool	$a_show_notes = `true`
	)

Definition at line 511 of file class.ilObjPortfolioTemplateGUI.php.

References ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ilLinkButton\getInstance(), and ILIAS\Repository\lng().

Referenced by executeCommand().

      : string {
         if (!$this->checkPermissionBool("write") &&
             $this->checkPermissionBool("read")) {
             $this->lng->loadLanguageModule("cntr");
 
             $button = ilLinkButton::getInstance();
             $button->setPrimary(true);
             $button->setCaption("prtf_create_portfolio_from_template");
             $button->setUrl($this->ctrl->getLinkTarget($this, "createfromtemplate"));
             $this->tpl->setHeaderActionMenu($button->render());
         }
 
         return parent::preview($a_return, $a_content, $a_show_notes);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveBlog()

ilObjPortfolioTemplateGUI::saveBlog ( )

protected

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

References ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), getPageInstance(), initBlogForm(), ILIAS\Repository\lng(), and ilPortfolioTemplatePage\TYPE_BLOG_TEMPLATE.

                                  : void
     {
         $form = $this->initBlogForm();
         if ($form->checkInput() && $this->checkPermissionBool("write")) {
             $page = $this->getPageInstance();
             $page->setType(ilPortfolioTemplatePage::TYPE_BLOG_TEMPLATE);
             $page->setTitle($form->getInput("blog"));
             $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:

◆ setTabs()

ilObjPortfolioTemplateGUI::setTabs ( )

protected

Definition at line 143 of file class.ilObjPortfolioTemplateGUI.php.

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

                                 : void
     {
         $ilHelp = $this->help;
 
         $ilHelp->setScreenIdComponent("prtt");
 
         if ($this->checkPermissionBool("write")) {
             $this->tabs_gui->addTab(
                 "pages",
                 $this->lng->txt("content"),
                 $this->ctrl->getLinkTarget($this, "view")
             );
         }
 
         if ($this->checkPermissionBool("read")) {
             $this->tabs_gui->addTab(
                 "id_info",
                 $this->lng->txt("info_short"),
                 $this->ctrl->getLinkTargetByClass(array("ilobjportfoliotemplategui", "ilinfoscreengui"), "showSummary")
             );
         }
 
         if ($this->checkPermissionBool("write")) {
             $this->tabs_gui->addTab(
                 "settings",
                 $this->lng->txt("settings"),
                 $this->ctrl->getLinkTarget($this, "edit")
             );
 
             $mdgui = new ilObjectMetaDataGUI($this->object, "pfpg");
             $mdtab = $mdgui->getTab();
             if ($mdtab) {
                 $this->tabs_gui->addTab(
                     "advmd",
                     $this->lng->txt("meta_data"),
                     $mdtab
                 );
             }
 
             $this->tabs_gui->addTab(
                 "export",
                 $this->lng->txt("export"),
                 $this->ctrl->getLinkTargetByClass("ilexportgui", "")
             );
         }
 
         if ($this->checkPermissionBool("read")) {
             $this->tabs_gui->addNonTabbedLink(
                 "preview",
                 $this->lng->txt("preview"),
                 $this->ctrl->getLinkTarget($this, "preview")
             );
         }
 
         // will add permissions if needed
         ilObject2GUI::setTabs();
     }

Here is the call graph for this function:

◆ updateCustom()

ilObjPortfolioTemplateGUI::updateCustom ( ilPropertyFormGUI $form )

protected

Definition at line 368 of file class.ilObjPortfolioTemplateGUI.php.

References ilObject2GUI\$object_service, ilObjectServiceSettingsGUI\CUSTOM_METADATA, ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), IL_CAL_UNIX, ILIAS\Repository\object(), and ilObjectServiceSettingsGUI\updateServiceSettingsForm().

                                                             : void
     {
         $obj_service = $this->object_service;
 
         $this->object->setOnline($form->getInput("online"));
 
         // activation
         $period = $form->getItemByPostVar("access_period");
         if ($period->getStart() && $period->getEnd()) {
             $this->object->setActivationLimited(true);
             $this->object->setActivationVisibility($form->getInput("access_visiblity"));
             $this->object->setActivationStartDate($period->getStart()->get(IL_CAL_UNIX));
             $this->object->setActivationEndDate($period->getEnd()->get(IL_CAL_UNIX));
         } else {
             $this->object->setActivationLimited(false);
         }
 
         parent::updateCustom($form);
 
         $obj_service->commonSettings()->legacyForm($form, $this->object)->saveTileImage();
 
         ilObjectServiceSettingsGUI::updateServiceSettingsForm(
             $this->object->getId(),
             $form,
             array(
                 ilObjectServiceSettingsGUI::CUSTOM_METADATA
             )
         );
     }

Here is the call graph for this function:

Field Documentation

◆ $help

ilHelpGUI ilObjPortfolioTemplateGUI::$help

protected

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

Referenced by setTabs().

◆ $nav_history

ilNavigationHistory ilObjPortfolioTemplateGUI::$nav_history

protected

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

Referenced by executeCommand().

◆ $tabs

ilTabsGUI ilObjPortfolioTemplateGUI::$tabs

protected

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

Referenced by infoScreenForward().

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

Modules/Portfolio/Template/class.ilObjPortfolioTemplateGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createFromTemplate()

◆ createFromTemplateOld()

◆ executeCommand()

◆ getEditFormCustomValues()

◆ getPageGUIClassName()

◆ getPageGUIInstance()

◆ getPageInstance()

◆ getType()

◆ infoScreen()

◆ infoScreenForward()

◆ initBlogForm()

◆ initCopyPageFormOptions()

◆ initDidacticTemplate()

◆ initEditCustomForm()

◆ preview()

◆ saveBlog()

◆ setTabs()

◆ updateCustom()

Field Documentation

◆ $help

◆ $nav_history

◆ $tabs