ilObjCategoryGUI Class Reference

Class ilObjCategoryGUI. More...

Inheritance diagram for ilObjCategoryGUI:

Collaboration diagram for ilObjCategoryGUI:

Public Member Functions
	__construct ( $a_data, int $a_id, bool $a_call_by_reference=true, bool $a_prepare_output=true)
	executeCommand ()
	getObjectMetadataGUI ()
	renderObject ()
	Render category. More...
	viewObject ()
	infoScreenObject ()
	this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed More...
	infoScreen ()
	show information screen More...
	updateObject ()
	listUsersObject (bool $show_delete=false)
	performDeleteUsersObject ()
	deleteUsersObject ()
	assignRolesObject ()
	assignSaveObject ()
Public Member Functions inherited from ilContainerGUI
	executeCommand ()
	forwardToPageObject ()
	addPageTabs ()
	getContainerPageHTML ()
	prepareOutput (bool $show_subobjects=true)
	getContentGUI ()
	renderObject ()
	renderBlockAsynchObject ()
	render the object More...
	setContentSubTabs ()
	showAdministrationPanel ()
	showPermanentLink ()
	editPageFrameObject ()
	cancelPageContentObject ()
	showLinkListObject ()
	clearAdminCommandsDetermination ()
	addHeaderRow (ilTemplate $a_tpl, string $a_type, bool $a_show_image=true)
	addMessageRow (ilTemplate $a_tpl, string $a_message, string $a_type)
	setPageEditorTabs ()
	addStandardContainerSubTabs (bool $a_include_view=true)
	Add standard container subtabs for view, manage, oderdering and text/media editor link. More...
	enableAdministrationPanelObject ()
	disableAdministrationPanelObject ()
	editOrderObject ()
	isActiveOrdering ()
	isActiveItemOrdering ()
	enableMultiDownloadObject ()
	isMultiDownloadEnabled ()
	cutObject ()
	cut object(s) out from a container and write the information to clipboard public More...
	copyObject ()
	Copy object(s) out from a container and write the information to clipboard It is not possible to copy multiple objects at once. More...
	downloadObject ()
	getBucketTitle ()
	linkObject ()
	create an new reference of an object in tree it's like a hard link of unix More...
	clearObject ()
	clear clipboard and go back to last object More...
	performPasteIntoMultipleObjectsObject ()
	initAndDisplayLinkIntoMultipleObjectsObject ()
	showPasteTreeObject ()
	cancelMoveLinkObject ()
	Cancel move|link empty clipboard and return to parent. More...
	keepObjectsInClipboardObject ()
	initAndDisplayCopyIntoMultipleObjectsObject ()
	initAndDisplayMoveIntoObjectObject ()
	pasteObject ()
	paste object from clipboard to current place Depending on the chosen command the object(s) are linked, copied or moved More...
	clipboardObject ()
	isActiveAdministrationPanel ()
	setColumnSettings (ilColumnGUI $column_gui)
	allowBlocksMoving ()
	Standard is to allow blocks moving. More...
	allowBlocksConfigure ()
	Standard is to allow blocks configuration. More...
	cloneAllObject ()
	Clone all object Overwritten method for copying container objects. More...
	saveSortingObject ()
	cloneNodes (int $srcRef, int $dstRef, array &$mapping, string $newName=null)
	Recursively clones all nodes of the RBAC tree. More...
	modifyItemGUI (ilObjectListGUI $a_item_list_gui, array $a_item_data)
	editStylePropertiesObject ()
	getAsynchItemListObject ()
	redrawListItemObject ()
	Redraw a list item (ajax) More...
	trashObject ()
	Show trash content of object. More...
	trashApplyFilterObject ()
	trashResetFilterObject ()
	removeFromSystemObject ()
	undeleteObject ()
	Get objects back from trash. More...
	confirmRemoveFromSystemObject ()
	setSideColumnReturn ()
	getAdminTabs ()
	competencesObject ()
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)
Public Member Functions inherited from ilDesktopItemHandling
	addToDeskObject ()
	Add desktop item public. More...
	removeFromDeskObject ()
	Remove from desktop public. More...

Static Public Member Functions
static	_getImportDir ()
static	_goto (string $a_target)
Static Public Member Functions inherited from ilContainerGUI
static	_buildPath (int $a_ref_id, int $a_course_ref_id)
	build path 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	CONTAINER_SETTING_TAXBLOCK = "tax_sblock_"
Data Fields inherited from ilContainerGUI
int	$bl_cnt = 1
bool	$multi_download_enabled = false
Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
const	ADMIN_MODE_NONE = ""
const	ADMIN_MODE_SETTINGS = "settings"
const	ADMIN_MODE_REPOSITORY = "repository"
const	UPLOAD_TYPE_LOCAL = 1
const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Protected Member Functions
	addHeaderAction ()
	getTabs ()
	initCreationForms (string $new_type)
	afterSave (ilObject $new_object)
	editInfoObject ()
	updateInfoObject ()
	initExtendedSettings ()
	setEditTabs ($active_tab="settings_misc")
	initEditForm ()
	getEditFormValues ()
	resetFilterObject ()
	import categories (static, also called by RootFolderGUI) More...
	applyFilterObject ()
	Apply filter. More...
	addUserAutoCompleteObject ()
	Show auto complete results. More...
	initTaxSubTabs ($a_active="tax_list")
	getTaxonomiesForRefId ()
	getActiveBlocks ()
Protected Member Functions inherited from ilContainerGUI
	getEditFormValues ()
	afterUpdate ()
	setTitleAndDescription ()
	showPossibleSubObjects ()
	supportsPageEditor ()
	getTabs ()
	showContainerPageTabs ()
	showPasswordInstructionObject (bool $a_init=true)
	initFormPasswordInstruction ()
	Init password form. More...
	savePasswordObject ()
	initEditForm ()
	initSortingForm (ilPropertyFormGUI $form, array $a_sorting_settings)
	Append sorting settings to property form. More...
	initListPresentationForm (ilPropertyFormGUI $form)
	Add list presentation settings to form. More...
	saveListPresentation (ilPropertyFormGUI $form)
	initSortingDirectionForm (ilContainerSortingSettings $sorting_settings, ilRadioOption $element, string $a_prefix)
	Add sorting direction. More...
	initManualSortingOptionForm (ilContainerSortingSettings $settings, ilRadioOption $element, string $a_prefix, array $a_sorting_settings)
	Add manual sorting options. More...
	saveSortingSettings (ilPropertyFormGUI $form)
	trashHandleFilter (bool $action_apply, bool $action_reset)
	restoreToNewLocationObject (ilPropertyFormGUI $form=null)
	getTreeSelectorGUI (string $cmd)
	initFilter ()
	showContainerFilter ()
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	assignObject ()
	setTitleAndDescription ()
	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...
	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	setTabs ()
	set admin tabs More...
	setAdminTabs ()
	set admin tabs More...
	setLocator ()
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator (bool $omit=true)
	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms (string $new_type)
	Init creation forms. More...
	getCreationFormsHTML (array $forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm (string $new_type)
	initDidacticTemplate (ilPropertyFormGUI $form)
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm (string $new_type)
	importFileObject (int $parent_id=null)
	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...
	setFormAction (string $cmd, string $form_action)
	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...
	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...
	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...
	getTabs ()
	overwrite in derived GUI class of your object type More...
	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...
	fillCloneTemplate (?string $tpl_name, string $type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	showCustomIconsEditing ( $input_colspan=1, ilPropertyFormGUI $form=null, $as_section=true)
	show edit section of custom icons for container More...

Protected Attributes
ilNavigationHistory	$nav_history
ilHelpGUI	$help
bool	$info_screen_enabled = false
ilObjectGUI	$gui_obj
bool	$creation_mode
ilAdvancedMDRecordGUI	$record_gui
StandardGUIRequest	$cat_request
Protected Attributes inherited from ilContainerGUI
ILIAS Style Content GUIService	$content_style_gui
ilRbacSystem	$rbacsystem
ilRbacReview	$rbacreview
ilTabsGUI	$tabs
ilErrorHandling	$error
ilObjectDefinition	$obj_definition
ilRbacAdmin	$rbacadmin
ilPropertyFormGUI	$form
ilLogger	$log
ilObjectDataCache	$obj_data_cache
Services	$global_screen
ilAppEventHandler	$app_event_handler
UIServices	$ui
ilContainerFilterService	$container_filter_service
ilContainerUserFilter	$container_user_filter = null
Standard	$ui_filter = null
bool	$edit_order = false
bool	$adminCommands = false
string	$requested_redirectSource = ""
int	$current_position = 0
ClipboardManager	$clipboard
StandardGUIRequest	$std_request
ViewManager	$view_manager
ilComponentFactory	$component_factory
ILIAS Style Content DomainService	$content_style_domain
Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service
ServerRequestInterface	$request
ilLocatorGUI	$locator
ilObjUser	$user
ilAccessHandler	$access
ilSetting	$settings
ilToolbarGUI	$toolbar
ilRbacAdmin	$rbac_admin
ilRbacSystem	$rbac_system
ilRbacReview	$rbac_review
ilObjectService	$object_service
ilObjectDefinition	$obj_definition
ilGlobalTemplateInterface	$tpl
ilTree	$tree
ilCtrl	$ctrl
ilErrorHandling	$error
ilLanguage	$lng
ilTabsGUI	$tabs_gui
ILIAS	$ilias
ArrayBasedRequestWrapper	$post_wrapper
RequestWrapper	$request_wrapper
Factory	$refinery
ilFavouritesManager	$favourites
ilObjectCustomIconFactory	$custom_icon_factory
ilObject	$object = null
bool	$creation_mode = false
	$data
int	$id
bool	$call_by_reference = false
bool	$prepare_output
int	$ref_id
int	$obj_id
int	$maxcount
array	$form_action = []
array	$return_location = []
array	$target_frame = []
string	$tmp_import_dir
string	$sub_objects = ""
bool	$omit_locator = false
string	$type = ""
string	$admin_mode = self::ADMIN_MODE_NONE
int	$requested_ref_id = 0
int	$requested_crtptrefid = 0
int	$requested_crtcb = 0
string	$requested_new_type = ""
string	$link_params
string	$html = ""

Private Member Functions
	getAssignableRoles ()
	checkGlobalRoles ($new_assigned)

Detailed Description

Class ilObjCategoryGUI.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de

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

ilObjCategoryGUI: ilPermissionGUI, ilContainerPageGUI, ilObjUserGUI, ilObjUserFolderGUI ilObjCategoryGUI: ilInfoScreenGUI, ilObjStyleSheetGUI, ilCommonActionDispatcherGUI, ilObjectTranslationGUI, ilObjectContentStyleSettingsGUI ilObjCategoryGUI: ilColumnGUI, ilObjectCopyGUI, ilUserTableGUI, ilDidacticTemplateGUI, ilExportGUI ilObjCategoryGUI: ilObjTaxonomyGUI, ilObjectMetaDataGUI, ilContainerNewsSettingsGUI, ilContainerFilterAdminGUI ilObjCategoryGUI: ilRepositoryTrashGUI

Definition at line 36 of file class.ilObjCategoryGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjCategoryGUI::__construct	(		$a_data,
		int	$a_id,
		bool	$a_call_by_reference = true,
		bool	$a_prepare_output = true
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilContainer\_lookupContainerSetting(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, ILIAS\Repository\lng(), ILIAS\Repository\object(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

      {
        global $DIC;

        $this->rbacsystem = $DIC->rbac()->system();
        $this->nav_history = $DIC["ilNavigationHistory"];
        $this->access = $DIC->access();
        $this->ctrl = $DIC->ctrl();
        $this->tabs = $DIC->tabs();
        $this->help = $DIC["ilHelp"];
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->tree = $DIC->repositoryTree();
        $this->error = $DIC["ilErr"];
        $this->settings = $DIC->settings();
        $this->tpl = $DIC["tpl"];
        $this->toolbar = $DIC->toolbar();
        $this->rbacreview = $DIC->rbac()->review();
        $this->rbacadmin = $DIC->rbac()->admin();

        $this->lng->loadLanguageModule('cat');
        $this->lng->loadLanguageModule('obj');

        $this->type = "cat";
        parent::__construct($a_data, $a_id, $a_call_by_reference, false);

        if (is_object($this->object)) {
            $this->info_screen_enabled = (bool) ilContainer::_lookupContainerSetting(
                $this->object->getId(),
                ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY,
                '1'
            );
        }
        $this->cat_request = $DIC
            ->category()
            ->internal()
            ->gui()
            ->standardRequest();
    }

Here is the call graph for this function:

Member Function Documentation

_getImportDir()

static ilObjCategoryGUI::_getImportDir ( )

static

Definition at line 879 of file class.ilObjCategoryGUI.php.

References ilFileUtils\getDataDir().

                                          : string
    {
        return ilFileUtils::getDataDir() . "/cat_import";
    }

Here is the call graph for this function:

_goto()

static ilObjCategoryGUI::_goto ( string  $a_target )

static

Definition at line 1185 of file class.ilObjCategoryGUI.php.

References $DIC, $ilErr, ilObjectGUI\$lng, ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ROOT_FOLDER_ID, and ilLanguage\txt().

Referenced by ilObjCategoryReferenceGUI\_goto().

                                                  : void
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();

        $ilAccess = $DIC->access();
        $ilErr = $DIC["ilErr"];
        $lng = $DIC->language();
        if ($ilAccess->checkAccess("read", "", (int) $a_target)) {
            ilObjectGUI::_gotoRepositoryNode((int) $a_target);
        } elseif ($ilAccess->checkAccess("visible", "", (int) $a_target)) {
            ilObjectGUI::_gotoRepositoryNode((int) $a_target, "infoScreen");
        } elseif ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
            $main_tpl->setOnScreenMessage('failure', sprintf(
                $lng->txt("msg_no_perm_read_item"),
                ilObject::_lookupTitle(ilObject::_lookupObjId((int) $a_target))
            ), true);
            ilObjectGUI::_gotoRepositoryRoot();
        }

        $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addHeaderAction()

ilObjCategoryGUI::addHeaderAction ( )

protected

Definition at line 324 of file class.ilObjCategoryGUI.php.

References ilPreviewGUI\initPreview().

Referenced by executeCommand().

                                        : void
    {
        ilPreviewGUI::initPreview();
        parent::addHeaderAction();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addUserAutoCompleteObject()

ilObjCategoryGUI::addUserAutoCompleteObject ( )

protected

Show auto complete results.

Definition at line 973 of file class.ilObjCategoryGUI.php.

References exit, and ilUserAutoComplete\MAX_ENTRIES.

                                                  : void
    {
        $auto = new ilUserAutoComplete();
        $auto->setSearchFields(['login', 'firstname', 'lastname', 'email']);
        $auto->enableFieldSearchableCheck(true);
        //$auto->isMoreLinkAvailable(true);

        if (($this->cat_request->getFetchAll())) {
            $auto->setLimit(ilUserAutoComplete::MAX_ENTRIES);
        }

        echo $auto->getList($this->cat_request->getTerm());
        exit();
    }

afterSave()

ilObjCategoryGUI::afterSave ( ilObject  $new_object )

protected

Definition at line 531 of file class.ilObjCategoryGUI.php.

References ilObjectGUI\$settings, ilObjectGUI\$tree, ILIAS\Repository\ctrl(), ilObject\getId(), ilObject\getRefId(), ILIAS\Repository\lng(), ilObjectGUI\redirectToRefId(), and ilContainer\SORT_TITLE.

                                                      : void
    {
        $tree = $this->tree;

        // default: sort by title
        $settings = new ilContainerSortingSettings($new_object->getId());
        $settings->setSortMode(ilContainer::SORT_TITLE);
        $settings->save();

        // inherit parents content style, if not individual
        $this->content_style_domain
            ->styleForRefId($new_object->getRefId())
            ->inheritFromParent();

        // always send a message
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("cat_added"), true);
        $this->ctrl->setParameter($this, "ref_id", $new_object->getRefId());
        $this->redirectToRefId($new_object->getRefId(), "");
    }

Here is the call graph for this function:

applyFilterObject()

ilObjCategoryGUI::applyFilterObject ( )

protected

Apply filter.

Returns

Definition at line 906 of file class.ilObjCategoryGUI.php.

References ilContainerGUI\$tabs, listUsersObject(), and ilUserTableGUI\MODE_LOCAL_USER.

                                          : void
    {
        $ilTabs = $this->tabs;

        $utab = new ilUserTableGUI($this, "listUsers", ilUserTableGUI::MODE_LOCAL_USER);
        $utab->resetOffset();
        $utab->writeFilterToSession();
        $this->listUsersObject();
    }

Here is the call graph for this function:

assignRolesObject()

ilObjCategoryGUI::assignRolesObject

(

)

Definition at line 1032 of file class.ilObjCategoryGUI.php.

References $help, ilContainerGUI\$rbacreview, ilContainerGUI\$tabs, ilRbacReview\assignedRoles(), ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), ilLegacyFormElementsUtil\formCheckbox(), getAssignableRoles(), ilObjectFactory\getInstanceByObjId(), listUsersObject(), ILIAS\Repository\lng(), and ilHelpGUI\setScreenIdComponent().

Referenced by assignSaveObject().

                                       : void
    {
        $rbacreview = $this->rbacreview;
        $ilTabs = $this->tabs;

        $this->checkPermission("cat_administrate_users");

        if ($this->cat_request->getObjId() === 0) {
            $this->tpl->setOnScreenMessage('failure', 'no_user_selected');
            $this->listUsersObject();
            return;
        }

        $ilTabs->clearTargets();
        $ilTabs->setBackTarget($this->lng->txt('backto_lua'), $this->ctrl->getLinkTarget($this, 'listUsers'));
        $ilHelp = $this->help;
        $ilHelp->setScreenIdComponent("cat");
        $ilHelp->setScreenId("administrate_user");
        $ilHelp->setSubScreenId("assign_roles");


        $roles = $this->getAssignableRoles();

        $ass_roles = $rbacreview->assignedRoles($this->cat_request->getObjId());

        $counter = 0;
        $f_result = [];

        foreach ($roles as $role) {
            $role_obj = ilObjectFactory::getInstanceByObjId((int) $role['obj_id']);

            $disabled = false;
            $f_result[$counter]['checkbox'] = ilLegacyFormElementsUtil::formCheckbox(
                in_array((int) $role['obj_id'], $ass_roles, true),
                'role_ids[]',
                (string) $role['obj_id'],
                $disabled
            );
            $f_result[$counter]['title'] = $role_obj->getTitle() ?: "";
            $f_result[$counter]['desc'] = $role_obj->getDescription() ?: "";
            $f_result[$counter]['type'] = ($role['role_type'] ?? '') === 'global' ?
                $this->lng->txt('global') :
                $this->lng->txt('local');

            unset($role_obj);
            ++$counter;
        }

        $table = new ilCategoryAssignRoleTableGUI($this, "assignRoles");
        $tmp_obj = ilObjectFactory::getInstanceByObjId($this->cat_request->getObjId());
        $title = $this->lng->txt('role_assignment') . ' (' . $tmp_obj->getFullname() . ')';
        $table->setTitle($title, "icon_role.svg", $this->lng->txt("role_assignment"));
        $table->setData($f_result);
        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

assignSaveObject()

ilObjCategoryGUI::assignSaveObject

(

)

Definition at line 1088 of file class.ilObjCategoryGUI.php.

References ilContainerGUI\$rbacadmin, ilContainerGUI\$rbacreview, ilLocalUser\_getAllUserIds(), ilRbacReview\assignedRoles(), assignRolesObject(), ilRbacAdmin\assignUser(), checkGlobalRoles(), ilObjectGUI\checkPermission(), ilRbacAdmin\deassignUser(), getAssignableRoles(), listUsersObject(), and ILIAS\Repository\lng().

                                      : void
    {
        $rbacreview = $this->rbacreview;
        $rbacadmin = $this->rbacadmin;
        $this->checkPermission("cat_administrate_users");

        // check hack
        if ($this->cat_request->getObjId() === 0 ||
            !in_array($this->cat_request->getObjId(), ilLocalUser::_getAllUserIds(), true)) {
            $this->tpl->setOnScreenMessage('failure', 'no_user_selected');
            $this->listUsersObject();
            return;
        }
        $roles = $this->getAssignableRoles();

        // check minimum one global role
        if (!$this->checkGlobalRoles($this->cat_request->getRoleIds())) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_global_role_left'));
            $this->assignRolesObject();
            return;
        }

        $new_role_ids = $this->cat_request->getRoleIds();
        $assigned_roles = $rbacreview->assignedRoles($this->cat_request->getObjId());
        foreach ($roles as $role) {
            if (in_array((int) $role['obj_id'], $new_role_ids, true) && !in_array((int) $role['obj_id'], $assigned_roles, true)) {
                $rbacadmin->assignUser((int) $role['obj_id'], $this->cat_request->getObjId());
            }
            if (in_array((int) $role['obj_id'], $assigned_roles, true) && !in_array((int) $role['obj_id'], $new_role_ids, true)) {
                $rbacadmin->deassignUser((int) $role['obj_id'], $this->cat_request->getObjId());
            }
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('role_assignment_updated'));
        $this->assignRolesObject();
    }

Here is the call graph for this function:

checkGlobalRoles()

ilObjCategoryGUI::checkGlobalRoles (   $new_assigned )

private

Definition at line 1146 of file class.ilObjCategoryGUI.php.

References $ilUser, ilContainerGUI\$rbacreview, ilObjectGUI\$user, ilRbacReview\assignedRoles(), ilObjectGUI\checkPermission(), ilRbacReview\getGlobalAssignableRoles(), ilRbacReview\getGlobalRoles(), ilRbacReview\getGlobalRolesArray(), ilObjectFactory\getInstanceByObjId(), and SYSTEM_ROLE_ID.

Referenced by assignSaveObject().

                                                    : bool
    {
        $rbacreview = $this->rbacreview;
        $ilUser = $this->user;

        $this->checkPermission("cat_administrate_users");

        // return true if it's not a local user
        $tmp_obj = ilObjectFactory::getInstanceByObjId($this->cat_request->getObjId());
        if ($tmp_obj->getTimeLimitOwner() !== $this->object->getRefId() &&
           !in_array(SYSTEM_ROLE_ID, $rbacreview->assignedRoles($ilUser->getId()), true)) {
            return true;
        }

        // new assignment by form
        $new_assigned = $new_assigned ?: [];
        $assigned = $rbacreview->assignedRoles($this->cat_request->getObjId());

        // all assignable globals
        if (!in_array(SYSTEM_ROLE_ID, $rbacreview->assignedRoles($ilUser->getId()), true)) {
            $ga = $rbacreview->getGlobalAssignableRoles();
        } else {
            $ga = $rbacreview->getGlobalRolesArray();
        }
        $global_assignable = [];
        foreach ($ga as $role) {
            $global_assignable[] = $role['obj_id'];
        }

        $new_visible_assigned_roles = array_intersect($new_assigned, $global_assignable);
        $all_assigned_roles = array_intersect($assigned, $rbacreview->getGlobalRoles());
        $main_assigned_roles = array_diff($all_assigned_roles, $global_assignable);

        if (!count($new_visible_assigned_roles) && !count($main_assigned_roles)) {
            return false;
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteUsersObject()

ilObjCategoryGUI::deleteUsersObject

(

)

Definition at line 1005 of file class.ilObjCategoryGUI.php.

References $name, ilObjectGUI\$user, ilObjUser\_lookupName(), ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), listUsersObject(), and ILIAS\Repository\lng().

                                       : void
    {
        $this->checkPermission("cat_administrate_users");
        if ($this->cat_request->getIds() === []) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_users_selected'));
            $this->listUsersObject();
            return;
        }

        $confirm = new ilConfirmationGUI();
        $confirm->setFormAction($this->ctrl->getFormAction($this));
        $confirm->setHeaderText($this->lng->txt('sure_delete_selected_users'));
        $confirm->setConfirm($this->lng->txt('delete'), 'performDeleteUsers');
        $confirm->setCancel($this->lng->txt('cancel'), 'listUsers');

        foreach ($this->cat_request->getIds() as $user) {
            $name = ilObjUser::_lookupName($user);

            $confirm->addItem(
                'user_ids[]',
                (string) $user,
                $name['lastname'] . ', ' . $name['firstname'] . ' [' . $name['login'] . ']'
            );
        }
        $this->tpl->setContent($confirm->getHTML());
    }

Here is the call graph for this function:

editInfoObject()

ilObjCategoryGUI::editInfoObject ( )

protected

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

References ilObjectGUI\checkPermission(), ILIAS\Repository\form(), initExtendedSettings(), and setEditTabs().

Referenced by updateInfoObject().

                                       : void
    {
        $this->checkPermission("write");
        $this->setEditTabs();
        $this->tabs_gui->activateTab('settings');
        $this->tabs_gui->setSubTabActive('edit_cat_settings');

        $this->initExtendedSettings();
        $this->tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilObjCategoryGUI::executeCommand

(

)

Definition at line 92 of file class.ilObjCategoryGUI.php.

References ilObjectGUI\$access, ilObjectGUI\$ctrl, $help, $nav_history, ilContainerGUI\$tabs, ilLink\_getLink(), addHeaderAction(), ilObjectGUI\checkPermission(), ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ilContainerGUI\forwardToPageObject(), ilObjectGUI\getCreationMode(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), getObjectMetadataGUI(), infoScreen(), initTaxSubTabs(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilContainerGUI\prepareOutput(), renderObject(), ilObjectGUI\setCreationMode(), setEditTabs(), ilHelpGUI\setScreenIdComponent(), ilContainerGUI\setTitleAndDescription(), and ilContainerGUI\showContainerPageTabs().

                                    : void
    {
        $ilNavigationHistory = $this->nav_history;
        $ilAccess = $this->access;
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;

        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        $header_action = true;
        switch ($next_class) {

            case strtolower(ilRepositoryTrashGUI::class):
                $ru = new ilRepositoryTrashGUI($this);
                $this->ctrl->setReturn($this, 'trash');
                $this->ctrl->forwardCommand($ru);
                break;

            case "ilobjusergui":
                $this->tabs_gui->setTabActive('administrate_users');
                if ($this->cat_request->getObjId() === 0) {
                    $this->gui_obj = new ilObjUserGUI(
                        "",
                        $this->cat_request->getRefId(),
                        true,
                        false
                    );
                } else {
                    $this->gui_obj = new ilObjUserGUI(
                        "",
                        $this->cat_request->getObjId(),
                        false,
                        false
                    );
                }
                $this->gui_obj->setCreationMode($this->creation_mode);
                $this->ctrl->forwardCommand($this->gui_obj);

                $ilTabs->clearTargets();
                $ilTabs->setBackTarget($this->lng->txt('backto_lua'), $this->ctrl->getLinkTarget($this, 'listUsers'));
                $ilHelp = $this->help;
                $ilHelp->setScreenIdComponent("cat");
                $ilHelp->setScreenId("administrate_user");
                $ilHelp->setSubScreenId($ilCtrl->getCmd());
                break;

            case "ilobjuserfoldergui":
                $this->gui_obj = new ilObjUserFolderGUI(
                    "",
                    $this->cat_request->getRefId(),
                    true
                );
                $this->gui_obj->setUserOwnerId($this->cat_request->getRefId());
                $this->gui_obj->setCreationMode($this->creation_mode);
                $this->ctrl->forwardCommand($this->gui_obj);

                $ilTabs->clearTargets();
                $ilTabs->setBackTarget($this->lng->txt('backto_lua'), $this->ctrl->getLinkTarget($this, 'listUsers'));
                $ilHelp = $this->help;
                $ilHelp->setScreenIdComponent("cat");
                $ilHelp->setScreenId("administrate_user");
                $ilHelp->setSubScreenId($ilCtrl->getCmd());
                break;

            case "ilcolumngui":
                $this->checkPermission("read");
                $this->prepareOutput();
                $this->content_style_gui->addCss(
                    $this->tpl,
                    $this->object->getRefId()
                );
                $this->renderObject();
                break;

            case 'ilpermissiongui':
                $this->prepareOutput();
                $this->tabs_gui->setTabActive('perm_settings');
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;

            case 'ilinfoscreengui':
                if ($this->info_screen_enabled) {
                    $this->prepareOutput();
                    $this->infoScreen();
                }
                break;

            // container page editing
            case "ilcontainerpagegui":
                $this->prepareOutput(false);
                $ret = $this->forwardToPageObject();
                if ($ret !== "") {
                    $this->tpl->setContent($ret);
                }
                $header_action = false;
                break;

            case 'ilobjectcopygui':
                $this->prepareOutput();

                $cp = new ilObjectCopyGUI($this);
                $cp->setType('cat');
                $this->ctrl->forwardCommand($cp);
                break;

            case "ilobjectcontentstylesettingsgui":
                $this->checkPermission("write");
                $this->setTitleAndDescription();
                $this->showContainerPageTabs();
                $settings_gui = $this->content_style_gui
                    ->objectSettingsGUIForRefId(
                        null,
                        $this->object->getRefId()
                    );
                $this->ctrl->forwardCommand($settings_gui);
                break;

            case 'ilusertablegui':
                $u_table = new ilUserTableGUI($this, "listUsers");
                $u_table->initFilter();
                $this->ctrl->setReturn($this, 'listUsers');
                $this->ctrl->forwardCommand($u_table);
                break;

            case "ilcommonactiondispatchergui":
                $this->prepareOutput();
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;

            case 'ildidactictemplategui':
                $this->ctrl->setReturn($this, 'edit');
                $did = new ilDidacticTemplateGUI($this);
                $this->ctrl->forwardCommand($did);
                break;

            case 'ilexportgui':
                $this->prepareOutput();
                $this->tabs_gui->setTabActive('export');
                $exp = new ilExportGUI($this);
                $exp->addFormat('xml');
                $this->ctrl->forwardCommand($exp);
                break;

            case 'ilobjecttranslationgui':
                $this->checkPermissionBool("write");
                $this->prepareOutput();
                //$this->tabs_gui->setTabActive('export');
                $this->setEditTabs("settings_trans");
                $transgui = new ilObjectTranslationGUI($this);
                $this->ctrl->forwardCommand($transgui);
                break;

            case 'ilobjtaxonomygui':
                $this->checkPermissionBool("write");
                $this->prepareOutput();
                $this->initTaxSubTabs();
                $tax = new ilObjTaxonomyGUI();
                $tax->setAssignedObject($this->object->getId());
                $tax->setMultiple(true);
                $tax->setListInfo($this->lng->txt("cntr_tax_list_info"));
                $this->ctrl->forwardCommand($tax);
                break;

            case 'ilobjectmetadatagui':
                $this->checkPermissionBool("write");
                $this->prepareOutput();
                $this->tabs_gui->activateTab('meta_data');
                $this->ctrl->forwardCommand($this->getObjectMetadataGUI());
                break;

            case "ilcontainernewssettingsgui":
                $this->prepareOutput();
                $this->tabs_gui->setTabActive('settings');
                $this->setEditTabs();
                $this->tabs_gui->activateSubTab('obj_news_settings');
                $news_set_gui = new ilContainerNewsSettingsGUI($this);
                $news_set_gui->setHideByDate(true);
                $this->ctrl->forwardCommand($news_set_gui);
                break;

            case 'ilcontainerfilteradmingui':
                $this->checkPermissionBool("write");
                $this->prepareOutput();
                $this->setEditTabs($active_tab = "settings_filter");
                $this->tabs_gui->activateTab('settings');
                $this->ctrl->forwardCommand(new ilContainerFilterAdminGUI($this));
                break;

            default:
                if ($cmd === "infoScreen") {
                    $this->checkPermission("visible");
                } else {
                    $this->checkPermission("read");
                }

                // add entry to navigation history
                if (!$this->getCreationMode() &&
                    $ilAccess->checkAccess("read", "", $this->cat_request->getRefId())) {
                    $ilNavigationHistory->addItem(
                        $this->cat_request->getRefId(),
                        ilLink::_getLink($this->cat_request->getRefId(), "cat"),
                        "cat"
                    );
                }

                $this->prepareOutput();
                if (is_object($this->object)) {
                    $this->content_style_gui->addCss(
                        $this->tpl,
                        $this->object->getRefId()
                    );
                }

                if (!$cmd) {
                    $cmd = "render";
                }
                $cmd .= "Object";
                $this->tabs_gui->activateTab("view_content");   // see #19868
                $this->$cmd();

                break;
        }

        if ($header_action) {
            $this->addHeaderAction();
        }
    }

Here is the call graph for this function:

getActiveBlocks()

ilObjCategoryGUI::getActiveBlocks ( )

protected

Definition at line 1255 of file class.ilObjCategoryGUI.php.

References $res, ilContainer\_getContainerSettings(), and ILIAS\Repository\object().

Referenced by getObjectMetadataGUI().

                                        : array
    {
        $res = [];

        $prefix = self::CONTAINER_SETTING_TAXBLOCK;

        foreach (ilContainer::_getContainerSettings($this->object->getId()) as $keyword => $value) {
            if ($value && strpos($keyword, $prefix) === 0) {
                $res[] = substr($keyword, strlen($prefix));
            }
        }

        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAssignableRoles()

ilObjCategoryGUI::getAssignableRoles ( )

private

Definition at line 1125 of file class.ilObjCategoryGUI.php.

References $ilUser, ilContainerGUI\$rbacreview, ilObjectGUI\$user, ilRbacReview\assignedRoles(), ilRbacReview\getAssignableChildRoles(), ilRbacReview\getGlobalAssignableRoles(), ilRbacReview\getGlobalRolesArray(), ilObjectFactory\getInstanceByObjId(), and SYSTEM_ROLE_ID.

Referenced by assignRolesObject(), and assignSaveObject().

                                         : array
    {
        $rbacreview = $this->rbacreview;
        $ilUser = $this->user;

        // check local user
        $tmp_obj = ilObjectFactory::getInstanceByObjId($this->cat_request->getObjId());
        // Admin => all roles
        if (in_array(SYSTEM_ROLE_ID, $rbacreview->assignedRoles($ilUser->getId()), true)) {
            $global_roles = $rbacreview->getGlobalRolesArray();
        } elseif ($tmp_obj->getTimeLimitOwner() === $this->object->getRefId()) {
            $global_roles = $rbacreview->getGlobalAssignableRoles();
        } else {
            $global_roles = [];
        }
        return array_merge(
            $global_roles,
            $rbacreview->getAssignableChildRoles($this->object->getRefId())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEditFormValues()

ilObjCategoryGUI::getEditFormValues ( )

protected

Definition at line 794 of file class.ilObjCategoryGUI.php.

                                          : array
    {
        return [];
    }

getObjectMetadataGUI()

ilObjCategoryGUI::getObjectMetadataGUI

(

)

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

References ilContainerGUI\$form, ilContainer\_deleteContainerSettings(), ilContainer\_lookupContainerSetting(), ilObject\_lookupDescription(), ilContainer\_writeContainerSetting(), ilPropertyFormGUI\addItem(), getActiveBlocks(), ilPropertyFormGUI\getInput(), getTaxonomiesForRefId(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilObjectServiceSettingsGUI\TAXONOMIES.

Referenced by executeCommand().

                                          : ilObjectMetaDataGUI
    {
        $md_gui = new ilObjectMetaDataGUI($this->object);
        if (ilContainer::_lookupContainerSetting(
            $this->object->getId(),
            ilObjectServiceSettingsGUI::TAXONOMIES,
            '0'
        )) {
            $md_gui->enableTaxonomyDefinition(true);
            $tax = $md_gui->getTaxonomyObjGUI();
            $tax->setMultiple(true);
            $tax->setListInfo($this->lng->txt("cntr_tax_list_info"));
            $taxonomies = $this->getTaxonomiesForRefId();
            if (count($taxonomies)) {
                $md_gui->setTaxonomySettings(function ($form) {
                    $tax = $this->getTaxonomiesForRefId();
                    $block = new ilCheckboxGroupInputGUI($this->lng->txt("cntr_taxonomy_show_sideblock"), "sblock");
                    $form->addItem($block);

                    $current = $this->getActiveBlocks();

                    $value = null;
                    foreach ($tax as $tax_id => $tax_item) {
                        $option = new ilCheckboxOption(
                            $tax_item["title"],
                            (string) $tax_id,
                            ilObject::_lookupDescription($tax_id)
                        );

                        if ((int) $tax_item["source"] !== $this->object->getRefId()) {
                            $loc = new ilLocatorGUI();
                            $loc->setTextOnly(true);
                            $loc->addRepositoryItems((int) $tax_item["source"]);
                            $option->setInfo($loc->getHTML());
                        }

                        $block->addOption($option);

                        if (in_array($tax_id, $current)) {
                            $value[] = $tax_id;
                        }
                    }

                    $block->setValue($value);
                }, function ($form) {
                    $taxonomies = $this->getTaxonomiesForRefId();
                    if (count($taxonomies)) {
                        $sblock = $form->getInput("sblock");

                        $prefix = self::CONTAINER_SETTING_TAXBLOCK;

                        ilContainer::_deleteContainerSettings(
                            $this->object->getId(),
                            $prefix . "%",
                            true
                        );

                        if (is_array($sblock)) {
                            foreach ($sblock as $tax_id) {
                                ilContainer::_writeContainerSetting(
                                    $this->object->getId(),
                                    $prefix . $tax_id,
                                    '1'
                                );
                            }
                        }
                    }
                });
            }
        }
        return $md_gui;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTabs()

ilObjCategoryGUI::getTabs ( )

protected

Definition at line 403 of file class.ilObjCategoryGUI.php.

References ilObjectGUI\$access, $help, ilObjectGUI\$lng, ilContainerGUI\$rbacsystem, ilContainer\_lookupContainerSetting(), ilRbacSystem\checkAccess(), ILIAS\Repository\ctrl(), ilUserAccountSettings\getInstance(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilObjectServiceSettingsGUI\TAXONOMIES, and ilLanguage\txt().

                                : void
    {
        $rbacsystem = $this->rbacsystem;
        $lng = $this->lng;
        $ilHelp = $this->help;
        $ilAccess = $this->access;

        if ($this->ctrl->getCmd() === "editPageContent") {
            return;
        }

        $ilHelp->setScreenIdComponent("cat");

        if ($rbacsystem->checkAccess('read', $this->ref_id)) {
            $this->tabs_gui->addTab(
                "view_content",
                $lng->txt("content"),
                $this->ctrl->getLinkTarget($this, "")
            );

            //BEGIN ChangeEvent add info tab to category object
            if ($this->info_screen_enabled) {
                $force_active = $this->ctrl->getNextClass() === "ilinfoscreengui"
                    || strtolower($this->cat_request->getCmdClass()) === "ilnotegui";
                $this->tabs_gui->addTarget(
                    "info_short",
                    $this->ctrl->getLinkTargetByClass(
                        ["ilobjcategorygui", "ilinfoscreengui"],
                        "showSummary"
                    ),
                    ["showSummary", "", "infoScreen"],
                    "",
                    "",
                    $force_active
                );
            }
            //END ChangeEvent add info tab to category object
        }

        if ($rbacsystem->checkAccess('write', $this->ref_id)) {
            $force_active = ($this->ctrl->getCmd() === "edit");
            $this->tabs_gui->addTarget(
                "settings",
                $this->ctrl->getLinkTarget($this, "edit"),
                "edit",
                get_class($this),
                "",
                $force_active
            );



            // metadata / taxonomies
            $mdgui = new ilObjectMetaDataGUI($this->object);
            if (ilContainer::_lookupContainerSetting(
                $this->object->getId(),
                ilObjectServiceSettingsGUI::TAXONOMIES,
                '0'
            )) {
                $mdgui->enableTaxonomyDefinition(true);
            }
            $mdtab = $mdgui->getTab();
            if ($mdtab) {
                $this->tabs_gui->addTab(
                    "meta_data",
                    $this->lng->txt("meta_data"),
                    $mdtab
                );
            }
        }

        if (ilUserAccountSettings::getInstance()->isLocalUserAdministrationEnabled() &&
            $rbacsystem->checkAccess('cat_administrate_users', $this->ref_id)) {
            $this->tabs_gui->addTarget(
                "administrate_users",
                $this->ctrl->getLinkTarget($this, "listUsers"),
                "listUsers",
                get_class($this)
            );
        }

        if ($ilAccess->checkAccess('write', '', $this->object->getRefId())) {
            $this->tabs_gui->addTarget(
                'export',
                $this->ctrl->getLinkTargetByClass('ilexportgui', ''),
                'export',
                'ilexportgui'
            );
        }

        // parent tabs (all container: edit_permission, clipboard, trash
        parent::getTabs();
    }

Here is the call graph for this function:

getTaxonomiesForRefId()

ilObjCategoryGUI::getTaxonomiesForRefId ( )

protected

Definition at line 1228 of file class.ilObjCategoryGUI.php.

References $res, ilObjectGUI\$tree, ilTree\getPathFull(), and ilObjTaxonomy\getUsageOfObject().

Referenced by getObjectMetadataGUI().

                                              : array
    {
        $tree = $this->tree;

        // see ilTaxMDGUI::getSelectableTaxonomies()

        $res = [];
        foreach ($tree->getPathFull($this->object->getRefId()) as $node) {
            //if ($node["ref_id"] != $this->object->getRefId())
            {
                // find all defined taxes for parent node, activation is not relevant
                $node_taxes = ilObjTaxonomy::getUsageOfObject((int) $node["obj_id"], true);
                if (count($node_taxes)) {
                    foreach ($node_taxes as $node_tax) {
                        $res[$node_tax["tax_id"]] = [
                            "title" => $node_tax["title"]
                        , "source" => $node["child"]
                        ];
                    }
                }
            }
        }

        asort($res);
        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

infoScreen()

ilObjCategoryGUI::infoScreen

(

)

show information screen

Definition at line 566 of file class.ilObjCategoryGUI.php.

References ilObjectGUI\$access, ilObjectGUI\$ctrl, ilContainerGUI\$error, $ilErr, ILIAS\Repository\lng(), ilAdvancedMDRecordGUI\MODE_INFO, ILIAS\Repository\object(), ilAdvancedMDRecordGUI\parse(), and ilAdvancedMDRecordGUI\setInfoObject().

Referenced by executeCommand(), and infoScreenObject().

                                : string
    {
        $ilAccess = $this->access;
        $ilCtrl = $this->ctrl;
        $ilErr = $this->error;

        if (!$ilAccess->checkAccess("visible", "", $this->ref_id)) {
            $ilErr->raiseError($this->lng->txt("msg_no_perm_read"), $ilErr->MESSAGE);
        }

        if (!$this->info_screen_enabled) {
            return "";
        }

        // #10986
        $this->tabs_gui->setTabActive('info_short');

        $info = new ilInfoScreenGUI($this);

        $info->enablePrivateNotes();

        if ($ilAccess->checkAccess("read", "", $this->cat_request->getRefId())) {
            $info->enableNews();
        }

        // no news editing for files, just notifications
        $info->enableNewsEditing(false);
        if ($ilAccess->checkAccess("write", "", $this->cat_request->getRefId())) {
            $news_set = new ilSetting("news");
            $enable_internal_rss = $news_set->get("enable_rss_for_internal");

            if ($enable_internal_rss) {
                $info->setBlockProperty("news", "settings", '1');
                $info->setBlockProperty("news", "public_notifications_option", '1');
            }
        }

        $record_gui = new ilAdvancedMDRecordGUI(ilAdvancedMDRecordGUI::MODE_INFO, 'cat', $this->object->getId());
        $record_gui->setInfoObject($info);
        $record_gui->parse();


        // standard meta data
        $info->addMetaDataSections($this->object->getId(), 0, $this->object->getType());

        // forward the command
        if ($ilCtrl->getNextClass() === "ilinfoscreengui") {
            $ilCtrl->forwardCommand($info);
        } else {
            return $ilCtrl->getHTML($info);
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

infoScreenObject()

ilObjCategoryGUI::infoScreenObject

(

)

this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed

Definition at line 556 of file class.ilObjCategoryGUI.php.

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

                                      : void
    {
        $this->ctrl->setCmd("showSummary");
        $this->ctrl->setCmdClass("ilinfoscreengui");
        $this->infoScreen();
    }

Here is the call graph for this function:

initCreationForms()

ilObjCategoryGUI::initCreationForms ( string  $new_type )

protected

Definition at line 524 of file class.ilObjCategoryGUI.php.

                                                          : array
    {
        $forms = parent::initCreationForms($new_type);
        //unset($forms[self::CFORM_IMPORT]);
        return $forms;
    }

initEditForm()

ilObjCategoryGUI::initEditForm ( )

protected

Definition at line 712 of file class.ilObjCategoryGUI.php.

References ilContainerGUI\$form, ilContainer\_lookupContainerSetting(), ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ILIAS\Repository\ctrl(), ilObjectServiceSettingsGUI\CUSTOM_METADATA, ilObjectServiceSettingsGUI\FILTER, ilObjectGUI\getObjectService(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, ilObjectGUI\initDidacticTemplate(), ilContainerGUI\initListPresentationForm(), ilObjectServiceSettingsGUI\initServiceSettingsForm(), ilContainerGUI\initSortingForm(), ILIAS\Repository\lng(), ilObjectServiceSettingsGUI\NEWS_VISIBILITY, ILIAS\Repository\object(), setEditTabs(), ilFormGUI\setFormAction(), ilFormPropertyGUI\setInfo(), ilPropertyFormGUI\setTitle(), ilContainer\SORT_CREATION, ilContainer\SORT_MANUAL, ilContainer\SORT_TITLE, ilObjectServiceSettingsGUI\TAG_CLOUD, and ilObjectServiceSettingsGUI\TAXONOMIES.

Referenced by updateObject().

                                     : ilPropertyFormGUI
    {
        $obj_service = $this->getObjectService();

        $this->lng->loadLanguageModule($this->object->getType());
        $this->setEditTabs();

        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt($this->object->getType() . "_edit"));

        // title/description
        $this->initFormTitleDescription($form);

        // Show didactic template type
        $this->initDidacticTemplate($form);

        // presentation
        $pres = new ilFormSectionHeaderGUI();
        $pres->setTitle($this->lng->txt('obj_presentation'));
        $form->addItem($pres);

        // title and icon visibility
        $form = $obj_service->commonSettings()->legacyForm($form, $this->object)->addTitleIconVisibility();

        // top actions visibility
        $form = $obj_service->commonSettings()->legacyForm($form, $this->object)->addTopActionsVisibility();

        // custom icon
        $form = $obj_service->commonSettings()->legacyForm($form, $this->object)->addIcon();

        // tile image
        $form = $obj_service->commonSettings()->legacyForm($form, $this->object)->addTileImage();

        // list presentation
        $form = $this->initListPresentationForm($form);

        // sorting
        $form = $this->initSortingForm(
            $form,
            [
                    ilContainer::SORT_TITLE,
                    ilContainer::SORT_CREATION,
                    ilContainer::SORT_MANUAL
            ]
        );

        // block limit
        $bl = new ilNumberInputGUI($this->lng->txt("cont_block_limit"), "block_limit");
        $bl->setInfo($this->lng->txt("cont_block_limit_info"));
        $bl->setValue(ilContainer::_lookupContainerSetting($this->object->getId(), "block_limit"));
        $form->addItem($bl);

        // icon settings

        // Edit ecs export settings
        $ecs = new ilECSCategorySettings($this->object);
        $ecs->addSettingsToForm($form, 'cat');

        // services
        $sh = new ilFormSectionHeaderGUI();
        $sh->setTitle($this->lng->txt('obj_features'));
        $form->addItem($sh);

        ilObjectServiceSettingsGUI::initServiceSettingsForm(
            $this->object->getId(),
            $form,
            [
                    ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY,
                    ilObjectServiceSettingsGUI::NEWS_VISIBILITY,
                    ilObjectServiceSettingsGUI::TAXONOMIES,
                    ilObjectServiceSettingsGUI::CUSTOM_METADATA,
                    ilObjectServiceSettingsGUI::TAG_CLOUD,
                    ilObjectServiceSettingsGUI::FILTER
            ]
        );

        $form->addCommandButton("update", $this->lng->txt("save"));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initExtendedSettings()

ilObjCategoryGUI::initExtendedSettings ( )

protected

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

References ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ILIAS\Repository\lng(), ilAdvancedMDRecordGUI\MODE_EDITOR, ILIAS\Repository\object(), and ilAdvancedMDRecordGUI\setPropertyForm().

Referenced by editInfoObject(), and updateInfoObject().

                                             : bool
    {
        if (is_object($this->form)) {
            return true;
        }

        $this->form = new ilPropertyFormGUI();
        $this->form->setFormAction($this->ctrl->getFormAction($this));
        $this->form->setTitle($this->lng->txt('ext_cat_settings'));
        $this->form->addCommandButton('updateInfo', $this->lng->txt('save'));
        $this->form->addCommandButton('editInfo', $this->lng->txt('cancel'));

        $this->record_gui = new ilAdvancedMDRecordGUI(ilAdvancedMDRecordGUI::MODE_EDITOR, 'cat', $this->object->getId());
        $this->record_gui->setPropertyForm($this->form);
        $this->record_gui->parse();

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTaxSubTabs()

ilObjCategoryGUI::initTaxSubTabs (   $a_active = "tax_list" )

protected

Definition at line 1212 of file class.ilObjCategoryGUI.php.

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

Referenced by executeCommand().

                                                             : void
    {
        $this->tabs_gui->setTabActive("obj_tool_setting_taxonomies");
        $this->tabs_gui->addSubTab(
            "tax_settings",
            $this->lng->txt("cntr_taxonomy_sideblock_settings"),
            $this->ctrl->getLinkTarget($this, "editTaxonomySettings")
        );
        $this->tabs_gui->addSubTab(
            "tax_list",
            $this->lng->txt("cntr_taxonomy_definitions"),
            $this->ctrl->getLinkTargetByClass("ilobjtaxonomygui", "")
        );
        $this->tabs_gui->activateSubTab($a_active);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listUsersObject()

ilObjCategoryGUI::listUsersObject

(

bool

$show_delete = false

)

Definition at line 917 of file class.ilObjCategoryGUI.php.

References ilContainerGUI\$error, $ilErr, $ilUser, ilContainerGUI\$rbacreview, ilContainerGUI\$rbacsystem, ilObjectGUI\$toolbar, ilObjectGUI\$user, ilRbacReview\assignedRoles(), ilRbacSystem\checkAccess(), ILIAS\Repository\ctrl(), ilRbacReview\getGlobalAssignableRoles(), ILIAS\Repository\lng(), ilUserTableGUI\MODE_LOCAL_USER, and SYSTEM_ROLE_ID.

Referenced by applyFilterObject(), assignRolesObject(), assignSaveObject(), deleteUsersObject(), performDeleteUsersObject(), and resetFilterObject().

                                                              : void
    {
        $ilUser = $this->user;
        $ilErr = $this->error;
        $ilToolbar = $this->toolbar;

        $rbacsystem = $this->rbacsystem;
        $rbacreview = $this->rbacreview;

        if (!$rbacsystem->checkAccess("cat_administrate_users", $this->object->getRefId())) {
            $ilErr->raiseError($this->lng->txt("msg_no_perm_admin_users"), $ilErr->MESSAGE);
        }
        $this->tabs_gui->setTabActive('administrate_users');



        $this->tpl->addBlockfile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.cat_admin_users.html',
            "Modules/Category"
        );

        if (count($rbacreview->getGlobalAssignableRoles()) ||
            in_array(SYSTEM_ROLE_ID, $rbacreview->assignedRoles($ilUser->getId()), true)) {
            $ilToolbar->addButton(
                $this->lng->txt('add_user'),
                $this->ctrl->getLinkTargetByClass('ilobjusergui', 'create')
            );

            $ilToolbar->addButton(
                $this->lng->txt('import_users'),
                $this->ctrl->getLinkTargetByClass('ilobjuserfoldergui', 'importUserForm')
            );
        } else {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('no_roles_user_can_be_assigned_to'));
        }

        if ($show_delete) {
            $this->tpl->setCurrentBlock("confirm_delete");
            $this->tpl->setVariable("CONFIRM_FORMACTION", $this->ctrl->getFormAction($this));
            $this->tpl->setVariable("TXT_CANCEL", $this->lng->txt('cancel'));
            $this->tpl->setVariable("CONFIRM_CMD", 'performDeleteUsers');
            $this->tpl->setVariable("TXT_CONFIRM", $this->lng->txt('delete'));
            $this->tpl->parseCurrentBlock();
        }

        $this->lng->loadLanguageModule('user');

        $utab = new ilUserTableGUI($this, 'listUsers', ilUserTableGUI::MODE_LOCAL_USER);
        $this->tpl->setVariable('USERS_TABLE', $utab->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

performDeleteUsersObject()

ilObjCategoryGUI::performDeleteUsersObject

(

)

Definition at line 988 of file class.ilObjCategoryGUI.php.

References ilLocalUser\_getAllUserIds(), ilObjectGUI\checkPermission(), ilObjectFactory\getInstanceByObjId(), listUsersObject(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

                                              : void
    {
        $this->checkPermission("cat_administrate_users");

        foreach ($this->cat_request->getUserIds() as $user_id) {
            if (!in_array($user_id, ilLocalUser::_getAllUserIds($this->object->getRefId()), true)) {
                throw new ilException('user id not valid');
            }
            if (!$tmp_obj = ilObjectFactory::getInstanceByObjId($user_id, false)) {
                continue;
            }
            $tmp_obj->delete();
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('deleted_users'));
        $this->listUsersObject();
    }

Here is the call graph for this function:

renderObject()

ilObjCategoryGUI::renderObject

(

)

Render category.

Definition at line 500 of file class.ilObjCategoryGUI.php.

References ilContainerGUI\$tabs, ilChangeEvent\_recordReadEvent(), ilTabsGUI\activateTab(), ILIAS\Repository\object(), and ILIAS\Repository\user().

Referenced by executeCommand(), and viewObject().

                                  : void
    {
        $ilTabs = $this->tabs;

        $ilTabs->activateTab("view_content");
        parent::renderObject();

        ilChangeEvent::_recordReadEvent(
            $this->object->getType(),
            $this->object->getRefId(),
            $this->object->getId(),
            $this->user->getId()
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resetFilterObject()

ilObjCategoryGUI::resetFilterObject ( )

protected

import categories (static, also called by RootFolderGUI)

Reset filter (note: this function existed before data table filter has been introduced

Definition at line 892 of file class.ilObjCategoryGUI.php.

References listUsersObject(), and ilUserTableGUI\MODE_LOCAL_USER.

                                          : void
    {
        $utab = new ilUserTableGUI($this, "listUsers", ilUserTableGUI::MODE_LOCAL_USER);
        $utab->resetOffset();
        $utab->resetFilter();

        // from "old" implementation
        $this->listUsersObject();
    }

Here is the call graph for this function:

setEditTabs()

ilObjCategoryGUI::setEditTabs (   $active_tab = "settings_misc" )

protected

Definition at line 673 of file class.ilObjCategoryGUI.php.

References ilContainer\_lookupContainerSetting(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilObjectServiceSettingsGUI\NEWS_VISIBILITY, and ILIAS\Repository\object().

Referenced by editInfoObject(), executeCommand(), initEditForm(), and updateObject().

                                                                 : void
    {
        $this->tabs_gui->addSubTab(
            "settings_misc",
            $this->lng->txt("settings"),
            $this->ctrl->getLinkTarget($this, "edit")
        );

        $this->tabs_gui->addSubTab(
            "settings_trans",
            $this->lng->txt("obj_multilinguality"),
            $this->ctrl->getLinkTargetByClass("ilobjecttranslationgui", "")
        );

        //news tab
        $news_active = ilContainer::_lookupContainerSetting(
            $this->object->getId(),
            ilObjectServiceSettingsGUI::NEWS_VISIBILITY,
            '1'
        );

        if ($news_active) {
            $this->tabs_gui->addSubTab(
                'obj_news_settings',
                $this->lng->txt("cont_news_settings"),
                $this->ctrl->getLinkTargetByClass('ilcontainernewssettingsgui')
            );
        }

        $this->tabs_gui->addSubTab(
            "settings_filter",
            $this->lng->txt("cont_filter"),
            $this->ctrl->getLinkTargetByClass("ilcontainerfilteradmingui", "")
        );

        $this->tabs_gui->activateTab("settings");
        $this->tabs_gui->activateSubTab($active_tab);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateInfoObject()

ilObjCategoryGUI::updateInfoObject ( )

protected

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

References ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), editInfoObject(), ILIAS\Repository\form(), initExtendedSettings(), and ILIAS\Repository\lng().

                                         : void
    {
        $this->checkPermission("write");

        // init form
        $this->initExtendedSettings();

        // still needed for date conversion and so on
        $this->form->checkInput();

        if ($this->record_gui->importEditFormPostValues()) {
            $this->record_gui->writeEditForm();

            $this->tpl->setOnScreenMessage('success', $this->lng->txt("settings_saved"), true);
            $this->ctrl->redirect($this, "editInfo");
        }

        $this->editInfoObject();
    }

Here is the call graph for this function:

updateObject()

ilObjCategoryGUI::updateObject

(

)

Definition at line 799 of file class.ilObjCategoryGUI.php.

References ilContainerGUI\$error, ilContainerGUI\$form, $ilErr, $ilUser, ilObjectGUI\$user, ilChangeEvent\_catchupWriteEvents(), ilContainer\_deleteContainerSettings(), ilChangeEvent\_recordWriteEvent(), ilContainer\_writeContainerSetting(), ilContainerGUI\afterUpdate(), ilPropertyFormGUI\checkInput(), ilObjectGUI\checkPermissionBool(), ilObjectServiceSettingsGUI\CUSTOM_METADATA, ilObjectServiceSettingsGUI\FILTER, ilPropertyFormGUI\getHTML(), ilPropertyFormGUI\getInput(), ilObjectGUI\getObjectService(), ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY, initEditForm(), ILIAS\Repository\lng(), ilObjectServiceSettingsGUI\NEWS_VISIBILITY, ILIAS\Repository\object(), ilContainerGUI\saveListPresentation(), ilContainerGUI\saveSortingSettings(), setEditTabs(), ilPropertyFormGUI\setValuesByPost(), ilObjectServiceSettingsGUI\TAG_CLOUD, ilObjectServiceSettingsGUI\TAXONOMIES, and ilObjectServiceSettingsGUI\updateServiceSettingsForm().

                                  : void
    {
        $ilErr = $this->error;
        $ilUser = $this->user;
        $obj_service = $this->getObjectService();

        if (!$this->checkPermissionBool("write")) {
            $ilErr->raiseError($this->lng->txt("msg_no_perm_write"), $ilErr->MESSAGE);
        } else {
            $form = $this->initEditForm();
            if ($form->checkInput()) {
                $title = $form->getInput("title");
                $desc = $form->getInput("desc");

                $this->object->setTitle($title);
                $this->object->setDescription($desc);
                $this->object->update();

                $this->saveSortingSettings($form);

                // title icon visibility
                $obj_service->commonSettings()->legacyForm($form, $this->object)->saveTitleIconVisibility();

                // top actions visibility
                $obj_service->commonSettings()->legacyForm($form, $this->object)->saveTopActionsVisibility();

                // custom icon
                $obj_service->commonSettings()->legacyForm($form, $this->object)->saveIcon();

                // tile image
                $obj_service->commonSettings()->legacyForm($form, $this->object)->saveTileImage();

                // list presentation
                $this->saveListPresentation($form);

                // BEGIN ChangeEvent: Record update
                ilChangeEvent::_recordWriteEvent($this->object->getId(), $ilUser->getId(), 'update');
                ilChangeEvent::_catchupWriteEvents($this->object->getId(), $ilUser->getId());
                // END ChangeEvent: Record update

                // services
                ilObjectServiceSettingsGUI::updateServiceSettingsForm(
                    $this->object->getId(),
                    $form,
                    [
                        ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY,
                        ilObjectServiceSettingsGUI::NEWS_VISIBILITY,
                        ilObjectServiceSettingsGUI::TAXONOMIES,
                        ilObjectServiceSettingsGUI::CUSTOM_METADATA,
                        ilObjectServiceSettingsGUI::TAG_CLOUD,
                        ilObjectServiceSettingsGUI::FILTER
                    ]
                );

                // block limit
                if ((int) $form->getInput("block_limit") > 0) {
                    ilContainer::_writeContainerSetting(
                        $this->object->getId(),
                        "block_limit",
                        (string) ((int) $form->getInput("block_limit"))
                    );
                } else {
                    ilContainer::_deleteContainerSettings($this->object->getId(), "block_limit");
                }
                // Update ecs export settings
                $ecs = new ilECSCategorySettings($this->object);
                if ($ecs->handleSettingsUpdate()) {
                    $this->afterUpdate();
                    return;
                }
            }

            // display form to correct errors
            $this->setEditTabs();
            $form->setValuesByPost();
            $this->tpl->setContent($form->getHTML());
        }
    }

Here is the call graph for this function:

viewObject()

ilObjCategoryGUI::viewObject

(

)

Definition at line 515 of file class.ilObjCategoryGUI.php.

References renderObject().

                                : void
    {
        if (strtolower($this->cat_request->getBaseClass()) === "iladministrationgui") {
            parent::viewObject();
            return;
        }
        $this->renderObject();
    }

Here is the call graph for this function:

Field Documentation

$cat_request

StandardGUIRequest ilObjCategoryGUI::$cat_request

protected

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

$creation_mode

bool ilObjCategoryGUI::$creation_mode

protected

Definition at line 44 of file class.ilObjCategoryGUI.php.

$gui_obj

ilObjectGUI ilObjCategoryGUI::$gui_obj

protected

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

$help

ilHelpGUI ilObjCategoryGUI::$help

protected

Definition at line 41 of file class.ilObjCategoryGUI.php.

Referenced by assignRolesObject(), executeCommand(), and getTabs().

$info_screen_enabled

bool ilObjCategoryGUI::$info_screen_enabled = false

protected

Definition at line 42 of file class.ilObjCategoryGUI.php.

$nav_history

ilNavigationHistory ilObjCategoryGUI::$nav_history

protected

Definition at line 40 of file class.ilObjCategoryGUI.php.

Referenced by executeCommand().

$record_gui

ilAdvancedMDRecordGUI ilObjCategoryGUI::$record_gui

protected

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

CONTAINER_SETTING_TAXBLOCK

const ilObjCategoryGUI::CONTAINER_SETTING_TAXBLOCK = "tax_sblock_"

Definition at line 38 of file class.ilObjCategoryGUI.php.

Referenced by ilTaxonomyClassificationProvider\getActiveTaxonomiesForParentRefId().

---

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

• Modules/Category/classes/class.ilObjCategoryGUI.php