ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilRoleDesktopItem Class Reference

Class ilObjRoleGUI. More...

+ Inheritance diagram for ilRoleDesktopItem:
+ Collaboration diagram for ilRoleDesktopItem:

Public Member Functions

 __construct ($a_role_id)
 Constructor @access 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 @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 ()
 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...
 
 redirectAfterCreation ()
 Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. 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
 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...
 
 showMountWebfolderIcon ()
 
 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...
 
- Protected Attributes inherited from ilObjectGUI
 $ilErr
 
 $locator
 
 $user
 
 $access
 
 $settings
 
 $rbacreview
 
 $toolbar
 
 $tmp_import_dir
 
 $tabs_gui = null
 
 $ctrl
 
 $object_service
 

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 @access public.

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

27 {
28 global $DIC;
29
30 $ilDB = $DIC['ilDB'];
31
32 $this->db = $ilDB;
33 $this->role_id = $a_role_id;
34 }
global $DIC
Definition: saml.php:7
global $ilDB

References $DIC, and $ilDB.

Member Function Documentation

◆ __assign()

ilRoleDesktopItem::__assign (   $a_item_id,
  $a_item_type 
)

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

156 {
157 global $DIC;
158
159 $rbacreview = $DIC['rbacreview'];
160
161 foreach ($rbacreview->assignedUsers($this->getRoleId()) as $user_id) {
162 if (is_object($tmp_user = ilObjectFactory::getInstanceByObjId($user_id, false))) {
163 if (!$tmp_user->isDesktopItem($a_item_id, $a_item_type)) {
164 $tmp_user->addDesktopItem($a_item_id, $a_item_type);
165 }
166 }
167 }
168 return true;
169 }
static getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id

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

Referenced by add().

+ 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 45 of file class.ilRoleDesktopItem.php.

46 {
47 global $DIC;
48
49 $ilDB = $DIC['ilDB'];
50
51 if ($a_item_type and $a_item_id) {
52 $next_id = $ilDB->nextId('role_desktop_items');
53 $query = "INSERT INTO role_desktop_items (role_item_id,role_id,item_id,item_type) " .
54 "VALUES (" .
55 $ilDB->quote($next_id, 'integer') . ',' .
56 $ilDB->quote($this->getRoleId(), 'integer') . ", " .
57 $ilDB->quote($a_item_id, 'integer') . ", " .
58 $ilDB->quote($a_item_type, 'text') . " " .
59 ")";
60 $res = $ilDB->manipulate($query);
61 $this->__assign($a_item_id, $a_item_type);
62
63 return true;
64 }
65 return false;
66 }
__assign($a_item_id, $a_item_type)
$query
foreach($_POST as $key=> $value) $res

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

+ Here is the call graph for this function:

◆ delete()

ilRoleDesktopItem::delete (   $a_role_item_id)

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

68 {
69 global $DIC;
70
71 $ilDB = $DIC['ilDB'];
72
73 $query = "DELETE FROM role_desktop_items " .
74 "WHERE role_item_id = " . $ilDB->quote($a_role_item_id, 'integer');
75 $res = $ilDB->manipulate($query);
76
77 return true;
78 }

References $DIC, $ilDB, $query, and $res.

◆ deleteAll()

ilRoleDesktopItem::deleteAll ( )

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

81 {
82 global $DIC;
83
84 $ilDB = $DIC['ilDB'];
85
86 $query = "DELETE FROM role_desktop_items " .
87 "WHERE role_id = " . $ilDB->quote($this->getRoleId(), 'integer');
88 $res = $ilDB->manipulate($query);
89
90 return true;
91 }

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

+ Here is the call graph for this function:

◆ getAll()

ilRoleDesktopItem::getAll ( )

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

129 {
130 global $DIC;
131
132 $tree = $DIC['tree'];
133 global $DIC;
134
135 $ilDB = $DIC['ilDB'];
136
137 $query = "SELECT * FROM role_desktop_items " .
138 "WHERE role_id = " . $this->db->quote($this->getRoleId(), 'integer') . " ";
139
140 $res = $ilDB->query($query);
141 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
142 // TODO this check must be modified for non tree objects
143 if (!$tree->isInTree($row->item_id)) {
144 $this->delete($row->role_item_id);
145 continue;
146 }
147 $items[$row->role_item_id]['item_id'] = $row->item_id;
148 $items[$row->role_item_id]['item_type'] = $row->item_type;
149 }
150
151 return $items ? $items : array();
152 }
$row

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

+ Here is the call graph for this function:

◆ getItem()

ilRoleDesktopItem::getItem (   $a_role_item_id)

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

108 {
109 global $DIC;
110
111 $ilDB = $DIC['ilDB'];
112
113 $query = "SELECT * FROM role_desktop_items " .
114 "WHERE role_id = " . $ilDB->quote($this->getRoleId(), 'integer') . " " .
115 "AND role_item_id = " . $ilDB->quote($a_role_item_id, 'integer') . " ";
116
117 $res = $ilDB->query($query);
118 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
119 $item['item_id'] = $row->item_id;
120 $item['item_type'] = $row->item_type;
121 }
122
123 return $item ? $item : array();
124 }

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

+ Here is the call graph for this function:

◆ getRoleId()

ilRoleDesktopItem::getRoleId ( )

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

References $role_id.

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

+ Here is the caller graph for this function:

◆ isAssigned()

ilRoleDesktopItem::isAssigned (   $a_item_ref_id)

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

94 {
95 global $DIC;
96
97 $ilDB = $DIC['ilDB'];
98
99 $query = "SELECT * FROM role_desktop_items " .
100 "WHERE role_id = " . $ilDB->quote($this->getRoleId(), 'integer') . " " .
101 "AND item_id = " . $ilDB->quote($a_item_ref_id, 'integer') . " ";
102 $res = $ilDB->query($query);
103
104 return $res->numRows() ? true : false;
105 }

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

+ Here is the call graph for this function:

◆ setRoleId()

ilRoleDesktopItem::setRoleId (   $a_role_id)

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

41 {
42 $this->role_id = $a_role_id;
43 }

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: