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 ()
	Functions that must be overwritten. More...

	executeCommand ()
	execute command More...

	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)
	Insert custom update form values into object. More...

	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)
	Show user page. More...

	createFromTemplateOld ()

	createFromTemplate ()

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

	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)
	Insert custom update form values into object. More...

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

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

	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 @access 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 ()
	list childs of current object 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...

Static Public Member Functions
static	_goto ($a_target)

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

Protected Member Functions
	setTabs ()
	create tabs (repository/workspace switch) More...

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

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

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

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

	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 ()
	Functions to be overwritten. More...

	determinePageCall ()

	handlePageCall ($a_cmd)

	setSettingsSubTabs ($a_active)

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

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

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

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

	deleteConfirmation ()
	Display delete confirmation form (workspace specific) More...

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

	setTitleAndDescription ()
	called by prepare output More...

	showUpperIcon ()

	omitLocator ($a_omit=true)

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

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

	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) 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...

	fillCloneSearchTemplate ($a_tpl_varname, $a_type)

	searchCloneSource ()

	buildCloneSelect ($existing_objs)

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

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

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

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

	showActions ()

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

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

	showMountWebfolderIcon ()

	setTabs ()
	set admin tabs @access public More...

	setAdminTabs ()
	set admin tabs @access 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 = ""

Protected Attributes inherited from ilObject2GUI
	$object_id

	$node_id

	$creation_forms = array()

	$id_type = array()

	$parent_id

	$access_handler

Protected Attributes inherited from ilObjectGUI
	$ilErr

	$locator

	$user

	$access

	$settings

	$rbacreview

	$toolbar

	$tmp_import_dir

	$tabs_gui = null

	$ctrl

	$object_service

Additional Inherited Members
Data Fields inherited from ilObject2GUI
	$tree

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

Version: $Id$

@ilCtrl_Calls ilObjPortfolioTemplateGUI: ilPortfolioTemplatePageGUI, ilPageObjectGUI, ilNoteGUI @ilCtrl_Calls ilObjPortfolioTemplateGUI: ilObjectCopyGUI, ilInfoScreenGUI, ilCommonActionDispatcherGUI @ilCtrl_Calls ilObjPortfolioTemplateGUI: ilPermissionGUI, ilExportGUI, ilObjStyleSheetGUI

Definition at line 18 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.

Reimplemented from ilObjPortfolioBaseGUI.

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

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

References $DIC, and user().

Here is the call graph for this function:

Member Function Documentation

◆ _goto()

static ilObjPortfolioTemplateGUI::_goto ( $a_target )

static

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

    {
        $id = explode("_", $a_target);
        
        $_GET["baseClass"] = "ilRepositoryGUI";
        $_GET["ref_id"] = $id[0];
        $_GET["cmd"] = "preview";
    
        include("ilias.php");
        exit;
    }

References $_GET, $id, and exit.

◆ afterSave()

ilObjPortfolioTemplateGUI::afterSave ( ilObject $a_new_object )

protected

Post (successful) object creation hook.

Parameters

ilObject $a_new_object

Reimplemented from ilObjectGUI.

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

    {
        if ($_POST["prtf"]) {
            include_once "Modules/Portfolio/classes/class.ilObjPortfolio.php";
            $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");
    }

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

Here is the call graph for this function:

◆ createFromTemplate()

ilObjPortfolioTemplateGUI::createFromTemplate ( )

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

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

◆ createFromTemplateOld()

ilObjPortfolioTemplateGUI::createFromTemplateOld ( )

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

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

◆ executeCommand()

ilObjPortfolioTemplateGUI::executeCommand ( )

execute command

Reimplemented from ilObject2GUI.

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

    {
        $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":
                include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;
            
            case "ilpermissiongui":
                $this->prepareOutput();
                $this->tabs_gui->activateTab("id_permissions");
                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
            
            case "ilobjectcopygui":
                $this->prepareOutput();
                include_once "./Services/Object/classes/class.ilObjectCopyGUI.php";
                $cp = new ilObjectCopyGUI($this);
                $cp->setType("prtt");
                $this->ctrl->forwardCommand($cp);
                break;
            
            case 'ilexportgui':
                $this->prepareOutput();
                $this->tabs_gui->activateTab("export");
                include_once("./Services/Export/classes/class.ilExportGUI.php");
                $exp_gui = new ilExportGUI($this);
                $exp_gui->addFormat("xml");
                $this->ctrl->forwardCommand($exp_gui);
                break;
            
            case "ilobjstylesheetgui":
                include_once("./Services/Style/Content/classes/class.ilObjStyleSheetGUI.php");
                $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();
        }
    }

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

Here is the call graph for this function:

◆ getEditFormCustomValues()

ilObjPortfolioTemplateGUI::getEditFormCustomValues ( array & $a_values )

protected

Add values to custom edit fields.

Parameters

array $a_values

Reimplemented from ilObjPortfolioBaseGUI.

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

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

References IL_CAL_UNIX.

◆ getPageGUIClassName()

ilObjPortfolioTemplateGUI::getPageGUIClassName ( )

Reimplemented from ilObjPortfolioBaseGUI.

Definition at line 423 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

Reimplemented from ilObjPortfolioBaseGUI.

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

    {
        include_once("Modules/Portfolio/classes/class.ilPortfolioTemplatePageGUI.php");
        $page_gui = new ilPortfolioTemplatePageGUI(
            $this->object->getId(),
            $a_page_id,
            0,
            $this->object->hasPublicComments()
        );
        $page_gui->setAdditional($this->getAdditional());
        return $page_gui;
    }

References ilObjPortfolioBaseGUI\getAdditional().

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

Reimplemented from ilObjPortfolioBaseGUI.

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

    {
        if (!$a_portfolio_id && $this->object) {
            $a_portfolio_id = $this->object->getId();
        }
        include_once "Modules/Portfolio/classes/class.ilPortfolioTemplatePage.php";
        $page = new ilPortfolioTemplatePage($a_page_id);
        $page->setPortfolioId($a_portfolio_id);
        return $page;
    }

Referenced by saveBlog().

Here is the caller graph for this function:

◆ getType()

ilObjPortfolioTemplateGUI::getType ( )

Functions that must be overwritten.

Reimplemented from ilObject2GUI.

Definition at line 51 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 201 of file class.ilObjPortfolioTemplateGUI.php.

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

References infoScreenForward().

Here is the call graph for this function:

◆ infoScreenForward()

ilObjPortfolioTemplateGUI::infoScreenForward ( )

show information screen

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

    {
        $ilTabs = $this->tabs;
        $ilToolbar = $this->toolbar;
        
        $ilTabs->activateTab("id_info");
 
        $this->checkPermission("visible");
    
        if ($this->checkPermissionBool("read")) {
            $this->lng->loadLanguageModule("cntr");
            
            include_once "Services/UIComponent/Button/classes/class.ilLinkButton.php";
            $button = ilLinkButton::getInstance();
            $button->setPrimary(true);
            $button->setCaption("prtf_create_portfolio_from_template");
            $button->setUrl($this->ctrl->getLinkTarget($this, "createfromtemplate"));
            $ilToolbar->addButtonInstance($button);
        }
                
        include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
        $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);
    }

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

Referenced by executeCommand(), and infoScreen().

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

Reimplemented from ilObjPortfolioBaseGUI.

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

    {
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $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;
    }

References $form.

Referenced by saveBlog().

Here is the caller graph for this function:

◆ initCopyPageFormOptions()

ilObjPortfolioTemplateGUI::initCopyPageFormOptions ( ilPropertyFormGUI $a_form )

protected

Reimplemented from ilObjPortfolioBaseGUI.

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

    {
        // 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);
    }

References $id, PHPMailer\PHPMailer\$options, $title, ilPropertyFormGUI\addItem(), and ilObjPortfolioTemplate\getAvailablePortfolioTemplates().

Here is the call graph for this function:

◆ initDidacticTemplate()

ilObjPortfolioTemplateGUI::initDidacticTemplate ( ilPropertyFormGUI $form )

protected

Show didactic template types.

Parameters

ilPropertyFormGUI $form

Returns: ilPropertyFormGUI $form

Reimplemented from ilObjectGUI.

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

    {
        $ilUser = $this->user;
        
        include_once "Modules/Portfolio/classes/class.ilObjPortfolio.php";
        $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;
    }

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

Here is the call graph for this function:

◆ initEditCustomForm()

ilObjPortfolioTemplateGUI::initEditCustomForm ( ilPropertyFormGUI $a_form )

protected

Add custom fields to update form.

Parameters

ilPropertyFormGUI $a_form

Reimplemented from ilObjPortfolioBaseGUI.

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

    {
        $obj_service = $this->object_service;
        // activation/availability
        
        include_once "Services/Object/classes/class.ilObjectActivation.php";
        $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);
                
        include_once "Services/Form/classes/class.ilDateDurationInputGUI.php";
        $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'));
    }

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

Here is the call graph for this function:

◆ preview()

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

Show user page.

Reimplemented from ilObjPortfolioBaseGUI.

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

    {
        if (!$this->checkPermissionBool("write") &&
            $this->checkPermissionBool("read")) {
            $this->lng->loadLanguageModule("cntr");
            
            include_once "Services/UIComponent/Button/classes/class.ilLinkButton.php";
            $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);
    }

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

Referenced by executeCommand().

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.

Reimplemented from ilObjPortfolioBaseGUI.

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

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

References $form, getPageInstance(), initBlogForm(), and ilPortfolioTemplatePage\TYPE_BLOG_TEMPLATE.

Here is the call graph for this function:

◆ setTabs()

ilObjPortfolioTemplateGUI::setTabs ( )

protected

create tabs (repository/workspace switch)

this had to be moved here because of the context-specific permission tab

Reimplemented from ilObject2GUI.

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

    {
        $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("user_profile_preview"),
                $this->ctrl->getLinkTarget($this, "preview")
            );
        }
        
        // will add permissions if needed
        ilObject2GUI::setTabs();
    }

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

Here is the call graph for this function:

◆ updateCustom()

ilObjPortfolioTemplateGUI::updateCustom ( ilPropertyFormGUI $a_form )

Insert custom update form values into object.

Parameters

ilPropertyFormGUI $a_form

Reimplemented from ilObjPortfolioBaseGUI.

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

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

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

Here is the call graph for this function:

Field Documentation

◆ $help

ilObjPortfolioTemplateGUI::$help

protected

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

Referenced by setTabs().

◆ $nav_history

ilObjPortfolioTemplateGUI::$nav_history

protected

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

Referenced by executeCommand().

◆ $tabs

ilObjPortfolioTemplateGUI::$tabs

protected

Definition at line 33 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

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _goto()

◆ 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