ILIAS  release_9 Revision v9.13-25-g2c18ec4c24f
ilObjPortfolioTemplateGUI Class Reference

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)
 
 view ()
 view object content (repository/workspace switch) More...
 
 getType ()
 Functions that must be overwritten. More...
 
 create ()
 CRUD. More...
 
 save ()
 
 edit ()
 
 update ()
 
 cancel ()
 
 importFile ()
 
 putObjectInTree (ilObject $obj, int $parent_node_id=null)
 Add object to tree at given position. More...
 
- Public Member Functions inherited from ilObjectGUI
 __construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true)
 
 getRefId ()
 
 setAdminMode (string $mode)
 
 getAdminMode ()
 
 getObject ()
 
 executeCommand ()
 
 withReferences ()
 determines whether objects are referenced or not (got ref ids or not) More...
 
 setCreationMode (bool $mode=true)
 If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...
 
 getCreationMode ()
 
 prepareOutput (bool $show_sub_objects=true)
 
 getAdminTabs ()
 administration tabs show only permissions and trash folder More...
 
 getHTML ()
 
 confirmedDeleteObject ()
 confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
 
 cancelObject ()
 cancel action and go back to previous page More...
 
 createObject ()
 create new object form More...
 
 editAvailabilityPeriodObject ()
 
 saveAvailabilityPeriodObject ()
 
 cancelCreation ()
 cancel create action and go back to repository parent More...
 
 saveObject ()
 
 getDidacticTemplateVar (string $type)
 Get didactic template setting from creation screen. More...
 
 putObjectInTree (ilObject $obj, int $parent_node_id=null)
 Add object to tree at given position. More...
 
 editObject ()
 
 addExternalEditFormCustom (ilPropertyFormGUI $form)
 
 updateObject ()
 updates object entry in object_data More...
 
 getFormAction (string $cmd, string $default_form_action="")
 Get form action for command (command is method name without "Object", e.g. More...
 
 isVisible (int $ref_id, string $type)
 
 viewObject ()
 viewObject container presentation for "administration -> repository, trash, permissions" More...
 
 deleteObject (bool $error=false)
 Display deletion confirmation screen. More...
 
 setColumnSettings (ilColumnGUI $column_gui)
 
 redirectAfterCreation ()
 Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More...
 
 addToDeskObject ()
 
 removeFromDeskObject ()
 
- Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
 callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)
 

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 ()
 
 getCurrentPage ()
 
 getCommentGUI ()
 
 showEditButton (int $page_id)
 
 initCopyPageFormOptions (ilPropertyFormGUI $a_form)
 
- Protected Member Functions inherited from ilObject2GUI
 afterConstructor ()
 Do anything that should be done after constructor in here. More...
 
 assignObject ()
 create object instance as internal property (repository/workspace switch) More...
 
 getAccessHandler ()
 
 setLocator ()
 set Locator More...
 
 deleteConfirmedObjects ()
 Delete objects (workspace specific) This should probably be moved elsewhere as done with RepUtil. More...
 
 setTitleAndDescription ()
 
 omitLocator (bool $omit=true)
 
 getTargetFrame (string $cmd, string $target_frame="")
 
 setTargetFrame (string $cmd, string $target_frame)
 
 getCenterColumnHTML ()
 
 getRightColumnHTML ()
 
 checkPermission (string $perm, string $cmd="", string $type="", int $ref_id=null)
 
 showPossibleSubObjects ()
 
 redirectToRefId (int $ref_id, string $cmd="")
 
 addAdminLocatorItems (bool $do_not_add_object=false)
 
 setTabs ()
 create tabs (repository/workspace switch) More...
 
 getReturnLocation (string $cmd, string $location="")
 Deprecated functions. More...
 
 setReturnLocation (string $cmd, string $location)
 
 showActions ()
 
 getTabs ()
 
 addLocatorItems ()
 Functions to be overwritten. More...
 
 initCreationForms (string $new_type)
 Init creation forms. More...
 
 checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $node_id=null)
 
 initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
 Add header action menu. More...
 
 redrawHeaderAction ()
 Updating icons after ajax call. More...
 
- Protected Member Functions inherited from ilObjectGUI
 getObjectService ()
 
 assignObject ()
 
 setTitleAndDescription ()
 
 createActionDispatcherGUI ()
 
 initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
 Add header action menu. More...
 
 insertHeaderAction (?ilObjectListGUI $list_gui=null)
 Insert header action into main template. More...
 
 addHeaderAction ()
 Add header action menu. More...
 
 redrawHeaderActionObject ()
 Ajax call: redraw action header only. More...
 
 setTabs ()
 set admin tabs More...
 
 setAdminTabs ()
 set admin tabs More...
 
 setLocator ()
 
 addLocatorItems ()
 should be overwritten to add object specific items (repository items are preloaded) More...
 
 omitLocator (bool $omit=true)
 
 addAdminLocatorItems (bool $do_not_add_object=false)
 should be overwritten to add object specific items (repository items are preloaded) More...
 
 initCreationForms (string $new_type)
 Init creation forms. More...
 
 getCreationFormsHTML (array $forms)
 Get HTML for creation forms (accordion) More...
 
 initCreateForm (string $new_type)
 
 initDidacticTemplate (ilPropertyFormGUI $form)
 
 addDidacticTemplateOptions (array &$a_options)
 Add custom templates. More...
 
 addAdoptContentLinkToToolbar ()
 
 addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)
 
 afterSave (ilObject $new_object)
 Post (successful) object creation hook. More...
 
 initEditForm ()
 
 initEditCustomForm (ilPropertyFormGUI $a_form)
 Add custom fields to update form. More...
 
 getEditFormValues ()
 
 getEditFormCustomValues (array &$a_values)
 Add values to custom edit fields. More...
 
 validateCustom (ilPropertyFormGUI $form)
 Validate custom values (if not possible with checkInput()) More...
 
 updateCustom (ilPropertyFormGUI $form)
 Insert custom update form values into object. More...
 
 afterUpdate ()
 Post (successful) object update hook. More...
 
 initImportForm (string $new_type)
 
 importFileObject (int $parent_id=null)
 
 afterImport (ilObject $new_object)
 Post (successful) object import hook. More...
 
 setFormAction (string $cmd, string $form_action)
 
 getReturnLocation (string $cmd, string $default_location="")
 Get return location for command (command is method name without "Object", e.g. More...
 
 setReturnLocation (string $cmd, string $location)
 set specific return location for command More...
 
 getTargetFrame (string $cmd, string $default_target_frame="")
 get target frame for command (command is method name without "Object", e.g. More...
 
 setTargetFrame (string $cmd, string $target_frame)
 Set specific target frame for command. More...
 
 showPossibleSubObjects ()
 show possible sub objects (pull down menu) More...
 
 getTabs ()
 overwrite in derived GUI class of your object type More...
 
 redirectToRefId (int $ref_id, string $cmd="")
 redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...
 
 getCenterColumnHTML ()
 Get center column. More...
 
 getRightColumnHTML ()
 Display right column. More...
 
 checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
 
 checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
 
 enableDragDropFileUpload ()
 Enables the file upload into this object by dropping files. More...
 

Protected Attributes

ilNavigationHistory $nav_history
 
ilHelpGUI $help
 
ilTabsGUI $tabs
 
- Protected Attributes inherited from ilObjPortfolioBaseGUI
ILIAS Notes Service $notes
 
ILIAS Portfolio InternalGUIService $gui
 
StandardGUIRequest $port_request
 
ilHelpGUI $help
 
int $user_id = 0
 
array $additional = array()
 
array $perma_link = []
 
int $page_id = 0
 
string $page_mode
 
int $requested_ppage
 
int $requested_user_page
 
string $requested_back_url = ""
 
ILIAS DI UIServices $ui
 
ILIAS HTTP Services $http
 
ILIAS Style Content GUIService $content_style_gui
 
ILIAS Style Content Object ObjectFacade $content_style_domain
 
- Protected Attributes inherited from ilObject2GUI
ilObjectDefinition $obj_definition
 
ilGlobalTemplateInterface $tpl
 
ilCtrl $ctrl
 
ilLanguage $lng
 
ilTabsGUI $tabs_gui
 
ilFavouritesManager $favourites
 
ilErrorHandling $error
 
ilLocatorGUI $locator
 
ilObjUser $user
 
ilAccessHandler $access
 
ilToolbarGUI $toolbar
 
ArrayBasedRequestWrapper $post_wrapper
 
RequestWrapper $request_wrapper
 
Factory $refinery
 
ilRbacAdmin $rbac_admin
 
ilRbacSystem $rbac_system
 
ilRbacReview $rbac_review
 
int $request_ref_id
 
int $id_type
 
int $parent_id
 
string $type
 
string $html
 
int $object_id
 
int $node_id = null
 
array $creation_forms = []
 
 $access_handler
 
- Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service $notes_service
 
ServerRequestInterface $request
 
ilLocatorGUI $locator
 
ilObjUser $user
 
ilAccessHandler $access
 
ilSetting $settings
 
ilToolbarGUI $toolbar
 
ilRbacAdmin $rbac_admin
 
ilRbacSystem $rbac_system
 
ilRbacReview $rbac_review
 
ilObjectService $object_service
 
ilObjectDefinition $obj_definition
 
ilGlobalTemplateInterface $tpl
 
ilTree $tree
 
ilCtrl $ctrl
 
ilErrorHandling $error
 
ilLanguage $lng
 
ilTabsGUI $tabs_gui
 
ILIAS $ilias
 
ArrayBasedRequestWrapper $post_wrapper
 
RequestWrapper $request_wrapper
 
Factory $refinery
 
ilFavouritesManager $favourites
 
ilObjectCustomIconFactory $custom_icon_factory
 
UIFactory $ui_factory
 
UIRenderer $ui_renderer
 
ilObject $object = null
 
bool $creation_mode = false
 
 $data
 
int $id
 
bool $call_by_reference = false
 
bool $prepare_output
 
int $ref_id
 
int $obj_id
 
int $maxcount
 
array $form_action = []
 
array $return_location = []
 
array $target_frame = []
 
string $tmp_import_dir
 
string $sub_objects = ""
 
bool $omit_locator = false
 
string $type = ""
 
string $admin_mode = self::ADMIN_MODE_NONE
 
int $requested_ref_id = 0
 
int $requested_crtptrefid = 0
 
int $requested_crtcb = 0
 
string $requested_new_type = ""
 
string $link_params
 
string $html = ""
 

Additional Inherited Members

- 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, ilCommentGUI 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\MetaData\Repository\Validation\Data\__construct(), ILIAS\Repository\help(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

40  {
41  parent::__construct($a_id, $a_id_type, $a_parent_node_id);
42  global $DIC;
43 
44  $this->nav_history = $DIC["ilNavigationHistory"];
45  $this->help = $DIC["ilHelp"];
46  $this->tabs = $DIC->tabs();
47  $this->toolbar = $DIC->toolbar();
48  $this->user = $DIC->user();
49  }
global $DIC
Definition: feed.php:28
__construct(VocabulariesInterface $vocabularies)
+ Here is the call graph for this function:

Member Function Documentation

◆ createFromTemplate()

ilObjPortfolioTemplateGUI::createFromTemplate ( )

Definition at line 534 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().

534  : void
535  {
536  $this->ctrl->setParameterByClass("ilobjportfoliogui", "prtt_pre", $this->object->getId());
537  $this->ctrl->redirectByClass(array("ilDashboardGUI", "ilportfoliorepositorygui", "ilobjportfoliogui"), "createFromTemplateDirect");
538  }
+ Here is the call graph for this function:

◆ createFromTemplateOld()

ilObjPortfolioTemplateGUI::createFromTemplateOld ( )

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

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

528  : void
529  {
530  $this->ctrl->setParameterByClass("ilobjportfoliogui", "prtt_pre", $this->object->getId());
531  $this->ctrl->redirectByClass(array("ilDashboardGUI", "ilportfoliorepositorygui", "ilobjportfoliogui"), "create");
532  }
+ Here is the call graph for this function:

◆ executeCommand()

ilObjPortfolioTemplateGUI::executeCommand ( )

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

References ilObjPortfolioBaseGUI\$gui, $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().

56  : void
57  {
58  $ilNavigationHistory = $this->nav_history;
59 
60  // add entry to navigation history
61  if (!$this->getCreationMode() &&
62  $this->getAccessHandler()->checkAccess("read", "", $this->node_id)) {
63  $link = $this->ctrl->getLinkTarget($this, "view");
64  $ilNavigationHistory->addItem($this->node_id, $link, "prtt");
65  }
66 
67  $next_class = $this->ctrl->getNextClass($this);
68  $cmd = $this->ctrl->getCmd("view");
69  switch ($next_class) {
70  case 'ilportfoliotemplatepagegui':
71  $this->determinePageCall(); // has to be done before locator!
72  $this->prepareOutput();
73  $this->handlePageCall($cmd);
74  break;
75 
76  case "ilcommentgui":
77  $this->preview();
78  break;
79 
80  case "ilinfoscreengui":
81  $this->prepareOutput();
82  $this->addHeaderAction();
83  $this->infoScreenForward();
84  break;
85 
86  case "ilcommonactiondispatchergui":
88  $this->prepareOutput();
89  $this->ctrl->forwardCommand($gui);
90  break;
91 
92  case "ilpermissiongui":
93  $this->prepareOutput();
94  $this->tabs_gui->activateTab("id_permissions");
95  $perm_gui = new ilPermissionGUI($this);
96  $this->ctrl->forwardCommand($perm_gui);
97  break;
98 
99  case "ilobjectcopygui":
100  $this->prepareOutput();
101  $cp = new ilObjectCopyGUI($this);
102  $cp->setType("prtt");
103  $this->ctrl->forwardCommand($cp);
104  break;
105 
106  case 'ilexportgui':
107  $this->prepareOutput();
108  $this->tabs_gui->activateTab("export");
109  $exp_gui = new ilExportGUI($this);
110  $exp_gui->addFormat("xml");
111  $this->ctrl->forwardCommand($exp_gui);
112  break;
113 
114  case "ilobjectcontentstylesettingsgui":
115  $this->checkPermission("write");
116  $this->prepareOutput();
117  $this->addHeaderAction();
118  $this->tabs_gui->activateTab("settings");
119  $this->setSettingsSubTabs("style");
120  $settings_gui = $this->content_style_gui
121  ->objectSettingsGUIForRefId(
122  null,
123  $this->object->getRefId()
124  );
125  $this->ctrl->forwardCommand($settings_gui);
126  break;
127 
128  case "ilobjectmetadatagui":
129  $this->checkPermission("write");
130  $this->prepareOutput();
131  $this->addHeaderAction();
132  $this->tabs_gui->activateTab("advmd");
133  $md_gui = new ilObjectMetaDataGUI($this->object, "pfpg");
134  $this->ctrl->forwardCommand($md_gui);
135  break;
136 
137  default:
138  $this->addHeaderAction();
140  }
141  }
checkPermission(string $perm, string $cmd="", string $type="", int $ref_id=null)
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
executeCommand()
execute command
ILIAS Portfolio InternalGUIService $gui
GUI class for the workflow of copying objects.
prepareOutput(bool $show_sub_objects=true)
Export User Interface Class.
preview(bool $a_return=false, $a_content=false, bool $a_show_notes=true)
New PermissionGUI (extends from old ilPermission2GUI) RBAC related output.
addHeaderAction()
Add header action menu.
static getInstanceFromAjaxCall()
(Re-)Build instance from ajax call
+ Here is the call graph for this function:

◆ getEditFormCustomValues()

ilObjPortfolioTemplateGUI::getEditFormCustomValues ( array &  $a_values)
protected

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

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

347  : void
348  {
349  $a_values["online"] = $this->object->isOnline();
350  $a_values["access_period"]["start"] = $this->object->getActivationStartDate()
351  ? new ilDateTime($this->object->getActivationStartDate(), IL_CAL_UNIX)
352  : null;
353  $a_values["access_period"]["end"] = $this->object->getActivationEndDate()
354  ? new ilDateTime($this->object->getActivationEndDate(), IL_CAL_UNIX)
355  : null;
356  $a_values["access_visiblity"] = $this->object->getActivationVisibility();
357 
358  $a_values['cont_custom_md'] = ilContainer::_lookupContainerSetting(
359  $this->object->getId(),
361  false
362  );
363 
364  parent::getEditFormCustomValues($a_values);
365  }
const IL_CAL_UNIX
static _lookupContainerSetting(int $a_id, string $a_keyword, string $a_default_value=null)
+ Here is the call graph for this function:

◆ getPageGUIClassName()

ilObjPortfolioTemplateGUI::getPageGUIClassName ( )

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

433  : string
434  {
435  return "ilportfoliotemplatepagegui";
436  }

◆ getPageGUIInstance()

ilObjPortfolioTemplateGUI::getPageGUIInstance ( int  $a_page_id)
protected

Get portfolio template page gui instance.

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

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

423  $page_gui = new ilPortfolioTemplatePageGUI(
424  $this->object->getId(),
425  $a_page_id,
426  0,
427  $this->object->hasPublicComments()
428  );
429  $page_gui->setAdditional($this->getAdditional());
430  return $page_gui;
431  }
setAdditional(array $a_additional)
Set Additonal Information.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
+ 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 405 of file class.ilObjPortfolioTemplateGUI.php.

References ilPageObject\getId().

Referenced by saveBlog().

409  if (!$a_portfolio_id && $this->object) {
410  $a_portfolio_id = $this->object->getId();
411  }
412  $page = new ilPortfolioTemplatePage((int) $a_page_id);
413  $page->setPortfolioId($a_portfolio_id);
414  return $page;
415  }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
+ 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.

51  : string
52  {
53  return "prtt";
54  }

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

204  : void
205  {
206  $this->ctrl->setCmd("showSummary");
207  $this->ctrl->setCmdClass("ilinfoscreengui");
208  $this->infoScreenForward();
209  }
+ 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(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by executeCommand(), and infoScreen().

211  : void
212  {
213  $ilTabs = $this->tabs;
214  $ilToolbar = $this->toolbar;
215 
216  $ilTabs->activateTab("id_info");
217 
218  $this->checkPermission("visible");
219 
220  if ($this->checkPermissionBool("read")) {
221  $this->lng->loadLanguageModule("cntr");
222 
223  $this->gui->button(
224  $this->lng->txt("prtf_create_portfolio_from_template"),
225  $this->ctrl->getLinkTarget($this, "createfromtemplate")
226  )->primary()->toToolbar();
227  }
228 
229  $info = new ilInfoScreenGUI($this);
230 
231  $info->enablePrivateNotes();
232 
233  if ($this->checkPermissionBool("read")) {
234  $info->enableNews();
235  }
236 
237  // no news editing for files, just notifications
238  $info->enableNewsEditing(false);
239  if ($this->checkPermissionBool("write")) {
240  $news_set = new ilSetting("news");
241  $enable_internal_rss = $news_set->get("enable_rss_for_internal");
242 
243  if ($enable_internal_rss) {
244  $info->setBlockProperty("news", "settings", true);
245  $info->setBlockProperty("news", "public_notifications_option", true);
246  }
247  }
248 
249  // standard meta data
250  $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());
251 
252  $this->ctrl->forwardCommand($info);
253  }
checkPermission(string $perm, string $cmd="", string $type="", int $ref_id=null)
Class ilInfoScreenGUI.
ilToolbarGUI $toolbar
checkPermissionBool(string $perm, string $cmd="", string $type="", ?int $node_id=null)
+ 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 464 of file class.ilObjPortfolioTemplateGUI.php.

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

Referenced by saveBlog().

465  {
466  $form = new ilPropertyFormGUI();
467  $form->setFormAction($this->ctrl->getFormAction($this));
468 
469  $obj = new ilTextInputGUI($this->lng->txt("title"), "blog");
470  $obj->setRequired(true);
471  $form->addItem($obj);
472 
473  // save and cancel commands
474  $form->setTitle($this->lng->txt("prtf_add_blog") . ": " .
475  $this->object->getTitle());
476  $form->addCommandButton("saveBlog", $this->lng->txt("save"));
477  $form->addCommandButton("view", $this->lng->txt("cancel"));
478 
479  return $form;
480  }
+ 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 438 of file class.ilObjPortfolioTemplateGUI.php.

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

438  : void
439  {
440  // always existing prtft
441  $hi = new ilHiddenInputGUI("target");
442  $hi->setValue("old");
443  $a_form->addItem($hi);
444 
445  $options = array();
447  foreach ($all as $id => $title) {
448  $options[$id] = $title;
449  }
450  $prtf = new ilSelectInputGUI($this->lng->txt("obj_prtt"), "prtf");
451  $prtf->setRequired(true);
452  $prtf->setOptions($options);
453  $a_form->addItem($prtf);
454  }
This class represents a selection list property in a property form.
static getAvailablePortfolioTemplates(string $a_permission="read")
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
setRequired(bool $a_required)
+ Here is the call graph for this function:

◆ initDidacticTemplate()

ilObjPortfolioTemplateGUI::initDidacticTemplate ( ilPropertyFormGUI  $form)
protected

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

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

261  {
262  $ilUser = $this->user;
263 
264  $all = ilObjPortfolio::getPortfoliosOfUser($ilUser->getId());
265  if (count($all)) {
266  $opts = array("" => $this->lng->txt("please_select"));
267  foreach ($all as $item) {
268  $opts[$item["id"]] = $item["title"];
269  }
270  $prtf = new ilSelectInputGUI($this->lng->txt("prtf_create_template_from_portfolio"), "prtf");
271  $prtf->setInfo($this->lng->txt("prtf_create_template_from_portfolio_info"));
272  $prtf->setOptions($opts);
273  $form->addItem($prtf);
274  }
275 
276  return $form;
277  }
This class represents a selection list property in a property form.
static getPortfoliosOfUser(int $a_user_id)
Get portfolios of user.
+ Here is the call graph for this function:

◆ initEditCustomForm()

ilObjPortfolioTemplateGUI::initEditCustomForm ( ilPropertyFormGUI  $a_form)
protected

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

References ilObjectGUI\$object_service, ilObject\_getAllReferences(), ilPropertyFormGUI\addItem(), ilObjectServiceSettingsGUI\CUSTOM_METADATA, ilPropertyFormGUI\getItemByPostVar(), ilObjectServiceSettingsGUI\initServiceSettingsForm(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

294  : void
295  {
296  $obj_service = $this->object_service;
297  // activation/availability
298 
299  $this->lng->loadLanguageModule('rep');
300 
301  $section = new ilFormSectionHeaderGUI();
302  $section->setTitle($this->lng->txt('rep_activation_availability'));
303  $a_form->addItem($section);
304 
305  // additional info only with multiple references
306  $act_obj_info = $act_ref_info = "";
307  if (count(ilObject::_getAllReferences($this->object->getId())) > 1) {
308  $act_obj_info = ' ' . $this->lng->txt('rep_activation_online_object_info');
309  $act_ref_info = $this->lng->txt('rep_activation_access_ref_info');
310  }
311 
312  $online = new ilCheckboxInputGUI($this->lng->txt('rep_activation_online'), 'online');
313  $online->setInfo($this->lng->txt('prtt_activation_online_info') . $act_obj_info);
314  $a_form->addItem($online);
315 
316  $dur = new ilDateDurationInputGUI($this->lng->txt("rep_time_based_availability"), "access_period");
317  $dur->setShowTime(true);
318  $dur->setEndText($this->lng->txt('rep_activation_limited_end'));
319  $a_form->addItem($dur);
320 
321  $visible = new ilCheckboxInputGUI($this->lng->txt('rep_activation_limited_visibility'), 'access_visiblity');
322  $visible->setInfo($this->lng->txt('prtt_activation_limited_visibility_info'));
323  $dur->addSubItem($visible);
324 
325  $section = new ilFormSectionHeaderGUI();
326  $section->setTitle($this->lng->txt('obj_presentation'));
327  $a_form->addItem($section);
328 
329  // tile image
330  $obj_service->commonSettings()->legacyForm($a_form, $this->object)->addTileImage();
331 
332 
333  parent::initEditCustomForm($a_form);
334 
336  $this->object->getId(),
337  $a_form,
338  array(
340  )
341  );
342 
343  $tit = $a_form->getItemByPostVar("title");
344  $tit->setInfo($this->lng->txt('prtt_title_info'));
345  }
getItemByPostVar(string $a_post_var)
static _getAllReferences(int $id)
get all reference ids for object ID
ilObjectService $object_service
static initServiceSettingsForm(int $obj_id, ilPropertyFormGUI $form, array $services)
+ 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 510 of file class.ilObjPortfolioTemplateGUI.php.

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

Referenced by executeCommand().

514  : string {
515  if (!$this->checkPermissionBool("write") &&
516  $this->checkPermissionBool("read")) {
517  $this->lng->loadLanguageModule("cntr");
518  $button = $this->gui->button(
519  $this->lng->txt("prtf_create_portfolio_from_template"),
520  $this->ctrl->getLinkTarget($this, "createfromtemplate")
521  )->primary();
522  $this->tpl->setHeaderActionMenu($button->render());
523  }
524 
525  return parent::preview($a_return, $a_content, $a_show_notes);
526  }
checkPermissionBool(string $perm, string $cmd="", string $type="", ?int $node_id=null)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ saveBlog()

ilObjPortfolioTemplateGUI::saveBlog ( )
protected

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

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

482  : void
483  {
484  $form = $this->initBlogForm();
485  if ($form->checkInput() && $this->checkPermissionBool("write")) {
486  $page = $this->getPageInstance();
488  $page->setTitle($form->getInput("blog"));
489  $page->create(false);
490 
491  $this->tpl->setOnScreenMessage('success', $this->lng->txt("prtf_blog_page_created"), true);
492  $this->ctrl->redirect($this, "view");
493  }
494 
495  $this->tabs_gui->clearTargets();
496  $this->tabs_gui->setBackTarget(
497  $this->lng->txt("back"),
498  $this->ctrl->getLinkTarget($this, "view")
499  );
500 
501  $form->setValuesByPost();
502  $this->tpl->setContent($form->getHTML());
503  }
initBlogForm()
Init blog template page form.
checkPermissionBool(string $perm, string $cmd="", string $type="", ?int $node_id=null)
getPageInstance(?int $a_page_id=null, ?int $a_portfolio_id=null)
Get portfolio template page instance.
+ 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().

143  : void
144  {
145  $ilHelp = $this->help;
146 
147  $ilHelp->setScreenIdComponent("prtt");
148 
149  if ($this->checkPermissionBool("write")) {
150  $this->tabs_gui->addTab(
151  "pages",
152  $this->lng->txt("content"),
153  $this->ctrl->getLinkTarget($this, "view")
154  );
155  }
156 
157  if ($this->checkPermissionBool("read")) {
158  $this->tabs_gui->addTab(
159  "id_info",
160  $this->lng->txt("info_short"),
161  $this->ctrl->getLinkTargetByClass(array("ilobjportfoliotemplategui", "ilinfoscreengui"), "showSummary")
162  );
163  }
164 
165  if ($this->checkPermissionBool("write")) {
166  $this->tabs_gui->addTab(
167  "settings",
168  $this->lng->txt("settings"),
169  $this->ctrl->getLinkTarget($this, "edit")
170  );
171 
172  $mdgui = new ilObjectMetaDataGUI($this->object, "pfpg");
173  $mdtab = $mdgui->getTab();
174  if ($mdtab) {
175  $this->tabs_gui->addTab(
176  "advmd",
177  $this->lng->txt("meta_data"),
178  $mdtab
179  );
180  }
181 
182  $this->tabs_gui->addTab(
183  "export",
184  $this->lng->txt("export"),
185  $this->ctrl->getLinkTargetByClass("ilexportgui", "")
186  );
187  }
188 
189  if ($this->checkPermissionBool("read")) {
190  $this->tabs_gui->addNonTabbedLink(
191  "preview",
192  $this->lng->txt("preview"),
193  $this->ctrl->getLinkTarget($this, "preview")
194  );
195  }
196 
197  // will add permissions if needed
199  }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
checkPermissionBool(string $perm, string $cmd="", string $type="", ?int $node_id=null)
setScreenIdComponent(string $a_comp)
setTabs()
create tabs (repository/workspace switch)
+ Here is the call graph for this function:

◆ updateCustom()

ilObjPortfolioTemplateGUI::updateCustom ( ilPropertyFormGUI  $form)
protected

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

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

367  : void
368  {
369  $obj_service = $this->object_service;
370 
371  $this->object->setOnline($form->getInput("online"));
372 
373  // activation
374  $period = $form->getItemByPostVar("access_period");
375  if ($period->getStart() && $period->getEnd()) {
376  $this->object->setActivationLimited(true);
377  $this->object->setActivationVisibility($form->getInput("access_visiblity"));
378  $this->object->setActivationStartDate($period->getStart()->get(IL_CAL_UNIX));
379  $this->object->setActivationEndDate($period->getEnd()->get(IL_CAL_UNIX));
380  } else {
381  $this->object->setActivationLimited(false);
382  }
383 
384  parent::updateCustom($form);
385 
386  $obj_service->commonSettings()->legacyForm($form, $this->object)->saveTileImage();
387 
389  $this->object->getId(),
390  $form,
391  array(
393  )
394  );
395  }
getItemByPostVar(string $a_post_var)
static updateServiceSettingsForm(int $obj_id, ilPropertyFormGUI $form, array $services)
const IL_CAL_UNIX
getInput(string $a_post_var, bool $ensureValidation=true)
Returns the input of an item, if item provides getInput method and as fallback the value of the HTTP-...
ilObjectService $object_service
+ 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: