Portfolio template view gui class. More...

Inheritance diagram for ilObjPortfolioTemplateGUI:

Collaboration diagram for ilObjPortfolioTemplateGUI:

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

	getType ()

	executeCommand ()

	infoScreen ()
	this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed More...

	infoScreenForward ()
	show information screen More...

	updateCustom (ilPropertyFormGUI $a_form)

	getPageGUIClassName ()

	initBlogForm ()
	Init blog template page form. More...

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

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

	createFromTemplateOld ()

	createFromTemplate ()

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

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

	getAdditional ()
	Get Additonal Information. More...

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

	updateCustom (ilPropertyFormGUI $a_form)

	getPageGUIClassName ()

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

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

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

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

	confirmPortfolioPageDeletion ()
	Confirm portfolio deletion. More...

	deletePortfolioPages ()
	Delete portfolio pages. More...

	preview ($a_return=false, $a_content=false, $a_show_notes=true)
	Show user page. More...

	export ($a_with_comments=false)

	exportWithComments ()

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

	copyPage ()

	initCopyPageForm ()

	setContentStyleSheet ($a_tpl=null)

	editStyleProperties ()

	initStylePropertiesForm ()

	createStyle ()

	editStyle ()

	deleteStyle ()

	saveStyleSettings ()

Public Member Functions inherited from ilObject2GUI
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	Constructor. More...

	executeCommand ()
	execute command More...

	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 ($a_mode=true)

	getCreationMode ()

	prepareOutput ($a_show_subobjects=true)

	isVisible ($a_ref_id, $a_type)

	trash ()

	undelete ()

	cancelDelete ()

	removeFromSystem ()

	cloneAll ()

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

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

	create ()
	Deleted in ilObject. More...

	save ()

	edit ()

	update ()

	cancel ()

	importFile ()
	Import. More...

	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...

Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...

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

	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...

	getCreationMode ()
	get creation mode More...

	prepareOutput ($a_show_subobjects=true)
	prepare output More...

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

	createObject ()
	create new object form More...

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

	saveObject ()
	save object More...

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

	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()
	edit object More...

	addExternalEditFormCustom (ilPropertyFormGUI $a_form)

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

	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...

	isVisible ($a_ref_id, $a_type)

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

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

	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...

	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. 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 $a_form)

	afterSave (ilObject $a_new_object)

	initEditCustomForm (ilPropertyFormGUI $a_form)

	getEditFormCustomValues (array &$a_values)

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

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

	initCopyPageFormOptions (ilPropertyFormGUI $a_form)

Protected Member Functions inherited from ilObjPortfolioBaseGUI
	addLocatorItems ()

	determinePageCall ()

	handlePageCall ($a_cmd)

	setSettingsSubTabs ($a_active)

	initEditCustomForm (ilPropertyFormGUI $a_form)

	getEditFormCustomValues (array &$a_values)

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

	getPageGUIInstance ($a_page_id)

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

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

	initBlogForm ()

	saveBlog ()

	showEditButton ($page_id)
	Show edit button. More...

	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 ()
	Get access handler. More...

	setLocator ()
	set Locator More...

	deleteConfirmedObjects ()
	Delete objects (workspace specific) More...

	setTitleAndDescription ()

	showUpperIcon ()

	omitLocator ($a_omit=true)

	getTargetFrame ($a_cmd, $a_target_frame="")

	setTargetFrame ($a_cmd, $a_target_frame)

	getCenterColumnHTML ()

	getRightColumnHTML ()

	setColumnSettings (ilColumnGUI $column_gui)

	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)

	showPossibleSubObjects ()

	redirectToRefId ($a_ref_id, $a_cmd="")

	fillCloneTemplate ($a_tpl_varname, $a_type)

	fillCloneSearchTemplate ($a_tpl_varname, $a_type)

	searchCloneSource ()

	buildCloneSelect ($existing_objs)

	addAdminLocatorItems ($a_do_not_add_object=false)

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

	getReturnLocation ($a_cmd, $a_location="")
	Deprecated functions. More...

	setReturnLocation ($a_cmd, $a_location)

	showActions ()

	getTabs ()

	__showButton ($a_cmd, $a_text, $a_target='')

	hitsperpageObject ()

&	__initTableGUI ()

	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")

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

	initCreationForms ($a_new_type)
	Init creation froms. More...

	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_node_id=null)
	Check permission. More...

	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...

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

	getPermanentLinkWidget ($a_append=null, $a_center=false)

	handleAutoRating (ilObject $a_new_obj)

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...

	assignObject ()

	setTitleAndDescription ()
	called by prepare output More...

	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...

	insertHeaderAction ($a_list_gui)
	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 public More...

	setAdminTabs ()
	set admin tabs public More...

	setLocator ()
	set Locator More...

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

	omitLocator ($a_omit=true)

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

	initCreationForms ($a_new_type)
	Init creation froms. More...

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

	initCreateForm ($a_new_type)
	Init object creation form. More...

	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...

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

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

	initEditForm ()
	Init object edit form. More...

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

	getEditFormValues ()
	Get values for edit form. More...

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

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

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

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

	initImportForm ($a_new_type)
	Init object import form. More...

	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...

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

	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...

	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...

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

	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...

	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...

	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...

	getTabs ()
	get tabs abstract method. More...

	__showButton ($a_cmd, $a_text, $a_target='')

	hitsperpageObject ()

&	__initTableGUI ()

	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...

	redirectToRefId ($a_ref_id, $a_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 $_GET["ref_id"] value More...

	fillCloneTemplate ($a_tpl_varname, $a_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...

	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...

	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...

	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...

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

	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Attributes
	$nav_history

	$help

	$tabs

Protected Attributes inherited from ilObjPortfolioBaseGUI
	$help

	$main_menu

	$user_id

	$additional = array()

	$perma_link

	$page_id

	$page_mode

	$requested_ppage

	$requested_user_page

	$requested_back_url = ""

	$ui

Protected Attributes inherited from ilObject2GUI
	$object_id

	$node_id

	$creation_forms = array()

	$id_type = array()

	$parent_id

	$access_handler

Protected Attributes inherited from ilObjectGUI
const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

	$ilErr

	$locator

	$user

	$access

	$rbacsystem

	$settings

	$rbacreview

	$toolbar

	$tmp_import_dir

	$tabs_gui = null

	$ctrl

	$object_service

	$favourites

	$request

Additional Inherited Members
Static Public Member Functions inherited from ilObjPortfolioBaseGUI
static	renderFullscreenHeader ($a_portfolio, $a_tpl, $a_user_id, $a_export=false)
	Render banner, user name. More...

Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $a_obj, $a_callback_ref_id)
	After creation callback. More...

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

static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

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	COPY_WIZARD_NEEDS_PAGE = 1

	$objDefinition

	$tpl

	$tree

	$lng

	$data

	$object

	$ref_id

	$obj_id

	$maxcount

	$formaction

	$return_location

	$target_frame

	$tab_target_script

	$actions

	$sub_objects

	$omit_locator = false

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

Detailed Description

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, ilObjStyleSheetGUI

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), help(), and 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

◆ afterSave()

ilObjPortfolioTemplateGUI::afterSave ( ilObject $a_new_object )

protected

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

References $_POST, $source, ilObjPortfolioBase\clonePagesAndSettings(), and ilObject\getId().

     {
         if ($_POST["prtf"]) {
             $source = new ilObjPortfolio($_POST["prtf"], false);
 
             ilObjPortfolio::clonePagesAndSettings($source, $a_new_object);
         }
 
         ilUtil::sendSuccess($this->lng->txt("prtt_portfolio_created"), true);
         $this->ctrl->setParameter($this, "prt_id", $a_new_object->getId());
         $this->ctrl->redirect($this, "view");
     }

Here is the call graph for this function:

◆ createFromTemplate()

ilObjPortfolioTemplateGUI::createFromTemplate ( )

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

References ilObjectGUI\$access, ilObjectGUI\$ctrl, $DIC, and ilObjectGUI\$ref_id.

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

◆ createFromTemplateOld()

ilObjPortfolioTemplateGUI::createFromTemplateOld ( )

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

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

◆ executeCommand()

ilObjPortfolioTemplateGUI::executeCommand ( )

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

References $_GET, $nav_history, $ret, ilObjectGUI\addHeaderAction(), ilObjPortfolioBaseGUI\determinePageCall(), ilObject2GUI\executeCommand(), ilObject2GUI\getAccessHandler(), ilObject2GUI\getCreationMode(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), ilObjPortfolioBaseGUI\handlePageCall(), infoScreenForward(), ilObjectGUI\omitLocator(), ilObject2GUI\prepareOutput(), and preview().

     {
         $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("view");
                 $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 "ilobjstylesheetgui":
                 $this->ctrl->setReturn($this, "editStyleProperties");
                 $style_gui = new ilObjStyleSheetGUI("", $this->object->getStyleSheetId(), false, false);
                 $style_gui->omitLocator();
                 if ($cmd == "create" || $_GET["new_type"] == "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;
 
             default:
                 $this->addHeaderAction($cmd);
                 return ilObject2GUI::executeCommand();
         }
     }

Here is the call graph for this function:

◆ getEditFormCustomValues()

ilObjPortfolioTemplateGUI::getEditFormCustomValues ( array & $a_values )

protected

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

References IL_CAL_UNIX.

     {
         $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();
 
         parent::getEditFormCustomValues($a_values);
     }

◆ getPageGUIClassName()

ilObjPortfolioTemplateGUI::getPageGUIClassName ( )

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

     {
         return "ilportfoliotemplatepagegui";
     }

◆ getPageGUIInstance()

ilObjPortfolioTemplateGUI::getPageGUIInstance ( $a_page_id )

protected

Get portfolio template page gui instance.

Parameters

int $a_page_id

Returns: ilPortfolioTemplatePageGUI

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

References ilObjPortfolioBaseGUI\getAdditional(), and ilPortfolioPageGUI\setAdditional().

     {
         $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	(	$a_page_id = `null`,
		$a_portfolio_id = `null`
	)

protected

Get portfolio template page instance.

Parameters

int	$a_page_id
int	$a_portfolio_id

Returns: ilPortfolioTemplatePage

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

Referenced by saveBlog().

     {
         if (!$a_portfolio_id && $this->object) {
             $a_portfolio_id = $this->object->getId();
         }
         $page = new ilPortfolioTemplatePage($a_page_id);
         $page->setPortfolioId($a_portfolio_id);
         return $page;
     }

Here is the caller graph for this function:

◆ getType()

ilObjPortfolioTemplateGUI::getType ( )

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

     {
         return "prtt";
     }

◆ infoScreen()

ilObjPortfolioTemplateGUI::infoScreen ( )

this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed

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

References infoScreenForward().

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

Here is the call graph for this function:

◆ infoScreenForward()

ilObjPortfolioTemplateGUI::infoScreenForward ( )

show information screen

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

References $tabs, ilObjectGUI\$toolbar, ilObject2GUI\checkPermission(), ilObject2GUI\checkPermissionBool(), and ilLinkButton\getInstance().

Referenced by executeCommand(), and infoScreen().

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

Init blog template page form.

Parameters

string $a_mode

Returns: ilPropertyFormGUI

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

Referenced by saveBlog().

     {
         $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 caller graph for this function:

◆ initCopyPageFormOptions()

ilObjPortfolioTemplateGUI::initCopyPageFormOptions ( ilPropertyFormGUI $a_form )

protected

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

References ilPropertyFormGUI\addItem(), and ilObjPortfolioTemplate\getAvailablePortfolioTemplates().

     {
         // 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 $a_form )

protected

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

References $ilUser, ilObjectGUI\$user, ilPropertyFormGUI\addItem(), and ilObjPortfolio\getPortfoliosOfUser().

     {
         $ilUser = $this->user;
 
         $all = ilObjPortfolio::getPortfoliosOfUser($ilUser->getId());
         if (sizeof($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);
             $a_form->addItem($prtf);
         }
 
         // yeah, I know.
         return $a_form;
     }

Here is the call graph for this function:

◆ initEditCustomForm()

ilObjPortfolioTemplateGUI::initEditCustomForm ( ilPropertyFormGUI $a_form )

protected

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

References ilObjectGUI\$object_service, $section, ilObject\_getAllReferences(), ilPropertyFormGUI\addItem(), ilPropertyFormGUI\getItemByPostVar(), ilFormPropertyGUI\setInfo(), and ilDateDurationInputGUI\setShowTime().

     {
         $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 (sizeof(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);
 
         $tit = $a_form->getItemByPostVar("title");
         $tit->setInfo($this->lng->txt('prtt_title_info'));
     }

Here is the call graph for this function:

◆ preview()

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

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

References ilObject2GUI\checkPermissionBool(), and ilLinkButton\getInstance().

Referenced by executeCommand().

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

Create new portfolio blog template page.

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

References ilObject2GUI\checkPermissionBool(), getPageInstance(), initBlogForm(), and ilPortfolioTemplatePage\TYPE_BLOG_TEMPLATE.

     {
         $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();
 
             ilUtil::sendSuccess($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 140 of file class.ilObjPortfolioTemplateGUI.php.

References $help, ilObject2GUI\checkPermissionBool(), and ilObject2GUI\setTabs().

     {
         $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")
             );
 
             $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 $a_form )

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

References ilObjectGUI\$object_service, ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), and IL_CAL_UNIX.

     {
         $obj_service = $this->object_service;
 
         $this->object->setOnline($a_form->getInput("online"));
 
         // activation
         $period = $a_form->getItemByPostVar("access_period");
         if ($period->getStart() && $period->getEnd()) {
             $this->object->setActivationLimited(true);
             $this->object->setActivationVisibility($a_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($a_form);
 
         $obj_service->commonSettings()->legacyForm($a_form, $this->object)->saveTileImage();
     }

Here is the call graph for this function:

Field Documentation

◆ $help

ilObjPortfolioTemplateGUI::$help

protected

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

Referenced by setTabs().

◆ $nav_history

ilObjPortfolioTemplateGUI::$nav_history

protected

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

Referenced by executeCommand().

◆ $tabs

ilObjPortfolioTemplateGUI::$tabs

protected

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

Referenced by infoScreenForward().

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

Modules/Portfolio/classes/class.ilObjPortfolioTemplateGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ afterSave()

◆ createFromTemplate()

◆ createFromTemplateOld()

◆ executeCommand()

◆ getEditFormCustomValues()

◆ getPageGUIClassName()

◆ getPageGUIInstance()

◆ getPageInstance()

◆ getType()

◆ infoScreen()

◆ infoScreenForward()

◆ initBlogForm()

◆ initCopyPageFormOptions()

◆ initDidacticTemplate()

◆ initEditCustomForm()

◆ preview()

◆ saveBlog()

◆ setTabs()

◆ updateCustom()

Field Documentation

◆ $help

◆ $nav_history

◆ $tabs