ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields
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
 assignObject ()
 prepareOutput ()
 prepare output
 setTitleAndDescription ()
 called by prepare output
 showUpperIcon ()
 showMountWebfolderIcon ()
 setTabs ()
 set admin tabs public
 setAdminTabs ()
 set admin tabs public
 getAdminTabs (&$tabs_gui)
 administration tabs show only permissions and trash folder
 getHTML ()
 setActions ($a_actions="")
 set possible actions for objects in list.
 setSubObjects ($a_sub_objects="")
 set possible subobjects for this object.
 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)
 undeleteObject ()
 get object back from trash
 insertSavedNodes ($a_source_id, $a_dest_id, $a_tree_id, &$a_affected_ids)
 recursive method to insert all saved nodes of the clipboard (maybe this function could be moved to a rbac class ?)
 confirmedDeleteObject ()
 confirmed deletion if object -> objects are moved to trash
 cancelDeleteObject ()
 cancel deletion of object
 removeFromSystemObject ()
 remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
 removeDeletedNodes ($a_node_id, $a_checked, $a_delete_objects, &$a_affected_ids)
 remove already deleted objects within the objects in trash recursive function
 createObject ()
 create new object form
 cancelObject ($in_rep=false)
 cancel action and go back to previous page public
 saveObject ()
 save object
 importObject ()
 import new object form
 editObject ()
 edit object
 displayEditForm ($fields)
 display edit form (usually called by editObject)
 updateObject ()
 updates object entry in object_data
 afterUpdate ()
 permObject ()
 show permissions of current node
 getFormAction ($a_cmd, $a_formaction="")
 get form action for command (command is method name without "Object", e.g.
 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
 permSaveObject ()
 save permissions
 isVisible ($a_ref_id, $a_type)
 displayList ()
 display object list
 viewObject ()
 list childs of current object
 deleteObject ($a_error=false)
 display deletion confirmation screen only for referenced objects.
 trashObject ()
 show trash content of object
 addRoleObject ()
 adds a local role This method is only called when choose the option 'you may add local roles'.
 showActions ($with_subobjects=false)
 show possible action (form buttons)
 getActions ()
 Get Actions.
 showPossibleSubObjects ()
 show possible subobjects (pulldown menu)
 getTemplateFile ($a_cmd, $a_type="")
 get a template blockfile format: tpl.
 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="")
 infoObject ()
 __buildRoleFilterSelect ()
 __filterRoles ($a_roles, $a_filter)
 ownerObject ()
 changeOwnerObject ()
 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.
 fillCloneSearchTemplate ($a_tpl_varname, $a_type)
 Add an object search in case the number of existing objects is too big to offer a selection list.
 cloneAllObject ()
 Clone single (not container object) Method is overwritten in ilContainerGUI.
 copyWizardHasOptions ($a_mode)
 Check if there is any modules specific option.
 getCenterColumnHTML ()
 Get center column.
 getRightColumnHTML ()
 Display right column.
 setColumnSettings ($column_gui)
 May be overwritten in subclasses.
 checkPermission ($a_perm, $a_cmd="")

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

Additional Inherited Members

- Protected Member Functions inherited from ilObjectGUI
 searchCloneSourceObject ()
 Search clone source by title.
 buildCloneSelect ($existing_objs)
 Build a select box for clonable objects (permission write)

Detailed Description

Class ilObjRoleGUI.

Author
Stefan Meyer smeye.nosp@m.r@da.nosp@m.tabay.nosp@m..de
Id:
class.ilRoleDesktopItem.php 15697 2008-01-08 20:04:33Z hschottm

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

Member Function Documentation

ilRoleDesktopItem::__assign (   $a_item_id,
  $a_item_type 
)

Definition at line 163 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 63 of file class.ilRoleDesktopItem.php.

References __assign(), and getRoleId().

Referenced by ilObjRoleGUI\assignDesktopItemObject().

{
global $ilDB;
if($a_item_type and $a_item_id)
{
$query = "INSERT INTO role_desktop_items ".
"SET role_id = ".$ilDB->quote($this->getRoleId()).", ".
"item_id = ".$ilDB->quote($a_item_id).", ".
"item_type = ".$ilDB->quote($a_item_type);
$this->db->query($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 82 of file class.ilRoleDesktopItem.php.

Referenced by ilObjRoleGUI\deleteDesktopItemsObject().

{
global $ilDB;
$query = "DELETE FROM role_desktop_items ".
"WHERE role_item_id = ".$ilDB->quote($a_role_item_id);
$this->db->query($query);
return true;
}

+ Here is the caller graph for this function:

ilRoleDesktopItem::deleteAll ( )

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

References getRoleId().

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

+ Here is the call graph for this function:

ilRoleDesktopItem::getAll ( )

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

References $res, ilObjectGUI\$tree, DB_FETCHMODE_OBJECT, and getRoleId().

{
global $tree;
$query = "SELECT * FROM role_desktop_items ".
"WHERE role_id = ".$this->db->quote($this->getRoleId())." ";
$res = $this->db->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 119 of file class.ilRoleDesktopItem.php.

References $res, DB_FETCHMODE_OBJECT, and getRoleId().

Referenced by ilObjRoleGUI\askDeleteDesktopItemObject().

{
global $ilDB;
$query = "SELECT * FROM role_desktop_items ".
"WHERE role_id = ".$ilDB->quote($this->getRoleId())." ".
"AND role_item_id = ".$ilDB->quote($a_role_item_id)." ";
$res = $this->db->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 54 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:

ilRoleDesktopItem::ilRoleDesktopItem (   $a_role_id)

Constructor public.

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

{
global $ilDB;
$this->db =& $ilDB;
$this->role_id = $a_role_id;
}
ilRoleDesktopItem::isAssigned (   $a_item_ref_id)

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

References $res, and getRoleId().

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

+ Here is the call graph for this function:

ilRoleDesktopItem::setRoleId (   $a_role_id)

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

{
$this->role_id = $a_role_id;
}

Field Documentation

ilRoleDesktopItem::$db

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

ilRoleDesktopItem::$role_id

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

Referenced by getRoleId().

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