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

Protected Attributes

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 
)

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

References $access, $DIC, ilObjectGUI\$id, $id_type, $ilUser, $object_id, $params, $refinery, ilObjectGUI\$tree, ilObject\_lookupObjectId(), ILIAS\Repository\access(), afterConstructor(), assignObject(), ILIAS\Repository\ctrl(), getType(), ILIAS\Repository\html(), ILIAS\Repository\lng(), ILIAS\Repository\locator(), ilWorkspaceTree\lookupObjectId(), ILIAS\Repository\object(), ILIAS\Repository\refinery(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

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) {
137  case self::REPOSITORY_NODE_ID:
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 
146  case self::REPOSITORY_OBJECT_ID:
147  $this->object_id = $id;
148  $this->tree = $tree;
149  $this->access_handler = $this->access;
150  $params[] = "obj_id"; // ???
151  break;
152 
153  case self::WORKSPACE_NODE_ID:
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 
162  case self::WORKSPACE_OBJECT_ID:
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 
170  case self::PORTFOLIO_OBJECT_ID:
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  }
if(! $DIC->user() ->getId()||!ilLTIConsumerAccess::hasCustomProviderCreationAccess()) $params
Definition: ltiregstart.php:33
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...
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
getType()
Functions that must be overwritten.
static _lookupObjectId(int $ref_id)
Base class for all sub item list gui's.
lookupObjectId(int $a_node_id)
Get object id for node id.
Access handler for portfolio NOTE: This file needs to stay in the classes directory, WAC will be confused otherwise.
$ilUser
Definition: imgupload.php:34
afterConstructor()
Do anything that should be done after constructor in here.
assignObject()
create object instance as internal property (repository/workspace switch)
ilAccessHandler $access
+ Here is the call graph for this function:

Member Function Documentation

◆ addAdminLocatorItems()

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

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

Referenced by ilObjectPluginGUI\executeCommand().

513  : void
514  {
515  parent::addAdminLocatorItems($do_not_add_object);
516  }
+ Here is the caller graph for this function:

◆ addLocatorItems()

ilObject2GUI::addLocatorItems ( )
protected

Functions to be overwritten.

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

References getType().

Referenced by setLocator().

604  : void
605  {
606  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ afterConstructor()

ilObject2GUI::afterConstructor ( )
protected

Do anything that should be done after constructor in here.

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

Referenced by __construct().

212  : void
213  {
214  }
+ Here is the caller graph for this function:

◆ assignObject()

ilObject2GUI::assignObject ( )
finalprotected

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

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

References ilObjectFactory\getInstanceByObjId(), and ilObjectFactory\getInstanceByRefId().

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

256  : void
257  {
258  if ($this->object_id != 0) {
259  switch ($this->id_type) {
260  case self::OBJECT_ID:
261  case self::REPOSITORY_OBJECT_ID:
262  case self::WORKSPACE_OBJECT_ID:
263  case self::PORTFOLIO_OBJECT_ID:
264  $this->object = ilObjectFactory::getInstanceByObjId($this->object_id);
265  break;
266 
267  case self::REPOSITORY_NODE_ID:
268  $this->object = ilObjectFactory::getInstanceByRefId($this->node_id);
269  break;
270 
271  case self::WORKSPACE_NODE_ID:
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
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cancel()

ilObject2GUI::cancel ( )

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.

References ilObjectGUI\$ref_id.

Referenced by ilObjHelpSettingsGUI\activateModule(), ilObjLinkResourceGUI\addLink(), ilObjMediaPoolGUI\allMedia(), ilObjMediaPoolGUI\bulkUpload(), ilObjLinkResourceGUI\confirmDeleteLink(), ilObjHelpSettingsGUI\confirmHelpModulesDeletion(), ilObjMediaPoolGUI\confirmRemove(), ilObjMediaPoolGUI\copyToClipboard(), ilObjMediaPoolGUI\createFolderForm(), ilObjMediaPoolGUI\createMediaFromUploadDir(), ilObjLinkResourceGUI\deactivateLink(), ilObjHelpSettingsGUI\deactivateModule(), ilObjHelpSettingsGUI\deleteHelpModules(), ilObjLinkResourceGUI\deleteLinks(), ilObjLinkResourceGUI\deleteParameter(), ilObjLinkResourceGUI\deleteParameterForm(), ilObjMediaPoolGUI\editFolder(), ilObjLinkResourceGUI\editLink(), ilObjMediaPoolGUI\editTitlesAndDescriptions(), ilObjPortfolioTemplateGUI\executeCommand(), ilObjectPluginGUI\executeCommand(), ilObjPortfolioGUI\executeCommand(), ilObjLinkResourceGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilObjBlogGUI\executeCommand(), ilObjLinkResourceGUI\history(), ilObjectPluginGUI\infoScreen(), ilObjPortfolioTemplateGUI\infoScreenForward(), ilObjDataCollectionGUI\infoScreenForward(), ilObjBlogGUI\infoScreenForward(), ilObjLinkResourceGUI\infoScreenForward(), ilObjMediaPoolGUI\insertFromClipboard(), ilObjItemGroupGUI\listMaterials(), ilObjMediaPoolGUI\listMedia(), ilObjLinkResourceGUI\manage(), ilObjMediaPoolGUI\openClipboard(), ilObjMediaPoolGUI\performBulkUpload(), ilObjMediaPoolGUI\remove(), ilObjLinkResourceGUI\saveAddLink(), ilObjContactAdministrationGUI\saveConfigurationForm(), ilObjMediaPoolGUI\saveFolder(), ilObjItemGroupGUI\saveItemAssignment(), ilObjLinkResourceGUI\saveLinkList(), ilObjLinkResourceGUI\saveSettings(), ilObjLinkResourceGUI\saveSorting(), ilObjMediaPoolGUI\saveTitlesAndDescriptions(), ilObjMediaPoolGUI\selectUploadDirFiles(), ilObjHelpSettingsGUI\setMode(), ilObjContentPageGUI\setTabs(), ilObjLinkResourceGUI\settings(), ilObjLinkResourceGUI\showLinks(), ilObjMediaPoolGUI\showMedia(), ilObjMediaPoolGUI\showPreview(), ilObjLinkResourceGUI\sort(), ilObjMediaPoolGUI\updateFolder(), ilObjLinkResourceGUI\updateLink(), ilObjLinkResourceGUI\updateLinks(), ilObjContentPageGUI\view(), and ilObjLinkResourceGUI\view().

491  : void {
492  parent::checkPermission($perm, $cmd, $type, $ref_id);
493  }
+ Here is the caller graph for this function:

◆ checkPermissionBool()

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

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

References $node_id, $parent_id, getAccessHandler(), ILIAS\Repository\object(), and ILIAS\Repository\user().

Referenced by ilObjLinkResourceGUI\activateTabs(), ilObjWorkspaceFolderGUI\addContentSubTabs(), ilObjBlogGUI\addContributor(), ilObjContentPageGUI\addToNavigationHistory(), ilObjPollGUI\confirmDeleteAllVotes(), ilObjBlogGUI\contributors(), ilObjWorkspaceFolderGUI\cut(), ilObjBlogGUI\deactivateAdmin(), ilObjPollGUI\deleteAllVotes(), ilObjWorkspaceFolderGUI\deleteConfirmation(), ilObjPortfolioBaseGUI\deletePortfolioPages(), ilObjPortfolioBaseGUI\determinePageCall(), ilObjFileGUI\edit(), ilObjMediaPoolGUI\edit(), ilRemoteObjectBaseGUI\editObject(), ilObjBibliographicGUI\editObject(), ilObjHelpSettingsGUI\editSettings(), ilRemoteObjectBaseGUI\executeCommand(), ilObjItemGroupGUI\executeCommand(), ilObjDataCollectionGUI\executeCommand(), ilObjBlogGUI\executeCommand(), ilObjContactAdministrationGUI\getAdminTabs(), ilObjHelpSettingsGUI\getAdminTabs(), ilObjWikiSettingsGUI\getAdminTabs(), ilObjPDFGenerationGUI\getAdminTabs(), ilObjContactAdministrationGUI\getConfigurationForm(), ilObjContentPageGUI\getContent(), ilObjFileGUI\getParentId(), ilObjPDFGenerationGUI\handleSaveAndConf(), ilObjPDFGenerationGUI\hasWritePermission(), ilObjPortfolioTemplateGUI\infoScreenForward(), ilObjDataCollectionGUI\infoScreenForward(), ilObjContentPageGUI\infoScreenForward(), ilObjFileGUI\infoScreenForward(), ilObjCmiXapiGUI\infoScreenForward(), ilObjBlogGUI\infoScreenForward(), ilObjLTIConsumerGUI\infoScreenForward(), ilObjLinkResourceGUI\infoScreenForward(), ilObjWikiSettingsGUI\initForm(), ilObjBlogGUI\isAdmin(), ilObjBlogGUI\mayContribute(), ilObjBlogGUI\mayEditPosting(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), ilObjContentPageGUI\populateContentToolbar(), ilObjPortfolioTemplateGUI\preview(), ilObjBlogGUI\preview(), ilObjPollGUI\render(), ilObjBlogGUI\render(), ilObjContentPageGUI\renderHeaderActions(), ilObjPortfolioTemplateGUI\saveBlog(), ilObjPortfolioBaseGUI\savePage(), ilObjPortfolioBaseGUI\savePortfolioPagesOrdering(), ilObjWikiSettingsGUI\saveSettings(), ilObjFileGUI\sendFile(), ilObjHelpSettingsGUI\setMode(), ilObjContentPageGUI\setSettingsSubTabs(), ilRemoteObjectBaseGUI\setTabs(), ilObjContentPageGUI\setTabs(), ilObjPortfolioTemplateGUI\setTabs(), ilObjPollGUI\setTabs(), ilObjBlogGUI\setTabs(), setTabs(), ilObjFileGUI\setTabs(), ilObjLinkResourceGUI\setTabs(), ilObjPortfolioBaseGUI\showEditButton(), ilObjPollGUI\showParticipants(), ilObjPollGUI\showParticipantVotes(), ilObjLinkResourceGUI\showToolbar(), ilRemoteObjectBaseGUI\updateObject(), ilObjHelpSettingsGUI\uploadHelpFile(), and ilObjPortfolioBaseGUI\view().

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  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ confirmedDelete()

ilObject2GUI::confirmedDelete ( )

Delete objects (repository/workspace switch)

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

References deleteConfirmedObjects().

363  : void
364  {
365  switch ($this->id_type) {
366  case self::REPOSITORY_NODE_ID:
367  case self::REPOSITORY_OBJECT_ID:
368  parent::confirmedDeleteObject();
369 
370  // no break
371  case self::WORKSPACE_NODE_ID:
372  case self::WORKSPACE_OBJECT_ID:
373  $this->deleteConfirmedObjects();
374 
375  // no break
376  case self::OBJECT_ID:
377  case self::PORTFOLIO_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...
+ Here is the call graph for this function:

◆ create()

ilObject2GUI::create ( )

CRUD.

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

Referenced by ilObjTaxonomyGUI\createAssignedTaxonomy().

616  : void
617  {
618  parent::createObject();
619  }
+ Here is the caller graph for this function:

◆ 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) {
343  case self::REPOSITORY_NODE_ID:
344  case self::REPOSITORY_OBJECT_ID:
345  parent::deleteObject();
346 
347  // no break
348  case self::WORKSPACE_NODE_ID:
349  case self::WORKSPACE_OBJECT_ID:
350  $this->deleteConfirmation();
351 
352  // no break
353  case self::OBJECT_ID:
354  case self::PORTFOLIO_OBJECT_ID:
355  // :TODO: should this ever occur?
356  break;
357  }
358  }

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

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

Referenced by confirmedDelete().

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...
static getInstanceByObjId(?int $obj_id, bool $stop_on_error=true)
get an instance of an Ilias object by object id
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ edit()

ilObject2GUI::edit ( )

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

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

◆ executeCommand()

ilObject2GUI::executeCommand ( )

execute command

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

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

Referenced by ilObjCmiXapiGUI\_goto(), ilObjLTIConsumerGUI\_goto(), ilObjPortfolioTemplateGUI\executeCommand(), ilObjFileGUI\getParentId(), ilObjTermsOfServiceGUI\getType(), and ilObjContentPageGUI\setTabs().

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)
ACL access handler GUI.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillCloneTemplate()

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

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

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

507  {
508  return parent::fillCloneTemplate($tpl_varname, $type);
509  }
+ Here is the caller graph for this function:

◆ getAccessHandler()

◆ getCenterColumnHTML()

ilObject2GUI::getCenterColumnHTML ( )
finalprotected

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

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

◆ getCreationMode()

◆ getHTML()

ilObject2GUI::getHTML ( )

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.

References $id_type.

Referenced by ilObjFileAbstractZipProcessor\__construct().

248  : int
249  {
250  return $this->id_type;
251  }
+ 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.

References getType().

Referenced by ilObjFileGUI\infoScreenForward(), ilObjBlogGUI\infoScreenForward(), and ilObjLinkResourceGUI\infoScreenForward().

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...
getType()
Functions that must be overwritten.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getReturnLocation()

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

Deprecated functions.

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

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

◆ getRightColumnHTML()

ilObject2GUI::getRightColumnHTML ( )
finalprotected

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

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

◆ getTabs()

ilObject2GUI::getTabs ( )
finalprotected

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  $target_frame = "" 
)
finalprotected

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

References ilObjectGUI\$target_frame.

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

◆ getType()

◆ handleAfterSaveCallback()

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

After creation callback.

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

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

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  }
global $DIC
Definition: feed.php:28
static _lookupType(int $id, bool $reference=false)
+ 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
[]

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.

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

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

770  : ?ilObjectListGUI
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  }
static prepareJsLinks(string $redraw_url, string $notes_url, string $tags_url, ilGlobalTemplateInterface $tpl=null)
Insert js/ajax links into template.
getType()
Functions that must be overwritten.
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...
+ Here is the call graph for this function:

◆ isVisible()

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

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

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

◆ omitLocator()

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

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.

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

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

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

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) {
676  case self::REPOSITORY_NODE_ID:
677  case self::REPOSITORY_OBJECT_ID:
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 
693  case self::WORKSPACE_NODE_ID:
694  case self::WORKSPACE_OBJECT_ID:
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:
704  case self::PORTFOLIO_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 gatherFaPa(int $a_ref_id, array $a_role_ids, bool $a_add_action=false)
setPermissions(int $parent_ref_id)
createReference()
creates reference for object
const CREATE_OBJECT
static add(int $a_action, int $a_ref_id, array $a_diff, bool $a_source_ref_id=false)
static _recordWriteEvent(int $obj_id, int $usr_id, string $action, ?int $parent_obj_id=null)
Records a write event.
putInTree(int $parent_ref_id)
maybe this method should be in tree object!?
+ 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

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

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

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

ilObject2GUI::save ( )

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

Referenced by ilObjLTIConsumerGUI\checkContentSelection().

620  : void
621  {
622  parent::saveObject();
623  }
+ Here is the caller graph for this function:

◆ setColumnSettings()

ilObject2GUI::setColumnSettings ( ilColumnGUI  $column_gui)
final

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

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

Referenced by ilObjMediaPoolGUI\executeCommand().

442  : void
443  {
444  parent::setCreationMode($mode);
445  }
+ Here is the caller graph for this function:

◆ setLocator()

ilObject2GUI::setLocator ( )
protected

set Locator

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

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

Referenced by ilObjectPluginGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilObjBlogGUI\executeCommand(), and ilObjContentPageGUI\setTabs().

290  : void
291  {
292  if ($this->omit_locator) {
293  return;
294  }
295 
296  switch ($this->id_type) {
297  case self::REPOSITORY_NODE_ID:
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 
331  case self::WORKSPACE_NODE_ID:
332  // :TODO:
333  break;
334  }
335  }
addLocatorItems()
Functions to be overwritten.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setReturnLocation()

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

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

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

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

Referenced by ilObjBibliographicGUI\afterSave(), ilObjTaxonomyGUI\createTaxNode(), ilObjTaxonomyGUI\deleteItems(), ilObjTaxonomyGUI\editSettings(), ilObjectPluginGUI\executeCommand(), ilObjTaxonomyGUI\listAssignedItems(), ilObjTaxonomyGUI\listNodes(), ilObjTaxonomyGUI\moveItems(), and ilObjPortfolioTemplateGUI\setTabs().

546  : void
547  {
548  switch ($this->id_type) {
549  case self::REPOSITORY_NODE_ID:
550  case self::REPOSITORY_OBJECT_ID:
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 
560  case self::WORKSPACE_NODE_ID:
561  case self::WORKSPACE_OBJECT_ID:
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")) &&
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)
+ 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

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

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

◆ setTitleAndDescription()

ilObject2GUI::setTitleAndDescription ( )
protected

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

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

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

◆ update()

ilObject2GUI::update ( )

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)

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

521  : void
522  {
523  switch ($this->id_type) {
524  case self::REPOSITORY_NODE_ID:
525  case self::REPOSITORY_OBJECT_ID:
526  parent::viewObject();
527  break;
528 
529  case self::WORKSPACE_NODE_ID:
530  case self::WORKSPACE_OBJECT_ID:
531  $this->render();
532 
533  // no break
534  case self::OBJECT_ID:
535  case self::PORTFOLIO_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.

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

ilCtrl ilObject2GUI::$ctrl
protected

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

Referenced by ilObjCmiXapiVerificationGUI\_goto(), ilObjLTIConsumerVerificationGUI\_goto(), ilObjCourseVerificationGUI\_goto(), ilObjCmiXapiGUI\_goto(), ilObjLTIConsumerGUI\_goto(), ilObjWorkspaceFolderGUI\_goto(), ilObjPortfolioGUI\_goto(), ilObjMediaPoolGUI\_goto(), ilObjLinkResourceGUI\_goto(), ilObjHelpSettingsGUI\activateModule(), ilObjWorkspaceFolderGUI\addContentSubTabs(), ilObjBlogGUI\addContributor(), ilObjBlogGUI\addHeaderActionForCommand(), ilObjectPluginGUI\addPermissionTab(), ilObjItemGroupGUI\afterSave(), ilObjBlogGUI\afterSave(), ilObjTaxonomyGUI\afterSave(), ilObjectPluginGUI\afterSave(), ilObjMediaPoolGUI\allMedia(), ilObjTaxonomyGUI\cancel(), ilObjMediaPoolGUI\cancelFolderUpdate(), ilObjMediaPoolGUI\cancelSave(), ilObjTaxonomyGUI\confirmDeleteTaxonomy(), ilObjTaxonomyGUI\confirmedDelete(), ilObjHelpSettingsGUI\confirmHelpModulesDeletion(), ilObjMediaPoolGUI\confirmRemove(), ilObjBlogGUI\contributors(), ilObjPortfolioTemplateGUI\createFromTemplate(), ilObjBlogGUI\createPosting(), ilObjHelpSettingsGUI\deactivateModule(), ilObjHelpSettingsGUI\deleteHelpModules(), ilObjTaxonomyGUI\deleteItems(), ilObjTaxonomyGUI\deleteTaxonomy(), ilObjExerciseVerificationGUI\downloadFromPortfolioPage(), ilObjHelpSettingsGUI\editSettings(), ilObjMediaPoolGUI\editTitlesAndDescriptions(), ilObjectPluginGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilObjTaxonomyGUI\executeCommand(), ilObjBlogGUI\executeCommand(), ilObjBlogGUI\getHTML(), ilObjPortfolioGUI\getOfflineMessage(), ilObjectPluginGUI\infoScreen(), ilObjectPluginGUI\initEditForm(), ilObjMediaPoolGUI\initFolderForm(), ilObjWikiSettingsGUI\initForm(), ilObjBlogGUI\initHeaderAction(), ilObjWorkspaceFolderGUI\initPasswordForm(), ilObjTaxonomyGUI\initSettingsForm(), ilObjTaxonomyGUI\initTaxNodeForm(), ilObjMediaPoolGUI\listMedia(), ilObjTaxonomyGUI\listNodes(), ilObjTaxonomyGUI\listTaxonomies(), ilObjTaxonomyGUI\moveItems(), ilObjMediaPoolGUI\openClipboard(), ilObjTaxonomyGUI\pasteItems(), ilObjBlogGUI\removeContributor(), ilObjWorkspaceFolderGUI\render(), ilObjBlogGUI\render(), ilObjBlogGUI\renderList(), ilObjBlogGUI\renderNavigationByAuthors(), ilObjBlogGUI\renderNavigationByDate(), ilObjBlogGUI\renderNavigationByKeywords(), ilObjBlogGUI\renderToolbarNavigation(), ilObjMediaPoolGUI\returnFromItem(), ilObjTaxonomyGUI\saveAssignedItemsSorting(), ilObjMediaPoolGUI\saveFolder(), ilObjItemGroupGUI\saveItemAssignment(), ilObjWikiSettingsGUI\saveSettings(), ilObjTaxonomyGUI\saveSorting(), ilObjTaxonomyGUI\saveTaxNode(), ilObjMediaPoolGUI\saveTitlesAndDescriptions(), ilObjMediaPoolGUI\selectUploadDirFiles(), ilObjMediaPoolGUI\setContentSubTabs(), ilObjHelpSettingsGUI\setMode(), ilObjBlogGUI\setNotification(), ilObjPortfolioGUI\setOnlineAndShare(), ilObjTaxonomyGUI\setTabs(), ilObjTaxonomyGUI\showTree(), ilObjMediaPoolGUI\updateFolder(), ilObjTaxonomyGUI\updateSettings(), ilObjTaxonomyGUI\updateTaxNode(), and ilObjHelpSettingsGUI\uploadHelpFile().

◆ $error

◆ $favourites

ilFavouritesManager ilObject2GUI::$favourites
protected

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

◆ $html

string ilObject2GUI::$html
protected

◆ $id_type

◆ $lng

ilLanguage ilObject2GUI::$lng
protected

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

Referenced by ilObjTaxonomyGUI\__construct(), ilObjBlogGUI\__construct(), ilObjItemGroupGUI\_goto(), ilObjCmiXapiGUI\_goto(), ilRemoteObjectBaseGUI\_goto(), ilObjectPluginGUI\_goto(), ilObjLTIConsumerGUI\_goto(), ilObjMediaPoolGUI\_goto(), ilObjLinkResourceGUI\_goto(), ilObjHelpSettingsGUI\activateModule(), ilObjWorkspaceFolderGUI\addContentSubTabs(), ilObjBlogGUI\addContributor(), ilObjBlogGUI\addUserFromAutoComplete(), ilObjItemGroupGUI\afterConstructor(), ilObjMediaPoolGUI\afterConstructor(), ilObjTaxonomyGUI\afterSave(), ilObjWorkspaceFolderGUI\checkPassword(), ilObjTaxonomyGUI\confirmDeleteTaxonomy(), ilObjHelpSettingsGUI\confirmHelpModulesDeletion(), ilObjMediaPoolGUI\confirmRemove(), ilObjBlogGUI\contributors(), ilObjHelpSettingsGUI\deactivateModule(), ilObjWorkspaceFolderGUI\deleteConfirmation(), ilObjTaxonomyGUI\deleteItems(), ilObjTaxonomyGUI\deleteTaxonomy(), ilObjHelpSettingsGUI\editSettings(), ilObjMediaPoolGUI\editTitlesAndDescriptions(), ilObjWikiSettingsGUI\executeCommand(), ilObjHelpSettingsGUI\executeCommand(), ilObjectPluginGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilObjBlogGUI\executeCommand(), ilObjBlogGUI\getHTML(), ilObjPortfolioGUI\getOfflineMessage(), ilObjMediaPoolGUI\getPreviewModalHTML(), ilObjectPluginGUI\infoScreen(), ilObjBlogGUI\initEditCustomForm(), ilObjectPluginGUI\initEditForm(), ilObjMediaPoolGUI\initFolderForm(), ilObjWikiSettingsGUI\initForm(), ilObjMediaPoolGUI\initMediaBulkForm(), ilObjWorkspaceFolderGUI\initPasswordForm(), ilObjTaxonomyGUI\initSettingsForm(), ilObjTaxonomyGUI\initTaxNodeForm(), ilObjMediaPoolGUI\listMedia(), ilObjTaxonomyGUI\listNodes(), ilObjTaxonomyGUI\listTaxonomies(), ilObjTaxonomyGUI\moveItems(), ilObjWorkspaceFolderGUI\passwordForm(), ilObjTaxonomyGUI\pasteItems(), ilObjBlogGUI\preview(), ilObjBlogGUI\removeContributor(), ilObjExerciseVerificationGUI\render(), ilObjSCORMVerificationGUI\render(), ilObjTestVerificationGUI\render(), ilObjCmiXapiVerificationGUI\render(), ilObjCourseVerificationGUI\render(), ilObjBlogGUI\render(), ilObjBlogGUI\renderList(), ilObjBlogGUI\renderToolbarNavigation(), ilObjTaxonomyGUI\saveAssignedItemsSorting(), ilObjMediaPoolGUI\saveFolder(), ilObjWikiSettingsGUI\saveSettings(), ilObjTaxonomyGUI\saveSorting(), ilObjTaxonomyGUI\saveTaxNode(), ilObjMediaPoolGUI\saveTitlesAndDescriptions(), ilObjMediaPoolGUI\selectUploadDirFiles(), ilObjHelpSettingsGUI\setMode(), ilObjPortfolioGUI\setOnlineAndShare(), ilObjMediaPoolGUI\setSettingsSubTabs(), ilObjWorkspaceFolderGUI\setTabs(), ilObjItemGroupGUI\setTabs(), ilObjBlogGUI\setTabs(), ilObjTaxonomyGUI\setTabs(), ilObjWorkspaceRootFolderGUI\setTitleAndDescription(), ilObjWorkspaceFolderGUI\showAdministrationPanel(), ilObjBlogGUI\updateCustom(), ilObjMediaPoolGUI\updateFolder(), ilObjTaxonomyGUI\updateSettings(), ilObjTaxonomyGUI\updateTaxNode(), ilObjHelpSettingsGUI\uploadHelpFile(), and ilObjPortfolioBaseGUI\view().

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

Referenced by ilObjBlogGUI\addContributor().

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

Referenced by __construct().

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

ilGlobalTemplateInterface ilObject2GUI::$tpl
protected

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

Referenced by ilObjFileGUI\addLegacyFormToAccordion(), ilObjFileGUI\addUIFormToAccordion(), ilObjMediaPoolGUI\allMedia(), ilObjTaxonomyGUI\confirmDeleteTaxonomy(), ilObjHelpSettingsGUI\confirmHelpModulesDeletion(), ilObjBlogGUI\contributors(), ilObjPortfolioGUI\create(), ilObjMediaPoolGUI\createFolderForm(), ilObjTaxonomyGUI\createTaxNode(), ilObjWorkspaceFolderGUI\deleteConfirmation(), ilObjTaxonomyGUI\deleteItems(), ilObjMediaPoolGUI\edit(), ilObjMediaPoolGUI\editFolder(), ilObjBibliographicGUI\editObject(), ilObjDataCollectionGUI\editObject(), ilObjWikiSettingsGUI\editSettings(), ilObjTaxonomyGUI\editSettings(), ilObjectPluginGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilObjBlogGUI\executeCommand(), ilObjLinkResourceGUI\exportHTML(), ilObjMediaPoolGUI\getPreviewModalHTML(), ilObjFileGUI\infoScreenForward(), ilObjTaxonomyGUI\listAssignedItems(), ilObjItemGroupGUI\listMaterials(), ilObjMediaPoolGUI\listMedia(), ilObjTaxonomyGUI\listNodes(), ilObjTaxonomyGUI\listTaxonomies(), ilObjTaxonomyGUI\moveItems(), ilObjWorkspaceFolderGUI\passwordForm(), ilObjWorkspaceFolderGUI\render(), ilObjBlogGUI\render(), ilObjBlogGUI\renderFullScreen(), ilObjMediaPoolGUI\saveFolder(), ilObjTaxonomyGUI\saveTaxNode(), ilObjMediaPoolGUI\selectUploadDirFiles(), ilObjPortfolioBaseGUI\setContentStyleSheet(), ilObjBlogGUI\setContentStyleSheet(), ilObjTaxonomyGUI\setTabs(), ilObjWorkspaceRootFolderGUI\setTitleAndDescription(), ilObjWorkspaceFolderGUI\share(), ilObjMediaPoolGUI\showPage(), ilObjMediaPoolGUI\updateFolder(), ilObjTaxonomyGUI\updateSettings(), and ilObjTaxonomyGUI\updateTaxNode().

◆ $type

◆ $user

◆ OBJECT_ID

const ilObject2GUI::OBJECT_ID = 0

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

Referenced by ilObjTaxonomyGUI\__construct().

◆ PORTFOLIO_OBJECT_ID

const ilObject2GUI::PORTFOLIO_OBJECT_ID = 5

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

◆ REPOSITORY_NODE_ID

◆ REPOSITORY_OBJECT_ID

const ilObject2GUI::REPOSITORY_OBJECT_ID = 3

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

◆ WORKSPACE_NODE_ID

◆ WORKSPACE_OBJECT_ID


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