ilObjRoleTemplateGUI Class Reference

Class ilObjRoleTemplateGUI. More...

Inheritance diagram for ilObjRoleTemplateGUI:

Collaboration diagram for ilObjRoleTemplateGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference)
	Constructor. More...
	executeCommand ()
	execute command More...
	createObject (ilPropertyFormGUI $form=null)
	create new role definition template More...
	editObject (ilPropertyFormGUI $form=null)
	Create new object. More...
	updateObject ()
	update role template object More...
	saveObject ()
	save a new role template object More...
	adoptPermSaveObject ()
	adopting permission setting from other roles/role templates More...
	getAdminTabs ()
	admin and normal tabs are equal for roles More...
	cancelObject ()
	cancelObject is called when an operation is canceled, method links back @access public More...
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 @access 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 ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...
	addToDeskObject ()
	@inheritDoc More...
	removeFromDeskObject ()
	@inheritDoc More...

Data Fields
const	FORM_MODE_EDIT = 1
const	FORM_MODE_CREATE = 2
	$type
	$rolf_ref_id
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
	initFormRoleTemplate ($a_mode=self::FORM_MODE_CREATE)
	Init create form. More...
	getTabs ()
	get tabs abstract method.@abstract overwrite in derived GUI class of your object type @access public Parameters object instance of ilTabsGUI More...
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) Parameters bool $a_do_not_add_object More...
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...
	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...
	setTabs ()
	set admin tabs @access public More...
	setAdminTabs ()
	set admin tabs @access 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
	$rbacsystem
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service
	$favourites

Detailed Description

Class ilObjRoleTemplateGUI.

Author

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

Version

$Id$

@ilCtrl_Calls ilObjRoleTemplateGUI:

Definition at line 18 of file class.ilObjRoleTemplateGUI.php.

Constructor & Destructor Documentation

__construct()

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

Constructor.

@access public

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

    {
        global $DIC;
 
        $lng = $DIC['lng'];
        
        $lng->loadLanguageModule('rbac');
        
        $this->type = "rolt";
        parent::__construct($a_data, $a_id, $a_call_by_reference, false);
        $this->rolf_ref_id = &$this->ref_id;
        $this->ctrl->saveParameter($this, "obj_id");
    }

References $DIC, ilObjectGUI\$lng, ilObjectGUI\$ref_id, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

addAdminLocatorItems()

ilObjRoleTemplateGUI::addAdminLocatorItems (   $a_do_not_add_object = false )

protected

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

Parameters

bool

$a_do_not_add_object

Reimplemented from ilObjectGUI.

Definition at line 486 of file class.ilObjRoleTemplateGUI.php.

    {
        global $DIC;
 
        $ilLocator = $DIC['ilLocator'];
        
        parent::addAdminLocatorItems(true);
                
        $ilLocator->addItem(
            ilObject::_lookupTitle(
                ilObject::_lookupObjId($_GET["ref_id"])
            ),
            $this->ctrl->getLinkTargetByClass("ilobjrolefoldergui", "view")
        );
    }

References $_GET, $DIC, ilObject\_lookupObjId(), and ilObject\_lookupTitle().

Here is the call graph for this function:

adoptPermSaveObject()

ilObjRoleTemplateGUI::adoptPermSaveObject

(

)

adopting permission setting from other roles/role templates

@access public

Definition at line 406 of file class.ilObjRoleTemplateGUI.php.

    {
        global $DIC;
 
        $rbacadmin = $DIC['rbacadmin'];
        $rbacsystem = $DIC['rbacsystem'];
        $rbacreview = $DIC['rbacreview'];
 
        if (!$rbacsystem->checkAccess('write', $this->rolf_ref_id)) {
            $this->ilias->raiseError($this->lng->txt("msg_no_perm_perm"), $this->ilias->error_obj->WARNING);
        } elseif ($this->obj_id == $_POST["adopt"]) {
            ilUtil::sendFailure($this->lng->txt("msg_perm_adopted_from_itself"), true);
        } else {
            $rbacadmin->deleteRolePermission($this->obj_id, $this->rolf_ref_id);
            $parentRoles = $rbacreview->getParentRoleIds($this->rolf_ref_id, true);
            $rbacadmin->copyRoleTemplatePermissions(
                $_POST["adopt"],
                $parentRoles[$_POST["adopt"]]["parent"],
                $this->rolf_ref_id,
                $this->obj_id
            );
            // update object data entry (to update last modification date)
            $this->object->update();
 
            // send info
            $obj_data = &$this->ilias->obj_factory->getInstanceByObjId($_POST["adopt"]);
            ilUtil::sendSuccess($this->lng->txt("msg_perm_adopted_from1") . " '" . $obj_data->getTitle() . "'.<br/>" . $this->lng->txt("msg_perm_adopted_from2"), true);
        }
 
        $this->ctrl->redirect($this, "perm");
    }

References $_POST, $DIC, ilObjectGUI\$rbacreview, ilObjectGUI\$rbacsystem, and ilUtil\sendFailure().

Here is the call graph for this function:

cancelObject()

ilObjRoleTemplateGUI::cancelObject

(

)

cancelObject is called when an operation is canceled, method links back @access public

Reimplemented from ilObjectGUI.

Definition at line 476 of file class.ilObjRoleTemplateGUI.php.

    {
        $this->ctrl->redirectByClass("ilobjrolefoldergui", "view");
    }

createObject()

ilObjRoleTemplateGUI::createObject

(

ilPropertyFormGUI

$form = null

)

create new role definition template

@access public

Definition at line 149 of file class.ilObjRoleTemplateGUI.php.

    {
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
 
        if (!$rbacsystem->checkAccess("create_rolt", $this->rolf_ref_id)) {
            $this->ilias->raiseError($this->lng->txt("permission_denied"), $this->ilias->error_obj->MESSAGE);
        }
        if (!$form) {
            $form = $this->initFormRoleTemplate(self::FORM_MODE_CREATE);
        }
        $this->tpl->setContent($form->getHTML());
        return true;
    }

References $DIC, ilObjectGUI\$rbacsystem, and initFormRoleTemplate().

Here is the call graph for this function:

editObject()

ilObjRoleTemplateGUI::editObject

(

ilPropertyFormGUI

$form = null

)

Create new object.

Definition at line 168 of file class.ilObjRoleTemplateGUI.php.

    {
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
 
        $this->tabs_gui->activateTab('settings');
        
        if (!$rbacsystem->checkAccess("write", $this->rolf_ref_id)) {
            $this->ilias->raiseError($this->lng->txt("msg_no_perm_write"), $this->ilias->error_obj->MESSAGE);
        }
        
        if (!$form) {
            $form = $this->initFormRoleTemplate(self::FORM_MODE_EDIT);
        }
        $GLOBALS['DIC']['tpl']->setContent($form->getHTML());
    }

References $DIC, $GLOBALS, ilObjectGUI\$rbacsystem, and initFormRoleTemplate().

Here is the call graph for this function:

executeCommand()

ilObjRoleTemplateGUI::executeCommand

(

)

execute command

Reimplemented from ilObjectGUI.

Definition at line 55 of file class.ilObjRoleTemplateGUI.php.

    {
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
 
        $this->prepareOutput();
 
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        switch ($next_class) {
            default:
                if (!$cmd) {
                    $cmd = "perm";
                }
                $cmd .= "Object";
                $this->$cmd();
                    
                break;
        }
 
        return true;
    }

References $DIC, ilObjectGUI\$rbacsystem, and ilObjectGUI\prepareOutput().

Here is the call graph for this function:

getAdminTabs()

ilObjRoleTemplateGUI::getAdminTabs

(

)

admin and normal tabs are equal for roles

Reimplemented from ilObjectGUI.

Definition at line 441 of file class.ilObjRoleTemplateGUI.php.

    {
        $this->getTabs();
    }

References getTabs().

Here is the call graph for this function:

getTabs()

ilObjRoleTemplateGUI::getTabs ( )

protected

get tabs abstract method.@abstract overwrite in derived GUI class of your object type @access public

Parameters

object

instance of ilTabsGUI

Reimplemented from ilObjectGUI.

Definition at line 449 of file class.ilObjRoleTemplateGUI.php.

    {
        global $DIC;
 
        $rbacsystem = $DIC->rbac()->system();
        $this->tabs_gui->setBackTarget($this->lng->txt('btn_back'), $this->ctrl->getParentReturn($this));
 
        if ($rbacsystem->checkAccess('write', $this->ref_id)) {
            $this->tabs_gui->addTab(
                'settings',
                $this->lng->txt('settings'),
                $this->ctrl->getLinkTarget($this, 'edit')
            );
        }
        if ($rbacsystem->checkAccess('edit_permission', $this->ref_id)) {
            $this->tabs_gui->addTab(
                'perm',
                $this->lng->txt('default_perm_settings'),
                $this->ctrl->getLinkTarget($this, 'perm')
            );
        }
    }

References $DIC, and ilObjectGUI\$rbacsystem.

Referenced by getAdminTabs().

Here is the caller graph for this function:

initFormRoleTemplate()

ilObjRoleTemplateGUI::initFormRoleTemplate (   $a_mode = self::FORM_MODE_CREATE )

protected

Init create form.

Parameters

bool	creation mode

Returns

ilPropertyFormGUI $form

Definition at line 85 of file class.ilObjRoleTemplateGUI.php.

    {
        include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();
 
        if ($this->creation_mode) {
            $this->ctrl->setParameter($this, "new_type", 'rolt');
        }
        
        $form->setFormAction($this->ctrl->getFormAction($this));
        
        if ($a_mode == self::FORM_MODE_CREATE) {
            $form->setTitle($this->lng->txt('rolt_new'));
            $form->addCommandButton('save', $this->lng->txt('rolt_new'));
        } else {
            $form->setTitle($this->lng->txt('rolt_edit'));
            $form->addCommandButton('update', $this->lng->txt('save'));
        }
        $form->addCommandButton('cancel', $this->lng->txt('cancel'));
        
        $title = new ilTextInputGUI($this->lng->txt('title'), 'title');
        if ($a_mode != self::FORM_MODE_CREATE) {
            if ($this->object->isInternalTemplate()) {
                $title->setDisabled(true);
            }
            $title->setValue(ilObjRole::_getTranslation($this->object->getTitle()));
        }
        $title->setSize(40);
        $title->setMaxLength(70);
        $title->setRequired(true);
        $form->addItem($title);
        
        $desc = new ilTextAreaInputGUI($this->lng->txt('description'), 'desc');
        
        if ($a_mode != self::FORM_MODE_CREATE) {
            $desc->setValue($this->object->getDescription());
        }
        $desc->setCols(40);
        $desc->setRows(3);
        $form->addItem($desc);
 
        if ($a_mode != self::FORM_MODE_CREATE) {
            $ilias_id = new ilNonEditableValueGUI($this->lng->txt("ilias_id"), "ilias_id");
            $ilias_id->setValue('il_' . IL_INST_ID . '_' . ilObject::_lookupType($this->object->getId()) . '_' . $this->object->getId());
            $form->addItem($ilias_id);
        }
 
        $pro = new ilCheckboxInputGUI($this->lng->txt('role_protect_permissions'), 'protected');
        $pro->setChecked($GLOBALS['DIC']['rbacreview']->isProtected(
            $this->rolf_ref_id,
            $this->object->getId()
        ));
        $pro->setValue(1);
        $form->addItem($pro);
 
        return $form;
    }

References $GLOBALS, ilObjRole\_getTranslation(), and ilObject\_lookupType().

Referenced by createObject(), editObject(), saveObject(), and updateObject().

Here is the call graph for this function:

Here is the caller graph for this function:

saveObject()

ilObjRoleTemplateGUI::saveObject

(

)

save a new role template object

@access public

Reimplemented from ilObjectGUI.

Definition at line 231 of file class.ilObjRoleTemplateGUI.php.

    {
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];
 
        if (!$rbacsystem->checkAccess("create_rolt", $this->rolf_ref_id)) {
            $this->ilias->raiseError($this->lng->txt("msg_no_perm_create_rolt"), $this->ilias->error_obj->WARNING);
        }
        $form = $this->initFormRoleTemplate();
        if ($form->checkInput()) {
            include_once("./Services/AccessControl/classes/class.ilObjRoleTemplate.php");
            $roltObj = new ilObjRoleTemplate();
            $roltObj->setTitle($form->getInput('title'));
            $roltObj->setDescription($form->getInput('desc'));
            $roltObj->create();
            $rbacadmin->assignRoleToFolder($roltObj->getId(), $this->rolf_ref_id, 'n');
            $rbacadmin->setProtected(
                $this->rolf_ref_id,
                $roltObj->getId(),
                $form->getInput('protected') ? 'y' : 'n'
            );
            
            ilUtil::sendSuccess($this->lng->txt("rolt_added"), true);
            // redirect to permission screen
            $this->ctrl->setParameter($this, 'obj_id', $roltObj->getId());
            $this->ctrl->redirect($this, 'perm');
        }
        $form->setValuesByPost();
        $this->createObject($form);
    }

References $DIC, ilObjectGUI\$rbacreview, ilObjectGUI\$rbacsystem, ilObjectGUI\createObject(), and initFormRoleTemplate().

Here is the call graph for this function:

updateObject()

ilObjRoleTemplateGUI::updateObject

(

)

update role template object

@access public

Reimplemented from ilObjectGUI.

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

    {
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];
 
        // check write access
        if (!$rbacsystem->checkAccess("write", $this->rolf_ref_id)) {
            $this->ilias->raiseError($this->lng->txt("msg_no_perm_modify_rolt"), $this->ilias->error_obj->WARNING);
        }
        
        $form = $this->initFormRoleTemplate(self::FORM_MODE_EDIT);
        if ($form->checkInput()) {
            if (!$this->object->isInternalTemplate()) {
                $this->object->setTitle($form->getInput('title'));
            }
            $this->object->setDescription($form->getInput('desc'));
            $rbacadmin->setProtected(
                $this->rolf_ref_id,
                $this->object->getId(),
                $form->getInput('protected') ? 'y' : 'n'
            );
            $this->object->update();
            ilUtil::sendSuccess($this->lng->txt("saved_successfully"), true);
            $this->ctrl->returnToParent($this);
        }
        
        $form->setValuesByPost();
        $this->editObject($form);
    }

References $DIC, ilObjectGUI\$rbacreview, ilObjectGUI\$rbacsystem, ilObjectGUI\editObject(), and initFormRoleTemplate().

Here is the call graph for this function:

Field Documentation

$rolf_ref_id

ilObjRoleTemplateGUI::$rolf_ref_id

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

$type

ilObjRoleTemplateGUI::$type

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

FORM_MODE_CREATE

const ilObjRoleTemplateGUI::FORM_MODE_CREATE = 2

Definition at line 21 of file class.ilObjRoleTemplateGUI.php.

FORM_MODE_EDIT

const ilObjRoleTemplateGUI::FORM_MODE_EDIT = 1

Definition at line 20 of file class.ilObjRoleTemplateGUI.php.

---

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

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