Inheritance diagram for ilObjRootFolder:
Collaboration diagram for ilObjRootFolder:
Public Member Functions | |
| ilObjRootFolder ($a_id, $a_call_by_reference=true) | |
| Constructor public. | |
| ilClone ($a_parent_ref) | |
| copy all properties and subobjects of a rootfolder. | |
| delete () | |
| delete rootfolder and all related data | |
| notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0) | |
| notifys an object about an event occured Based on the event happend, each object may decide how it reacts. | |
Detailed Description
Definition at line 37 of file class.ilObjRootFolder.php.
Member Function Documentation
| ilObjRootFolder::delete | ( | ) |
delete rootfolder and all related data
public
- Returns:
- boolean true if all object data were removed; false if only a references were removed
Reimplemented from ilObject.
Definition at line 80 of file class.ilObjRootFolder.php.
{
// delete is disabled
$message = get_class($this)."::delete(): Can't delete root folder!";
$this->ilias->raiseError($message,$this->ilias->error_obj->WARNING);
return false;
// always call parent delete function first!!
if (!parent::delete())
{
return false;
}
// put here rootfolder specific stuff
return true;;
}
| ilObjRootFolder::ilClone | ( | $ | a_parent_ref | ) |
copy all properties and subobjects of a rootfolder.
DISABLED public
- Returns:
- integer new ref id
Reimplemented from ilObject.
Definition at line 58 of file class.ilObjRootFolder.php.
References $rbacadmin.
{
// DISABLED
return false;
global $rbacadmin;
// always call parent ilClone function first!!
$new_ref_id = parent::ilClone($a_parent_ref);
// put here rootfolder specific stuff
// ... and finally always return new reference ID!!
return $new_ref_id;
}
| ilObjRootFolder::ilObjRootFolder | ( | $ | a_id, | |
| $ | a_call_by_reference = true | |||
| ) |
Constructor public.
- Parameters:
-
integer reference_id or object_id boolean treat the id as reference_id (true) or object_id (false)
Definition at line 45 of file class.ilObjRootFolder.php.
References ilObject::ilObject().
{
$this->type = "root";
$this->ilObject($a_id,$a_call_by_reference);
}
Here is the call graph for this function:
| ilObjRootFolder::notify | ( | $ | a_event, | |
| $ | a_ref_id, | |||
| $ | a_parent_non_rbac_id, | |||
| $ | a_node_id, | |||
| $ | a_params = 0 | |||
| ) |
notifys an object about an event occured Based on the event happend, each object may decide how it reacts.
public
- Parameters:
-
string event integer reference id of object where the event occured array passes optional parameters if required
- Returns:
- boolean
Reimplemented from ilObject.
Definition at line 109 of file class.ilObjRootFolder.php.
References $tree.
{
global $tree;
switch ($a_event)
{
case "link":
//var_dump("<pre>",$a_params,"</pre>");
//echo "RootFolder ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
//exit;
break;
case "cut":
//echo "RootFolder ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
//exit;
break;
case "copy":
//var_dump("<pre>",$a_params,"</pre>");
//echo "RootFolder ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
//exit;
break;
case "paste":
//echo "RootFolder ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
//exit;
break;
case "new":
//echo "RootFolder ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
//exit;
break;
}
return true;
}
The documentation for this class was generated from the following file:
- classes/class.ilObjRootFolder.php
