ILIAS  release_8 Revision v8.24
ilObject2GUI Class Reference

New implementation of ilObjectGUI. More...

+ Inheritance diagram for ilObject2GUI:
+ Collaboration diagram for ilObject2GUI:

Public Member Functions

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

Static Public Member Functions

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

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
 

Protected Member Functions

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

Protected Attributes

ilObjectDefinition $obj_definition
 
ilGlobalTemplateInterface $tpl
 
ilCtrl $ctrl
 
ilLanguage $lng
 
ilTabsGUI $tabs_gui
 
ilObjectService $object_service
 
ilFavouritesManager $favourites
 
ilErrorHandling $error
 
ilLocatorGUI $locator
 
ilObjUser $user
 
ilAccessHandler $access
 
ilToolbarGUI $toolbar
 
ArrayBasedRequestWrapper $post_wrapper
 
RequestWrapper $request_wrapper
 
Factory $refinery
 
ilRbacAdmin $rbac_admin
 
ilRbacSystem $rbac_system
 
ilRbacReview $rbac_review
 
int $request_ref_id
 
int $id_type
 
int $parent_id
 
string $type
 
string $html
 
int $object_id
 
int $node_id = null
 
array $creation_forms = array()
 
 $access_handler
 
- Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service $notes_service
 
ServerRequestInterface $request
 
ilLocatorGUI $locator
 
ilObjUser $user
 
ilAccessHandler $access
 
ilSetting $settings
 
ilToolbarGUI $toolbar
 
ilRbacAdmin $rbac_admin
 
ilRbacSystem $rbac_system
 
ilRbacReview $rbac_review
 
ilObjectService $object_service
 
ilObjectDefinition $obj_definition
 
ilGlobalTemplateInterface $tpl
 
ilTree $tree
 
ilCtrl $ctrl
 
ilErrorHandling $error
 
ilLanguage $lng
 
ilTabsGUI $tabs_gui
 
ILIAS $ilias
 
ArrayBasedRequestWrapper $post_wrapper
 
RequestWrapper $request_wrapper
 
Factory $refinery
 
ilFavouritesManager $favourites
 
ilObjectCustomIconFactory $custom_icon_factory
 
ilObject $object = null
 
bool $creation_mode = false
 
 $data
 
int $id
 
bool $call_by_reference = false
 
bool $prepare_output
 
int $ref_id
 
int $obj_id
 
int $maxcount
 
array $form_action = []
 
array $return_location = []
 
array $target_frame = []
 
string $tmp_import_dir
 
string $sub_objects = ""
 
bool $omit_locator = false
 
string $type = ""
 
string $admin_mode = self::ADMIN_MODE_NONE
 
int $requested_ref_id = 0
 
int $requested_crtptrefid = 0
 
int $requested_crtcb = 0
 
string $requested_new_type = ""
 
string $link_params
 
string $html = ""
 

Private Attributes

ilObjectRequestRetriever $retriever
 

Detailed Description

New implementation of ilObjectGUI.

(beta)

Differences to the ilObject implementation:

  • no $this->tree anymore
  • no $this->formaction anymore
  • no $this->return_location anymore
  • no $this->target_frame anymore
  • no $this->actions anymore
  • no $this->sub_objects anymore
  • no $this->data anymore
  • no $this->prepare_output anymore

All new modules should derive from this class.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Definition at line 43 of file class.ilObject2GUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObject2GUI::__construct ( int  $id = 0,
int  $id_type = self::REPOSITORY_NODE_ID,
int  $parent_node_id = 0 
)

Reimplemented in ilObjBlogGUI, ilObjCloudGUI, ilObjCmiXapiGUI, ilObjContentPageGUI, ilObjCourseVerificationGUI, ilObjDataCollectionGUI, ilObjFileGUI, ilObjItemGroupGUI, ilObjLTIConsumerGUI, ilObjMediaPoolGUI, ilObjPollGUI, ilObjPortfolioBaseGUI, ilObjPortfolioTemplateGUI, ilObjWikiSettingsGUI, ilObjWorkspaceRootFolderGUI, ilObjContactAdministrationGUI, ilObjHelpSettingsGUI, ilObjPDFGenerationGUI, ilOrgUnitExtensionGUI, ilObjTestVerificationGUI, ilObjLinkResourceGUI, and ilObjFileServicesGUI.

Definition at line 86 of file class.ilObject2GUI.php.

87 {
88 global $DIC;
89
90 $this->obj_definition = $DIC["objDefinition"];
91 $this->tpl = $DIC["tpl"];
92 $this->ctrl = $DIC["ilCtrl"];
93 $this->lng = $DIC["lng"];
94 $this->tabs_gui = $DIC["ilTabs"];
95 $this->object_service = $DIC->object();
96 $this->favourites = new ilFavouritesManager();
97 $this->error = $DIC['ilErr'];
98 $this->locator = $DIC["ilLocator"];
99 $this->user = $DIC->user();
100 $this->access = $DIC->access();
101 $this->toolbar = $DIC->toolbar();
102 $this->post_wrapper = $DIC->http()->wrapper()->post();
103 $this->request_wrapper = $DIC->http()->wrapper()->query();
104 $this->refinery = $DIC->refinery();
105 $this->retriever = new ilObjectRequestRetriever($DIC->http()->wrapper(), $this->refinery);
106 $this->rbac_admin = $DIC->rbac()->admin();
107 $this->rbac_system = $DIC->rbac()->system();
108 $this->rbac_review = $DIC->rbac()->review();
109
110 $tree = $DIC["tree"];
111
112 $this->requested_ref_id = 0;
113 if ($this->request_wrapper->has("ref_id")) {
114 $this->requested_ref_id = $this->request_wrapper->retrieve("ref_id", $this->refinery->kindlyTo()->int());
115 }
116 $this->id_type = $id_type;
117 $this->parent_id = $parent_node_id;
118 $this->type = $this->getType();
119 $this->html = "";
120 $this->notes_service = $DIC->notes();
121
122 $this->requested_new_type = '';
123 if ($this->request_wrapper->has("new_type")) {
124 $this->requested_new_type = $this->request_wrapper->retrieve(
125 "new_type",
126 $this->refinery->kindlyTo()->string()
127 );
128 } elseif ($this->post_wrapper->has("new_type")) {
129 $this->requested_new_type = $this->post_wrapper->retrieve(
130 "new_type",
131 $this->refinery->kindlyTo()->string()
132 );
133 }
134
135 $params = array();
136 switch ($this->id_type) {
138 $this->node_id = $id;
139 $this->object_id = ilObject::_lookupObjectId($this->node_id);
140 $this->tree = $tree;
141 $this->access_handler = $this->access;
142 $this->call_by_reference = true; // needed for prepareOutput()
143 $params[] = "ref_id";
144 break;
145
147 $this->object_id = $id;
148 $this->tree = $tree;
149 $this->access_handler = $this->access;
150 $params[] = "obj_id"; // ???
151 break;
152
154 $ilUser = $DIC["ilUser"];
155 $this->node_id = $id;
156 $this->tree = new ilWorkspaceTree($ilUser->getId());
157 $this->object_id = $this->tree->lookupObjectId($this->node_id);
158 $this->access_handler = new ilWorkspaceAccessHandler($this->tree);
159 $params[] = "wsp_id";
160 break;
161
163 $ilUser = $DIC["ilUser"];
164 $this->object_id = $id;
165 $this->tree = new ilWorkspaceTree($ilUser->getId());
166 $this->access_handler = new ilWorkspaceAccessHandler($this->tree);
167 $params[] = "obj_id"; // ???
168 break;
169
171 $this->object_id = $id;
172 $this->access_handler = new ilPortfolioAccessHandler();
173 $params[] = "prt_id";
174 break;
175
176 case self::OBJECT_ID:
177 $this->object_id = $id;
178 $this->access_handler = new ilDummyAccessHandler();
179 $params[] = "obj_id";
180 break;
181 }
182 $this->ctrl->saveParameter($this, $params);
183
184
185
186 // old stuff for legacy code (obsolete?)
187 if (!$this->object_id) {
188 $this->creation_mode = true;
189 }
190 if ($this->node_id) {
191 // add parent node id if missing
192 if (!$this->parent_id && $this->tree) {
193 $this->parent_id = $this->tree->getParentId($this->node_id);
194 }
195 }
196 $this->ref_id = $this->node_id ?? 0;
197 $this->obj_id = $this->object_id;
198
199 $this->assignObject();
200
201 // set context
202 if (is_object($this->object)) {
203 $this->ctrl->setContextObject($this->object->getId(), $this->object->getType());
204 }
205
206 $this->afterConstructor();
207 }
error(string $a_errmsg)
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
getType()
Functions that must be overwritten.
ilAccessHandler $access
assignObject()
create object instance as internal property (repository/workspace switch)
afterConstructor()
Do anything that should be done after constructor in here.
Base class for all sub item list gui's.
static _lookupObjectId(int $ref_id)
Access handler for portfolio NOTE: This file needs to stay in the classes directory,...
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
global $DIC
Definition: feed.php:28
$ilUser
Definition: imgupload.php:34
if(! $DIC->user() ->getId()||!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) $params
Definition: ltiregstart.php:33

References $access, $DIC, ilObjectGUI\$id, $id_type, $ilUser, $object_id, $params, ilObjectGUI\$tree, ilObject\_lookupObjectId(), ILIAS\Repository\access(), afterConstructor(), assignObject(), ILIAS\Repository\ctrl(), error(), getType(), ILIAS\Repository\html(), ILIAS\Repository\lng(), ILIAS\Repository\locator(), ILIAS\Repository\object(), OBJECT_ID, PORTFOLIO_OBJECT_ID, ILIAS\Repository\refinery(), REPOSITORY_NODE_ID, REPOSITORY_OBJECT_ID, ILIAS\Repository\toolbar(), ILIAS\Repository\user(), WORKSPACE_NODE_ID, and WORKSPACE_OBJECT_ID.

+ Here is the call graph for this function:

Member Function Documentation

◆ addAdminLocatorItems()

ilObject2GUI::addAdminLocatorItems ( bool  $do_not_add_object = false)
finalprotected

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

Reimplemented from ilObjectGUI.

Definition at line 513 of file class.ilObject2GUI.php.

513 : void
514 {
515 parent::addAdminLocatorItems($do_not_add_object);
516 }

Referenced by ilObjectPluginGUI\executeCommand().

+ Here is the caller graph for this function:

◆ addLocatorItems()

ilObject2GUI::addLocatorItems ( )
protected

Functions to be overwritten.

Reimplemented from ilObjectGUI.

Reimplemented in ilObjBibliographicGUI, ilObjBlogGUI, ilObjCmiXapiGUI, ilObjContentPageGUI, ilObjDataCollectionGUI, ilObjFileGUI, ilObjItemGroupGUI, ilObjLTIConsumerGUI, ilObjMediaPoolGUI, ilObjPollGUI, ilObjPortfolioBaseGUI, ilObjLinkResourceGUI, and ilObjectPluginGUI.

Definition at line 604 of file class.ilObject2GUI.php.

604 : void
605 {
606 }

Referenced by setLocator().

+ Here is the caller graph for this function:

◆ afterConstructor()

ilObject2GUI::afterConstructor ( )
protected

Do anything that should be done after constructor in here.

Reimplemented in ilObjItemGroupGUI, and ilObjMediaPoolGUI.

Definition at line 212 of file class.ilObject2GUI.php.

212 : void
213 {
214 }

Referenced by __construct().

+ Here is the caller graph for this function:

◆ assignObject()

ilObject2GUI::assignObject ( )
finalprotected

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

Reimplemented from ilObjectGUI.

Definition at line 256 of file class.ilObject2GUI.php.

256 : void
257 {
258 if ($this->object_id != 0) {
259 switch ($this->id_type) {
260 case self::OBJECT_ID:
264 $this->object = ilObjectFactory::getInstanceByObjId($this->object_id);
265 break;
266
268 $this->object = ilObjectFactory::getInstanceByRefId($this->node_id);
269 break;
270
272 // to be discussed
273 $this->object = ilObjectFactory::getInstanceByObjId($this->object_id);
274 break;
275 }
276 }
277 }
static getInstanceByRefId(int $ref_id, bool $stop_on_error=true)
get an instance of an Ilias object by reference id
static getInstanceByObjId(?int $obj_id, bool $stop_on_error=true)
get an instance of an Ilias object by object id

References ilObjectFactory\getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), OBJECT_ID, PORTFOLIO_OBJECT_ID, REPOSITORY_NODE_ID, REPOSITORY_OBJECT_ID, WORKSPACE_NODE_ID, and WORKSPACE_OBJECT_ID.

Referenced by ilObjAdministrativeNotificationGUI\__construct(), ilObjMainMenuGUI\__construct(), and __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cancel()

ilObject2GUI::cancel ( )

Reimplemented in ilObjTaxonomyGUI.

Definition at line 632 of file class.ilObject2GUI.php.

632 : void
633 {
634 parent::cancelObject();
635 }

◆ cancelDelete()

ilObject2GUI::cancelDelete ( )
final

Definition at line 498 of file class.ilObject2GUI.php.

498 : void
499 {
500 parent::cancelDeleteObject();
501 }

◆ checkPermission()

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

Definition at line 486 of file class.ilObject2GUI.php.

491 : void {
492 parent::checkPermission($perm, $cmd, $type, $ref_id);
493 }

Referenced by ilObjHelpSettingsGUI\activateModule(), ilObjLinkResourceGUI\addLink(), ilObjMediaPoolGUI\allMedia(), ilObjHelpSettingsGUI\confirmHelpModulesDeletion(), ilObjMediaPoolGUI\confirmRemove(), ilObjMediaPoolGUI\copyToClipboard(), ilObjMediaPoolGUI\createFolderForm(), ilObjHelpSettingsGUI\deactivateModule(), ilObjHelpSettingsGUI\deleteHelpModules(), ilObjLinkResourceGUI\deleteParameter(), ilObjLinkResourceGUI\deleteParameterForm(), ilObjMediaPoolGUI\editFolder(), ilObjLinkResourceGUI\editLink(), ilObjMediaPoolGUI\executeCommand(), ilObjPortfolioTemplateGUI\executeCommand(), ilObjLinkResourceGUI\executeCommand(), ilObjectPluginGUI\executeCommand(), ilObjectPluginGUI\infoScreen(), ilObjDataCollectionGUI\infoScreenForward(), ilObjPortfolioTemplateGUI\infoScreenForward(), ilObjMediaPoolGUI\insertFromClipboard(), ilObjItemGroupGUI\listMaterials(), ilObjMediaPoolGUI\listMedia(), ilObjMediaPoolGUI\openClipboard(), ilObjMediaPoolGUI\remove(), ilObjLinkResourceGUI\saveAddLink(), ilObjContactAdministrationGUI\saveConfigurationForm(), ilObjMediaPoolGUI\saveFolder(), ilObjItemGroupGUI\saveItemAssignment(), ilObjLinkResourceGUI\saveLinkList(), ilObjLinkResourceGUI\saveSettings(), ilObjHelpSettingsGUI\setMode(), ilObjLinkResourceGUI\settings(), ilObjMediaPoolGUI\showMedia(), ilObjMediaPoolGUI\showPreview(), ilObjMediaPoolGUI\updateFolder(), ilObjLinkResourceGUI\updateLink(), ilObjLinkResourceGUI\updateLinks(), and ilObjContentPageGUI\view().

+ Here is the caller graph for this function:

◆ checkPermissionBool()

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

Reimplemented from ilObjectGUI.

Reimplemented in ilObjPortfolioGUI, and ilObjTaxonomyGUI.

Definition at line 738 of file class.ilObject2GUI.php.

743 : bool {
744 if ($perm == "create") {
745 if (!$node_id) {
747 }
748 if ($node_id) {
749 return $this->getAccessHandler()->checkAccess($perm . "_" . $type, $cmd, $node_id);
750 }
751 } else {
752 if (!$node_id) {
754 }
755 if ($node_id) {
756 return $this->getAccessHandler()->checkAccess($perm, $cmd, $node_id);
757 }
758 }
759
760 // if we do not have a node id, check if current user is owner
761 if ($this->obj_id && $this->object->getOwner() == $this->user->getId()) {
762 return true;
763 }
764 return false;
765 }

References $type.

Referenced by ilObjWorkspaceFolderGUI\addContentSubTabs(), ilObjContentPageGUI\addToNavigationHistory(), ilObjPollGUI\confirmDeleteAllVotes(), ilObjWorkspaceFolderGUI\cut(), ilObjPollGUI\deleteAllVotes(), ilObjWorkspaceFolderGUI\deleteConfirmation(), ilObjPortfolioBaseGUI\determinePageCall(), ilObjMediaPoolGUI\edit(), ilObjBibliographicGUI\editObject(), ilRemoteObjectBaseGUI\editObject(), ilObjHelpSettingsGUI\editSettings(), ilObjDataCollectionGUI\executeCommand(), ilObjItemGroupGUI\executeCommand(), ilRemoteObjectBaseGUI\executeCommand(), ilObjWikiSettingsGUI\getAdminTabs(), ilObjContactAdministrationGUI\getAdminTabs(), ilObjHelpSettingsGUI\getAdminTabs(), ilObjPDFGenerationGUI\getAdminTabs(), ilObjContactAdministrationGUI\getConfigurationForm(), ilObjContentPageGUI\getContent(), ilObjPDFGenerationGUI\handleSaveAndConf(), ilObjPDFGenerationGUI\hasWritePermission(), ilObjCmiXapiGUI\infoScreenForward(), ilObjContentPageGUI\infoScreenForward(), ilObjDataCollectionGUI\infoScreenForward(), ilObjPortfolioTemplateGUI\infoScreenForward(), ilObjWikiSettingsGUI\initForm(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), ilObjPollGUI\render(), ilObjContentPageGUI\renderHeaderActions(), ilObjWikiSettingsGUI\saveSettings(), ilObjHelpSettingsGUI\setMode(), ilObjContentPageGUI\setSettingsSubTabs(), ilObjContentPageGUI\setTabs(), ilObjPollGUI\setTabs(), ilObjPortfolioTemplateGUI\setTabs(), ilRemoteObjectBaseGUI\setTabs(), ilObjPollGUI\showParticipants(), ilObjPollGUI\showParticipantVotes(), ilRemoteObjectBaseGUI\updateObject(), and ilObjHelpSettingsGUI\uploadHelpFile().

+ Here is the caller graph for this function:

◆ confirmedDelete()

ilObject2GUI::confirmedDelete ( )

Delete objects (repository/workspace switch)

Reimplemented in ilObjTaxonomyGUI.

Definition at line 363 of file class.ilObject2GUI.php.

363 : void
364 {
365 switch ($this->id_type) {
368 parent::confirmedDeleteObject();
369
370 // no break
373 $this->deleteConfirmedObjects();
374
375 // no break
376 case self::OBJECT_ID:
378 // :TODO: should this ever occur?
379 break;
380 }
381 }
deleteConfirmedObjects()
Delete objects (workspace specific) This should probably be moved elsewhere as done with RepUtil.

References deleteConfirmedObjects(), OBJECT_ID, PORTFOLIO_OBJECT_ID, REPOSITORY_NODE_ID, REPOSITORY_OBJECT_ID, WORKSPACE_NODE_ID, and WORKSPACE_OBJECT_ID.

+ Here is the call graph for this function:

◆ create()

ilObject2GUI::create ( )

◆ delete()

ilObject2GUI::delete ( )

Display delete confirmation form (repository/workspace switch)

Definition at line 340 of file class.ilObject2GUI.php.

340 : void
341 {
342 switch ($this->id_type) {
345 parent::deleteObject();
346
347 // no break
350 $this->deleteConfirmation();
351
352 // no break
353 case self::OBJECT_ID:
355 // :TODO: should this ever occur?
356 break;
357 }
358 }

References OBJECT_ID, PORTFOLIO_OBJECT_ID, REPOSITORY_NODE_ID, REPOSITORY_OBJECT_ID, WORKSPACE_NODE_ID, and WORKSPACE_OBJECT_ID.

◆ deleteConfirmedObjects()

ilObject2GUI::deleteConfirmedObjects ( )
protected

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

Definition at line 387 of file class.ilObject2GUI.php.

387 : void
388 {
389 if (!$this->post_wrapper->has("id")) {
390 $this->tpl->setOnScreenMessage("failure", $this->lng->txt("no_checkbox"), true);
391 $this->ctrl->redirect($this, "");
392 return;
393 }
394
395 $ids = $this->post_wrapper->retrieve(
396 "id",
397 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
398 );
399
400 if (count($ids) == 0) {
401 $this->tpl->setOnScreenMessage("failure", $this->lng->txt("no_checkbox"), true);
402 $this->ctrl->redirect($this, "");
403 return;
404 }
405
406 // #18797 - because of parent/child relations gather all nodes first
407 $del_nodes = array();
408 foreach ($ids as $node_id) {
409 $del_nodes[$node_id] = $this->tree->getNodeData($node_id);
410 }
411
412 foreach ($del_nodes as $node_id => $node) {
413 $this->tree->deleteReference($node_id);
414 if ($this->tree->isInTree($node_id)) {
415 $this->tree->deleteTree($node);
416 }
417
418 $this->getAccessHandler()->removePermission($node_id);
419
420 $object = ilObjectFactory::getInstanceByObjId((int) $node["obj_id"], false);
421 if ($object) {
422 $object->delete();
423 }
424 }
425
426 $this->tpl->setOnScreenMessage("success", $this->lng->txt("msg_removed"), true);
427 $this->ctrl->redirect($this, "");
428 }
delete()
delete object or referenced object (in the case of a referenced object, object data is only deleted i...

References $node_id, ilObjectGUI\$object, ILIAS\Repository\ctrl(), ilObject\delete(), getAccessHandler(), ilObjectFactory\getInstanceByObjId(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by confirmedDelete().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ edit()

ilObject2GUI::edit ( )

Reimplemented in ilObjFileGUI, ilObjItemGroupGUI, ilObjMediaPoolGUI, and ilObjWorkspaceFolderGUI.

Definition at line 624 of file class.ilObject2GUI.php.

624 : void
625 {
626 parent::editObject();
627 }

◆ executeCommand()

ilObject2GUI::executeCommand ( )

execute command

Reimplemented from ilObjectGUI.

Reimplemented in ilObjBibliographicGUI, ilObjBlogGUI, ilObjCloudGUI, ilObjDataCollectionGUI, ilObjItemGroupGUI, ilObjMediaPoolGUI, ilObjPollGUI, ilObjPortfolioGUI, ilObjPortfolioTemplateGUI, ilObjLinkResourceGUI, ilObjWikiSettingsGUI, ilObjWorkspaceFolderGUI, ilObjAdministrativeNotificationGUI, ilObjContactAdministrationGUI, ilObjFileServicesGUI, ilObjHelpSettingsGUI, ilObjMainMenuGUI, ilObjPDFGenerationGUI, ilObjectPluginGUI, ilObjTaxonomyGUI, and ilRemoteObjectBaseGUI.

Definition at line 219 of file class.ilObject2GUI.php.

219 : void
220 {
221 $next_class = $this->ctrl->getNextClass($this);
222 $cmd = $this->ctrl->getCmd();
223
224 $this->prepareOutput();
225
226 switch ($next_class) {
227 case "ilworkspaceaccessgui":
228 if ($this->node_id) {
229 $this->tabs_gui->activateTab("id_permissions");
230 $wspacc = new ilWorkspaceAccessGUI($this->node_id, $this->getAccessHandler());
231 $this->ctrl->forwardCommand($wspacc);
232 } else {
233 if (!$cmd) {
234 $cmd = "render";
235 }
236 $this->$cmd();
237 }
238 break;
239
240 default:
241 if (!$cmd) {
242 $cmd = "render";
243 }
244 $this->$cmd();
245 }
246 }
prepareOutput(bool $show_sub_objects=true)

References ILIAS\Repository\ctrl(), getAccessHandler(), and prepareOutput().

Referenced by ilObjPortfolioTemplateGUI\executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillCloneTemplate()

ilObject2GUI::fillCloneTemplate ( ?string  $tpl_name,
string  $type 
)
finalprotected

Fill object clone template This method can be called from any object GUI class that wants to offer object cloning.

Parameters
?stringtemplate variable name that will be filled
stringtype of new object
Returns
?ilPropertyFormGUI

Reimplemented from ilObjectGUI.

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

507 {
508 return parent::fillCloneTemplate($tpl_varname, $type);
509 }
This class represents a property form user interface.

References $type.

Referenced by ilObjLTIConsumerGUI\initCreationForms(), and ilObjectPluginGUI\initCreationForms().

+ Here is the caller graph for this function:

◆ getAccessHandler()

◆ getCenterColumnHTML()

ilObject2GUI::getCenterColumnHTML ( )
finalprotected

Get center column.

Reimplemented from ilObjectGUI.

Definition at line 474 of file class.ilObject2GUI.php.

474 : string
475 {
476 return parent::getCenterColumnHTML();
477 }

◆ getCreationMode()

◆ getHTML()

ilObject2GUI::getHTML ( )

Reimplemented from ilObjectGUI.

Reimplemented in ilObjBlogGUI.

Definition at line 430 of file class.ilObject2GUI.php.

430 : string
431 {
432 return parent::getHTML();
433 }

◆ getIdType()

ilObject2GUI::getIdType ( )

Definition at line 248 of file class.ilObject2GUI.php.

248 : int
249 {
250 return $this->id_type;
251 }

References $id_type.

Referenced by ilObjFileAbstractZipProcessor\__construct().

+ Here is the caller graph for this function:

◆ getPermanentLinkWidget()

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

Definition at line 819 of file class.ilObject2GUI.php.

819 : string
820 {
821 if ($this->id_type == self::WORKSPACE_NODE_ID) {
822 $append .= "_wsp";
823 }
824
825 $plink = new ilPermanentLinkGUI($this->getType(), $this->node_id, $append);
826 $plink->setIncludePermanentLinkText(false);
827 return $plink->getHTML();
828 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

◆ getReturnLocation()

ilObject2GUI::getReturnLocation ( string  $cmd,
string  $location = "" 
)
finalprotected

Deprecated functions.

Reimplemented from ilObjectGUI.

Definition at line 584 of file class.ilObject2GUI.php.

584 : string
585 {
586 die("ilObject2GUI::getReturnLocation() is deprecated.");
587 }

◆ getRightColumnHTML()

ilObject2GUI::getRightColumnHTML ( )
finalprotected

Display right column.

Reimplemented from ilObjectGUI.

Definition at line 478 of file class.ilObject2GUI.php.

478 : string
479 {
480 return parent::getRightColumnHTML();
481 }

◆ getTabs()

ilObject2GUI::getTabs ( )
finalprotected

@abstract overwrite in derived GUI class of your object type

Reimplemented from ilObjectGUI.

Definition at line 596 of file class.ilObject2GUI.php.

596 : void
597 {
598 die("ilObject2GUI::getTabs() is deprecated.");
599 }

◆ getTargetFrame()

ilObject2GUI::getTargetFrame ( string  $cmd,
string  $default_target_frame = "" 
)
finalprotected

get target frame for command (command is method name without "Object", e.g.

"perm")

Reimplemented from ilObjectGUI.

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

462 : string
463 {
464 return parent::getTargetFrame($cmd, $target_frame);
465 }

References ilObjectGUI\$target_frame.

◆ getType()

◆ handleAfterSaveCallback()

static ilObject2GUI::handleAfterSaveCallback ( ilObject  $obj,
?int  $callback_ref_id 
)
static

After creation callback.

Definition at line 720 of file class.ilObject2GUI.php.

721 {
722 global $DIC;
723 $objDefinition = $DIC["objDefinition"];
724
725 $callback_ref_id = (int) $callback_ref_id;
726 if ($callback_ref_id) {
727 $callback_type = ilObject::_lookupType($callback_ref_id, true);
728 $class_name = "ilObj" . $objDefinition->getClassName($callback_type) . "GUI";
729 if (strtolower($class_name) == "ilobjitemgroupgui") {
730 $callback_obj = new $class_name($callback_ref_id);
731 } else {
732 $callback_obj = new $class_name(null, $callback_ref_id, true, false);
733 }
734 $callback_obj->afterSaveCallback($obj);
735 }
736 }
static _lookupType(int $id, bool $reference=false)

References $DIC, ilObject\_lookupType(), and ILIAS\Repository\int().

+ Here is the call graph for this function:

◆ importFile()

ilObject2GUI::importFile ( )

Definition at line 654 of file class.ilObject2GUI.php.

654 : void
655 {
656 parent::importFileObject($this->parent_id);
657 }

◆ initCreationForms()

ilObject2GUI::initCreationForms ( string  $new_type)
protected

Init creation forms.

This will create the default creation forms: new, import, clone

Returns
\ilPropertyFormGUI[]

Reimplemented from ilObjectGUI.

Reimplemented in ilObjBibliographicGUI, ilObjLTIConsumerGUI, ilObjTaxonomyGUI, ilObjBlogGUI, ilObjItemGroupGUI, ilObjMediaPoolGUI, ilObjPortfolioGUI, and ilObjectPluginGUI.

Definition at line 642 of file class.ilObject2GUI.php.

642 : array
643 {
644 $forms = parent::initCreationForms($new_type);
645
646 // cloning doesn't work in workspace yet
647 if ($this->id_type == self::WORKSPACE_NODE_ID) {
648 unset($forms[self::CFORM_CLONE]);
649 }
650
651 return $forms;
652 }

◆ initHeaderAction()

ilObject2GUI::initHeaderAction ( ?string  $sub_type = null,
?int  $sub_id = null 
)
protected

Add header action menu.

Reimplemented from ilObjectGUI.

Reimplemented in ilObjLTIConsumerGUI, and ilObjCmiXapiGUI.

Definition at line 770 of file class.ilObject2GUI.php.

771 {
772 if ($this->id_type == self::WORKSPACE_NODE_ID) {
773 if (!$this->creation_mode && $this->object_id) {
774 $dispatcher = new ilCommonActionDispatcherGUI(
776 $this->getAccessHandler(),
777 $this->getType(),
778 $this->node_id,
779 $this->object_id
780 );
781
782 $dispatcher->setSubObject($sub_type, $sub_id);
783
785 $this->ctrl->getLinkTarget($this, "redrawHeaderAction", "", true),
786 "",
787 $this->ctrl->getLinkTargetByClass(["ilcommonactiondispatchergui", "iltagginggui"], "")
788 );
789
790 $lg = $dispatcher->initHeaderAction();
791
792 if (is_object($lg)) {
793 // to enable add to desktop / remove from desktop
794 if ($this instanceof ilDesktopItemHandling) {
795 $lg->setContainerObject($this);
796 }
797
798 // for activation checks see ilObjectGUI
799 // $lg->enableComments(true);
800 $lg->enableNotes(true);
801 // $lg->enableTags(true);
802 }
803
804 return $lg;
805 }
806 }
807
808 return parent::initHeaderAction($sub_type, $sub_id);
809 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
static prepareJsLinks(string $redraw_url, string $notes_url, string $tags_url, ilGlobalTemplateInterface $tpl=null)
Insert js/ajax links into template.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

References ILIAS\Repository\ctrl(), ilObjectListGUI\prepareJsLinks(), and ilCommonActionDispatcherGUI\TYPE_WORKSPACE.

+ Here is the call graph for this function:

◆ isVisible()

ilObject2GUI::isVisible ( int  $ref_id,
string  $type 
)
final

Reimplemented from ilObjectGUI.

Definition at line 470 of file class.ilObject2GUI.php.

470 : bool
471 {
472 return parent::isVisible($ref_id, $type);
473 }

References ilObjectGUI\$ref_id, and $type.

◆ omitLocator()

ilObject2GUI::omitLocator ( bool  $omit = true)
finalprotected

Reimplemented from ilObjectGUI.

Definition at line 458 of file class.ilObject2GUI.php.

458 : void
459 {
460 parent::omitLocator($omit);
461 }

◆ prepareOutput()

◆ putObjectInTree()

ilObject2GUI::putObjectInTree ( ilObject  $obj,
int  $parent_node_id = null 
)

Add object to tree at given position.

Reimplemented from ilObjectGUI.

Reimplemented in ilObjFileGUI.

Definition at line 662 of file class.ilObject2GUI.php.

662 : void
663 {
664 $this->object_id = $obj->getId();
665
666 if (!$parent_node_id) {
667 $parent_node_id = $this->parent_id;
668 }
669
670 // add new object to custom parent container
671 if ($this->retriever->has('crtptrefid')) {
672 $parent_node_id = $this->retriever->getMaybeInt('crtptrefid') ?? 0;
673 }
674
675 switch ($this->id_type) {
678 if (!$this->node_id) {
679 $obj->createReference();
680 $this->node_id = $obj->getRefId();
681 }
682 $obj->putInTree($parent_node_id);
683 $obj->setPermissions($parent_node_id);
684
685 // rbac log
686 $rbac_log_roles = $this->rbac_review->getParentRoleIds($this->node_id, false);
687 $rbac_log = ilRbacLog::gatherFaPa($this->node_id, array_keys($rbac_log_roles), true);
688 ilRbacLog::add(ilRbacLog::CREATE_OBJECT, $this->node_id, $rbac_log);
689
690 $this->ctrl->setParameter($this, "ref_id", $this->node_id);
691 break;
692
695 if (!$this->node_id) {
696 $this->node_id = $this->tree->insertObject($parent_node_id, $this->object_id);
697 }
698 $this->getAccessHandler()->setPermissions($parent_node_id, $this->node_id);
699
700 $this->ctrl->setParameter($this, "wsp_id", $this->node_id);
701 break;
702
703 case self::OBJECT_ID:
705 // do nothing
706 break;
707 }
708
709 // BEGIN ChangeEvent: Record save object.
710 ilChangeEvent::_recordWriteEvent($this->object_id, $this->user->getId(), 'create');
711 // END ChangeEvent: Record save object.
712
713 // use forced callback after object creation
714 self::handleAfterSaveCallback($obj, $this->retriever->getMaybeInt('crtcb'));
715 }
static _recordWriteEvent(int $obj_id, int $usr_id, string $action, ?int $parent_obj_id=null)
Records a write event.
static handleAfterSaveCallback(ilObject $obj, ?int $callback_ref_id)
After creation callback.
setPermissions(int $parent_ref_id)
createReference()
creates reference for object
putInTree(int $parent_ref_id)
maybe this method should be in tree object!?
static add(int $a_action, int $a_ref_id, array $a_diff, bool $a_source_ref_id=false)
static gatherFaPa(int $a_ref_id, array $a_role_ids, bool $a_add_action=false)
const CREATE_OBJECT

References ilChangeEvent\_recordWriteEvent(), ilRbacLog\add(), ilRbacLog\CREATE_OBJECT, ilObject\createReference(), ILIAS\Repository\ctrl(), ilRbacLog\gatherFaPa(), ilObject\getId(), ilObject\getRefId(), ilObject\putInTree(), ilObject\setPermissions(), and ILIAS\Repository\user().

Referenced by ilObjLTIConsumerGUI\createNewObject(), ilObjCmiXapiVerificationGUI\save(), ilObjCourseVerificationGUI\save(), ilObjExerciseVerificationGUI\save(), ilObjLTIConsumerVerificationGUI\save(), ilObjSCORMVerificationGUI\save(), and ilObjTestVerificationGUI\save().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ redirectToRefId()

ilObject2GUI::redirectToRefId ( int  $ref_id,
string  $cmd = "" 
)
finalprotected

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

Reimplemented from ilObjectGUI.

Definition at line 502 of file class.ilObject2GUI.php.

502 : void
503 {
504 parent::redirectToRefId($ref_id, $cmd);
505 }

References $ref_id.

◆ redrawHeaderAction()

ilObject2GUI::redrawHeaderAction ( )
protected

Updating icons after ajax call.

Definition at line 814 of file class.ilObject2GUI.php.

814 : void
815 {
816 parent::redrawHeaderActionObject();
817 }

◆ save()

◆ setColumnSettings()

ilObject2GUI::setColumnSettings ( ilColumnGUI  $column_gui)
final

Reimplemented from ilObjectGUI.

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

482 : void
483 {
484 parent::setColumnSettings($column_gui);
485 }

◆ setCreationMode()

ilObject2GUI::setCreationMode ( bool  $mode = true)
final

if true, a creation screen is displayed the current [ref_id] don't belong to the current class! The mode is determined in ilRepositoryGUI

Reimplemented from ilObjectGUI.

Definition at line 442 of file class.ilObject2GUI.php.

442 : void
443 {
444 parent::setCreationMode($mode);
445 }

Referenced by ilObjMediaPoolGUI\executeCommand().

+ Here is the caller graph for this function:

◆ setLocator()

ilObject2GUI::setLocator ( )
protected

set Locator

Reimplemented from ilObjectGUI.

Reimplemented in ilOrgUnitExtensionGUI.

Definition at line 290 of file class.ilObject2GUI.php.

290 : void
291 {
292 if ($this->omit_locator) {
293 return;
294 }
295
296 switch ($this->id_type) {
298 $ref_id = $this->node_id ?: $this->parent_id;
299 $this->locator->addRepositoryItems($ref_id);
300
301 // not so nice workaround: todo: handle locator as tabs in ilTemplate
302 if ($this->admin_mode == self::ADMIN_MODE_NONE &&
303 strtolower($this->ctrl->getCmdClass()) == "ilobjrolegui") {
304 $this->ctrl->setParameterByClass(
305 "ilobjrolegui",
306 "rolf_ref_id",
307 $this->request_wrapper->has("rolf_ref_id")
308 ? $this->request_wrapper->retrieve("rolf_ref_id", $this->refinery->kindlyTo()->string())
309 : null
310 );
311 $this->ctrl->setParameterByClass(
312 "ilobjrolegui",
313 "obj_id",
314 $this->request_wrapper->retrieve("obj_id", $this->refinery->kindlyTo()->string())
315 );
316 $this->locator->addItem(
317 $this->lng->txt("role"),
318 $this->ctrl->getLinkTargetByClass(array("ilpermissiongui",
319 "ilobjrolegui"), "perm")
320 );
321 }
322
323 // in workspace this is done in ilPersonalWorkspaceGUI
324 if ($this->object_id) {
325 $this->addLocatorItems();
326 }
327 $this->tpl->setLocator();
328
329 break;
330
332 // :TODO:
333 break;
334 }
335 }
addLocatorItems()
Functions to be overwritten.

References $parent_id, ilObjectGUI\$ref_id, addLocatorItems(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\locator(), REPOSITORY_NODE_ID, and WORKSPACE_NODE_ID.

Referenced by ilObjMediaPoolGUI\executeCommand(), and ilObjectPluginGUI\executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setReturnLocation()

ilObject2GUI::setReturnLocation ( string  $cmd,
string  $location 
)
finalprotected

set specific return location for command

Reimplemented from ilObjectGUI.

Definition at line 588 of file class.ilObject2GUI.php.

588 : void
589 {
590 die("ilObject2GUI::setReturnLocation() is deprecated.");
591 }

◆ setTabs()

ilObject2GUI::setTabs ( )
protected

create tabs (repository/workspace switch)

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

Reimplemented from ilObjectGUI.

Reimplemented in ilObjBlogGUI, ilObjCmiXapiGUI, ilObjContentPageGUI, ilObjDataCollectionGUI, ilObjFileGUI, ilObjItemGroupGUI, ilObjLTIConsumerGUI, ilObjMediaPoolGUI, ilObjPollGUI, ilObjPortfolioGUI, ilObjPortfolioTemplateGUI, ilObjLinkResourceGUI, and ilRemoteObjectBaseGUI.

Definition at line 546 of file class.ilObject2GUI.php.

546 : void
547 {
548 switch ($this->id_type) {
551 if ($this->checkPermissionBool("edit_permission")) {
552 $this->tabs_gui->addTab(
553 "id_permissions",
554 $this->lng->txt("perm_settings"),
555 $this->ctrl->getLinkTargetByClass(array(get_class($this), "ilpermissiongui"), "perm")
556 );
557 }
558 break;
559
562 // only files and blogs can be shared for now
563 if (
564 $this->checkPermissionBool("edit_permission") &&
565 in_array($this->type, array("file", "blog")) &&
566 $this->node_id
567 ) {
568 $this->tabs_gui->addTab(
569 "id_permissions",
570 $this->lng->txt("wsp_permissions"),
571 $this->ctrl->getLinkTargetByClass(array(get_class($this), "ilworkspaceaccessgui"), "share")
572 );
573 }
574 break;
575 }
576 }
checkPermissionBool(string $perm, string $cmd="", string $type="", ?int $node_id=null)

References ILIAS\Repository\lng().

Referenced by ilObjectPluginGUI\executeCommand(), and ilObjPortfolioTemplateGUI\setTabs().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setTargetFrame()

ilObject2GUI::setTargetFrame ( string  $cmd,
string  $target_frame 
)
finalprotected

Set specific target frame for command.

Reimplemented from ilObjectGUI.

Definition at line 466 of file class.ilObject2GUI.php.

466 : void
467 {
468 parent::setTargetFrame($cmd, $target_frame);
469 }

References ilObjectGUI\$target_frame.

◆ setTitleAndDescription()

ilObject2GUI::setTitleAndDescription ( )
protected

Reimplemented from ilObjectGUI.

Reimplemented in ilObjContentPageGUI, ilObjPortfolioGUI, ilObjWorkspaceRootFolderGUI, and ilObjFileServicesGUI.

Definition at line 454 of file class.ilObject2GUI.php.

454 : void
455 {
456 parent::setTitleAndDescription();
457 }

◆ showActions()

ilObject2GUI::showActions ( )
finalprotected

Definition at line 592 of file class.ilObject2GUI.php.

592 : void
593 {
594 die("ilObject2GUI::showActions() is deprecated.");
595 }

◆ showPossibleSubObjects()

ilObject2GUI::showPossibleSubObjects ( )
finalprotected

show possible sub objects (pull down menu)

Reimplemented from ilObjectGUI.

Definition at line 494 of file class.ilObject2GUI.php.

494 : void
495 {
496 parent::showPossibleSubObjects();
497 }

◆ update()

ilObject2GUI::update ( )

Reimplemented in ilObjFileGUI, and ilObjWorkspaceFolderGUI.

Definition at line 628 of file class.ilObject2GUI.php.

628 : void
629 {
630 parent::updateObject();
631 }

◆ view()

ilObject2GUI::view ( )

view object content (repository/workspace switch)

Reimplemented in ilObjBibliographicGUI, ilObjContentPageGUI, ilObjPortfolioBaseGUI, and ilObjLinkResourceGUI.

Definition at line 521 of file class.ilObject2GUI.php.

521 : void
522 {
523 switch ($this->id_type) {
526 parent::viewObject();
527 break;
528
531 $this->render();
532
533 // no break
534 case self::OBJECT_ID:
536 // :TODO: should this ever occur? do nothing or edit() ?!
537 break;
538 }
539 }

◆ withReferences()

ilObject2GUI::withReferences ( )
final

Final/Private declaration of unchanged parent methods.

Reimplemented from ilObjectGUI.

Definition at line 438 of file class.ilObject2GUI.php.

438 : bool
439 {
440 return parent::withReferences();
441 }

Field Documentation

◆ $access

◆ $access_handler

◆ $creation_forms

array ilObject2GUI::$creation_forms = array()
protected

Definition at line 79 of file class.ilObject2GUI.php.

◆ $ctrl

◆ $error

ilErrorHandling ilObject2GUI::$error
protected

◆ $favourites

ilFavouritesManager ilObject2GUI::$favourites
protected

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

◆ $html

string ilObject2GUI::$html
protected

Definition at line 75 of file class.ilObject2GUI.php.

Referenced by ilObjBibliographicGUI\showContent().

◆ $id_type

◆ $lng

ilLanguage ilObject2GUI::$lng
protected

Definition at line 55 of file class.ilObject2GUI.php.

Referenced by ilObjTaxonomyGUI\__construct(), ilObjBlogGUI\__construct(), ilObjectPluginGUI\_goto(), ilObjCmiXapiGUI\_goto(), ilObjItemGroupGUI\_goto(), ilRemoteObjectBaseGUI\_goto(), ilObjHelpSettingsGUI\activateModule(), ilObjWorkspaceFolderGUI\addContentSubTabs(), ilObjItemGroupGUI\afterConstructor(), ilObjMediaPoolGUI\afterConstructor(), ilObjWorkspaceFolderGUI\checkPassword(), ilObjHelpSettingsGUI\confirmHelpModulesDeletion(), ilObjMediaPoolGUI\confirmRemove(), ilObjHelpSettingsGUI\deactivateModule(), ilObjWorkspaceFolderGUI\deleteConfirmation(), ilObjHelpSettingsGUI\editSettings(), ilObjMediaPoolGUI\executeCommand(), ilObjWikiSettingsGUI\executeCommand(), ilObjHelpSettingsGUI\executeCommand(), ilObjectPluginGUI\executeCommand(), ilObjectPluginGUI\infoScreen(), ilObjectPluginGUI\initEditForm(), ilObjMediaPoolGUI\initFolderForm(), ilObjWikiSettingsGUI\initForm(), ilObjWorkspaceFolderGUI\initPasswordForm(), ilObjMediaPoolGUI\listMedia(), ilObjWorkspaceFolderGUI\passwordForm(), ilObjCmiXapiVerificationGUI\render(), ilObjCourseVerificationGUI\render(), ilObjSCORMVerificationGUI\render(), ilObjTestVerificationGUI\render(), ilObjMediaPoolGUI\saveFolder(), ilObjWikiSettingsGUI\saveSettings(), ilObjHelpSettingsGUI\setMode(), ilObjItemGroupGUI\setTabs(), ilObjWorkspaceFolderGUI\setTabs(), ilObjWorkspaceRootFolderGUI\setTitleAndDescription(), ilObjWorkspaceFolderGUI\showAdministrationPanel(), ilObjMediaPoolGUI\updateFolder(), and ilObjHelpSettingsGUI\uploadHelpFile().

◆ $locator

◆ $node_id

◆ $obj_definition

ilObjectDefinition ilObject2GUI::$obj_definition
protected

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

◆ $object_id

int ilObject2GUI::$object_id
protected

Definition at line 77 of file class.ilObject2GUI.php.

Referenced by __construct().

◆ $object_service

◆ $parent_id

◆ $post_wrapper

ArrayBasedRequestWrapper ilObject2GUI::$post_wrapper
protected

Definition at line 64 of file class.ilObject2GUI.php.

◆ $rbac_admin

ilRbacAdmin ilObject2GUI::$rbac_admin
protected

Definition at line 67 of file class.ilObject2GUI.php.

◆ $rbac_review

ilRbacReview ilObject2GUI::$rbac_review
protected

Definition at line 69 of file class.ilObject2GUI.php.

◆ $rbac_system

ilRbacSystem ilObject2GUI::$rbac_system
protected

Definition at line 68 of file class.ilObject2GUI.php.

◆ $refinery

Factory ilObject2GUI::$refinery
protected

Definition at line 66 of file class.ilObject2GUI.php.

◆ $request_ref_id

int ilObject2GUI::$request_ref_id
protected

Definition at line 71 of file class.ilObject2GUI.php.

◆ $request_wrapper

RequestWrapper ilObject2GUI::$request_wrapper
protected

Definition at line 65 of file class.ilObject2GUI.php.

◆ $retriever

ilObjectRequestRetriever ilObject2GUI::$retriever
private

Definition at line 84 of file class.ilObject2GUI.php.

◆ $tabs_gui

ilTabsGUI ilObject2GUI::$tabs_gui
protected

◆ $toolbar

◆ $tpl

◆ $type

◆ $user

◆ OBJECT_ID

const ilObject2GUI::OBJECT_ID = 0

◆ PORTFOLIO_OBJECT_ID

const ilObject2GUI::PORTFOLIO_OBJECT_ID = 5

Definition at line 50 of file class.ilObject2GUI.php.

Referenced by __construct(), assignObject(), confirmedDelete(), and delete().

◆ REPOSITORY_NODE_ID

◆ REPOSITORY_OBJECT_ID

const ilObject2GUI::REPOSITORY_OBJECT_ID = 3

Definition at line 48 of file class.ilObject2GUI.php.

Referenced by __construct(), assignObject(), confirmedDelete(), and delete().

◆ WORKSPACE_NODE_ID

◆ WORKSPACE_OBJECT_ID


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