Object GUI class for repository plugins. More...

Inheritance diagram for ilObjectPluginGUI:

Collaboration diagram for ilObjectPluginGUI:

Public Member Functions
	executeCommand ()
	execute command More...

	getAfterCreationCmd ()
	Cmd that will be redirected to after creation of a new object. More...

	getStandardCmd ()

	performCommand (string $cmd)

	addInilPluginAdminfoTab ()

	addPermissionTab ()

	addInfoTab ()

	addExportTab ()

	infoScreen ()

	addInfoItems (ilInfoScreenGUI $info)
	Add items to info screen. More...

Public Member Functions inherited from ilObject2GUI
	__construct (int $id=0, int $id_type=self::REPOSITORY_NODE_ID, int $parent_node_id=0)

	executeCommand ()
	execute command More...

	getIdType ()

	delete ()
	Display delete confirmation form (repository/workspace switch) More...

	confirmedDelete ()
	Delete objects (repository/workspace switch) More...

	getHTML ()

	withReferences ()
	Final/Private declaration of unchanged parent methods. More...

	setCreationMode (bool $mode=true)
	if true, a creation screen is displayed the current [ref_id] don't belong to the current class! The mode is determined in ilRepositoryGUI More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	isVisible (int $ref_id, string $type)

	setColumnSettings (ilColumnGUI $column_gui)

	cancelDelete ()

	view ()
	view object content (repository/workspace switch) More...

	getType ()
	Functions that must be overwritten. More...

	create ()
	CRUD. More...

	save ()

	edit ()

	update ()

	cancel ()

	importFile ()

	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...

Public Member Functions inherited from ilObjectGUI
	__construct ($data, int $id=0, bool $call_by_reference=true, bool $prepare_output=true)

	getRefId ()

	setAdminMode (string $mode)

	getAdminMode ()

	getObject ()

	executeCommand ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	setCreationMode (bool $mode=true)
	if true, a creation screen is displayed the current [ref_id] don't belong to the current class! The mode is determined in ilRepositoryGUI More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelDeleteObject ()
	cancel deletion of object More...

	cancelObject ()
	cancel action and go back to previous page More...

	createObject ()
	create new object form More...

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()

	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()

	addExternalEditFormCustom (ilPropertyFormGUI $form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...

	isVisible (int $ref_id, string $type)

	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...

	setColumnSettings (ilColumnGUI $column_gui)

	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html Should be overwritten and redirect to settings screen. More...

	addToDeskObject ()

	removeFromDeskObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Static Public Member Functions
static	_goto (array $a_target)

Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $obj, ?int $callback_ref_id)
	After creation callback. More...

Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode (int $ref_id, string $cmd="")

static	_gotoSharedWorkspaceNode (int $wsp_id)

Protected Member Functions
	addLocatorItems ()
	Functions to be overwritten. More...

	getPlugin ()
	Get plugin object. More...

	txt (string $a_var)

	getCreationFormTitle (int $a_form_type)
	Use custom creation form titles. More...

	initCreationForms (string $new_type)
	Init creation forms this will create the default creation forms: new, import, clone. More...

	supportsCloning ()

	initCreateForm (string $new_type)
	Init object creation form. More...

	initEditForm ()
	Init object update form. More...

	initImportForm (string $new_type)
	Init object import form. More...

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

	supportsExport ()

	lookupParentTitleInCreationMode ()

Protected Member Functions inherited from ilObject2GUI
	afterConstructor ()
	Do anything that should be done after constructor in here. More...

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

	getAccessHandler ()

	setLocator ()
	set Locator More...

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

	setTitleAndDescription ()

	omitLocator (bool $omit=true)

	getTargetFrame (string $cmd, string $target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

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

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...

	fillCloneTemplate (?string $tpl_varname, string $type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...

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

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

	getReturnLocation (string $cmd, string $location="")
	Deprecated functions. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

	showActions ()

	getTabs ()
	@abstract overwrite in derived GUI class of your object type More...

	addLocatorItems ()
	Functions to be overwritten. More...

	initCreationForms (string $new_type)
	Init creation forms. More...

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

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	redrawHeaderAction ()
	Updating icons after ajax call. More...

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

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...

	addHeaderAction ()
	Add header action menu. More...

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	setTabs ()
	set admin tabs More...

	setAdminTabs ()
	set admin tabs More...

	setLocator ()

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

	omitLocator (bool $omit=true)

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

	initCreationForms (string $new_type)
	Init creation forms. More...

	getCreationFormsHTML (array $forms)
	Get HTML for creation forms (accordion) More...

	initCreateForm (string $new_type)

	initDidacticTemplate (ilPropertyFormGUI $form)

	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...

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

	initEditForm ()

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

	getEditFormValues ()

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

	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	initImportForm (string $new_type)

	importFileObject (int $parent_id=null)

	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...

	setFormAction (string $cmd, string $form_action)

	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	getTabs ()
	@abstract overwrite in derived GUI class of your object type More...

	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...

	fillCloneTemplate (?string $tpl_name, string $type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

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

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

	showCustomIconsEditing ( $input_colspan=1, ilPropertyFormGUI $form=null, $as_section=true)
	show edit section of custom icons for container More...

Protected Attributes
ilComponentRepository	$component_repository

ilNavigationHistory	$nav_history

ilTabsGUI	$tabs

ilPlugin	$plugin = null

PluginSlotGUIRequest	$slot_request

ilComponentFactory	$component_factory

Protected Attributes inherited from ilObject2GUI
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 = ""

Additional Inherited Members
Data Fields inherited from ilObject2GUI
const	OBJECT_ID = 0

const	REPOSITORY_NODE_ID = 1

const	WORKSPACE_NODE_ID = 2

const	REPOSITORY_OBJECT_ID = 3

const	WORKSPACE_OBJECT_ID = 4

const	PORTFOLIO_OBJECT_ID = 5

Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION

const	ADMIN_MODE_NONE = ""

const	ADMIN_MODE_SETTINGS = "settings"

const	ADMIN_MODE_REPOSITORY = "repository"

const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

Detailed Description

Object GUI class for repository plugins.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 25 of file class.ilObjectPluginGUI.php.

Member Function Documentation

◆ _goto()

static ilObjectPluginGUI::_goto ( array $a_target )

static

Parameters

list<string> $a_target

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

                                                 : void
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();
 
        $ilCtrl = $DIC->ctrl();
        $ilAccess = $DIC->access();
        $lng = $DIC->language();
 
        $t = explode("_", $a_target[0]);
        $ref_id = (int) $t[0];
        $class_name = $a_target[1];
 
        if ($ilAccess->checkAccess("read", "", $ref_id)) {
            $ilCtrl->setTargetScript('ilias.php');
            $ilCtrl->setParameterByClass($class_name, "ref_id", $ref_id);
            $ilCtrl->redirectByClass(["ilobjplugindispatchgui", $class_name], "");
        } elseif ($ilAccess->checkAccess("visible", "", $ref_id)) {
            $ilCtrl->setTargetScript('ilias.php');
            $ilCtrl->setParameterByClass($class_name, "ref_id", $ref_id);
            $ilCtrl->redirectByClass(["ilobjplugindispatchgui", $class_name], "infoScreen");
        } elseif ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
            $main_tpl->setOnScreenMessage('failure', sprintf(
                $lng->txt("msg_no_perm_read_item"),
                ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id))
            ));
            ilObjectGUI::_gotoRepositoryRoot();
        }
    }

References $DIC, ilObject2GUI\$lng, ilObjectGUI\$ref_id, ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ILIAS\Repository\int(), ROOT_FOLDER_ID, and ilLanguage\txt().

Here is the call graph for this function:

◆ addExportTab()

ilObjectPluginGUI::addExportTab ( )

Definition at line 417 of file class.ilObjectPluginGUI.php.

                                  : void
    {
        // write
        if ($this->access->checkAccess('write', "", $this->object->getRefId())) {
            $this->tabs->addTarget(
                'export',
                $this->ctrl->getLinkTargetByClass("ilexportgui", ''),
                'export',
                'ilexportgui'
            );
        }
    }

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ addInfoItems()

ilObjectPluginGUI::addInfoItems ( ilInfoScreenGUI $info )

Add items to info screen.

Definition at line 455 of file class.ilObjectPluginGUI.php.

                                                       : void
    {
    }

Referenced by infoScreen().

Here is the caller graph for this function:

◆ addInfoTab()

ilObjectPluginGUI::addInfoTab ( )

Definition at line 399 of file class.ilObjectPluginGUI.php.

                                : void
    {
        $ilAccess = $this->access;
        $ilTabs = $this->tabs;
 
        // info screen
        if ($ilAccess->checkAccess('visible', "", $this->object->getRefId())) {
            $ilTabs->addTarget(
                "info_short",
                $this->ctrl->getLinkTargetByClass(
                    "ilinfoscreengui",
                    "showSummary"
                ),
                "showSummary"
            );
        }
    }

References ilObject2GUI\$access, $tabs, ilTabsGUI\addTarget(), and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ addInilPluginAdminfoTab()

ilObjectPluginGUI::addInilPluginAdminfoTab ( )

Definition at line 364 of file class.ilObjectPluginGUI.php.

                                             : void
    {
        $ilAccess = $this->access;
        $ilTabs = $this->tabs;
 
        // info screen
        if ($ilAccess->checkAccess('visible', "", $this->object->getRefId())) {
            $ilTabs->addTarget(
                "info_short",
                $this->ctrl->getLinkTargetByClass(
                    "ilinfoscreengui",
                    "showSummary"
                ),
                "showSummary"
            );
        }
    }

References ilObject2GUI\$access, $tabs, ilTabsGUI\addTarget(), and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ addLocatorItems()

ilObjectPluginGUI::addLocatorItems ( )

protected

Functions to be overwritten.

Reimplemented from ilObject2GUI.

Definition at line 184 of file class.ilObjectPluginGUI.php.

                                        : void
    {
        $ilLocator = $this->locator;
 
        if (!$this->getCreationMode()) {
            $ilLocator->addItem(
                $this->object->getTitle(),
                $this->ctrl->getLinkTarget($this, $this->getStandardCmd()),
                "",
                $this->slot_request->getRefId()
            );
        }
    }

References ilObject2GUI\$locator, ilLocatorGUI\addItem(), ilObject2GUI\getCreationMode(), and ILIAS\Repository\object().

Here is the call graph for this function:

◆ addPermissionTab()

ilObjectPluginGUI::addPermissionTab ( )

Definition at line 382 of file class.ilObjectPluginGUI.php.

                                      : void
    {
        $ilAccess = $this->access;
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
 
        // edit permissions
        if ($ilAccess->checkAccess('edit_permission', "", $this->object->getRefId())) {
            $ilTabs->addTarget(
                "perm_settings",
                $ilCtrl->getLinkTargetByClass("ilpermissiongui", "perm"),
                ["perm", "info", "owner"],
                'ilpermissiongui'
            );
        }
    }

References ilObject2GUI\$access, ilObject2GUI\$ctrl, and $tabs.

◆ afterSave()

ilObjectPluginGUI::afterSave ( ilObject $new_object )

protected

Post (successful) object creation hook.

Reimplemented from ilObjectGUI.

Definition at line 344 of file class.ilObjectPluginGUI.php.

                                                      : void
    {
        $ilCtrl = $this->ctrl;
        // always send a message
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("object_added"), true);
 
        $ilCtrl->setTargetScript('ilias.php');
        $ilCtrl->setParameterByClass(get_class($this), "ref_id", $new_object->getRefId());
        $ilCtrl->redirectByClass(["ilobjplugindispatchgui", get_class($this)], $this->getAfterCreationCmd());
    }

References ilObject2GUI\$ctrl, getAfterCreationCmd(), ilObject\getRefId(), ILIAS\Repository\lng(), and ilCtrl\setTargetScript().

Here is the call graph for this function:

◆ executeCommand()

ilObjectPluginGUI::executeCommand ( )

execute command

Reimplemented from ilObject2GUI.

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

                                    : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $ilAccess = $this->access;
        $lng = $this->lng;
        $ilNavigationHistory = $this->nav_history;
        $ilTabs = $this->tabs;
 
        // get standard template (includes main menu and general layout)
        $tpl->loadStandardTemplate();
 
        // set title
        if (!$this->getCreationMode()) {
            $tpl->setTitle($this->object->getTitle());
            $tpl->setTitleIcon(ilObject::_getIcon($this->object->getId()));
 
            // set tabs
            if (strtolower($this->slot_request->getBaseClass()) !== "iladministrationgui") {
                $this->setTabs();
                $this->setLocator();
            } else {
                $this->addAdminLocatorItems();
                $tpl->setLocator();
                $this->setAdminTabs();
            }
 
            if ($ilAccess->checkAccess('read', '', $this->object->getRefId())) {
                $ilNavigationHistory->addItem(
                    $this->object->getRefId(),
                    ilLink::_getLink($this->object->getRefId(), $this->object->getType()),
                    $this->object->getType()
                );
            }
        } else {
            // show info of parent
            $tpl->setTitle($this->lookupParentTitleInCreationMode());
            $tpl->setTitleIcon(
                ilObject::_getIcon(ilObject::_lookupObjId(
                    $this->slot_request->getRefId()
                ), "big"),
                $lng->txt("obj_" . ilObject::_lookupType(
                    $this->slot_request->getRefId(),
                    true
                ))
            );
            $this->setLocator();
        }
 
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        switch ($next_class) {
            case "ilinfoscreengui":
                $this->checkPermission("visible");
                $this->infoScreen();    // forwards command
                break;
 
            case 'ilpermissiongui':
                $perm_gui = new ilPermissionGUI($this);
                $ilTabs->setTabActive("perm_settings");
                $ilCtrl->forwardCommand($perm_gui);
                break;
 
            case 'ilobjectcopygui':
                $cp = new ilObjectCopyGUI($this);
                $cp->setType($this->getType());
                $this->ctrl->forwardCommand($cp);
                break;
 
            case 'ilexportgui':
                // only if plugin supports it?
                $this->tabs->setTabActive("export");
                $exp = new ilExportGUI($this);
                $exp->addFormat('xml');
                $this->ctrl->forwardCommand($exp);
                break;
 
            case 'illearningprogressgui':
                $user_id = $this->user->getId();
                if ($this->slot_request->getUserId() > 0 && $this->access->checkAccess(
                    'write',
                    "",
                    $this->object->getRefId()
                )) {
                    $user_id = $this->slot_request->getUserId();
                }
                $ilTabs->setTabActive("learning_progress");
                $new_gui = new ilLearningProgressGUI(
                    ilLearningProgressBaseGUI::LP_CONTEXT_REPOSITORY,
                    $this->object->getRefId(),
                    $user_id
                );
                $this->ctrl->forwardCommand($new_gui);
                break;
            case 'ilcommonactiondispatchergui':
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;
            default:
                if ($cmd === "save" || $this->getCreationMode()) {
                    $this->$cmd();
                    return;
                }
                if (!$cmd) {
                    $cmd = $this->getStandardCmd();
                }
                if ($cmd === "infoScreen") {
                    $ilCtrl->setCmd("showSummary");
                    $ilCtrl->setCmdClass("ilinfoscreengui");
                    $this->infoScreen();
                } else {
                    $this->performCommand($cmd);
                }
                break;
        }
 
        if (!$this->getCreationMode()) {
            $tpl->printToStdout();
        }
    }

References ilObject2GUI\$access, ilObject2GUI\$ctrl, ilObject2GUI\$lng, $nav_history, $tabs, ilObject2GUI\$tpl, ilObject\_getIcon(), ilLink\_getLink(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilObject2GUI\addAdminLocatorItems(), ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), ilObject2GUI\getCreationMode(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getStandardCmd(), ilObject2GUI\getType(), infoScreen(), ilGlobalTemplateInterface\loadStandardTemplate(), lookupParentTitleInCreationMode(), ilLearningProgressBaseGUI\LP_CONTEXT_REPOSITORY, ILIAS\Repository\object(), performCommand(), ilGlobalTemplateInterface\printToStdout(), ilObjectGUI\setAdminTabs(), ilObject2GUI\setLocator(), ilGlobalTemplateInterface\setLocator(), ilObject2GUI\setTabs(), ilGlobalTemplateInterface\setTitle(), ilGlobalTemplateInterface\setTitleIcon(), ILIAS\Repository\tabs(), ilLanguage\txt(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ getAfterCreationCmd()

ilObjectPluginGUI::getAfterCreationCmd ( )

abstract

Cmd that will be redirected to after creation of a new object.

Referenced by afterSave().

Here is the caller graph for this function:

◆ getCreationFormTitle()

ilObjectPluginGUI::getCreationFormTitle ( int $a_form_type )

protected

Use custom creation form titles.

Definition at line 218 of file class.ilObjectPluginGUI.php.

                                                             : string
    {
        switch ($a_form_type) {
            case self::CFORM_NEW:
                return $this->txt($this->getType() . "_new");
 
            case self::CFORM_IMPORT:
                return $this->lng->txt("import");
 
            case self::CFORM_CLONE:
                return $this->txt("objs_" . $this->getType() . "_duplicate");
        }
        return "";
    }

References ilObjectGUI\CFORM_CLONE, ilObjectGUI\CFORM_IMPORT, ilObjectGUI\CFORM_NEW, ilObject2GUI\getType(), ILIAS\Repository\lng(), and txt().

Here is the call graph for this function:

◆ getPlugin()

ilObjectPluginGUI::getPlugin ( )

protected

Get plugin object.

Exceptions

ilPluginException

Definition at line 202 of file class.ilObjectPluginGUI.php.

                                  : ilPlugin
    {
        if (!$this->plugin) {
            $this->plugin = $this->component_factory->getPlugin($this->getType());
        }
        return $this->plugin;
    }

References $plugin, and ilObject2GUI\getType().

Referenced by supportsExport(), and txt().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStandardCmd()

ilObjectPluginGUI::getStandardCmd ( )

abstract

Referenced by executeCommand().

Here is the caller graph for this function:

◆ infoScreen()

ilObjectPluginGUI::infoScreen ( )

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

                                : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;
 
        $ilTabs->activateTab("info_short");
 
        $this->checkPermission("visible");
 
        $info = new ilInfoScreenGUI($this);
        $info->enablePrivateNotes();
 
        // general information
        $lng->loadLanguageModule("meta");
 
        $this->addInfoItems($info);
 
        // forward the command
        $ilCtrl->forwardCommand($info);
    }

References ilObject2GUI\$ctrl, ilObject2GUI\$lng, $tabs, ilTabsGUI\activateTab(), addInfoItems(), ilObject2GUI\checkPermission(), and ilLanguage\loadLanguageModule().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreateForm()

ilObjectPluginGUI::initCreateForm ( string $new_type )

protected

Init object creation form.

Reimplemented from ilObjectGUI.

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

                                                       : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setTarget("_top");
        $form->setFormAction($this->ctrl->getFormAction($this, "save"));
        $form->setTitle($this->txt($new_type . "_new"));
 
        // title
        $ti = new ilTextInputGUI($this->lng->txt("title"), "title");
        $ti->setSize(min(40, ilObject::TITLE_LENGTH));
        $ti->setMaxLength(ilObject::TITLE_LENGTH);
        $ti->setRequired(true);
        $form->addItem($ti);
 
        // description
        $ta = new ilTextAreaInputGUI($this->lng->txt("description"), "desc");
        $ta->setCols(40);
        $ta->setRows(2);
        $form->addItem($ta);
 
        $form->addCommandButton("save", $this->txt($new_type . "_add"));
        $form->addCommandButton("cancel", $this->lng->txt("cancel"));
 
        return $form;
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilObject\TITLE_LENGTH, and txt().

Referenced by initCreationForms().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreationForms()

ilObjectPluginGUI::initCreationForms ( string $new_type )

protected

Init creation forms this will create the default creation forms: new, import, clone.

Reimplemented from ilObject2GUI.

Definition at line 237 of file class.ilObjectPluginGUI.php.

                                                          : array
    {
        $forms = [];
        $forms[self::CFORM_NEW] = $this->initCreateForm($new_type);
 
        if ($this->supportsExport()) {
            $forms[self::CFORM_IMPORT] = $this->initImportForm($new_type);
        }
        if ($this->supportsCloning()) {
            $forms[self::CFORM_CLONE] = $this->fillCloneTemplate(null, $new_type);
        }
 
        return $forms;
    }

References ilObjectGUI\CFORM_CLONE, ilObjectGUI\CFORM_IMPORT, ilObjectGUI\CFORM_NEW, ilObject2GUI\fillCloneTemplate(), initCreateForm(), initImportForm(), supportsCloning(), and supportsExport().

Here is the call graph for this function:

◆ initEditForm()

ilObjectPluginGUI::initEditForm ( )

protected

Init object update form.

Reimplemented from ilObjectGUI.

Definition at line 292 of file class.ilObjectPluginGUI.php.

                                     : ilPropertyFormGUI
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        $form = new ilPropertyFormGUI();
        $form->setTarget("_top");
        $form->setFormAction($ilCtrl->getFormAction($this, "update"));
        $form->setTitle($lng->txt("edit"));
 
        // title
        $ti = new ilTextInputGUI($lng->txt("title"), "title");
        $ti->setSize(min(40, ilObject::TITLE_LENGTH));
        $ti->setMaxLength(ilObject::TITLE_LENGTH);
        $ti->setRequired(true);
        $form->addItem($ti);
 
        // description
        $ta = new ilTextAreaInputGUI($lng->txt("description"), "desc");
        $ta->setCols(40);
        $ta->setRows(2);
        $form->addItem($ta);
 
        $form->addCommandButton("update", $lng->txt("save"));
        // $this->form->addCommandButton("cancelUpdate", $lng->txt("cancel"));
 
        return $form;
    }

References ilObject2GUI\$ctrl, ilObject2GUI\$lng, ilObject\TITLE_LENGTH, and ilLanguage\txt().

Here is the call graph for this function:

◆ initImportForm()

ilObjectPluginGUI::initImportForm ( string $new_type )

protected

Init object import form.

Parameters

string new type

Returns: ilPropertyFormGUI

Reimplemented from ilObjectGUI.

Definition at line 326 of file class.ilObjectPluginGUI.php.

                                                       : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setTarget("_top");
        $form->setFormAction($this->ctrl->getFormAction($this, "importFile"));
        $form->setTitle($this->lng->txt("import"));
 
        $fi = new ilFileInputGUI($this->lng->txt("import_file"), "importfile");
        $fi->setSuffixes(["zip"]);
        $fi->setRequired(true);
        $form->addItem($fi);
 
        $form->addCommandButton("importFile", $this->lng->txt("import"));
        $form->addCommandButton("cancel", $this->lng->txt("cancel"));
 
        return $form;
    }

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

Referenced by initCreationForms().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupParentTitleInCreationMode()

ilObjectPluginGUI::lookupParentTitleInCreationMode ( )

protected

Reimplemented in ilOrgUnitExtensionGUI.

Definition at line 499 of file class.ilObjectPluginGUI.php.

                                                        : string
    {
        return ilObject::_lookupTitle(ilObject::_lookupObjId(
            $this->slot_request->getRefId()
        ));
    }

References ilObject\_lookupObjId(), and ilObject\_lookupTitle().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ performCommand()

ilObjectPluginGUI::performCommand ( string $cmd )

abstract

Referenced by executeCommand().

Here is the caller graph for this function:

◆ supportsCloning()

ilObjectPluginGUI::supportsCloning ( )

protected

Returns: bool returns true if this plugin object supports cloning

Reimplemented in ilOrgUnitExtensionGUI.

Definition at line 255 of file class.ilObjectPluginGUI.php.

                                        : bool
    {
        return true;
    }

Referenced by initCreationForms().

Here is the caller graph for this function:

◆ supportsExport()

ilObjectPluginGUI::supportsExport ( )

protected

Reimplemented in ilOrgUnitExtensionGUI.

Definition at line 492 of file class.ilObjectPluginGUI.php.

                                       : bool
    {
        $component_repository = $this->component_repository;
 
        return $component_repository->getPluginSlotById("robj")->getPluginByName($this->getPlugin()->getPluginName())->supportsExport();
    }

References $component_repository, getPlugin(), and ilComponentRepository\getPluginSlotById().

Referenced by initCreationForms().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ txt()

ilObjectPluginGUI::txt ( string $a_var )

finalprotected

Definition at line 210 of file class.ilObjectPluginGUI.php.

                                               : string
    {
        return $this->getPlugin()->txt($a_var);
    }

References getPlugin().

Referenced by getCreationFormTitle(), and initCreateForm().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $component_factory

ilComponentFactory ilObjectPluginGUI::$component_factory

protected

Definition at line 32 of file class.ilObjectPluginGUI.php.

◆ $component_repository

ilComponentRepository ilObjectPluginGUI::$component_repository

protected

Definition at line 27 of file class.ilObjectPluginGUI.php.

Referenced by supportsExport().

◆ $nav_history

ilNavigationHistory ilObjectPluginGUI::$nav_history

protected

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

Referenced by executeCommand().

◆ $plugin

ilPlugin ilObjectPluginGUI::$plugin = null

protected

Definition at line 30 of file class.ilObjectPluginGUI.php.

Referenced by getPlugin().

◆ $slot_request

PluginSlotGUIRequest ilObjectPluginGUI::$slot_request

protected

Definition at line 31 of file class.ilObjectPluginGUI.php.

◆ $tabs

ilTabsGUI ilObjectPluginGUI::$tabs

protected

Definition at line 29 of file class.ilObjectPluginGUI.php.

Referenced by addInfoTab(), addInilPluginAdminfoTab(), addPermissionTab(), executeCommand(), and infoScreen().

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

Services/Repository/PluginSlot/class.ilObjectPluginGUI.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _goto()

◆ addExportTab()

◆ addInfoItems()

◆ addInfoTab()

◆ addInilPluginAdminfoTab()

◆ addLocatorItems()

◆ addPermissionTab()

◆ afterSave()

◆ executeCommand()

◆ getAfterCreationCmd()

◆ getCreationFormTitle()

◆ getPlugin()

◆ getStandardCmd()

◆ infoScreen()

◆ initCreateForm()

◆ initCreationForms()

◆ initEditForm()

◆ initImportForm()

◆ lookupParentTitleInCreationMode()

◆ performCommand()

◆ supportsCloning()

◆ supportsExport()

◆ txt()

Field Documentation

◆ $component_factory

◆ $component_repository

◆ $nav_history

◆ $plugin

◆ $slot_request

◆ $tabs