ilObjRoleFolderGUI Class Reference

Class ilObjRoleFolderGUI. More...

Inheritance diagram for ilObjRoleFolderGUI:

Collaboration diagram for ilObjRoleFolderGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference)
	Constructor public. More...
	executeCommand ()
	viewObject ()
	ilErrorHandler $ilErr ilRbacSystem $rbacsystem ilToolbarGUI $ilToolbar More...
	resetFilterObject ()
	Reset role filter. More...
	createObject ()
	role folders are created automatically DEPRECATED !!! public More...
	deleteObject ($a_error=false)
	display deletion confirmation screen DEPRECATED !!! public More...
	adoptPermSaveObject ()
	??? TODO: what is the purpose of this function? public More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) overwritten to prevent displaying of role templates in local role folders More...
	saveObject ()
	save object public More...
	getAdminTabs ()
	Add role folder tabs ilTree $tree ilLanguage $lng. More...
	editSettingsObject (ilPropertyFormGUI $a_form=null)
	saveSettingsObject ()
	addToExternalSettingsForm ($a_form_id)
Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	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 public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	list childs of current object More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...

Data Fields
	$type
Data Fields inherited from ilObjectGUI
const	COPY_WIZARD_NEEDS_PAGE = 1
	$objDefinition
	$tpl
	$tree
	$lng
	$data
	$object
	$ref_id
	$obj_id
	$maxcount
	$formaction
	$return_location
	$target_frame
	$tab_target_script
	$actions
	$sub_objects
	$omit_locator = false
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Protected Member Functions
	roleSearchObject ()
	Search target roles. More...
	initRoleSearchForm ()
	Init role search form. More...
	roleSearchFormObject ()
	Parse search query type $ilCtrl. More...
	roleSearchListObject ()
	List roles. More...
	chooseCopyBehaviourObject ()
	Chosse change existing objects,... More...
	initCopyBehaviourForm ()
	Show copy behaviour form. More...
	copyRoleObject ()
	Copy role. More...
	addRolePermissionsObject ()
	Add role permissions. More...
	doAddRolePermissions ($source, $target, $change_existing)
	do add role permission More...
	removeRolePermissionsObject ()
	Remove role permissions. More...
	doRemoveRolePermissions ($source, $target, $change_existing)
	do add role permission More...
	doCopyRole ($source, $target, $change_existing)
	Perform copy of role ilTree $tree <type> $rbacadmin <type> $rbacreview. More...
	doChangeExistingObjects ($a_start_obj, $a_target_role)
	Do change existing objects type $rbacreview. More...
	applyFilterObject ()
	Apply role filter. More...
	confirmDeleteObject ()
	Confirm deletion of roles. More...
	deleteRoleObject ()
	Delete roles. More...
	initSettingsForm ()
Protected Member Functions inherited from ilObjectGUI
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	showMountWebfolderIcon ()
	setTabs ()
	set admin tabs public More...
	setAdminTabs ()
	set admin tabs public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...
	redirectToRefId ($a_ref_id, $a_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 $_GET["ref_id"] value More...
	fillCloneTemplate ($a_tpl_varname, $a_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...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...
Protected Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$settings
	$rbacreview
	$toolbar
	$rbacsystem
	$tmp_import_dir
	$tabs_gui = null
	$ctrl

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

Version

$Id$

ilObjRoleFolderGUI: ilPermissionGUI

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

Constructor & Destructor Documentation

__construct()

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

Constructor public.

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

References ilObjectGUI\$lng.

    {
        global $lng;

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

Member Function Documentation

addRolePermissionsObject()

ilObjRoleFolderGUI::addRolePermissionsObject ( )

protected

Add role permissions.

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

References $_POST, $form, $ilCtrl, $source, array, doAddRolePermissions(), initCopyBehaviourForm(), and ilUtil\sendSuccess().

    {
        global $ilCtrl;

        // Finally copy role/rolt
        $roles = explode(',', $_POST['roles']);
        $source = (int) $_REQUEST['copy_source'];

        $form = $this->initCopyBehaviourForm();
        if ($form->checkInput()) {
            foreach ((array) $roles as $role_id) {
                if ($role_id != $source) {
                    $this->doAddRolePermissions($source, $role_id, $form->getInput('change_existing'));
                }
            }

            ilUtil::sendSuccess($this->lng->txt('rbac_copy_finished'), true);
            $ilCtrl->redirect($this, 'view');
        }
    }

Here is the call graph for this function:

addToExternalSettingsForm()

ilObjRoleFolderGUI::addToExternalSettingsForm

(

$a_form_id

)

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

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

    {
        switch ($a_form_id) {
            case ilAdministrationSettingsFormHandler::FORM_SECURITY:
                
                include_once('./Services/PrivacySecurity/classes/class.ilSecuritySettings.php');
                $security = ilSecuritySettings::_getInstance();
                
                $fields = array('adm_adm_role_protect' => array($security->isAdminRoleProtected(), ilAdministrationSettingsFormHandler::VALUE_BOOL));
                
                return array(array("editSettings", $fields));
                
            case ilAdministrationSettingsFormHandler::FORM_PRIVACY:
                
                include_once('./Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
                $privacy = ilPrivacySettings::_getInstance();
                
                $subitems = null;
                if ((bool) $privacy->enabledRbacLog()) {
                    $subitems = array('rbac_log_age' => $privacy->getRbacLogAge());
                }
                $fields = array('rbac_log' => array($privacy->enabledRbacLog(), ilAdministrationSettingsFormHandler::VALUE_BOOL, $subitems));
                
                return array(array("editSettings", $fields));
        }
    }

Here is the call graph for this function:

adoptPermSaveObject()

ilObjRoleFolderGUI::adoptPermSaveObject

(

)

??? TODO: what is the purpose of this function? public

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

References ilUtil\sendSuccess().

    {
        ilUtil::sendSuccess($this->lng->txt("saved_successfully"), true);
        
        $this->ctrl->redirect($this, "view");
    }

Here is the call graph for this function:

applyFilterObject()

ilObjRoleFolderGUI::applyFilterObject ( )

protected

Apply role filter.

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

References $table, and viewObject().

    {
        include_once './Services/AccessControl/classes/class.ilRoleTableGUI.php';
        $table = new ilRoleTableGUI($this, 'view');
        $table->init();
        $table->resetOffset();
        $table->writeFilterToSession();

        $this->viewObject();
    }

Here is the call graph for this function:

chooseCopyBehaviourObject()

ilObjRoleFolderGUI::chooseCopyBehaviourObject ( )

protected

Chosse change existing objects,...

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

References $form, $ilCtrl, and initCopyBehaviourForm().

    {
        global $ilCtrl, $ilTabs;

        $ilCtrl->saveParameter($this, 'copy_source', (int) $_REQUEST['copy_source']);
        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $this->lng->txt('rbac_back_to_overview'),
            $this->ctrl->getLinkTarget($this, 'roleSearchList')
        );
        $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 528 of file class.ilObjRoleFolderGUI.php.

References $_POST, $ilCtrl, ilObjRole\_getTranslation(), ilObject\_lookupTitle(), and ilUtil\sendFailure().

    {
        global $ilCtrl;

        if (!count($_POST['roles'])) {
            ilUtil::sendFailure($this->lng->txt('select_one'), true);
            $ilCtrl->redirect($this, 'view');
        }

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

        include_once './Services/Utilities/classes/class.ilConfirmationGUI.php';
        $confirm = new ilConfirmationGUI();
        $confirm->setHeaderText($question);
        $confirm->setFormAction($ilCtrl->getFormAction($this));
        $confirm->setHeaderText($this->lng->txt("info_delete_sure"));
        $confirm->setConfirm($this->lng->txt('delete'), 'deleteRole');
        $confirm->setCancel($this->lng->txt('cancel'), 'cancel');


        include_once './Services/AccessControl/classes/class.ilObjRole.php';
        foreach ($_POST['roles'] as $role_id) {
            $confirm->addItem(
                'roles[]',
                $role_id,
                ilObjRole::_getTranslation(ilObject::_lookupTitle($role_id))
            );
        }
        $this->tpl->setContent($confirm->getHTML());
    }

Here is the call graph for this function:

copyRoleObject()

ilObjRoleFolderGUI::copyRoleObject ( )

protected

Copy role.

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

References $_POST, $form, $ilCtrl, $source, array, doCopyRole(), initCopyBehaviourForm(), and ilUtil\sendSuccess().

    {
        global $ilCtrl;

        // Finally copy role/rolt
        $roles = explode(',', $_POST['roles']);
        $source = (int) $_REQUEST['copy_source'];

        $form = $this->initCopyBehaviourForm();
        if ($form->checkInput()) {
            foreach ((array) $roles as $role_id) {
                if ($role_id != $source) {
                    $this->doCopyRole($source, $role_id, $form->getInput('change_existing'));
                }
            }

            ilUtil::sendSuccess($this->lng->txt('rbac_copy_finished'), true);
            $ilCtrl->redirect($this, 'view');
        }
    }

Here is the call graph for this function:

createObject()

ilObjRoleFolderGUI::createObject

(

)

role folders are created automatically DEPRECATED !!! public

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

    {
        $this->ilias->raiseError($this->lng->txt("permission_denied"), $this->ilias->error_obj->MESSAGE);
        
        /*
        $this->object->setTitle($this->lng->txt("obj_".$this->object->getType()."_local"));
        $this->object->setDescription("obj_".$this->object->getType()."_local_desc");

        $this->saveObject();
        */
    }

deleteObject()

ilObjRoleFolderGUI::deleteObject

(

$a_error = false

)

display deletion confirmation screen DEPRECATED !!! public

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

    {
        $this->ilias->raiseError($this->lng->txt("permission_denied"), $this->ilias->error_obj->MESSAGE);
    }

deleteRoleObject()

ilObjRoleFolderGUI::deleteRoleObject ( )

protected

Delete roles.

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

References $_POST, $id, $ilCtrl, ilObjectGUI\$ilErr, ilObjectGUI\$rbacreview, ilObjectGUI\$rbacsystem, array, ilObjectFactory\getInstanceByObjId(), and ilUtil\sendSuccess().

    {
        global $rbacsystem,$ilErr,$rbacreview,$ilCtrl;

        if (!$rbacsystem->checkAccess('delete', $this->object->getRefId())) {
            $ilErr->raiseError(
                $this->lng->txt('msg_no_perm_delete'),
                $ilErr->MESSAGE
            );
        }

        foreach ((array) $_POST['roles'] as $id) {
            // instatiate correct object class (role or rolt)
            $obj = ilObjectFactory::getInstanceByObjId($id, false);

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

            $obj->delete();
        }

        // set correct return location if rolefolder is removed
        ilUtil::sendSuccess($this->lng->txt("msg_deleted_roles_rolts"), true);
        $ilCtrl->redirect($this, 'view');
    }

Here is the call graph for this function:

doAddRolePermissions()

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

protected

do add role permission

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

References ilObjectGUI\$rbacreview, $source, $target, doChangeExistingObjects(), and object.

Referenced by addRolePermissionsObject().

    {
        global $rbacadmin, $rbacreview;
        
        $rbacadmin->copyRolePermissionUnion(
            $source,
            $this->object->getRefId(),
            $target,
            $rbacreview->getRoleFolderOfRole($target),
            $target,
            $rbacreview->getRoleFolderOfRole($target)
        );
        
        if ($change_existing) {
            $target_obj = $rbacreview->getRoleFolderOfRole($target);
            $this->doChangeExistingObjects($target_obj, $target);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doChangeExistingObjects()

ilObjRoleFolderGUI::doChangeExistingObjects (   $a_start_obj,   $a_target_role  )

protected

Do change existing objects type $rbacreview.

Parameters

type	$a_start_obj
type	$a_source_role

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

References ilObjectGUI\$rbacreview, array, ilObjRole\MODE_PROTECTED_DELETE_LOCAL_POLICIES, and ilObjRole\MODE_UNPROTECTED_DELETE_LOCAL_POLICIES.

Referenced by doAddRolePermissions(), and doRemoveRolePermissions().

    {
        global $rbacreview;
        
        if (!$a_start_obj) {
            // todo error handling
        }
        
        include_once './Services/AccessControl/classes/class.ilObjRole.php';
        if ($rbacreview->isProtected($this->object->getRefId(), $a_source_role)) {
            $mode = ilObjRole::MODE_PROTECTED_DELETE_LOCAL_POLICIES;
        } else {
            $mode = ilObjRole::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES;
        }

        if ($a_start_obj) {
            $role = new ilObjRole($a_target_role);
            $role->changeExistingObjects(
                $a_start_obj,
                $mode,
                array('all')
            );
        }
    }

Here is the caller graph for this function:

doCopyRole()

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

protected

Perform copy of role ilTree $tree <type> $rbacadmin <type> $rbacreview.

Parameters

<type>	$source
<type>	$target
<type>	$change_existing

Returns

<type>

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

References ilObjectGUI\$rbacreview, $source, $target, ilObjectGUI\$tree, array, ilObjRole\MODE_PROTECTED_DELETE_LOCAL_POLICIES, ilObjRole\MODE_UNPROTECTED_DELETE_LOCAL_POLICIES, and object.

Referenced by copyRoleObject().

    {
        global $tree, $rbacadmin, $rbacreview;

        $target_obj = $rbacreview->getRoleFolderOfRole($target);
        
        // Copy role template permissions
        $rbacadmin->copyRoleTemplatePermissions(
            $source,
            $this->object->getRefId(),
            $target_obj,
            $target
        );

        if (!$change_existing || !$target_obj) {
            return true;
        }
        
        $start = $target_obj;

        include_once './Services/AccessControl/classes/class.ilObjRole.php';
        if ($rbacreview->isProtected($this->object->getRefId(), $source)) {
            $mode = ilObjRole::MODE_PROTECTED_DELETE_LOCAL_POLICIES;
        } else {
            $mode = ilObjRole::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES;
        }

        if ($start) {
            $role = new ilObjRole($target);
            $role->changeExistingObjects(
                $start,
                $mode,
                array('all')
            );
        }
    }

Here is the caller graph for this function:

doRemoveRolePermissions()

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

protected

do add role permission

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

References ilObjectGUI\$rbacreview, $source, $target, doChangeExistingObjects(), ilLoggerFactory\getLogger(), and object.

Referenced by removeRolePermissionsObject().

    {
        global $rbacadmin, $rbacreview;
        
        ilLoggerFactory::getLogger('ac')->debug('Remove permission source: ' . $source);
        ilLoggerFactory::getLogger('ac')->debug('Remove permission target: ' . $target);
        ilLoggerFactory::getLogger('ac')->debug('Remove permission change existing: ' . $change_existing);
        
        $rbacadmin->copyRolePermissionSubtract(
            $source,
            $this->object->getRefId(),
            $target,
            $rbacreview->getRoleFolderOfRole($target)
        );
        
        if ($change_existing) {
            $target_obj = $rbacreview->getRoleFolderOfRole($target);
            $this->doChangeExistingObjects($target_obj, $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 742 of file class.ilObjRoleFolderGUI.php.

References initSettingsForm().

Referenced by saveSettingsObject().

    {
        if (!$a_form) {
            $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 60 of file class.ilObjRoleFolderGUI.php.

References $ret, and ilObjectGUI\prepareOutput().

    {
        global $ilTabs;

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

        switch ($next_class) {

            case 'ilpermissiongui':
                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                $perm_gui = new ilPermissionGUI($this);
                $ret =&$this->ctrl->forwardCommand($perm_gui);
                break;

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

                break;
        }
        return true;
    }

Here is the call graph for this function:

getAdminTabs()

ilObjRoleFolderGUI::getAdminTabs

(

)

Add role folder tabs ilTree $tree ilLanguage $lng.

Parameters

ilTabsGUI

$tabs_gui

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

References array, and ilObjectGUI\checkPermissionBool().

    {
        if ($this->checkPermissionBool("visible,read")) {
            $this->tabs_gui->addTarget(
                "view",
                $this->ctrl->getLinkTarget($this, "view"),
                array("", "view"),
                get_class($this)
            );
            
            $this->tabs_gui->addTarget(
                "settings",
                $this->ctrl->getLinkTarget($this, "editSettings"),
                array("editSettings"),
                get_class($this)
            );
        }

        if ($this->checkPermissionBool("edit_permission")) {
            $this->tabs_gui->addTarget(
                "perm_settings",
                $this->ctrl->getLinkTargetByClass(
                    array(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 261 of file class.ilObjRoleFolderGUI.php.

References $_POST, $form, $ilCtrl, ilObject\_lookupType(), array, and ilFormPropertyGUI\setRequired().

Referenced by addRolePermissionsObject(), chooseCopyBehaviourObject(), copyRoleObject(), and removeRolePermissionsObject().

    {
        global $ilCtrl;

        include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();
        $form->setTitle($this->lng->txt('rbac_copy_behaviour'));
        $form->setFormAction($ilCtrl->getFormAction($this, 'chooseCopyBehaviour'));

        $ce = new ilRadioGroupInputGUI($this->lng->txt('change_existing_objects'), 'change_existing');
        $ce->setRequired(true);
        $ce->setValue(1);
        $form->addItem($ce);

        $ceo = new ilRadioOption($this->lng->txt('change_existing_objects'), 1);
        $ce->addOption($ceo);

        $cne = new ilRadioOption($this->lng->txt('rbac_not_change_existing_objects'), 0);
        $ce->addOption($cne);

        $roles = new ilHiddenInputGUI('roles');
        $roles->setValue(implode(',', (array) $_POST['roles']));
        $form->addItem($roles);
        
        
        // if source is role template show option add permission, remove permissions and copy permissions
        if (ilObject::_lookupType((int) $_REQUEST['copy_source']) == 'rolt') {
            $form->addCommandButton('addRolePermissions', $this->lng->txt('rbac_copy_role_add_perm'));
            $form->addCommandButton('removeRolePermissions', $this->lng->txt('rbac_copy_role_remove_perm'));
            $form->addCommandButton('copyRole', $this->lng->txt('rbac_copy_role_copy'));
        } else {
            $form->addCommandButton('copyRole', $this->lng->txt('rbac_copy_role'));
        }
        return $form;
    }

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 166 of file class.ilObjRoleFolderGUI.php.

References $form, $ilCtrl, and ilFormPropertyGUI\setRequired().

Referenced by roleSearchFormObject(), and roleSearchObject().

    {
        global $ilCtrl;

        include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();
        $form->setTitle($this->lng->txt('rbac_role_title'));
        $form->setFormAction($ilCtrl->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:

initSettingsForm()

ilObjRoleFolderGUI::initSettingsForm ( )

protected

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

References $form, $GLOBALS, $ilUser, ilObjectGUI\$rbacreview, ilPrivacySettings\_getInstance(), ilSecuritySettings\_getInstance(), and ilFormPropertyGUI\setInfo().

Referenced by editSettingsObject(), and saveSettingsObject().

    {
        global $rbacreview, $ilUser;
        
        $this->lng->loadLanguageModule('ps');
        
        include_once('./Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
        include_once('./Services/PrivacySecurity/classes/class.ilSecuritySettings.php');
        $privacy = ilPrivacySettings::_getInstance();
        $security = ilSecuritySettings::_getInstance();
        
        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, "saveSettings"));
        $form->setTitle($this->lng->txt('settings'));
        
        // protected admin
        $admin = new ilCheckboxInputGUI($GLOBALS['lng']->txt('adm_adm_role_protect'), 'admin_role');
        $admin->setDisabled(!$rbacreview->isAssigned($ilUser->getId(), SYSTEM_ROLE_ID));
        $admin->setInfo($this->lng->txt('adm_adm_role_protect_info'));
        $admin->setChecked((int) $security->isAdminRoleProtected());
        $admin->setValue(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($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 371 of file class.ilObjRoleFolderGUI.php.

References $_POST, $form, $ilCtrl, $source, array, doRemoveRolePermissions(), initCopyBehaviourForm(), and ilUtil\sendSuccess().

    {
        global $ilCtrl;

        // Finally copy role/rolt
        $roles = explode(',', $_POST['roles']);
        $source = (int) $_REQUEST['copy_source'];

        $form = $this->initCopyBehaviourForm();
        if ($form->checkInput()) {
            foreach ((array) $roles as $role_id) {
                if ($role_id != $source) {
                    $this->doRemoveRolePermissions($source, $role_id, $form->getInput('change_existing'));
                }
            }

            ilUtil::sendSuccess($this->lng->txt('rbac_copy_finished'), true);
            $ilCtrl->redirect($this, 'view');
        }
    }

Here is the call graph for this function:

resetFilterObject()

ilObjRoleFolderGUI::resetFilterObject

(

)

Reset role filter.

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

References $table, and viewObject().

    {
        include_once './Services/AccessControl/classes/class.ilRoleTableGUI.php';
        $table = new ilRoleTableGUI($this, 'view');
        $table->init();
        $table->resetOffset();
        $table->resetFilter();

        $this->viewObject();
    }

Here is the call graph for this function:

roleSearchFormObject()

ilObjRoleFolderGUI::roleSearchFormObject ( )

protected

Parse search query type $ilCtrl.

Returns

type

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

References $_SESSION, $form, $ilCtrl, initRoleSearchForm(), roleSearchListObject(), and ilUtil\sendFailure().

    {
        global $ilCtrl;
        
        $_SESSION['rolf_search_query'] = '';
        $ilCtrl->setParameter($this, 'copy_source', (int) $_REQUEST['copy_source']);

        $form = $this->initRoleSearchForm();
        if ($form->checkInput()) {
            $_SESSION['rolf_search_query'] = $form->getInput('title');
            return $this->roleSearchListObject();
        }

        ilUtil::sendFailure($this->lng->txt('msg_no_search_string'), true);
        $form->setValuesByPost();
        $ilCtrl->redirect($this, 'roleSearch');
    }

Here is the call graph for this function:

roleSearchListObject()

ilObjRoleFolderGUI::roleSearchListObject ( )

protected

List roles.

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

References $_SESSION, $ilCtrl, $table, object, ilUtil\sendFailure(), ilUtil\sendInfo(), and ilRoleTableGUI\TYPE_SEARCH.

Referenced by roleSearchFormObject().

    {
        global $ilTabs, $ilCtrl;

        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $this->lng->txt('rbac_back_to_overview'),
            $this->ctrl->getLinkTarget($this, 'roleSearchList')
        );

        $ilCtrl->setParameter($this, 'copy_source', (int) $_REQUEST['copy_source']);

        if (strlen($_SESSION['rolf_search_query'])) {
            ilUtil::sendInfo($this->lng->txt('rbac_select_copy_targets'));

            include_once './Services/AccessControl/classes/class.ilRoleTableGUI.php';
            $table = new ilRoleTableGUI($this, 'roleSearchList');
            $table->setType(ilRoleTableGUI::TYPE_SEARCH);
            $table->setRoleTitleFilter($_SESSION['rolf_search_query']);
            $table->init();
            $table->parse($this->object->getId());
            return $this->tpl->setContent($table->getHTML());
        }

        ilUtil::sendFailure($this->lng->txt('msg_no_search_string'), true);
        $ilCtrl->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 142 of file class.ilObjRoleFolderGUI.php.

References $form, $ilCtrl, ilObjectGUI\$ilErr, ilObjectGUI\$rbacsystem, initRoleSearchForm(), and ilUtil\sendInfo().

    {
        global $rbacsystem, $ilCtrl, $ilTabs;

        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $this->lng->txt('rbac_back_to_overview'),
            $this->ctrl->getLinkTarget($this, 'view')
        );

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

        $ilCtrl->setParameter($this, 'copy_source', (int) $_REQUEST['copy_source']);
        ilUtil::sendInfo($this->lng->txt('rbac_choose_copy_targets'));

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

Here is the call graph for this function:

saveObject()

ilObjRoleFolderGUI::saveObject

(

)

save object public

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

References $_GET, $_POST, and ilUtil\sendSuccess().

    {
        global $rbacadmin;

        // role folders are created automatically
        $_GET["new_type"] = $this->object->getType();
        $_POST["Fobject"]["title"] = $this->object->getTitle();
        $_POST["Fobject"]["desc"] = $this->object->getDescription();

        // always call parent method first to create an object_data entry & a reference
        $newObj = parent::saveObject();

        // put here your object specific stuff

        // always send a message
        ilUtil::sendSuccess($this->lng->txt("rolf_added"), true);
        
        $this->ctrl->redirect($this, "view");
    }

Here is the call graph for this function:

saveSettingsObject()

ilObjRoleFolderGUI::saveSettingsObject

(

)

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

References $_POST, $form, ilObjectGUI\$ilErr, $ilUser, ilObjectGUI\$rbacreview, ilPrivacySettings\_getInstance(), ilSecuritySettings\_getInstance(), ilObjectGUI\checkPermissionBool(), editSettingsObject(), initSettingsForm(), and ilUtil\sendSuccess().

    {
        global $ilErr, $rbacreview, $ilUser;
        
        if (!$this->checkPermissionBool("write")) {
            $ilErr->raiseError($this->lng->txt('permission_denied'), $ilErr->MESSAGE);
        }
        
        $form = $this->initSettingsForm();
        if ($form->checkInput()) {
            include_once('./Services/PrivacySecurity/classes/class.ilPrivacySettings.php');
            $privacy = ilPrivacySettings::_getInstance();
            $privacy->enableRbacLog((int) $_POST['rbac_log']);
            $privacy->setRbacLogAge((int) $_POST['rbac_log_age']);
            $privacy->save();
                        
            if ($rbacreview->isAssigned($ilUser->getId(), SYSTEM_ROLE_ID)) {
                include_once('./Services/PrivacySecurity/classes/class.ilSecuritySettings.php');
                $security = ilSecuritySettings::_getInstance();
                $security->protectedAdminRole((int) $_POST['admin_role']);
                $security->save();
            }
            
            ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);
            $this->ctrl->redirect($this, "editSettings");
        }
        
        $form->setValuesByPost();
        $this->editSettingsObject($form);
    }

Here is the call graph for this function:

showPossibleSubObjects()

ilObjRoleFolderGUI::showPossibleSubObjects

(

)

show possible subobjects (pulldown menu) overwritten to prevent displaying of role templates in local role folders

public

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

References $d, $i, ilObjectGUI\$rbacsystem, $row, data, ilUtil\formSelect(), and object.

    {
        global $rbacsystem;

        $d = $this->objDefinition->getCreatableSubObjects($this->object->getType());
        
        if ($this->object->getRefId() != ROLE_FOLDER_ID or !$rbacsystem->checkAccess('create_rolt', ROLE_FOLDER_ID)) {
            unset($d["rolt"]);
        }
        
        if (!$rbacsystem->checkAccess('create_role', $this->object->getRefId())) {
            unset($d["role"]);
        }

        if (count($d) > 0) {
            foreach ($d as $row) {
                $count = 0;
                if ($row["max"] > 0) {
                    //how many elements are present?
                    for ($i=0; $i<count($this->data["ctrl"]); $i++) {
                        if ($this->data["ctrl"][$i]["type"] == $row["name"]) {
                            $count++;
                        }
                    }
                }
                if ($row["max"] == "" || $count < $row["max"]) {
                    $subobj[] = $row["name"];
                }
            }
        }

        if (is_array($subobj)) {
            //build form
            $opts = ilUtil::formSelect(12, "new_type", $subobj);
            $this->tpl->setCurrentBlock("add_object");
            $this->tpl->setVariable("SELECT_OBJTYPE", $opts);
            $this->tpl->setVariable("BTN_NAME", "create");
            $this->tpl->setVariable("TXT_ADD", $this->lng->txt("add"));
            $this->tpl->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

viewObject()

ilObjRoleFolderGUI::viewObject

(

)

ilErrorHandler $ilErr ilRbacSystem $rbacsystem ilToolbarGUI $ilToolbar

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

References ilObjectGUI\$ilErr, ilObjectGUI\$rbacreview, ilObjectGUI\$rbacsystem, $table, and object.

Referenced by applyFilterObject(), and resetFilterObject().

    {
        global $ilErr, $rbacsystem, $ilToolbar,$rbacreview,$ilTabs;

        $ilTabs->activateTab('view');

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

        
        if ($rbacsystem->checkAccess('create_role', $this->object->getRefId())) {
            $this->ctrl->setParameter($this, 'new_type', 'role');
            $ilToolbar->addButton(
                $this->lng->txt('rolf_create_role'),
                $this->ctrl->getLinkTarget($this, 'create')
            );
        }
        if ($rbacsystem->checkAccess('create_rolt', $this->object->getRefId())) {
            $this->ctrl->setParameter($this, 'new_type', 'rolt');
            $ilToolbar->addButton(
                $this->lng->txt('rolf_create_rolt'),
                $this->ctrl->getLinkTarget($this, 'create')
            );
            $this->ctrl->clearParameters($this);
        }

        if (
            $rbacsystem->checkAccess('create_rolt', $this->object->getRefId()) ||
            $rbacsystem->checkAccess('create_rolt', $this->object->getRefId())
        ) {
            $ilToolbar->addButton(
                $this->lng->txt('rbac_import_role'),
                $this->ctrl->getLinkTargetByClass('ilPermissionGUI', 'displayImportRoleForm')
            );
        }

        include_once './Services/AccessControl/classes/class.ilRoleTableGUI.php';
        $table = new ilRoleTableGUI($this, 'view');
        $table->init();
        $table->parse($this->object->getId());

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

Here is the caller graph for this function:

Field Documentation

$type

ilObjRoleFolderGUI::$type

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

---

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

• Services/AccessControl/classes/class.ilObjRoleFolderGUI.php