Inheritance diagram for ilRoleDesktopItem:

Collaboration diagram for ilRoleDesktopItem:

Public Member Functions
	__construct ($a_role_id)
	Constructor public. More...

	getRoleId ()

	setRoleId ($a_role_id)

	add ($a_item_id, $a_item_type)

	delete ($a_role_item_id)

	deleteAll ()

	isAssigned ($a_item_ref_id)

	getItem ($a_role_item_id)

	getAll ()

	__assign ($a_item_id, $a_item_type)

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
	$db

	$role_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

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

Protected Attributes inherited from ilObjectGUI
	$ilErr

	$locator

	$user

	$access

	$settings

	$rbacreview

	$toolbar

	$rbacsystem

	$tmp_import_dir

	$tabs_gui = null

	$ctrl

Detailed Description

Class ilObjRoleGUI.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om $Id$

Definition at line 17 of file class.ilRoleDesktopItem.php.

Constructor & Destructor Documentation

◆ __construct()

ilRoleDesktopItem::__construct ( $a_role_id )

Constructor public.

Definition at line 26 of file class.ilRoleDesktopItem.php.

References $ilDB.

     {
         global $ilDB;
 
         $this->db = $ilDB;
         $this->role_id = $a_role_id;
     }

Member Function Documentation

◆ __assign()

ilRoleDesktopItem::__assign	(	$a_item_id,
		$a_item_type
	)

Definition at line 139 of file class.ilRoleDesktopItem.php.

References ilObjectGUI\$rbacreview, and ilObjectFactory\getInstanceByObjId().

Referenced by add().

     {
         global $rbacreview;
 
         foreach ($rbacreview->assignedUsers($this->getRoleId()) as $user_id) {
             if (is_object($tmp_user = ilObjectFactory::getInstanceByObjId($user_id, false))) {
                 if (!$tmp_user->isDesktopItem($a_item_id, $a_item_type)) {
                     $tmp_user->addDesktopItem($a_item_id, $a_item_type);
                 }
             }
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ add()

ilRoleDesktopItem::add	(	$a_item_id,
		$a_item_type
	)

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

References $ilDB, $query, $res, __assign(), and getRoleId().

Referenced by ilPermissionGUI\addRole(), and ilObjRoleGUI\assignDesktopItemObject().

     {
         global $ilDB;
         
         if ($a_item_type and $a_item_id) {
             $next_id = $ilDB->nextId('role_desktop_items');
             $query = "INSERT INTO role_desktop_items (role_item_id,role_id,item_id,item_type) " .
                 "VALUES (" .
                 $ilDB->quote($next_id, 'integer') . ',' .
                 $ilDB->quote($this->getRoleId(), 'integer') . ", " .
                 $ilDB->quote($a_item_id, 'integer') . ", " .
                 $ilDB->quote($a_item_type, 'text') . " " .
                 ")";
             $res = $ilDB->manipulate($query);
             $this->__assign($a_item_id, $a_item_type);
             
             return true;
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilRoleDesktopItem::delete ( $a_role_item_id )

Definition at line 63 of file class.ilRoleDesktopItem.php.

References $ilDB, $query, and $res.

Referenced by ilObjRoleGUI\deleteDesktopItemsObject().

     {
         global $ilDB;
         
         $query = "DELETE FROM role_desktop_items " .
             "WHERE role_item_id = " . $ilDB->quote($a_role_item_id, 'integer');
         $res = $ilDB->manipulate($query);
 
         return true;
     }

Here is the caller graph for this function:

◆ deleteAll()

ilRoleDesktopItem::deleteAll ( )

Definition at line 74 of file class.ilRoleDesktopItem.php.

References $ilDB, $query, $res, and getRoleId().

     {
         global $ilDB;
         
         $query = "DELETE FROM role_desktop_items " .
             "WHERE role_id = " . $ilDB->quote($this->getRoleId(), 'integer');
         $res = $ilDB->manipulate($query);
 
         return true;
     }

Here is the call graph for this function:

◆ getAll()

ilRoleDesktopItem::getAll ( )

Definition at line 116 of file class.ilRoleDesktopItem.php.

References $ilDB, $query, $res, $row, ilObjectGUI\$tree, array, ilDBConstants\FETCHMODE_OBJECT, and getRoleId().

     {
         global $tree;
         global $ilDB;
 
         $query = "SELECT * FROM role_desktop_items " .
             "WHERE role_id = " . $this->db->quote($this->getRoleId(), 'integer') . " ";
 
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             // TODO this check must be modified for non tree objects
             if (!$tree->isInTree($row->item_id)) {
                 $this->delete($row->role_item_id);
                 continue;
             }
             $items[$row->role_item_id]['item_id'] = $row->item_id;
             $items[$row->role_item_id]['item_type'] = $row->item_type;
         }
 
         return $items ? $items : array();
     }

Here is the call graph for this function:

◆ getItem()

ilRoleDesktopItem::getItem ( $a_role_item_id )

Definition at line 97 of file class.ilRoleDesktopItem.php.

References $ilDB, $query, $res, $row, array, ilDBConstants\FETCHMODE_OBJECT, and getRoleId().

     {
         global $ilDB;
         
         $query = "SELECT * FROM role_desktop_items " .
             "WHERE role_id = " . $ilDB->quote($this->getRoleId(), 'integer') . " " .
             "AND role_item_id = " . $ilDB->quote($a_role_item_id, 'integer') . " ";
 
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $item['item_id'] = $row->item_id;
             $item['item_type'] = $row->item_type;
         }
 
         return $item ? $item : array();
     }

Here is the call graph for this function:

◆ getRoleId()

ilRoleDesktopItem::getRoleId ( )

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

References $role_id.

Referenced by add(), deleteAll(), getAll(), getItem(), and isAssigned().

     {
         return $this->role_id;
     }

Here is the caller graph for this function:

◆ isAssigned()

ilRoleDesktopItem::isAssigned ( $a_item_ref_id )

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

References $ilDB, $query, $res, and getRoleId().

     {
         global $ilDB;
         
         $query = "SELECT * FROM role_desktop_items " .
             "WHERE role_id = " . $ilDB->quote($this->getRoleId(), 'integer') . " " .
             "AND item_id = " . $ilDB->quote($a_item_ref_id, 'integer') . " ";
         $res = $ilDB->query($query);
 
         return $res->numRows() ? true : false;
     }

Here is the call graph for this function:

◆ setRoleId()

ilRoleDesktopItem::setRoleId ( $a_role_id )

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

     {
         $this->role_id = $a_role_id;
     }

Field Documentation

◆ $db

ilRoleDesktopItem::$db

Definition at line 19 of file class.ilRoleDesktopItem.php.

◆ $role_id

ilRoleDesktopItem::$role_id

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

Referenced by getRoleId().

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

Services/AccessControl/classes/class.ilRoleDesktopItem.php

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __assign()

◆ add()

◆ delete()

◆ deleteAll()

◆ getAll()

◆ getItem()

◆ getRoleId()

◆ isAssigned()

◆ setRoleId()

Field Documentation

◆ $db

◆ $role_id