User Interface class for item groups. More...

Inheritance diagram for ilObjItemGroupGUI:

Collaboration diagram for ilObjItemGroupGUI:

Public Member Functions
	__construct (int $a_id=0, int $a_id_type=self::REPOSITORY_NODE_ID, int $a_parent_node_id=0)

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

	executeCommand ()
	execute command More...

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

	edit ()

	listMaterials ()

	getCreatableObjectTypes ()

	saveItemAssignment ()

	getTemplate ()

	gotoParent ()

	afterSaveCallback (ilObject $a_obj)
	Custom callback after object is created (in parent container) More...

	save ()

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] 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	_goto (string $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
	afterConstructor ()
	Do anything that should be done after constructor in here. More...

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

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

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

	setSettingsSubTabs (string $active_tab="general")

	getEditFormCustomValues (array &$a_values)
	Get edit form values (custom part) More...

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

	initCreateForm (string $new_type)

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

	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
ILIAS ItemGroup InternalGUIService	$gui

StandardGUIRequest	$ig_request

ilTabsGUI	$tabs

ilHelpGUI	$help

Protected Attributes inherited from ilObject2GUI
ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ilFavouritesManager	$favourites

ilErrorHandling	$error

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilToolbarGUI	$toolbar

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 = ""

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	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]

Detailed Description

User Interface class for item groups.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ilObjItemGroupGUI: ilPermissionGUI, ilDidacticTemplateGUI @ilCtrl_Calls ilObjItemGroupGUI: ilCommonActionDispatcherGUI, ilObjectCopyGUI, @ilCtrl_Calls ilObjItemGroupGUI: ILIAS\ILIASObject\Properties\Translations\TranslationGUI, @ilCtrl_isCalledBy ilObjItemGroupGUI: ilRepositoryGUI, ilAdministrationGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjItemGroupGUI::__construct	(	int	$a_id = `0`,
		int	$a_id_type = `self::REPOSITORY_NODE_ID`,
		int	$a_parent_node_id = `0`
	)

Reimplemented from ilObject2GUI.

Definition at line 37 of file class.ilObjItemGroupGUI.php.

      {
        global $DIC;
        parent::__construct($a_id, $a_id_type, $a_parent_node_id);
 
        $this->lng = $DIC->language();
        $this->tabs = $DIC->tabs();
        $this->access = $DIC->access();
        $this->tpl = $DIC["tpl"];
        $this->ctrl = $DIC->ctrl();
        $this->locator = $DIC["ilLocator"];
        $this->tree = $DIC->repositoryTree();
        $this->help = $DIC["ilHelp"];
        $this->gui = $DIC->itemGroup()->internal()->gui();
        $this->ig_request = $this->gui
            ->standardRequest();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\locator(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

Member Function Documentation

◆ _goto()

static ilObjItemGroupGUI::_goto ( string $a_target )

static

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

                                                  : void
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();
 
        $ilAccess = $DIC->access();
        $lng = $DIC->language();
        $tree = $DIC->repositoryTree();
 
        $targets = explode('_', $a_target);
        $ref_id = $targets[0];
        $par_id = $tree->getParentId($ref_id);
 
        if ($ilAccess->checkAccess("read", "", $par_id)) {
            ilUtil::redirect(ilLink::_getLink($par_id));
            exit;
        } elseif ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
            $main_tpl->setOnScreenMessage('failure', sprintf(
                $lng->txt("msg_no_perm_read_item"),
                ilObject::_lookupTitle(ilObject::_lookupObjId($a_target))
            ), true);
            ilObjectGUI::_gotoRepositoryRoot();
        }
 
        throw new ilPermissionException($lng->txt("msg_no_perm_read"));
    }

References $DIC, ilObject2GUI\$lng, ilObjectGUI\$ref_id, ilObjectGUI\$tree, ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), exit, ilTree\getParentId(), ilUtil\redirect(), ROOT_FOLDER_ID, and ilLanguage\txt().

Here is the call graph for this function:

◆ addLocatorItems()

ilObjItemGroupGUI::addLocatorItems ( )

Functions to be overwritten.

Reimplemented from ilObject2GUI.

Definition at line 128 of file class.ilObjItemGroupGUI.php.

                                     : void
    {
        $ilLocator = $this->locator;
        $ilAccess = $this->access;
 
        if (is_object($this->object) && $ilAccess->checkAccess("write", "", $this->object->getRefId())) {
            $ilLocator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, "listMaterials"), "", $this->requested_ref_id);
        }
    }

References ilObject2GUI\$access, ilObject2GUI\$locator, and ILIAS\Repository\object().

Here is the call graph for this function:

◆ afterConstructor()

ilObjItemGroupGUI::afterConstructor ( )

protected

Do anything that should be done after constructor in here.

Reimplemented from ilObject2GUI.

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

                                         : void
    {
        $lng = $this->lng;
 
        $lng->loadLanguageModule("itgr");
        $this->ctrl->saveParameter($this, array("ref_id"));
    }

References ilObject2GUI\$lng, ILIAS\Repository\ctrl(), and ilLanguage\loadLanguageModule().

Here is the call graph for this function:

◆ afterSaveCallback()

ilObjItemGroupGUI::afterSaveCallback ( ilObject $a_obj )

Custom callback after object is created (in parent container)

Definition at line 391 of file class.ilObjItemGroupGUI.php.

                                                      : void
    {
        // add new object to materials
        $items = new ilItemGroupItems($this->object->getRefId());
        $items->addItem($a_obj->getRefId());
        $items->update();
    }

References ilObject\getRefId(), and ILIAS\Repository\object().

Here is the call graph for this function:

◆ afterUpdate()

ilObjItemGroupGUI::afterUpdate ( )

protected

Post (successful) object update hook.

Reimplemented from ilObjectGUI.

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

                                    : void
    {
        // check if template is changed
        $current_tpl_id = ilDidacticTemplateObjSettings::lookupTemplateId(
            $this->object->getRefId()
        );
        $new_tpl_id = $this->getDidacticTemplateVar('dtpl');
 
        if ($new_tpl_id !== $current_tpl_id) {
            $this->ctrl->setParameterByClass(ilDidacticTemplateGUI::class, "didactic_type", $new_tpl_id);
            $this->ctrl->redirectByClass(ilDidacticTemplateGUI::class, "confirmTemplateSwitch");
            return;
        }
        parent::afterUpdate();
    }

References ILIAS\Repository\ctrl(), ilObjectGUI\getDidacticTemplateVar(), ilDidacticTemplateObjSettings\lookupTemplateId(), and ILIAS\Repository\object().

Here is the call graph for this function:

◆ edit()

ilObjItemGroupGUI::edit ( )

Reimplemented from ilObject2GUI.

Definition at line 190 of file class.ilObjItemGroupGUI.php.

                          : void
    {
        if (!$this->checkPermissionBool("write")) {
            $this->error->raiseError($this->lng->txt("msg_no_perm_write"), $this->error->MESSAGE);
        }
 
        $this->tabs_gui->activateTab("settings");
 
        $form = $this->initEditForm();
        $values = $this->getEditFormValues();
        if ($values) {
            $form->setValuesByArray($values, true);
        }
 
        $this->addExternalEditFormCustom($form);
 
        $this->tpl->setContent($form->getHTML());
        $this->setSettingsSubTabs("general");
    }

References ilObjectGUI\addExternalEditFormCustom(), ilObject2GUI\checkPermissionBool(), error(), ilObjectGUI\getEditFormValues(), ilObjectGUI\initEditForm(), ILIAS\Repository\lng(), and setSettingsSubTabs().

Here is the call graph for this function:

◆ executeCommand()

ilObjItemGroupGUI::executeCommand ( )

execute command

Reimplemented from ilObject2GUI.

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

                                    : void
    {
        $ilTabs = $this->tabs;
        $next_class = $this->ctrl->getNextClass($this);
 
        switch ($next_class) {
            case 'ilpermissiongui':
                $this->prepareOutput();
                $ilTabs->activateTab("perm_settings");
                $this->addHeaderAction();
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
 
            case "ilcommonactiondispatchergui":
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;
 
            case strtolower(TranslationGUI::class):
                $this->checkPermissionBool("write");
                $this->prepareOutput();
                $this->setSettingsSubTabs("settings_trans");
                $transgui = new TranslationGUI(
                    $this->getObject(),
                    $this->lng,
                    $this->access,
                    $this->user,
                    $this->ctrl,
                    $this->tpl,
                    $this->ui_factory,
                    $this->ui_renderer,
                    $this->http,
                    $this->refinery,
                    $this->toolbar
                );
                $transgui->supportContentTranslation(false);
                $this->ctrl->forwardCommand($transgui);
                break;
 
            case 'ildidactictemplategui':
                $this->checkPermissionBool("write");
                $this->prepareOutput();
                $this->ctrl->setReturn($this, 'edit');
                $did = new ilDidacticTemplateGUI($this, $this->ig_request->getDidactivTemplateId());
                $this->ctrl->forwardCommand($did);
                break;
 
            default:
                $cmd = $this->ctrl->getCmd("listMaterials");
                $this->prepareOutput();
                $this->addHeaderAction();
                $this->$cmd();
                break;
        }
    }

References $gui, $tabs, ILIAS\Repository\access(), ilObjectGUI\addHeaderAction(), ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), ilObjectGUI\getObject(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilObject2GUI\prepareOutput(), ILIAS\Repository\refinery(), setSettingsSubTabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ getCreatableObjectTypes()

ilObjItemGroupGUI::getCreatableObjectTypes ( )

Reimplemented from ilObjectGUI.

Definition at line 254 of file class.ilObjItemGroupGUI.php.

                                             : array
    {
        $parent_ref_id = $this->tree->getParentId($this->object->getRefId());
        $parent_type = ilObject::_lookupType($parent_ref_id, true);
        $parent_gui_class = 'ilObj' . $this->obj_definition->getClassName($parent_type) . 'GUI';
        $parent_gui = new $parent_gui_class('', $parent_ref_id, true, false);
        $types = $parent_gui->getCreatableObjectTypes();
        foreach (array_merge(['itgr', 'sess' ], $this->obj_definition->getSideBlockTypes()) as $type_to_remove) {
            unset($types[$type_to_remove]);
        }
        return $types;
    }

References ilObject\_lookupType(), and ILIAS\Repository\object().

Referenced by listMaterials().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEditFormCustomValues()

ilObjItemGroupGUI::getEditFormCustomValues ( array & $a_values )

protected

Get edit form values (custom part)

Reimplemented from ilObjectGUI.

Definition at line 402 of file class.ilObjItemGroupGUI.php.

                                                                : void
    {
        $a_values["show_title"] = !$this->object->getHideTitle();
        $a_values["behaviour"] = $this->object->getBehaviour();
        $a_values["list_presentation"] = $this->object->getListPresentation();
        $a_values["tile_size"] = $this->object->getTileSize();
    }

◆ getTemplate()

ilObjItemGroupGUI::getTemplate ( )

Definition at line 282 of file class.ilObjItemGroupGUI.php.

                                 : void
    {
        $this->tpl->loadStandardTemplate();
    }

◆ getType()

ilObjItemGroupGUI::getType ( )

final

Functions that must be overwritten.

Reimplemented from ilObject2GUI.

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

                                   : string
    {
        return "itgr";
    }

◆ gotoParent()

ilObjItemGroupGUI::gotoParent ( )

Definition at line 374 of file class.ilObjItemGroupGUI.php.

                                : void
    {
        $ilAccess = $this->access;
        $tree = $this->tree;
 
        $ref_id = $this->object->getRefId();
        $par_id = $tree->getParentId($ref_id);
 
        if ($ilAccess->checkAccess("read", "", $par_id)) {
            ilUtil::redirect(ilLink::_getLink($par_id));
            exit;
        }
    }

References ilObject2GUI\$access, ilObjectGUI\$ref_id, ilObjectGUI\$tree, exit, ilTree\getParentId(), and ilUtil\redirect().

Here is the call graph for this function:

◆ initCreateForm()

ilObjItemGroupGUI::initCreateForm ( string $new_type )

protected

Reimplemented from ilObjectGUI.

Definition at line 421 of file class.ilObjItemGroupGUI.php.

                                                       : \ILIAS\UI\Component\Input\Container\Form\Standard
    {
        $object = $this->getObject();
        if ($object === null) {
            $object = new ilObject();
        }
        $form_fields['title'] = $this->ui_factory->input()->field()->text($this->lng->txt('title'))
            ->withMaxLength(ilObject::TITLE_LENGTH)
            ->withRequired(true);
 
        $didactic_templates = $this->didacticTemplatesToForm();
 
        if ($didactic_templates !== null) {
            $form_fields['didactic_templates'] = $didactic_templates;
        }
 
        return $this->ui_factory->input()->container()->form()->standard(
            $this->ctrl->getFormAction($this, 'save'),
            $form_fields
        )->withSubmitLabel($this->lng->txt($new_type . '_add'));
    }

References ilObjectGUI\$object, ILIAS\Repository\ctrl(), ilObjectGUI\didacticTemplatesToForm(), ilObjectGUI\getObject(), ILIAS\Repository\lng(), and ilObject\TITLE_LENGTH.

Referenced by save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initEditCustomForm()

ilObjItemGroupGUI::initEditCustomForm ( ilPropertyFormGUI $a_form )

protected

Add custom fields to update form.

Reimplemented from ilObjectGUI.

Definition at line 138 of file class.ilObjItemGroupGUI.php.

                                                                  : void
    {
        $form->removeItemByPostVar("desc");
 
        // Show didactic template type
        $this->initDidacticTemplate($form);
 
        // presentation
        $pres = new ilFormSectionHeaderGUI();
        $pres->setTitle($this->lng->txt('obj_presentation'));
        $form->addItem($pres);
 
        // show title
        $cb = new ilCheckboxInputGUI($this->lng->txt("itgr_show_title"), "show_title");
        $cb->setInfo($this->lng->txt("itgr_show_title_info"));
        $form->addItem($cb);
 
        // behaviour
        $options = ilItemGroupBehaviour::getAll();
        $si = new ilSelectInputGUI($this->lng->txt("itgr_behaviour"), "behaviour");
        $si->setInfo($this->lng->txt("itgr_behaviour_info"));
        $si->setOptions($options);
        $cb->addSubItem($si);
 
        // tile/list
        $lpres = new ilRadioGroupInputGUI($this->lng->txt('itgr_list_presentation'), "list_presentation");
 
        $std_list = new ilRadioOption($this->lng->txt('itgr_list_default'), "");
        $std_list->setInfo($this->lng->txt('itgr_list_default_info'));
        $lpres->addOption($std_list);
 
        $item_list = new ilRadioOption($this->lng->txt('itgr_list'), "list");
        $lpres->addOption($item_list);
 
        $tile_view = new ilRadioOption($this->lng->txt('itgr_tile'), "tile");
        $lpres->addOption($tile_view);
 
        // tile size
        $si = new ilRadioGroupInputGUI($this->lng->txt("itgr_tile_size"), "tile_size");
        $dummy_container = new ilContainer();
        $this->lng->loadLanguageModule("cont");
        foreach ($dummy_container->getTileSizes() as $key => $txt) {
            $op = new ilRadioOption($txt, $key);
            $si->addOption($op);
        }
        $tile_view->addSubItem($si);
        $si->setValue($this->object->getTileSize());
 
        $lpres->setValue($this->object->getListPresentation());
        $form->addItem($lpres);
    }

References $txt, ilPropertyFormGUI\addItem(), ilItemGroupBehaviour\getAll(), ilObjectGUI\initDidacticTemplate(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilPropertyFormGUI\removeItemByPostVar().

Here is the call graph for this function:

◆ listMaterials()

ilObjItemGroupGUI::listMaterials ( )

Definition at line 226 of file class.ilObjItemGroupGUI.php.

                                   : void
    {
        $tree = $this->tree;
        $ilTabs = $this->tabs;
        $tpl = $this->tpl;
 
        $this->checkPermission("write");
 
        $ilTabs->activateTab("materials");
 
        $parent_ref_id = $tree->getParentId($this->object->getRefId());
        $parent_type = ilObject::_lookupType($parent_ref_id, true);
        $parent_gui_class = 'ilObj' . $this->obj_definition->getClassName($parent_type) . 'GUI';
        $this->ctrl->setParameterByClass($parent_gui_class, 'ref_id', $parent_ref_id);
        $gui = new ILIAS\ILIASObject\Creation\AddNewItemGUI(
            $this->buildAddNewItemElements(
                $this->getCreatableObjectTypes(),
                $parent_gui_class,
                $this->object->getRefId()
            )
        );
        $gui->render();
        $this->ctrl->clearParameterByClass($parent_gui_class, 'ref_id');
 
        $tab = new ilItemGroupItemsTableGUI($this->gui, $this, "listMaterials");
        $tpl->setContent($tab->getHTML());
    }

References $gui, $tabs, ilObject2GUI\$tpl, ilObjectGUI\$tree, ilObject\_lookupType(), ilObjectGUI\buildAddNewItemElements(), ilObject2GUI\checkPermission(), ILIAS\Repository\ctrl(), getCreatableObjectTypes(), ilTree\getParentId(), ILIAS\Repository\object(), and ILIAS\UICore\GlobalTemplate\setContent().

Here is the call graph for this function:

◆ save()

ilObjItemGroupGUI::save ( )

Reimplemented from ilObject2GUI.

Definition at line 443 of file class.ilObjItemGroupGUI.php.

                          : void
    {
        // create permission is already checked in createObject. This check here is done to prevent hacking attempts
        if (!$this->checkPermissionBool("create", "", $this->requested_new_type)) {
            $this->error->raiseError($this->lng->txt("no_create_permission"), $this->error->MESSAGE);
        }
 
        $this->lng->loadLanguageModule($this->requested_new_type);
        $this->ctrl->setParameter($this, "new_type", $this->requested_new_type);
 
        $form = $this->initCreateForm($this->requested_new_type);
        $data = $form->withRequest($this->request)->getData();
        if ($data === null) {
            $this->tpl->setContent($this->getCreationFormsHTML($form));
            return;
        }
 
        $this->ctrl->setParameter($this, 'new_type', '');
 
        $new_obj = new ilObjItemGroup();
        $new_obj->setType($this->requested_new_type);
        $new_obj->processAutoRating();
        $new_obj->setTitle($data['title']);
        $new_obj->create();
 
        $this->putObjectInTree($new_obj);
 
        $dtpl = $data['didactic_templates'] ?? null;
        if ($dtpl !== null) {
            $dtpl_id = $this->parseDidacticTemplateVar($dtpl, 'dtpl');
            $new_obj->applyDidacticTemplate($dtpl_id);
        }
 
        $this->ctrl->setParameterByClass(self::class, 'ref_id', $new_obj->getRefId());
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("object_added"), true);
        $this->ctrl->redirectByClass(self::class, "listMaterials");
    }

References ilObjectGUI\$data, ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), error(), ilObjectGUI\getCreationFormsHTML(), initCreateForm(), ILIAS\Repository\lng(), ilObjectGUI\parseDidacticTemplateVar(), and ilObject2GUI\putObjectInTree().

Here is the call graph for this function:

◆ saveItemAssignment()

ilObjItemGroupGUI::saveItemAssignment ( )

Definition at line 267 of file class.ilObjItemGroupGUI.php.

                                        : void
    {
        $ilCtrl = $this->ctrl;
 
        $this->checkPermission("write");
 
        $item_group_items = new ilItemGroupItems($this->object->getRefId());
        $items = $this->ig_request->getItems();
        $item_group_items->setItems($items);
        $item_group_items->update();
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
        $ilCtrl->redirect($this, "listMaterials");
    }

References ilObject2GUI\$ctrl, ilObject2GUI\checkPermission(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Here is the call graph for this function:

◆ setSettingsSubTabs()

ilObjItemGroupGUI::setSettingsSubTabs ( string $active_tab = "general" )

protected

Definition at line 330 of file class.ilObjItemGroupGUI.php.

                                                                         : void
    {
        $this->tabs_gui->addSubTab(
            "general",
            $this->lng->txt("settings"),
            $this->ctrl->getLinkTarget($this, "edit")
        );
 
        $this->tabs_gui->addSubTab(
            "settings_trans",
            $this->lng->txt("obj_multilinguality"),
            $this->ctrl->getLinkTargetByClass(TranslationGUI::class, "")
        );
        $this->tabs_gui->activateTab("settings");
        $this->tabs_gui->activateSubTab($active_tab);
    }

References ILIAS\Repository\lng().

Referenced by edit(), and executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTabs()

ilObjItemGroupGUI::setTabs ( )

protected

create tabs (repository/workspace switch)

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

Reimplemented from ilObject2GUI.

Definition at line 287 of file class.ilObjItemGroupGUI.php.

                                : void
    {
        $ilAccess = $this->access;
        $ilTabs = $this->tabs;
        $ilHelp = $this->help;
        $lng = $this->lng;
        $tree = $this->tree;
 
        $ilHelp->setScreenIdComponent("itgr");
 
        $parent_ref_id = $tree->getParentId($this->object->getRefId());
        $parent_obj_id = ilObject::_lookupObjId($parent_ref_id);
        $parent_type = ilObject::_lookupType($parent_obj_id);
 
        $ilTabs->setBackTarget(
            $lng->txt('obj_' . $parent_type),
            ilLink::_getLink($parent_ref_id),
            "_top"
        );
 
        if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
            $ilTabs->addTab(
                'materials',
                $lng->txt('itgr_materials'),
                $this->ctrl->getLinkTarget($this, 'listMaterials')
            );
 
            $ilTabs->addTab(
                'settings',
                $lng->txt('settings'),
                $this->ctrl->getLinkTarget($this, 'edit')
            );
        }
 
        if ($ilAccess->checkAccess("edit_permission", "", $this->object->getRefId())) {
            $ilTabs->addTab(
                "perm_settings",
                $lng->txt('perm_settings'),
                $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm")
            );
        }
    }

References ilObject2GUI\$access, $help, ilObject2GUI\$lng, $tabs, ilObjectGUI\$tree, ilObject\_lookupObjId(), ilObject\_lookupType(), ilTree\getParentId(), ILIAS\Repository\object(), and ilLanguage\txt().

Here is the call graph for this function:

◆ updateCustom()

ilObjItemGroupGUI::updateCustom ( ilPropertyFormGUI $form )

protected

Insert custom update form values into object.

Reimplemented from ilObjectGUI.

Definition at line 410 of file class.ilObjItemGroupGUI.php.

                                                            : void
    {
        $this->object->setHideTitle(!$form->getInput("show_title"));
        $behaviour = ($form->getInput("show_title"))
            ? $form->getInput("behaviour")
            : ilItemGroupBehaviour::ALWAYS_OPEN;
        $this->object->setBehaviour($behaviour);
        $this->object->setListPresentation($form->getInput("list_presentation"));
        $this->object->setTileSize($form->getInput("tile_size"));
    }

References ilItemGroupBehaviour\ALWAYS_OPEN, and ilPropertyFormGUI\getInput().

Here is the call graph for this function:

Field Documentation

◆ $gui

ILIAS ItemGroup InternalGUIService ilObjItemGroupGUI::$gui

protected

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

Referenced by executeCommand(), and listMaterials().

◆ $help

ilHelpGUI ilObjItemGroupGUI::$help

protected

Definition at line 35 of file class.ilObjItemGroupGUI.php.

Referenced by setTabs().

◆ $ig_request

StandardGUIRequest ilObjItemGroupGUI::$ig_request

protected

Definition at line 33 of file class.ilObjItemGroupGUI.php.

◆ $tabs

ilTabsGUI ilObjItemGroupGUI::$tabs

protected

Definition at line 34 of file class.ilObjItemGroupGUI.php.

Referenced by executeCommand(), listMaterials(), and setTabs().

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

components/ILIAS/ItemGroup/classes/class.ilObjItemGroupGUI.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _goto()

◆ addLocatorItems()

◆ afterConstructor()

◆ afterSaveCallback()

◆ afterUpdate()

◆ edit()

◆ executeCommand()

◆ getCreatableObjectTypes()

◆ getEditFormCustomValues()

◆ getTemplate()

◆ getType()

◆ gotoParent()

◆ initCreateForm()

◆ initEditCustomForm()

◆ listMaterials()

◆ save()

◆ saveItemAssignment()

◆ setSettingsSubTabs()

◆ setTabs()

◆ updateCustom()

Field Documentation

◆ $gui

◆ $help

◆ $ig_request

◆ $tabs