ILIAS  Release_4_2_x_branch Revision 61807
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilRoleDesktopItem Class Reference

Class ilObjRoleGUI. More...

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

Public Member Functions

 ilRoleDesktopItem ($a_role_id)
 Constructor public.
 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
 ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
 Constructor public.
executeCommand ()
 execute command
 withReferences ()
 determines wether objects are referenced or not (got ref ids or not)
 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
 getCreationMode ()
 get creation mode
 getAdminTabs (&$tabs_gui)
 administration tabs show only permissions and trash folder
 getHTML ()
 undeleteObject ()
 Get objects back from trash.
 confirmedDeleteObject ()
 confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled
 cancelDeleteObject ()
 cancel deletion of object
 removeFromSystemObject ()
 remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
 cancelObject ($in_rep=false)
 cancel action and go back to previous page public
 createObject ()
 create new object form
 cancelCreation ()
 cancel create action and go back to repository parent
 saveObject ()
 save object
 editObject ()
 edit object
 updateObject ()
 updates object entry in object_data
 getFormAction ($a_cmd, $a_formaction="")
 get form action for command (command is method name without "Object", e.g.
 isVisible ($a_ref_id, $a_type)
 viewObject ()
 list childs of current object
 deleteObject ($a_error=false)
 Display deletion confirmation screen.
 trashObject ()
 Show trash content of object.
 getTemplateFile ($a_cmd, $a_type="")
 get a template blockfile format: tpl.
 cloneAllObject ()
 Clone single (not container object) Method is overwritten in ilContainerGUI.
 copyWizardHasOptions ($a_mode)
 Check if there is any modules specific option.

Data Fields

 $db
 $role_id
- Data Fields inherited from ilObjectGUI
const COPY_WIZARD_NEEDS_PAGE = 1
 $ilias
 $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

- Protected Member Functions inherited from ilObjectGUI
 assignObject ()
 prepareOutput ()
 prepare output
 setTitleAndDescription ()
 called by prepare output
 initHeaderAction ($a_sub_type=null, $a_sub_id=null)
 Add header action menu.
 insertHeaderAction ($a_list_gui)
 Insert header action into main template.
 addHeaderAction ()
 Add header action menu.
 redrawHeaderActionObject ()
 Ajax call: redraw action header only.
 showUpperIcon ()
 setTabs ()
 set admin tabs public
 setAdminTabs ()
 set admin tabs public
 setLocator ()
 set Locator
 addLocatorItems ()
 should be overwritten to add object specific items (repository items are preloaded)
 omitLocator ($a_omit=true)
 addAdminLocatorItems ()
 should be overwritten to add object specific items (repository items are preloaded)
 initCreationForms ($a_new_type)
 Init creation froms.
 getCreationFormsHTML (array $a_forms)
 Get HTML for creation forms (accordion)
 initCreateForm ($a_new_type)
 Init object creation form.
 initDidacticTemplate (ilPropertyFormGUI $form)
 Show didactic template types.
 addDidacticTemplateOptions (array &$a_options)
 Add custom templates.
 getDidacticTemplateVar ($a_type)
 Get didactic template setting from creation screen.
 putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
 Add object to tree at given position.
 afterSave (ilObject $a_new_object)
 Post (successful) object creation hook.
 initEditForm ()
 Init object edit form.
 initEditCustomForm (ilPropertyFormGUI $a_form)
 Add custom fields to update form.
 getEditFormValues ()
 Get values for edit form.
 getEditFormCustomValues (array &$a_values)
 Add values to custom edit fields.
 updateCustom (ilPropertyFormGUI $a_form)
 Insert custom update form values into object.
 afterUpdate ()
 Post (successful) object update hook.
 initImportForm ($a_new_type)
 Init object import form.
 importFileObject ($parent_id=null)
 Import.
 afterImport (ilObject $a_new_object)
 Post (successful) object import hook.
 setFormAction ($a_cmd, $a_formaction)
 set specific form action for command
 getReturnLocation ($a_cmd, $a_location="")
 get return location for command (command is method name without "Object", e.g.
 setReturnLocation ($a_cmd, $a_location)
 set specific return location for command
 getTargetFrame ($a_cmd, $a_target_frame="")
 get target frame for command (command is method name without "Object", e.g.
 setTargetFrame ($a_cmd, $a_target_frame)
 set specific target frame for command
 showPossibleSubObjects ()
 show possible subobjects (pulldown menu)
 getTitlesByRefId ($a_ref_ids)
 get Titles of objects this method is used for error messages in methods cut/copy/paste
 getTabs (&$tabs_gui)
 get tabs abstract method.
 __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
 __showClipboardTable ($a_result_set, $a_from="")
 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
 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.
 getCenterColumnHTML ()
 Get center column.
 getRightColumnHTML ()
 Display right column.
 setColumnSettings ($column_gui)
 May be overwritten in subclasses.
 checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission and redirect on error.
 checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission.

Detailed Description

Class ilObjRoleGUI.

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Id:
class.ilRoleDesktopItem.php 24095 2010-06-08 10:53:56Z smeyer

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

Member Function Documentation

ilRoleDesktopItem::__assign (   $a_item_id,
  $a_item_type 
)

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

References 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:

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 ilPermission2GUI\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:

ilRoleDesktopItem::delete (   $a_role_item_id)

Definition at line 64 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:

ilRoleDesktopItem::deleteAll ( )

Definition at line 75 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:

ilRoleDesktopItem::getAll ( )

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

References $ilDB, $query, $res, $row, ilObjectGUI\$tree, DB_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(DB_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:

ilRoleDesktopItem::getItem (   $a_role_item_id)

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

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

Referenced by ilObjRoleGUI\askDeleteDesktopItemObject().

{
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(DB_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:

+ Here is the caller graph for this function:

ilRoleDesktopItem::getRoleId ( )

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

References $role_id.

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

{
}

+ Here is the caller graph for this function:

ilRoleDesktopItem::ilRoleDesktopItem (   $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;
}
ilRoleDesktopItem::isAssigned (   $a_item_ref_id)

Definition at line 86 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:

ilRoleDesktopItem::setRoleId (   $a_role_id)

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

{
$this->role_id = $a_role_id;
}

Field Documentation

ilRoleDesktopItem::$db

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

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: