ilObjRoleFolderGUI Class Reference

Class ilObjRoleFolderGUI. More...

Inheritance diagram for ilObjRoleFolderGUI:

Collaboration diagram for ilObjRoleFolderGUI:

Public Member Functions
	__construct ($a_data, int $a_id, bool $a_call_by_reference)
	Constructor public. More...
	executeCommand ()
	returnObject ()
	viewObject ()
	resetFilterObject ()
	Reset role filter. More...
	getAdminTabs ()
	Add role folder tabs. More...
	editSettingsObject (?ilPropertyFormGUI $a_form=null)
	saveSettingsObject ()
	addToExternalSettingsForm (int $a_form_id)
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)

Protected Member Functions
	initCopySourceFromGET ()
	initRolesFromPOST ()
	roleSearchObject ()
	Search target roles. More...
	initRoleSearchForm ()
	Init role search form. More...
	roleSearchFormObject ()
	Parse search query. More...
	roleSearchListObject ()
	List roles. More...
	chooseCopyBehaviourObject (?ilPropertyFormGUI $form=null)
	Choose option for copying roles/role templates. More...
	initCopyBehaviourForm ()
	Show copy behaviour form. More...
	adjustRoleObject ()
	Copy role. More...
	doAddRolePermissions (int $source, int $target)
	do add role permission More...
	removeRolePermissionsObject ()
	Remove role permissions. More...
	doRemoveRolePermissions (int $source, int $target)
	do add role permission More...
	doCopyRole (int $source, int $target)
	Perform copy of role. More...
	doChangeExistingObjects (int $a_start_obj, int $a_target_role, int $a_operation_mode, int $a_source_role)
	Do change existing objects. More...
	applyFilterObject ()
	Apply role filter. More...
	confirmDeleteObject ()
	Confirm deletion of roles. More...
	deleteRoleObject ()
	Delete roles. More...
	initSettingsForm ()
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 ()
	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
ilRbacAdmin	$rbacadmin
GlobalHttpState	$http
Factory	$refinery
UIFactory	$ui_factory
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
Refinery	$refinery
ilFavouritesManager	$favourites
ilObjectCustomIconFactory	$custom_icon_factory
UIFactory	$ui_factory
UIRenderer	$ui_renderer
Filesystem	$temp_file_system
ilObject	$object = null
bool	$creation_mode = false
	$data
int	$id
bool	$call_by_reference = false
bool	$prepare_output
int	$ref_id
int	$obj_id
int	$maxcount
array	$form_action = []
array	$return_location = []
array	$target_frame = []
string	$tmp_import_dir
string	$sub_objects = ""
bool	$omit_locator = false
string	$type = ""
string	$admin_mode = self::ADMIN_MODE_NONE
int	$requested_ref_id = 0
int	$requested_crtptrefid = 0
int	$requested_crtcb = 0
string	$requested_new_type = ""
string	$link_params
string	$html = ""

Private Attributes
const	COPY_ADD_PERMISSIONS = 1
const	COPY_CLONE_PERMISSIONS = 2
const	COPY_REMOVE_PERMISSIONS = 3
const	COPY_CHANGE_EXISTING_OBJECTS = 1
ilLogger	$logger

Additional Inherited Members
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 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

Class ilObjRoleFolderGUI.

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 ilObjRoleFolderGUI: ilPermissionGUI

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

Constructor & Destructor Documentation

__construct()

ilObjRoleFolderGUI::__construct	(		$a_data,
		int	$a_id,
		bool	$a_call_by_reference
	)

Constructor public.

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), and ILIAS\Repository\refinery().

    {
        global $DIC;

        $this->logger = $DIC->logger()->ac();
        $this->rbacadmin = $DIC['rbacadmin'];
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->ui_factory = $DIC['ui.factory'];

        $this->type = "rolf";
        parent::__construct($a_data, $a_id, $a_call_by_reference, false);
        $this->lng->loadLanguageModule('rbac');
    }

Here is the call graph for this function:

Member Function Documentation

addToExternalSettingsForm()

ilObjRoleFolderGUI::addToExternalSettingsForm

(

int

$a_form_id

)

Definition at line 779 of file class.ilObjRoleFolderGUI.php.

References ilSecuritySettings\_getInstance(), ilAdministrationSettingsFormHandler\FORM_PRIVACY, ilAdministrationSettingsFormHandler\FORM_SECURITY, ilPrivacySettings\getInstance(), null, and ilAdministrationSettingsFormHandler\VALUE_BOOL.

                                                             : array
    {
        switch ($a_form_id) {
            case ilAdministrationSettingsFormHandler::FORM_SECURITY:

                $security = ilSecuritySettings::_getInstance();

                $fields = ['adm_adm_role_protect' => [$security->isAdminRoleProtected(),
                                                                ilAdministrationSettingsFormHandler::VALUE_BOOL
                ]
                ];

                return [["editSettings", $fields]];

            case ilAdministrationSettingsFormHandler::FORM_PRIVACY:

                $privacy = ilPrivacySettings::getInstance();

                $subitems = null;
                if ($privacy->enabledRbacLog()) {
                    $subitems = ['rbac_log_age' => $privacy->getRbacLogAge()];
                }
                $fields = ['rbac_log' => [$privacy->enabledRbacLog(),
                                                    ilAdministrationSettingsFormHandler::VALUE_BOOL,
                                                    $subitems
                ]
                ];

                return [["editSettings", $fields]];
        }
        return [];
    }

Here is the call graph for this function:

adjustRoleObject()

ilObjRoleFolderGUI::adjustRoleObject ( )

protected

Copy role.

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

References ilObjectGUI\checkPermission(), ILIAS\Repository\ctrl(), doAddRolePermissions(), doChangeExistingObjects(), doCopyRole(), doRemoveRolePermissions(), initCopyBehaviourForm(), initCopySourceFromGET(), initRolesFromPOST(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ilObjRole\MODE_ADD_OPERATIONS, ilObjRole\MODE_READ_OPERATIONS, and ilObjRole\MODE_REMOVE_OPERATIONS.

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

        $roles = $this->initRolesFromPOST();
        $source = $this->initCopySourceFromGET();

        $form = $this->initCopyBehaviourForm();
        if ($form->checkInput()) {
            $adjustment_type = $form->getInput('type');
            foreach ((array) $roles as $role_id) {
                if ($role_id !== $source) {
                    $start_obj = $this->rbac_review->getRoleFolderOfRole($role_id);
                    $this->logger->debug('Start object: ' . $start_obj);

                    switch ($adjustment_type) {
                        case self::COPY_ADD_PERMISSIONS:
                            $change_existing = (bool) $form->getInput('add_ce_type');
                            $this->doAddRolePermissions(
                                $source,
                                $role_id
                            );
                            if ($change_existing) {
                                $this->doChangeExistingObjects(
                                    $start_obj,
                                    $role_id,
                                    \ilObjRole::MODE_ADD_OPERATIONS,
                                    $source
                                );
                            }
                            break;
                        case self::COPY_CLONE_PERMISSIONS:
                            $change_existing = (bool) $form->getInput('clone_ce_type');
                            $this->doCopyRole(
                                $source,
                                $role_id
                            );
                            if ($change_existing) {
                                $this->doChangeExistingObjects(
                                    $start_obj,
                                    $role_id,
                                    \ilObjRole::MODE_READ_OPERATIONS,
                                    $source
                                );
                            }
                            break;
                        case self::COPY_REMOVE_PERMISSIONS:
                            $change_existing = (bool) $form->getInput('remove_ce_type');
                            $this->doRemoveRolePermissions(
                                $source,
                                $role_id
                            );
                            if ($change_existing) {
                                $this->doChangeExistingObjects(
                                    $start_obj,
                                    $role_id,
                                    \ilObjRole::MODE_REMOVE_OPERATIONS,
                                    $source
                                );
                            }
                            break;
                    }
                }
            }
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('rbac_copy_finished'), true);
            $this->ctrl->redirect($this, 'view');
        }
    }

Here is the call graph for this function:

applyFilterObject()

ilObjRoleFolderGUI::applyFilterObject ( )

protected

Apply role filter.

Definition at line 579 of file class.ilObjRoleFolderGUI.php.

References viewObject().

                                          : void
    {
        $table = new ilRoleTableGUI($this, 'view');
        $table->init();
        $table->resetOffset();
        $table->writeFilterToSession();

        $this->viewObject();
    }

Here is the call graph for this function:

chooseCopyBehaviourObject()

ilObjRoleFolderGUI::chooseCopyBehaviourObject ( ?ilPropertyFormGUI  $form = null )

protected

Choose option for copying roles/role templates.

Definition at line 270 of file class.ilObjRoleFolderGUI.php.

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

                                                                                 : void
    {
        $this->initCopySourceFromGET();

        $this->ctrl->saveParameter($this, 'csource');
        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $this->lng->txt('rbac_back_to_overview'),
            $this->ctrl->getLinkTarget($this, 'view')
        );
        if (!$form instanceof \ilPropertyFormGUI) {
            $form = $this->initCopyBehaviourForm();
        }
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

confirmDeleteObject()

ilObjRoleFolderGUI::confirmDeleteObject ( )

protected

Confirm deletion of roles.

Definition at line 605 of file class.ilObjRoleFolderGUI.php.

References ilObjRole\_getTranslation(), ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), initRolesFromPOST(), and ILIAS\Repository\lng().

                                            : void
    {
        $roles = $this->initRolesFromPOST();
        if ($roles === []) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
            $this->ctrl->redirect($this, 'view');
        }

        $question = $this->lng->txt('rbac_role_delete_qst');

        $confirm = new ilConfirmationGUI();
        $confirm->setHeaderText($question);
        $confirm->setFormAction($this->ctrl->getFormAction($this));
        $confirm->setHeaderText($this->lng->txt("info_delete_sure"));
        $confirm->setConfirm($this->lng->txt('delete'), 'deleteRole');
        $confirm->setCancel($this->lng->txt('cancel'), 'cancel');

        foreach ($roles as $role_id) {
            $confirm->addItem(
                'roles[]',
                (string) $role_id,
                ilObjRole::_getTranslation(ilObject::_lookupTitle($role_id))
            );
        }
        $this->tpl->setContent($confirm->getHTML());
    }

Here is the call graph for this function:

deleteRoleObject()

ilObjRoleFolderGUI::deleteRoleObject ( )

protected

Delete roles.

Definition at line 635 of file class.ilObjRoleFolderGUI.php.

References ilObjectGUI\$id, ILIAS\Repository\ctrl(), ilObjectFactory\getInstanceByObjId(), initRolesFromPOST(), and ILIAS\Repository\lng().

                                         : void
    {
        if (!$this->rbac_system->checkAccess('delete', $this->object->getRefId())) {
            $this->error->raiseError(
                $this->lng->txt('msg_no_perm_delete'),
                $this->error->MESSAGE
            );
        }

        foreach ($this->initRolesFromPOST() as $id) {
            // instatiate correct object class (role or rolt)
            $obj = ilObjectFactory::getInstanceByObjId($id, false);

            if ($obj->getType() == "role") {
                $rolf_arr = $this->rbac_review->getFoldersAssignedToRole($obj->getId(), true);
                $obj->setParent($rolf_arr[0]);
            }

            $obj->delete();
        }

        // set correct return location if rolefolder is removed
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_deleted_roles_rolts"), true);
        $this->ctrl->redirect($this, 'view');
    }

Here is the call graph for this function:

doAddRolePermissions()

ilObjRoleFolderGUI::doAddRolePermissions ( int  $source, int  $target  )

protected

do add role permission

Definition at line 471 of file class.ilObjRoleFolderGUI.php.

Referenced by adjustRoleObject().

                                                                     : void
    {
        $source_definition = $this->rbac_review->getRoleFolderOfRole($source);
        $this->rbacadmin->copyRolePermissionUnion(
            $source,
            $source_definition,
            $target,
            $this->rbac_review->getRoleFolderOfRole($target),
            $target,
            $this->rbac_review->getRoleFolderOfRole($target)
        );
    }

Here is the caller graph for this function:

doChangeExistingObjects()

ilObjRoleFolderGUI::doChangeExistingObjects ( int  $a_start_obj, int  $a_target_role, int  $a_operation_mode, int  $a_source_role  )

protected

Do change existing objects.

Definition at line 540 of file class.ilObjRoleFolderGUI.php.

References ilLogLevel\DEBUG, ILIAS\Repository\logger(), ilObjRole\MODE_PROTECTED_KEEP_LOCAL_POLICIES, ilObjRole\MODE_READ_OPERATIONS, ilObjRole\MODE_UNPROTECTED_KEEP_LOCAL_POLICIES, and ilLogLevel\WARNING.

Referenced by adjustRoleObject().

     : void {
        if (!$a_start_obj) {
            $this->logger->warning('Missing parameter start object.');
            $this->logger->logStack(\ilLogLevel::WARNING);
            throw new InvalidArgumentException('Missing parameter: start object');
        }
        // the mode is unchanged and read out from the target object
        $target_ref_id = $this->rbac_review->getRoleFolderOfRole($a_target_role);
        if ($this->rbac_review->isProtected($target_ref_id, $a_target_role)) {
            $mode = \ilObjRole::MODE_PROTECTED_KEEP_LOCAL_POLICIES;
        } else {
            $mode = \ilObjRole::MODE_UNPROTECTED_KEEP_LOCAL_POLICIES;
        }
        $operation_stack = [];
        if ($a_operation_mode !== \ilObjRole::MODE_READ_OPERATIONS) {
            $operation_stack[] = $this->rbac_review->getAllOperationsOfRole($a_source_role, $this->ref_id);
        }
        $this->logger->debug('Current operation stack');
        $this->logger->dump($operation_stack, ilLogLevel::DEBUG);

        $role = new ilObjRole($a_target_role);
        $role->changeExistingObjects(
            $a_start_obj,
            $mode,
            ['all'],
            [],
            $a_operation_mode,
            $operation_stack
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doCopyRole()

ilObjRoleFolderGUI::doCopyRole ( int  $source, int  $target  )

protected

Perform copy of role.

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

Referenced by adjustRoleObject().

                                                           : void
    {
        $target_obj = $this->rbac_review->getRoleFolderOfRole($target);
        $source_obj = $this->rbac_review->getRoleFolderOfRole($source);
        // Copy role template permissions
        $this->rbacadmin->copyRoleTemplatePermissions(
            $source,
            $source_obj,
            $target_obj,
            $target
        );
    }

Here is the caller graph for this function:

doRemoveRolePermissions()

ilObjRoleFolderGUI::doRemoveRolePermissions ( int  $source, int  $target  )

protected

do add role permission

Definition at line 508 of file class.ilObjRoleFolderGUI.php.

References ILIAS\Repository\logger().

Referenced by adjustRoleObject(), and removeRolePermissionsObject().

                                                                        : void
    {
        $this->logger->debug('Remove permission source: ' . $source);
        $this->logger->debug('Remove permission target: ' . $target);
        $source_obj = $this->rbac_review->getRoleFolderOfRole($source);
        $this->rbacadmin->copyRolePermissionSubtract(
            $source,
            $source_obj,
            $target,
            $this->rbac_review->getRoleFolderOfRole($target)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editSettingsObject()

ilObjRoleFolderGUI::editSettingsObject

(

?ilPropertyFormGUI

$a_form = null

)

Definition at line 698 of file class.ilObjRoleFolderGUI.php.

References initSettingsForm(), and null.

Referenced by saveSettingsObject().

                                                                         : void
    {
        if ($a_form === null) {
            $a_form = $this->initSettingsForm();
        }

        $this->tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilObjRoleFolderGUI::executeCommand

(

)

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

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

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
        $this->prepareOutput();

        switch ($next_class) {
            case 'ilpermissiongui':
                $perm_gui = new ilPermissionGUI($this);
                $ret = $this->ctrl->forwardCommand($perm_gui);
                break;

            default:
                $this->ctrl->setReturn($this, "view");
                if (!$cmd) {
                    $cmd = "view";
                }
                $cmd .= "Object";
                $this->$cmd();

                break;
        }
    }

Here is the call graph for this function:

getAdminTabs()

ilObjRoleFolderGUI::getAdminTabs

(

)

Add role folder tabs.

Parameters

ilTabsGUI

$tabs_gui

ilLanguage $lng ilTree $tree

Definition at line 667 of file class.ilObjRoleFolderGUI.php.

References ilObjectGUI\checkPermissionBool(), and ILIAS\Repository\ctrl().

                                  : void
    {
        if ($this->checkPermissionBool("visible,read")) {
            $this->tabs_gui->addTarget(
                "view",
                $this->ctrl->getLinkTarget($this, "view"),
                ["", "view"],
                get_class($this)
            );

            $this->tabs_gui->addTarget(
                "settings",
                $this->ctrl->getLinkTarget($this, "editSettings"),
                ["editSettings"],
                get_class($this)
            );
        }

        if ($this->checkPermissionBool("edit_permission")) {
            $this->tabs_gui->addTarget(
                "perm_settings",
                $this->ctrl->getLinkTargetByClass(
                    [get_class($this), 'ilpermissiongui'],
                    "perm"
                ),
                "",
                "ilpermissiongui"
            );
        }
    }

Here is the call graph for this function:

initCopyBehaviourForm()

ilObjRoleFolderGUI::initCopyBehaviourForm ( )

protected

Show copy behaviour form.

Definition at line 289 of file class.ilObjRoleFolderGUI.php.

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

Referenced by adjustRoleObject(), chooseCopyBehaviourObject(), and removeRolePermissionsObject().

                                              : ilPropertyFormGUI
    {
        // not only for role templates; add/remove permissions is also applicable for roles
        $full_featured = true;

        $form = new ilPropertyFormGUI();
        $form->setTitle($this->lng->txt('rbac_copy_behaviour'));
        $form->setFormAction($this->ctrl->getFormAction($this, 'chooseCopyBehaviour'));

        $copy_type = new \ilRadioGroupInputGUI(
            $this->lng->txt('rbac_form_copy_roles_adjust_type'),
            'type'
        );
        $copy_type->setRequired(true);
        $copy_type->setValue((string) self::COPY_CLONE_PERMISSIONS);

        if ($full_featured) {
            $add = new \ilRadioOption(
                $this->lng->txt('rbac_form_copy_roles_adjust_type_add'),
                (string) self::COPY_ADD_PERMISSIONS,
                $this->lng->txt('rbac_form_copy_roles_adjust_type_add_info')
            );
            $copy_type->addOption($add);

            $ce_type_add = new \ilRadioGroupInputGUI(
                '',
                'add_ce_type'
            );
            $ce_type_add->setRequired(true);
            $ce_add_yes = new \ilRadioOption(
                $this->lng->txt('rbac_form_copy_roles_ce_add_yes'),
                (string) self::COPY_CHANGE_EXISTING_OBJECTS,
                $this->lng->txt('rbac_form_copy_roles_ce_add_yes_info')
            );
            $ce_type_add->addOption($ce_add_yes);
            $ce_add_no = new \ilRadioOption(
                $this->lng->txt('rbac_form_copy_roles_ce_add_no'),
                (string) 0,
                $this->lng->txt('rbac_form_copy_roles_ce_add_no_info')
            );
            $ce_type_add->addOption($ce_add_no);
            $add->addSubItem($ce_type_add);
        }
        $clone = new \ilRadioOption(
            $this->lng->txt('rbac_form_copy_roles_adjust_type_clone'),
            (string) self::COPY_CLONE_PERMISSIONS,
            $this->lng->txt('rbac_form_copy_roles_adjust_type_clone_info')
        );
        $copy_type->addOption($clone);

        $ce_type_clone = new \ilRadioGroupInputGUI(
            '',
            'clone_ce_type'
        );
        $ce_type_clone->setRequired(true);
        $ce_clone_yes = new \ilRadioOption(
            $this->lng->txt('rbac_form_copy_roles_ce_clone_yes'),
            (string) self::COPY_CHANGE_EXISTING_OBJECTS,
            $this->lng->txt('rbac_form_copy_roles_ce_clone_yes_info')
        );
        $ce_type_clone->addOption($ce_clone_yes);
        $ce_clone_no = new \ilRadioOption(
            $this->lng->txt('rbac_form_copy_roles_ce_clone_no'),
            (string) 0,
            $this->lng->txt('rbac_form_copy_roles_ce_clone_no_info')
        );
        $ce_type_clone->addOption($ce_clone_no);
        $clone->addSubItem($ce_type_clone);

        if ($full_featured) {
            $remove = new \ilRadioOption(
                $this->lng->txt('rbac_form_copy_roles_adjust_type_remove'),
                (string) self::COPY_REMOVE_PERMISSIONS,
                $this->lng->txt('rbac_form_copy_roles_adjust_type_remove_info')
            );
            $copy_type->addOption($remove);
            $ce_type_remove = new \ilRadioGroupInputGUI(
                '',
                'remove_ce_type'
            );
            $ce_type_remove->setRequired(true);
            $ce_remove_yes = new \ilRadioOption(
                $this->lng->txt('rbac_form_copy_roles_ce_remove_yes'),
                (string) self::COPY_CHANGE_EXISTING_OBJECTS,
                $this->lng->txt('rbac_form_copy_roles_ce_remove_yes_info')
            );
            $ce_type_remove->addOption($ce_remove_yes);
            $ce_remove_no = new \ilRadioOption(
                $this->lng->txt('rbac_form_copy_roles_ce_remove_no'),
                (string) 0,
                $this->lng->txt('rbac_form_copy_roles_ce_remove_no_info')
            );
            $ce_type_remove->addOption($ce_remove_no);
            $remove->addSubItem($ce_type_remove);
        }

        $form->addItem($copy_type);

        $roles = new ilHiddenInputGUI('roles');
        $roles->setValue(implode(',', $this->initRolesFromPOST()));
        $form->addItem($roles);

        $form->addCommandButton('roleSearchList', $this->lng->txt('back'));
        $form->addCommandButton('adjustRole', $this->lng->txt('rbac_form_copy_roles_adjust_button'));
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initCopySourceFromGET()

ilObjRoleFolderGUI::initCopySourceFromGET ( )

protected

Definition at line 89 of file class.ilObjRoleFolderGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by adjustRoleObject(), chooseCopyBehaviourObject(), removeRolePermissionsObject(), roleSearchFormObject(), roleSearchListObject(), and roleSearchObject().

                                              : int
    {
        if ($this->http->wrapper()->query()->has('csource')) {
            return $this->http->wrapper()->query()->retrieve(
                'csource',
                $this->refinery->kindlyTo()->int()
            );
        }
        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initRoleSearchForm()

ilObjRoleFolderGUI::initRoleSearchForm ( )

protected

Init role search form.

Definition at line 203 of file class.ilObjRoleFolderGUI.php.

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

Referenced by roleSearchFormObject(), and roleSearchObject().

                                           : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setTitle($this->lng->txt('rbac_role_title'));
        $form->setFormAction($this->ctrl->getFormAction($this, 'view'));

        $search = new ilTextInputGUI($this->lng->txt('title'), 'title');
        $search->setRequired(true);
        $search->setSize(30);
        $search->setMaxLength(255);
        $form->addItem($search);

        $form->addCommandButton('roleSearchForm', $this->lng->txt('search'));
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initRolesFromPOST()

ilObjRoleFolderGUI::initRolesFromPOST ( )

protected

Returns

int[]

Definition at line 103 of file class.ilObjRoleFolderGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by adjustRoleObject(), confirmDeleteObject(), deleteRoleObject(), initCopyBehaviourForm(), and removeRolePermissionsObject().

                                          : array
    {
        if ($this->http->wrapper()->post()->has('roles')) {
            return $this->http->wrapper()->post()->retrieve(
                'roles',
                $this->refinery->byTrying([
                    $this->refinery->kindlyTo()->listOf(
                        $this->refinery->kindlyTo()->int()
                    ),
                    $this->refinery->in()->series([
                        $this->refinery->custom()->transformation(function ($v) {
                            return explode(',', $v);
                        }),
                        $this->refinery->kindlyTo()->listOf(
                            $this->refinery->kindlyTo()->int()
                        )
                    ])
                ])
            );
        }
        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initSettingsForm()

ilObjRoleFolderGUI::initSettingsForm ( )

protected

Definition at line 737 of file class.ilObjRoleFolderGUI.php.

References $check, $DIC, $GLOBALS, ilObjectGUI\$user, ilSecuritySettings\_getInstance(), ILIAS\Repository\ctrl(), ilObject\getId(), ilPrivacySettings\getInstance(), ILIAS\Repository\lng(), ilFormPropertyGUI\setInfo(), and SYSTEM_ROLE_ID.

Referenced by editSettingsObject(), and saveSettingsObject().

                                         : ilPropertyFormGUI
    {
        global $DIC;

        $user = $DIC->user();

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

        $privacy = ilPrivacySettings::getInstance();
        $security = ilSecuritySettings::_getInstance();

        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, "saveSettings"));
        $form->setTitle($this->lng->txt('settings'));

        // protected admin
        $admin = new ilCheckboxInputGUI($GLOBALS['DIC']['lng']->txt('adm_adm_role_protect'), 'admin_role');
        $admin->setDisabled(!$this->rbac_review->isAssigned($user->getId(), SYSTEM_ROLE_ID));
        $admin->setInfo($this->lng->txt('adm_adm_role_protect_info'));
        $admin->setChecked($security->isAdminRoleProtected());
        $admin->setValue((string) 1);
        $form->addItem($admin);

        $check = new ilCheckboxInputGUI($this->lng->txt('rbac_log'), 'rbac_log');
        $check->setInfo($this->lng->txt('rbac_log_info'));
        $check->setChecked($privacy->enabledRbacLog());
        $form->addItem($check);

        $age = new ilNumberInputGUI($this->lng->txt('rbac_log_age'), 'rbac_log_age');
        $age->setInfo($this->lng->txt('rbac_log_age_info'));
        $age->setValue((string) $privacy->getRbacLogAge());
        $age->setMinValue(1);
        $age->setMaxValue(24);
        $age->setSize(2);
        $age->setMaxLength(2);
        $check->addSubItem($age);

        $form->addCommandButton('saveSettings', $this->lng->txt('save'));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

removeRolePermissionsObject()

ilObjRoleFolderGUI::removeRolePermissionsObject ( )

protected

Remove role permissions.

Definition at line 487 of file class.ilObjRoleFolderGUI.php.

References ILIAS\Repository\ctrl(), doRemoveRolePermissions(), initCopyBehaviourForm(), initCopySourceFromGET(), initRolesFromPOST(), and ILIAS\Repository\lng().

                                                    : void
    {
        // Finally copy role/rolt
        $roles = $this->initRolesFromPOST();
        $source = $this->initCopySourceFromGET();

        $form = $this->initCopyBehaviourForm();
        if ($form->checkInput()) {
            foreach ((array) $roles as $role_id) {
                if ($role_id !== $source) {
                    $this->doRemoveRolePermissions($source, $role_id);
                }
            }
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('rbac_copy_finished'), true);
            $this->ctrl->redirect($this, 'view');
        }
    }

Here is the call graph for this function:

resetFilterObject()

ilObjRoleFolderGUI::resetFilterObject

(

)

Reset role filter.

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

References viewObject().

                                       : void
    {
        $table = new ilRoleTableGUI($this, 'view');
        $table->init();
        $table->resetOffset();
        $table->resetFilter();

        $this->viewObject();
    }

Here is the call graph for this function:

returnObject()

ilObjRoleFolderGUI::returnObject

(

)

Definition at line 126 of file class.ilObjRoleFolderGUI.php.

References viewObject().

                                  : void
    {
        $this->viewObject();
    }

Here is the call graph for this function:

roleSearchFormObject()

ilObjRoleFolderGUI::roleSearchFormObject ( )

protected

Parse search query.

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

References ILIAS\Repository\ctrl(), initCopySourceFromGET(), initRoleSearchForm(), ILIAS\Repository\lng(), roleSearchListObject(), and ilSession\set().

                                             : void
    {
        ilSession::set('rolf_search_query', '');
        $this->ctrl->setParameter($this, 'csource', $this->initCopySourceFromGET());

        $form = $this->initRoleSearchForm();
        if ($form->checkInput()) {
            ilSession::set('rolf_search_query', $form->getInput('title'));
            $this->roleSearchListObject();
            return;
        }

        $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_search_string'), true);
        $form->setValuesByPost();
        $this->ctrl->redirect($this, 'roleSearch');
    }

Here is the call graph for this function:

roleSearchListObject()

ilObjRoleFolderGUI::roleSearchListObject ( )

protected

List roles.

Definition at line 242 of file class.ilObjRoleFolderGUI.php.

References ILIAS\Repository\ctrl(), ilSession\get(), initCopySourceFromGET(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ilRoleTableGUI\TYPE_SEARCH.

Referenced by roleSearchFormObject().

                                             : void
    {
        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $this->lng->txt('rbac_back_to_overview'),
            $this->ctrl->getLinkTarget($this, 'view')
        );

        $this->ctrl->setParameter($this, 'csource', $this->initCopySourceFromGET());

        if (strlen(ilSession::get('rolf_search_query'))) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('rbac_select_copy_targets'));
            $table = new ilRoleTableGUI($this, 'roleSearchList');
            $table->setType(ilRoleTableGUI::TYPE_SEARCH);
            $table->setRoleTitleFilter(ilSession::get('rolf_search_query'));
            $table->init();
            $table->parse($this->object->getId());
            $this->tpl->setContent($table->getHTML());
            return;
        }

        $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_search_string'), true);
        $this->ctrl->redirect($this, 'roleSearch');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

roleSearchObject()

ilObjRoleFolderGUI::roleSearchObject ( )

protected

Search target roles.

Definition at line 181 of file class.ilObjRoleFolderGUI.php.

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

                                         : void
    {
        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $this->lng->txt('rbac_back_to_overview'),
            $this->ctrl->getLinkTarget($this, 'view')
        );

        if (!$this->rbac_system->checkAccess('visible,read', $this->object->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $this->ctrl->setParameter($this, 'csource', $this->initCopySourceFromGET());
        $this->tpl->setOnScreenMessage('info', $this->lng->txt('rbac_choose_copy_targets'));

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

Here is the call graph for this function:

saveSettingsObject()

ilObjRoleFolderGUI::saveSettingsObject

(

)

Definition at line 707 of file class.ilObjRoleFolderGUI.php.

References $DIC, ilObjectGUI\$user, ilSecuritySettings\_getInstance(), ilObjectGUI\checkPermissionBool(), ILIAS\Repository\ctrl(), editSettingsObject(), ilObject\getId(), ilPrivacySettings\getInstance(), initSettingsForm(), ILIAS\Repository\lng(), and SYSTEM_ROLE_ID.

                                        : void
    {
        global $DIC;

        $user = $DIC->user();

        if (!$this->checkPermissionBool("write")) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $form = $this->initSettingsForm();
        if ($form->checkInput()) {
            $privacy = ilPrivacySettings::getInstance();
            $privacy->enableRbacLog((bool) $form->getInput('rbac_log'));
            $privacy->setRbacLogAge((int) $form->getInput('rbac_log_age'));
            $privacy->save();

            if ($this->rbac_review->isAssigned($user->getId(), SYSTEM_ROLE_ID)) {
                $security = ilSecuritySettings::_getInstance();
                $security->protectedAdminRole((bool) $form->getInput('admin_role'));
                $security->save();
            }
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("settings_saved"), true);
            $this->ctrl->redirect($this, "editSettings");
        }

        $form->setValuesByPost();
        $this->editSettingsObject($form);
    }

Here is the call graph for this function:

viewObject()

ilObjRoleFolderGUI::viewObject

(

)

Definition at line 131 of file class.ilObjRoleFolderGUI.php.

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

Referenced by applyFilterObject(), resetFilterObject(), and returnObject().

                                : void
    {
        $this->tabs_gui->activateTab('view');

        if (!$this->rbac_system->checkAccess('visible,read', $this->object->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        if ($this->rbac_system->checkAccess('create_role', $this->object->getRefId())) {
            $this->ctrl->setParameter($this, 'new_type', 'role');
            $this->toolbar->addComponent(
                $this->ui_factory->link()->standard(
                    $this->lng->txt('rolf_create_role'),
                    $this->ctrl->getLinkTargetByClass(ilObjRoleGUI::class, 'create')
                )
            );
        }
        if ($this->rbac_system->checkAccess('create_rolt', $this->object->getRefId())) {
            $this->ctrl->setParameter($this, 'new_type', 'rolt');
            $this->toolbar->addComponent(
                $this->ui_factory->link()->standard(
                    $this->lng->txt('rolf_create_rolt'),
                    $this->ctrl->getLinkTargetByClass(ilObjRoleTemplateGUI::class, 'create')
                )
            );
            $this->ctrl->clearParameters($this);
        }

        if (
            $this->rbac_system->checkAccess('create_rolt', $this->object->getRefId()) ||
            $this->rbac_system->checkAccess('create_rolt', $this->object->getRefId())
        ) {
            $this->toolbar->addComponent(
                $this->ui_factory->link()->standard(
                    $this->lng->txt('rbac_import_role'),
                    $this->ctrl->getLinkTargetByClass('ilPermissionGUI', 'displayImportRoleForm')
                )
            );
        }

        $table = new ilRoleTableGUI($this, 'view');
        $table->init();
        $table->parse($this->object->getId());

        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$http

GlobalHttpState ilObjRoleFolderGUI::$http

protected

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

$logger

ilLogger ilObjRoleFolderGUI::$logger

private

Definition at line 39 of file class.ilObjRoleFolderGUI.php.

$rbacadmin

ilRbacAdmin ilObjRoleFolderGUI::$rbacadmin

protected

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

$refinery

Factory ilObjRoleFolderGUI::$refinery

protected

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

$ui_factory

UIFactory ilObjRoleFolderGUI::$ui_factory

protected

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

COPY_ADD_PERMISSIONS

const ilObjRoleFolderGUI::COPY_ADD_PERMISSIONS = 1

private

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

COPY_CHANGE_EXISTING_OBJECTS

const ilObjRoleFolderGUI::COPY_CHANGE_EXISTING_OBJECTS = 1

private

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

COPY_CLONE_PERMISSIONS

const ilObjRoleFolderGUI::COPY_CLONE_PERMISSIONS = 2

private

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

COPY_REMOVE_PERMISSIONS

const ilObjRoleFolderGUI::COPY_REMOVE_PERMISSIONS = 3

private

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

---

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

• components/ILIAS/AccessControl/classes/class.ilObjRoleFolderGUI.php