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

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...
	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...
	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $node_id=null)
	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...
	redrawHeaderAction ()
	Updating icons after ajax call. More...
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	assignObject ()
	setTitleAndDescription ()
	createActionDispatcherGUI ()
	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...
	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	setTabs ()
	set admin tabs More...
	setAdminTabs ()
	set admin tabs More...
	setLocator ()
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator (bool $omit=true)
	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	getCreationFormsHTML (StandardForm|ilPropertyFormGUI|array $form)
	getTitleForCreationFormPage ()
	getCreationFormTitle ()
	initCreateForm (string $new_type)
	didacticTemplatesToForm ()
	initDidacticTemplate (ilPropertyFormGUI $form)
	retrieveAdditionalDidacticTemplateOptions ()
	addAdoptContentLinkToToolbar ()
	addImportButtonToToolbar ()
	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)
	parseDidacticTemplateVar (string $var, string $type)
	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...
	routeImportCmdObject ()
	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)
	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)
	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...
	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...
	getCreatableObjectTypes ()
	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)
	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Protected Attributes
ilObjectDefinition	$obj_definition
ilGlobalTemplateInterface	$tpl
ilCtrl	$ctrl
ilLanguage	$lng
ilTabsGUI	$tabs_gui
ilFavouritesManager	$favourites
ilErrorHandling	$error
ilLocatorGUI	$locator
ilObjUser	$user
ilAccessHandler	$access
ilToolbarGUI	$toolbar
Factory	$refinery
ilRbacAdmin	$rbac_admin
ilRbacSystem	$rbac_system
ilRbacReview	$rbac_review
int	$request_ref_id
int	$id_type
int	$parent_id
string	$type
string	$html
int	$object_id
int	$node_id = null
array	$creation_forms = []
	$access_handler
Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service
GlobalHttpState	$http
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
Refinery	$refinery
ilFavouritesManager	$favourites
CustomIconFactory	$custom_icon_factory
UIFactory	$ui_factory
UIRenderer	$ui_renderer
Filesystem	$temp_file_system
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, ilObjCmiXapiGUI, ilObjContactAdministrationGUI, ilObjContentPageGUI, ilObjCourseVerificationGUI, ilObjDataCollectionGUI, ilObjFileGUI, ilObjHelpSettingsGUI, ilObjLegalNoticeGUI, ilObjItemGroupGUI, ilObjLTIConsumerGUI, ilObjMediaPoolGUI, ilObjPollGUI, ilObjPortfolioBaseGUI, ilObjPortfolioTemplateGUI, ilObjTermsOfServiceGUI, ilObjWikiSettingsGUI, ilObjWorkspaceRootFolderGUI, ilOrgUnitExtensionGUI, and ilObjFileServicesGUI.

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

    {
        global $DIC;
 
        $this->obj_definition = $DIC["objDefinition"];
        $this->tpl = $DIC["tpl"];
        $this->ctrl = $DIC["ilCtrl"];
        $this->lng = $DIC["lng"];
        $this->tabs_gui = $DIC["ilTabs"];
        $this->object_service = $DIC->object();
        $this->favourites = new ilFavouritesManager();
        $this->error = $DIC['ilErr'];
        $this->locator = $DIC["ilLocator"];
        $this->user = $DIC->user();
        $this->access = $DIC->access();
        $this->toolbar = $DIC->toolbar();
        $this->http = $DIC['http'];
        $this->request = $this->http->request();
        $this->post_wrapper = $this->http->wrapper()->post();
        $this->request_wrapper = $this->http->wrapper()->query();
        $this->refinery = $DIC->refinery();
        $this->retriever = new ilObjectRequestRetriever($DIC->http()->wrapper(), $this->refinery);
        $this->rbac_admin = $DIC->rbac()->admin();
        $this->rbac_system = $DIC->rbac()->system();
        $this->rbac_review = $DIC->rbac()->review();
        $this->ui_factory = $DIC['ui.factory'];
        $this->ui_renderer = $DIC['ui.renderer'];
        $this->settings = $DIC['ilSetting'];
        $this->temp_file_system = $DIC->filesystem()->temp();
 
        $tree = $DIC["tree"];
 
        $this->requested_ref_id = 0;
        if ($this->request_wrapper->has("ref_id")) {
            $this->requested_ref_id = $this->request_wrapper->retrieve("ref_id", $this->refinery->kindlyTo()->int());
        }
        $this->id_type = $id_type;
        $this->parent_id = $parent_node_id;
        $this->type = $this->getType();
        $this->html = "";
        $this->notes_service = $DIC->notes();
 
        $this->requested_new_type = '';
        if ($this->request_wrapper->has("new_type")) {
            $this->requested_new_type = $this->request_wrapper->retrieve(
                "new_type",
                $this->refinery->kindlyTo()->string()
            );
        } elseif ($this->post_wrapper->has("new_type")) {
            $this->requested_new_type = $this->post_wrapper->retrieve(
                "new_type",
                $this->refinery->kindlyTo()->string()
            );
        }
 
        $params = [];
        switch ($this->id_type) {
            case self::REPOSITORY_NODE_ID:
                $this->node_id = $id;
                $this->object_id = ilObject::_lookupObjectId($this->node_id);
                $this->tree = $tree;
                $this->access_handler = $this->access;
                $this->call_by_reference = true;  // needed for prepareOutput()
                $params[] = "ref_id";
                break;
 
            case self::REPOSITORY_OBJECT_ID:
                $this->object_id = $id;
                $this->tree = $tree;
                $this->access_handler = $this->access;
                $params[] = "obj_id"; // ???
                break;
 
            case self::WORKSPACE_NODE_ID:
                $ilUser = $DIC["ilUser"];
                $this->node_id = $id;
                $this->tree = new ilWorkspaceTree($ilUser->getId());
                $this->object_id = $this->tree->lookupObjectId($this->node_id);
                $this->access_handler = new ilWorkspaceAccessHandler($this->tree);
                $params[] = "wsp_id";
                break;
 
            case self::WORKSPACE_OBJECT_ID:
                $ilUser = $DIC["ilUser"];
                $this->object_id = $id;
                $this->tree = new ilWorkspaceTree($ilUser->getId());
                $this->access_handler = new ilWorkspaceAccessHandler($this->tree);
                $params[] = "obj_id"; // ???
                break;
 
            case self::PORTFOLIO_OBJECT_ID:
                $this->object_id = $id;
                $this->access_handler = new ilPortfolioAccessHandler();
                $params[] = "prt_id";
                break;
 
            case self::OBJECT_ID:
                $this->object_id = $id;
                $this->access_handler = new ilDummyAccessHandler();
                $params[] = "obj_id";
                break;
        }
        $this->ctrl->saveParameter($this, $params);
 
 
 
        // old stuff for legacy code (obsolete?)
        if (!$this->object_id) {
            $this->creation_mode = true;
        }
        if ($this->node_id) {
            // add parent node id if missing
            if (!$this->parent_id && $this->tree) {
                $this->parent_id = $this->tree->getParentId($this->node_id);
            }
        }
        $this->ref_id = $this->node_id ?? 0;
        $this->obj_id = $this->object_id;
 
        $this->assignObject();
 
        // set context
        if (is_object($this->object)) {
            $this->ctrl->setContextObject($this->object->getId(), $this->object->getType());
        }
 
        $this->afterConstructor();
    }

References $access, $DIC, ilObjectGUI\$id, $id_type, $object_id, $params, ilObjectGUI\$tree, ilObject\_lookupObjectId(), ILIAS\Repository\access(), afterConstructor(), assignObject(), ILIAS\Repository\ctrl(), error(), getType(), ILIAS\Repository\html(), ILIAS\FileDelivery\http(), 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\settings(), 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 509 of file class.ilObject2GUI.php.

                                                                                  : void
    {
        parent::addAdminLocatorItems($do_not_add_object);
    }

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, ilObjectPluginGUI, and ilObjLinkResourceGUI.

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

                                        : void
    {
    }

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 215 of file class.ilObject2GUI.php.

                                         : void
    {
    }

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 259 of file class.ilObject2GUI.php.

                                           : void
    {
        if ($this->object_id != 0) {
            switch ($this->id_type) {
                case self::OBJECT_ID:
                case self::REPOSITORY_OBJECT_ID:
                case self::WORKSPACE_OBJECT_ID:
                case self::PORTFOLIO_OBJECT_ID:
                    $this->object = ilObjectFactory::getInstanceByObjId($this->object_id);
                    break;
 
                case self::REPOSITORY_NODE_ID:
                    $this->object = ilObjectFactory::getInstanceByRefId($this->node_id);
                    break;
 
                case self::WORKSPACE_NODE_ID:
                    // to be discussed
                    $this->object = ilObjectFactory::getInstanceByObjId($this->object_id);
                    break;
            }
        }
    }

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(), ilObjFooterAdministrationGUI\__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 628 of file class.ilObject2GUI.php.

                            : void
    {
        parent::cancelObject();
    }

checkPermission()

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

finalprotected

Reimplemented from ilObjectGUI.

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

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

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(), ilObjBlogGUI\executeCommand(), ilObjDataCollectionGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilObjPortfolioTemplateGUI\executeCommand(), ilObjectPluginGUI\executeCommand(), ilObjLinkResourceGUI\executeCommand(), ilObjectPluginGUI\infoScreen(), ilObjBlogGUI\infoScreenForward(), ilObjDataCollectionGUI\infoScreenForward(), ilObjPortfolioTemplateGUI\infoScreenForward(), ilObjMediaPoolGUI\insertFromClipboard(), ilObjItemGroupGUI\listMaterials(), ilObjMediaPoolGUI\listMedia(), ilObjMediaPoolGUI\openClipboard(), ilObjMediaPoolGUI\remove(), ilObjLinkResourceGUI\saveAddLink(), ilObjContactAdministrationGUI\saveConfigurationForm(), ilObjMediaPoolGUI\saveFolder(), ilObjItemGroupGUI\saveItemAssignment(), ilObjLinkResourceGUI\saveLinkList(), ilObjHelpSettingsGUI\saveOrdering(), ilObjHelpSettingsGUI\setMode(), ilObjLinkResourceGUI\settings(), ilObjMediaPoolGUI\showMedia(), ilObjMediaPoolGUI\showPreview(), ilObjMediaPoolGUI\updateFolder(), 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 712 of file class.ilObject2GUI.php.

     : bool {
        if ($perm == "create") {
            if (!$node_id) {
                $node_id = $this->parent_id;
            }
            if ($node_id) {
                return $this->getAccessHandler()->checkAccess($perm . "_" . $type, $cmd, $node_id);
            }
        } else {
            if (!$node_id) {
                $node_id = $this->node_id;
            }
            if ($node_id) {
                return $this->getAccessHandler()->checkAccess($perm, $cmd, $node_id);
            }
        }
 
        // if we do not have a node id, check if current user is owner
        if ($this->obj_id && $this->object->getOwner() == $this->user->getId()) {
            return true;
        }
        return false;
    }

Referenced by ilObjWorkspaceFolderGUI\addContentSubTabs(), ilObjContentPageGUI\addToNavigationHistory(), ilObjPollGUI\confirmDeleteAllVotes(), ilObjWorkspaceFolderGUI\cut(), ilObjPollGUI\deleteAllVotes(), ilObjWorkspaceFolderGUI\deleteConfirmation(), ilObjPortfolioBaseGUI\determinePageCall(), ilObjDataCollectionGUI\edit(), ilObjItemGroupGUI\edit(), ilObjBibliographicGUI\editObject(), ilRemoteObjectBaseGUI\editObject(), ilObjHelpSettingsGUI\editSettings(), ilObjBlogGUI\executeCommand(), ilObjDataCollectionGUI\executeCommand(), ilObjLegalNoticeGUI\executeCommand(), ilObjItemGroupGUI\executeCommand(), ilRemoteObjectBaseGUI\executeCommand(), ilObjContactAdministrationGUI\getAdminTabs(), ilObjHelpSettingsGUI\getAdminTabs(), ilObjWikiSettingsGUI\getAdminTabs(), ilObjContactAdministrationGUI\getConfigurationForm(), ilObjContentPageGUI\getContent(), ilObjBlogGUI\infoScreenForward(), ilObjCmiXapiGUI\infoScreenForward(), ilObjContentPageGUI\infoScreenForward(), ilObjDataCollectionGUI\infoScreenForward(), ilObjPortfolioTemplateGUI\infoScreenForward(), ilObjWikiSettingsGUI\initForm(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), ilObjBlogGUI\render(), ilObjPollGUI\render(), ilObjContentPageGUI\renderHeaderActions(), ilObjItemGroupGUI\save(), ilObjBibliographicGUI\saveObject(), ilObjLTIConsumerGUI\saveObject(), ilObjLinkResourceGUI\saveObject(), ilObjWikiSettingsGUI\saveSettings(), ilObjHelpSettingsGUI\setMode(), ilObjContentPageGUI\setSettingsSubTabs(), ilObjBlogGUI\setTabs(), ilObjContentPageGUI\setTabs(), ilObjPollGUI\setTabs(), ilObjPortfolioTemplateGUI\setTabs(), ilRemoteObjectBaseGUI\setTabs(), ilObjPollGUI\showParticipants(), ilObjPollGUI\showParticipantVotes(), ilObjDataCollectionGUI\update(), 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 366 of file class.ilObject2GUI.php.

                                     : void
    {
        switch ($this->id_type) {
            case self::REPOSITORY_NODE_ID:
            case self::REPOSITORY_OBJECT_ID:
                parent::confirmedDeleteObject();
 
                // no break
            case self::WORKSPACE_NODE_ID:
            case self::WORKSPACE_OBJECT_ID:
                $this->deleteConfirmedObjects();
 
                // no break
            case self::OBJECT_ID:
            case self::PORTFOLIO_OBJECT_ID:
                // :TODO: should this ever occur?
                break;
        }
    }

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

(

)

CRUD.

Reimplemented in ilObjCmiXapiVerificationGUI, ilObjCourseVerificationGUI, ilObjExerciseVerificationGUI, ilObjLTIConsumerVerificationGUI, ilObjPortfolioGUI, ilObjSCORMVerificationGUI, and ilObjTestVerificationGUI.

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

                            : void
    {
        parent::createObject();
    }

delete()

ilObject2GUI::delete

(

)

Display delete confirmation form (repository/workspace switch)

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

                            : void
    {
        switch ($this->id_type) {
            case self::REPOSITORY_NODE_ID:
            case self::REPOSITORY_OBJECT_ID:
                parent::deleteObject();
 
                // no break
            case self::WORKSPACE_NODE_ID:
            case self::WORKSPACE_OBJECT_ID:
                $this->deleteConfirmation();
 
                // no break
            case self::OBJECT_ID:
            case self::PORTFOLIO_OBJECT_ID:
                // :TODO: should this ever occur?
                break;
        }
    }

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 390 of file class.ilObject2GUI.php.

                                               : void
    {
        if (!$this->post_wrapper->has("id")) {
            $this->tpl->setOnScreenMessage("failure", $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "");
            return;
        }
 
        $ids = $this->post_wrapper->retrieve(
            "id",
            $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
        );
 
        if (count($ids) == 0) {
            $this->tpl->setOnScreenMessage("failure", $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "");
            return;
        }
 
        // #18797 - because of parent/child relations gather all nodes first
        $del_nodes = [];
        foreach ($ids as $node_id) {
            $del_nodes[$node_id] = $this->tree->getNodeData($node_id);
        }
 
        foreach ($del_nodes as $node_id => $node) {
            $this->tree->deleteReference($node_id);
            if ($this->tree->isInTree($node_id)) {
                $this->tree->deleteTree($node);
            }
 
            $this->getAccessHandler()->removePermission($node_id);
 
            $object = ilObjectFactory::getInstanceByObjId((int) $node["obj_id"], false);
            if ($object) {
                $object->delete();
            }
        }
 
        $this->tpl->setOnScreenMessage("success", $this->lng->txt("msg_removed"), true);
        $this->ctrl->redirect($this, "");
    }

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 ilObjBlogGUI, ilObjDataCollectionGUI, ilObjFileGUI, ilObjItemGroupGUI, ilObjMediaPoolGUI, ilObjPortfolioGUI, ilObjPortfolioTemplateGUI, and ilObjWorkspaceFolderGUI.

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

                          : void
    {
        parent::editObject();
    }

executeCommand()

ilObject2GUI::executeCommand

(

)

execute command

Reimplemented from ilObjectGUI.

Reimplemented in ilObjAdministrativeNotificationGUI, ilObjBibliographicGUI, ilObjBlogGUI, ilObjContactAdministrationGUI, ilObjDataCollectionGUI, ilObjDataProtectionGUI, ilObjFileServicesGUI, ilObjFooterAdministrationGUI, ilObjHelpSettingsGUI, ilObjLegalNoticeGUI, ilObjItemGroupGUI, ilObjLegalDocumentsGUI, ilObjMainMenuGUI, ilObjMediaPoolGUI, ilObjPollGUI, ilObjPortfolioGUI, ilObjPortfolioTemplateGUI, ilObjectPluginGUI, ilObjTaxonomyGUI, ilObjTermsOfServiceGUI, ilObjLinkResourceGUI, ilRemoteObjectBaseGUI, ilObjWikiSettingsGUI, and ilObjWorkspaceFolderGUI.

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

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        $this->prepareOutput();
 
        switch ($next_class) {
            case "ilworkspaceaccessgui":
                if ($this->node_id) {
                    $this->tabs_gui->activateTab("id_permissions");
                    $wspacc = new ilWorkspaceAccessGUI($this->node_id, $this->getAccessHandler());
                    $this->ctrl->forwardCommand($wspacc);
                } else {
                    if (!$cmd) {
                        $cmd = "render";
                    }
                    $this->$cmd();
                }
                break;
 
            default:
                if (!$cmd) {
                    $cmd = "render";
                }
                $this->$cmd();
        }
    }

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:

getAccessHandler()

ilObject2GUI::getAccessHandler ( )

protected

Returns

mixed

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

    {
        return $this->access_handler;
    }

References $access_handler.

Referenced by ilObjBlogGUI\__construct(), ilObjWorkspaceFolderGUI\applyShareFilter(), ilObjWorkspaceFolderGUI\copyShared(), deleteConfirmedObjects(), ilObjBlogGUI\executeCommand(), executeCommand(), ilObjPollGUI\executeCommand(), ilObjPortfolioTemplateGUI\executeCommand(), ilObjWorkspaceFolderGUI\initPasswordForm(), ilObjWorkspaceFolderGUI\listSharedResourcesOfOtherUser(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), ilObjWorkspaceFolderGUI\render(), ilObjCmiXapiVerificationGUI\render(), ilObjLTIConsumerVerificationGUI\render(), ilObjCourseVerificationGUI\render(), ilObjSCORMVerificationGUI\render(), ilObjTestVerificationGUI\render(), ilObjWorkspaceFolderGUI\resetShareFilter(), ilObjWorkspaceFolderGUI\setTabs(), and ilObjWorkspaceFolderGUI\share().

Here is the caller graph for this function:

getCenterColumnHTML()

ilObject2GUI::getCenterColumnHTML ( )

finalprotected

Get center column.

Reimplemented from ilObjectGUI.

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

                                                  : string
    {
        return parent::getCenterColumnHTML();
    }

getCreationMode()

ilObject2GUI::getCreationMode ( )

final

Reimplemented from ilObjectGUI.

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

                                           : bool
    {
        return parent::getCreationMode();
    }

Referenced by ilObjMediaPoolGUI\addLocatorItems(), ilObjectPluginGUI\addLocatorItems(), ilObjContentPageGUI\addToNavigationHistory(), ilObjMediaPoolGUI\afterConstructor(), ilObjBlogGUI\executeCommand(), ilObjDataCollectionGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilObjPollGUI\executeCommand(), ilObjPortfolioTemplateGUI\executeCommand(), ilObjectPluginGUI\executeCommand(), ilObjLinkResourceGUI\executeCommand(), ilObjContentPageGUI\initEditCustomForm(), ilObjContentPageGUI\renderHeaderActions(), and ilOrgUnitExtensionGUI\setLocator().

Here is the caller graph for this function:

getHTML()

ilObject2GUI::getHTML

(

)

Reimplemented from ilObjectGUI.

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

                             : string
    {
        return parent::getHTML();
    }

getIdType()

ilObject2GUI::getIdType

(

)

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

                               : int
    {
        return $this->id_type;
    }

References $id_type.

Referenced by ilObjFileAbstractZipProcessor\__construct(), and ilObjLinkResourceGUI\executeCommand().

Here is the caller graph for this function:

getReturnLocation()

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

finalprotected

Deprecated functions.

Reimplemented from ilObjectGUI.

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

                                                                                  : string
    {
        die("ilObject2GUI::getReturnLocation() is deprecated.");
    }

getRightColumnHTML()

ilObject2GUI::getRightColumnHTML ( )

finalprotected

Display right column.

Reimplemented from ilObjectGUI.

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

                                                 : string
    {
        return parent::getRightColumnHTML();
    }

getTabs()

ilObject2GUI::getTabs ( )

finalprotected

@abstract overwrite in derived GUI class of your object type

Reimplemented from ilObjectGUI.

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

                                      : void
    {
        die("ilObject2GUI::getTabs() is deprecated.");
    }

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 465 of file class.ilObject2GUI.php.

                                                                                   : string
    {
        return parent::getTargetFrame($cmd, $target_frame);
    }

References ilObjectGUI\$target_frame.

getType()

ilObject2GUI::getType ( )

abstract

Functions that must be overwritten.

Reimplemented in ilObjAdministrativeNotificationGUI, ilObjBibliographicGUI, ilObjBlogGUI, ilObjCmiXapiGUI, ilObjCmiXapiVerificationGUI, ilObjContactAdministrationGUI, ilObjContentPageGUI, ilObjCourseVerificationGUI, ilObjDataCollectionGUI, ilObjDataProtectionGUI, ilObjExerciseVerificationGUI, ilObjFileGUI, ilObjFileServicesGUI, ilObjFooterAdministrationGUI, ilObjHelpSettingsGUI, ilObjLegalNoticeGUI, ilObjItemGroupGUI, ilObjLegalDocumentsGUI, ilObjLTIConsumerGUI, ilObjLTIConsumerVerificationGUI, ilObjMainMenuGUI, ilObjMediaPoolGUI, ilObjPollGUI, ilObjPortfolioGUI, ilObjPortfolioTemplateGUI, ilObjRemoteCategoryGUI, ilObjRemoteCourseGUI, ilObjRemoteFileGUI, ilObjRemoteGlossaryGUI, ilObjRemoteGroupGUI, ilObjRemoteLearningModuleGUI, ilObjRemoteTestGUI, ilObjRemoteWikiGUI, ilObjSCORMVerificationGUI, ilObjTaxonomyGUI, ilObjTermsOfServiceGUI, ilObjTestVerificationGUI, ilObjLinkResourceGUI, ilObjWikiSettingsGUI, ilObjWorkspaceFolderGUI, and ilObjWorkspaceRootFolderGUI.

Referenced by __construct(), ilRemoteObjectBaseGUI\callObject(), ilObjectPluginGUI\executeCommand(), ilObjectPluginGUI\getCreationFormTitle(), ilObjectPluginGUI\getPlugin(), ilRemoteObjectBaseGUI\infoScreen(), ilRemoteObjectBaseGUI\initEditForm(), and ilRemoteObjectBaseGUI\updateObject().

Here is the caller graph for this function:

handleAfterSaveCallback()

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

static

After creation callback.

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

    {
        global $DIC;
        $objDefinition = $DIC["objDefinition"];
 
        $callback_ref_id = (int) $callback_ref_id;
        if ($callback_ref_id) {
            $callback_type = ilObject::_lookupType($callback_ref_id, true);
            $class_name = "ilObj" . $objDefinition->getClassName($callback_type) . "GUI";
            if (strtolower($class_name) == "ilobjitemgroupgui") {
                $callback_obj = new $class_name($callback_ref_id);
            } else {
                $callback_obj = new $class_name(null, $callback_ref_id, true, false);
            }
            $callback_obj->afterSaveCallback($obj);
        }
    }

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

Here is the call graph for this function:

initHeaderAction()

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

protected

Add header action menu.

Reimplemented from ilObjectGUI.

Reimplemented in ilObjFileGUI, ilObjLTIConsumerGUI, and ilObjCmiXapiGUI.

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

                                                                                      : ?ilObjectListGUI
    {
        if ($this->id_type == self::WORKSPACE_NODE_ID) {
            if (!$this->creation_mode && $this->object_id) {
                $dispatcher = new ilCommonActionDispatcherGUI(
                    ilCommonActionDispatcherGUI::TYPE_WORKSPACE,
                    $this->getAccessHandler(),
                    $this->getType(),
                    $this->node_id,
                    $this->object_id
                );
 
                $dispatcher->setSubObject($sub_type, $sub_id);
 
                ilObjectListGUI::prepareJsLinks(
                    $this->ctrl->getLinkTarget($this, "redrawHeaderAction", "", true),
                    "",
                    $this->ctrl->getLinkTargetByClass(["ilcommonactiondispatchergui", "iltagginggui"], "")
                );
 
                $lg = $dispatcher->initHeaderAction();
 
                if (is_object($lg)) {
                    // to enable add to desktop / remove from desktop
                    if ($this instanceof ilDesktopItemHandling) {
                        $lg->setContainerObject($this);
                    }
 
                    // for activation checks see ilObjectGUI
                    // $lg->enableComments(true);
                    $lg->enableNotes(true);
                    // $lg->enableTags(true);
                }
 
                return $lg;
            }
        }
 
        return parent::initHeaderAction($sub_type, $sub_id);
    }

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 473 of file class.ilObject2GUI.php.

                                                              : bool
    {
        return parent::isVisible($ref_id, $type);
    }

References ilObjectGUI\$ref_id, $type, and ILIAS\GlobalScreen\Scope\isVisible().

Here is the call graph for this function:

omitLocator()

ilObject2GUI::omitLocator ( bool  $omit = true )

finalprotected

Reimplemented from ilObjectGUI.

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

                                                           : void
    {
        parent::omitLocator($omit);
    }

prepareOutput()

ilObject2GUI::prepareOutput ( bool  $show_sub_objects = true )

final

Reimplemented from ilObjectGUI.

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

                                                                      : bool
    {
        return parent::prepareOutput($show_sub_objects);
    }

Referenced by ilObjBlogGUI\createExportFile(), ilObjBlogGUI\createExportFileWithComments(), ilObjAdministrativeNotificationGUI\executeCommand(), ilObjBibliographicGUI\executeCommand(), ilObjBlogGUI\executeCommand(), ilObjContactAdministrationGUI\executeCommand(), ilObjDataCollectionGUI\executeCommand(), ilObjDataProtectionGUI\executeCommand(), ilObjFileServicesGUI\executeCommand(), ilObjFooterAdministrationGUI\executeCommand(), ilObjHelpSettingsGUI\executeCommand(), executeCommand(), ilObjLegalNoticeGUI\executeCommand(), ilObjItemGroupGUI\executeCommand(), ilObjMainMenuGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilObjPollGUI\executeCommand(), ilObjPortfolioTemplateGUI\executeCommand(), ilObjTermsOfServiceGUI\executeCommand(), ilObjLinkResourceGUI\executeCommand(), ilRemoteObjectBaseGUI\executeCommand(), ilObjWikiSettingsGUI\executeCommand(), ilObjWorkspaceFolderGUI\executeCommand(), and ilObjBlogGUI\showExportGUI().

Here is the caller graph for this function:

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 636 of file class.ilObject2GUI.php.

                                                                               : void
    {
        $this->object_id = $obj->getId();
 
        if (!$parent_node_id) {
            $parent_node_id = $this->parent_id;
        }
 
        // add new object to custom parent container
        if ($this->retriever->has('crtptrefid')) {
            $parent_node_id = $this->retriever->getMaybeInt('crtptrefid') ?? 0;
        }
 
        switch ($this->id_type) {
            case self::REPOSITORY_NODE_ID:
            case self::REPOSITORY_OBJECT_ID:
                if (!$this->node_id) {
                    $obj->createReference();
                    $this->node_id = $obj->getRefId();
                }
                $obj->putInTree($parent_node_id);
                $obj->setPermissions($parent_node_id);
 
                // rbac log
                $rbac_log_roles = $this->rbac_review->getParentRoleIds($this->node_id, false);
                $rbac_log = ilRbacLog::gatherFaPa($this->node_id, array_keys($rbac_log_roles), true);
                ilRbacLog::add(ilRbacLog::CREATE_OBJECT, $this->node_id, $rbac_log);
 
                $this->ctrl->setParameter($this, "ref_id", $this->node_id);
                break;
 
            case self::WORKSPACE_NODE_ID:
            case self::WORKSPACE_OBJECT_ID:
                if (!$this->node_id) {
                    $this->node_id = $this->tree->insertObject($parent_node_id, $this->object_id);
                }
                $this->getAccessHandler()->setPermissions($parent_node_id, $this->node_id);
 
                $this->ctrl->setParameter($this, "wsp_id", $this->node_id);
                break;
 
            case self::OBJECT_ID:
            case self::PORTFOLIO_OBJECT_ID:
                // do nothing
                break;
        }
 
        // BEGIN ChangeEvent: Record save object.
        ilChangeEvent::_recordWriteEvent($this->object_id, $this->user->getId(), 'create');
        // END ChangeEvent: Record save object.
 
        // use forced callback after object creation
        self::handleAfterSaveCallback($obj, $this->retriever->getMaybeInt('crtcb'));
    }

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(), ilObjItemGroupGUI\save(), ilObjLTIConsumerVerificationGUI\save(), ilObjSCORMVerificationGUI\save(), ilObjTestVerificationGUI\save(), ilObjBibliographicGUI\saveObject(), ilObjLTIConsumerGUI\saveObject(), and ilObjLinkResourceGUI\saveObject().

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.

                                                                           : void
    {
        parent::redirectToRefId($ref_id, $cmd);
    }

References $ref_id.

redrawHeaderAction()

ilObject2GUI::redrawHeaderAction ( )

protected

Updating icons after ajax call.

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

                                           : void
    {
        parent::redrawHeaderActionObject();
    }

save()

ilObject2GUI::save

(

)

Reimplemented in ilObjBibliographicGUI, ilObjCmiXapiVerificationGUI, ilObjCourseVerificationGUI, ilObjExerciseVerificationGUI, ilObjItemGroupGUI, ilObjLTIConsumerVerificationGUI, ilObjPortfolioGUI, ilObjSCORMVerificationGUI, ilObjTaxonomyGUI, ilObjTestVerificationGUI, and ilObjLinkResourceGUI.

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

                          : void
    {
        parent::saveObject();
    }

setColumnSettings()

ilObject2GUI::setColumnSettings ( ilColumnGUI  $column_gui )

final

Reimplemented from ilObjectGUI.

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

                                                                    : void
    {
        parent::setColumnSettings($column_gui);
    }

setCreationMode()

ilObject2GUI::setCreationMode ( bool  $mode = true )

final

If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI.

Reimplemented from ilObjectGUI.

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

                                                            : void
    {
        parent::setCreationMode($mode);
    }

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 293 of file class.ilObject2GUI.php.

                                   : void
    {
        if ($this->omit_locator) {
            return;
        }
 
        switch ($this->id_type) {
            case self::REPOSITORY_NODE_ID:
                $ref_id = $this->node_id ?: $this->parent_id;
                $this->locator->addRepositoryItems($ref_id);
 
                // not so nice workaround: todo: handle locator as tabs in ilTemplate
                if ($this->admin_mode == self::ADMIN_MODE_NONE &&
                    strtolower($this->ctrl->getCmdClass()) == "ilobjrolegui") {
                    $this->ctrl->setParameterByClass(
                        "ilobjrolegui",
                        "rolf_ref_id",
                        $this->request_wrapper->has("rolf_ref_id")
                            ? $this->request_wrapper->retrieve("rolf_ref_id", $this->refinery->kindlyTo()->string())
                            : null
                    );
                    $this->ctrl->setParameterByClass(
                        "ilobjrolegui",
                        "obj_id",
                        $this->request_wrapper->retrieve("obj_id", $this->refinery->kindlyTo()->string())
                    );
                    $this->locator->addItem(
                        $this->lng->txt("role"),
                        $this->ctrl->getLinkTargetByClass(["ilpermissiongui",
                            "ilobjrolegui"], "perm")
                    );
                }
 
                // in workspace this is done in ilPersonalWorkspaceGUI
                if ($this->object_id) {
                    $this->addLocatorItems();
                }
                $this->tpl->setLocator();
 
                break;
 
            case self::WORKSPACE_NODE_ID:
                // :TODO:
                break;
        }
    }

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 ilObjBlogGUI\executeCommand(), 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 584 of file class.ilObject2GUI.php.

                                                                             : void
    {
        die("ilObject2GUI::setReturnLocation() is deprecated.");
    }

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 542 of file class.ilObject2GUI.php.

                                : void
    {
        switch ($this->id_type) {
            case self::REPOSITORY_NODE_ID:
            case self::REPOSITORY_OBJECT_ID:
                if ($this->checkPermissionBool("edit_permission")) {
                    $this->tabs_gui->addTab(
                        "id_permissions",
                        $this->lng->txt("perm_settings"),
                        $this->ctrl->getLinkTargetByClass([get_class($this), "ilpermissiongui"], "perm")
                    );
                }
                break;
 
            case self::WORKSPACE_NODE_ID:
            case self::WORKSPACE_OBJECT_ID:
                // only files and blogs can be shared for now
                if (
                    $this->checkPermissionBool("edit_permission") &&
                    in_array($this->type, ["file", "blog"]) &&
                    $this->node_id
                ) {
                    $this->tabs_gui->addTab(
                        "id_permissions",
                        $this->lng->txt("wsp_permissions"),
                        $this->ctrl->getLinkTargetByClass([get_class($this), "ilworkspaceaccessgui"], "share")
                    );
                }
                break;
        }
    }

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 469 of file class.ilObject2GUI.php.

                                                                              : void
    {
        parent::setTargetFrame($cmd, $target_frame);
    }

References ilObjectGUI\$target_frame.

setTitleAndDescription()

ilObject2GUI::setTitleAndDescription ( )

protected

Reimplemented from ilObjectGUI.

Reimplemented in ilObjContentPageGUI, ilObjFileServicesGUI, ilObjPortfolioGUI, and ilObjWorkspaceRootFolderGUI.

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

                                               : void
    {
        parent::setTitleAndDescription();
    }

showActions()

ilObject2GUI::showActions ( )

finalprotected

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

                                          : void
    {
        die("ilObject2GUI::showActions() is deprecated.");
    }

showPossibleSubObjects()

ilObject2GUI::showPossibleSubObjects ( )

finalprotected

show possible sub objects (pull down menu)

Reimplemented from ilObjectGUI.

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

                                                     : void
    {
        parent::showPossibleSubObjects();
    }

update()

ilObject2GUI::update

(

)

Reimplemented in ilObjDataCollectionGUI, and ilObjWorkspaceFolderGUI.

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

                            : void
    {
        parent::updateObject();
    }

Referenced by ilObjDataProtectionGUI\form(), and ilObjTermsOfServiceGUI\form().

Here is the caller graph for this function:

view()

ilObject2GUI::view

(

)

view object content (repository/workspace switch)

Reimplemented in ilObjBibliographicGUI, ilObjContentPageGUI, ilObjDataProtectionGUI, ilObjPortfolioBaseGUI, and ilObjLinkResourceGUI.

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

                          : void
    {
        switch ($this->id_type) {
            case self::REPOSITORY_NODE_ID:
            case self::REPOSITORY_OBJECT_ID:
                parent::viewObject();
                break;
 
            case self::WORKSPACE_NODE_ID:
            case self::WORKSPACE_OBJECT_ID:
                $this->render();
 
                // no break
            case self::OBJECT_ID:
            case self::PORTFOLIO_OBJECT_ID:
                // :TODO: should this ever occur?  do nothing or edit() ?!
                break;
        }
    }

withReferences()

ilObject2GUI::withReferences ( )

final

Final/Private declaration of unchanged parent methods.

Reimplemented from ilObjectGUI.

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

                                          : bool
    {
        return parent::withReferences();
    }

Field Documentation

$access

ilAccessHandler ilObject2GUI::$access

protected

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

Referenced by __construct(), ilObjCmiXapiGUI\_goto(), ilObjDataCollectionGUI\_goto(), ilObjectPluginGUI\addInfoTab(), ilObjectPluginGUI\addInilPluginAdminfoTab(), ilObjItemGroupGUI\addLocatorItems(), ilObjMediaPoolGUI\addLocatorItems(), ilObjectPluginGUI\addPermissionTab(), ilObjMediaPoolGUI\executeCommand(), ilObjectPluginGUI\executeCommand(), ilObjItemGroupGUI\gotoParent(), ilObjMediaPoolGUI\listMedia(), ilObjBlogGUI\setSettingsSubTabs(), and ilObjItemGroupGUI\setTabs().

$access_handler

ilObject2GUI::$access_handler

protected

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

Referenced by getAccessHandler(), ilObjCmiXapiVerificationGUI\render(), ilObjLTIConsumerVerificationGUI\render(), ilObjCourseVerificationGUI\render(), ilObjSCORMVerificationGUI\render(), and ilObjTestVerificationGUI\render().

$creation_forms

array ilObject2GUI::$creation_forms = []

protected

Definition at line 76 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(), ilObjCmiXapiGUI\_goto(), ilObjCourseVerificationGUI\_goto(), ilObjWorkspaceFolderGUI\_goto(), ilObjWorkspaceFolderGUI\addContentSubTabs(), ilObjectPluginGUI\addPermissionTab(), ilObjBlogGUI\afterSave(), ilObjectPluginGUI\afterSave(), ilObjMediaPoolGUI\allMedia(), ilObjMediaPoolGUI\cancelFolderUpdate(), ilObjMediaPoolGUI\cancelSave(), ilObjMediaPoolGUI\confirmRemove(), ilObjBlogGUI\createPosting(), ilObjBlogGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilObjectPluginGUI\executeCommand(), ilObjectPluginGUI\infoScreen(), ilObjectPluginGUI\initEditForm(), ilObjMediaPoolGUI\initFolderForm(), ilObjWikiSettingsGUI\initForm(), ilObjWorkspaceFolderGUI\initPasswordForm(), ilObjMediaPoolGUI\listMedia(), ilObjMediaPoolGUI\openClipboard(), ilObjBlogGUI\render(), ilObjWorkspaceFolderGUI\render(), ilObjMediaPoolGUI\returnFromItem(), ilObjMediaPoolGUI\saveFolder(), ilObjItemGroupGUI\saveItemAssignment(), ilObjWikiSettingsGUI\saveSettings(), and ilObjMediaPoolGUI\updateFolder().

$error

ilErrorHandling ilObject2GUI::$error

protected

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

Referenced by ilObjLTIConsumerGUI\addDynReg().

$favourites

ilFavouritesManager ilObject2GUI::$favourites

protected

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

$html

string ilObject2GUI::$html

protected

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

$id_type

int ilObject2GUI::$id_type

protected

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

Referenced by ilObjFileServicesGUI\__construct(), __construct(), and getIdType().

$lng

ilLanguage ilObject2GUI::$lng

protected

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

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

$locator

ilLocatorGUI ilObject2GUI::$locator

protected

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

Referenced by ilObjCmiXapiGUI\addLocatorItems(), ilObjItemGroupGUI\addLocatorItems(), ilObjMediaPoolGUI\addLocatorItems(), ilObjPortfolioBaseGUI\addLocatorItems(), and ilObjectPluginGUI\addLocatorItems().

$node_id

int ilObject2GUI::$node_id = null

protected

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

Referenced by ilObjWorkspaceFolderGUI\checkPassword(), ilObjWorkspaceFolderGUI\deleteConfirmation(), deleteConfirmedObjects(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), ilObjCmiXapiVerificationGUI\save(), ilObjCourseVerificationGUI\save(), ilObjExerciseVerificationGUI\save(), ilObjLTIConsumerVerificationGUI\save(), ilObjSCORMVerificationGUI\save(), and ilObjTestVerificationGUI\save().

$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 74 of file class.ilObject2GUI.php.

Referenced by __construct().

$parent_id

int ilObject2GUI::$parent_id

protected

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

Referenced by ilObjFileGUI\getParentId(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), ilObjCmiXapiVerificationGUI\save(), ilObjCourseVerificationGUI\save(), ilObjExerciseVerificationGUI\save(), ilObjLTIConsumerVerificationGUI\save(), ilObjSCORMVerificationGUI\save(), ilObjTestVerificationGUI\save(), setLocator(), and ilOrgUnitExtensionGUI\setLocator().

$rbac_admin

ilRbacAdmin ilObject2GUI::$rbac_admin

protected

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

$rbac_review

ilRbacReview ilObject2GUI::$rbac_review

protected

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

$rbac_system

ilRbacSystem ilObject2GUI::$rbac_system

protected

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

$refinery

Factory ilObject2GUI::$refinery

protected

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

$request_ref_id

int ilObject2GUI::$request_ref_id

protected

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

$retriever

ilObjectRequestRetriever ilObject2GUI::$retriever

private

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

$tabs_gui

ilTabsGUI ilObject2GUI::$tabs_gui

protected

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

Referenced by ilObjExerciseVerificationGUI\create().

$toolbar

ilToolbarGUI ilObject2GUI::$toolbar

protected

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

Referenced by ilObjPortfolioTemplateGUI\infoScreenForward(), ilObjMediaPoolGUI\listMedia(), and ilObjWorkspaceFolderGUI\showAdministrationPanel().

$tpl

ilGlobalTemplateInterface ilObject2GUI::$tpl

protected

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

Referenced by ilObjDataCollectionGUI\_goto(), ilObjMediaPoolGUI\allMedia(), ilObjMediaPoolGUI\createFolderForm(), ilObjWorkspaceFolderGUI\deleteConfirmation(), ilObjMediaPoolGUI\editFolder(), ilObjWikiSettingsGUI\editSettings(), ilObjBlogGUI\executeCommand(), ilObjMediaPoolGUI\executeCommand(), ilObjectPluginGUI\executeCommand(), ilObjItemGroupGUI\listMaterials(), ilObjMediaPoolGUI\listMedia(), ilObjWorkspaceFolderGUI\passwordForm(), ilObjBlogGUI\render(), ilObjWorkspaceFolderGUI\render(), ilObjMediaPoolGUI\saveFolder(), ilObjWorkspaceRootFolderGUI\setTitleAndDescription(), ilObjWorkspaceFolderGUI\share(), ilObjMediaPoolGUI\showPage(), and ilObjMediaPoolGUI\updateFolder().

$type

string ilObject2GUI::$type

protected

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

Referenced by ilObjWorkspaceFolderGUI\buildAvailableObjectTypes(), ilObjWorkspaceFolderGUI\buildObjectType(), ilObjMediaPoolGUI\confirmRemove(), ilObjMediaPoolGUI\copyToClipboard(), ilObjWorkspaceFolderGUI\deleteConfirmation(), ilObjDataProtectionGUI\form(), ilObjCmiXapiGUI\initCreateForm(), isVisible(), ilObjMediaPoolGUI\returnFromItem(), and ilObjContactAdministrationGUI\saveConfigurationForm().

$user

ilObjUser ilObject2GUI::$user

protected

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

Referenced by ilObjMediaPoolGUI\allMedia(), ilObjWorkspaceFolderGUI\copy(), ilObjMediaPoolGUI\copyToClipboard(), ilObjBlogGUI\createPosting(), ilObjPortfolioTemplateGUI\initDidacticTemplate(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), ilObjWorkspaceFolderGUI\render(), and ilObjExerciseVerificationGUI\save().

OBJECT_ID

const ilObject2GUI::OBJECT_ID = 0

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

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

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

const ilObject2GUI::REPOSITORY_NODE_ID = 1

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

Referenced by __construct(), assignObject(), confirmedDelete(), delete(), ilAdministrationGUI\executeCommand(), ilRepositoryGUI\executeCommand(), ilLinkResourceHandlerGUI\executeCommand(), ilFileVersionsGUI\getParentIdType(), ilAdministrationSettingsFormHandler\getSettingsGUIInstance(), ilObjectGUI\routeImportCmdObject(), and setLocator().

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

const ilObject2GUI::WORKSPACE_NODE_ID = 2

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

Referenced by __construct(), assignObject(), confirmedDelete(), delete(), ilPersonalWorkspaceGUI\executeCommand(), ilSharedResourceGUI\executeCommand(), ilFileVersionsGUI\getParentIdType(), ilObjFileAbstractZipProcessor\isWorkspace(), ILIAS\Blog\Permission\PermissionManager\mayContribute(), and setLocator().

WORKSPACE_OBJECT_ID

const ilObject2GUI::WORKSPACE_OBJECT_ID = 4

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

Referenced by __construct(), assignObject(), confirmedDelete(), delete(), ilPortfolioPageGUI\dlcmxv(), ilPortfolioPageGUI\dlcrsv(), ilPortfolioPageGUI\dlexcv(), ilPortfolioPageGUI\dlltiv(), ilPortfolioPageGUI\dlscov(), ilPortfolioPageGUI\dltstv(), and ilObjLinkResourceGUI\executeCommand().

---

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

• components/ILIAS/ILIASObject/classes/class.ilObject2GUI.php