Public Member Functions

ilObjPersonalDesktopSettings Class Reference

Class ilObjPersonalDesktopSettings. More...

Inheritance diagram for ilObjPersonalDesktopSettings:
Collaboration diagram for ilObjPersonalDesktopSettings:

Public Member Functions

 ilObjPersonalDesktopSettings ($a_id=0, $a_call_by_reference=true)
 Constructor public.
 update ()
 update object data
 read ()
 read style folder data
 delete ()
 delete object and all related data
 initDefaultRoles ()
 init default roles settings
 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

Class ilObjPersonalDesktopSettings.

Author:
Alex Killing <alex.killing@gmx.de>
Version:
$Id$

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


Member Function Documentation

ilObjPersonalDesktopSettings::delete (  ) 

delete object 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 88 of file class.ilObjPersonalDesktopSettings.php.

        {               
                // always call parent delete function first!!
                if (!parent::delete())
                {
                        return false;
                }
                
                //put here your module specific stuff
                
                return true;
        }

ilObjPersonalDesktopSettings::ilObjPersonalDesktopSettings ( a_id = 0,
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 43 of file class.ilObjPersonalDesktopSettings.php.

References ilObject::ilObject().

        {
                $this->type = "pdts";
                $this->ilObject($a_id,$a_call_by_reference);
        }

Here is the call graph for this function:

ilObjPersonalDesktopSettings::initDefaultRoles (  ) 

init default roles settings

If your module does not require any default roles, delete this method (For an example how this method is used, look at ilObjForum)

public

Returns:
array object IDs of created local roles.

Reimplemented from ilObject.

Definition at line 110 of file class.ilObjPersonalDesktopSettings.php.

        {
                global $rbacadmin;
                
                // create a local role folder
                //$rfoldObj = $this->createRoleFolder("Local roles","Role Folder of forum obj_no.".$this->getId());

                // create moderator role and assign role to rolefolder...
                //$roleObj = $rfoldObj->createRole("Moderator","Moderator of forum obj_no.".$this->getId());
                //$roles[] = $roleObj->getId();

                //unset($rfoldObj);
                //unset($roleObj);

                return $roles ? $roles : array();
        }

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

If you are not required to handle any events related to your module, just delete this method. (For an example how this method is used, look at ilObjGroup)

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 140 of file class.ilObjPersonalDesktopSettings.php.

References $_GET, and ilObject::getType().

        {
                global $tree;
                
                switch ($a_event)
                {
                        case "link":
                                
                                //var_dump("<pre>",$a_params,"</pre>");
                                //echo "Module name ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
                                //exit;
                                break;
                        
                        case "cut":
                                
                                //echo "Module name ".$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 "Module name ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
                                //exit;
                                break;

                        case "paste":
                                
                                //echo "Module name ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
                                //exit;
                                break;
                        
                        case "new":
                                
                                //echo "Module name ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
                                //exit;
                                break;
                }
                
                // At the beginning of the recursive process it avoids second call of the notify function with the same parameter
                if ($a_node_id==$_GET["ref_id"])
                {       
                        $parent_obj =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
                        $parent_type = $parent_obj->getType();
                        if($parent_type == $this->getType())
                        {
                                $a_node_id = (int) $tree->getParentId($a_node_id);
                        }
                }
                
                parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params);
        }

Here is the call graph for this function:

ilObjPersonalDesktopSettings::read (  ) 

read style folder data

Definition at line 70 of file class.ilObjPersonalDesktopSettings.php.

        {
                global $ilDB;

                parent::read();

        }

ilObjPersonalDesktopSettings::update (  ) 

update object data

public

Returns:
boolean

Reimplemented from ilObject.

Definition at line 55 of file class.ilObjPersonalDesktopSettings.php.

        {
                global $ilDB;
                
                if (!parent::update())
                {                       
                        return false;
                }

                return true;
        }


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