Inheritance diagram for ilObjStyleSheetFolder:

Collaboration diagram for ilObjStyleSheetFolder:

Public Member Functions
	ilObjStyleSheetFolder ($a_id=0, $a_call_by_reference=true)
	Constructor public.
	addStyle ($a_style_id)
	add style to style folder
	removeStyle ($a_id)
	remove Style from style list
	update ()
	update object data
	read ()
	read style folder data
	getStyles ()
	get style ids
	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.
Data Fields
	$styles

Detailed Description

Class ilObjStyleSheetFolder.

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

Version:

Id:: class.ilObjStyleSheetFolder.php 13414 2007-03-08 12:41:48Z smeyer

Definition at line 35 of file class.ilObjStyleSheetFolder.php.

Member Function Documentation

ilObjStyleSheetFolder::addStyle ( $ a_style_id )

add style to style folder

Parameters:

int

$a_style_id style id

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

References ilObject::_lookupTitle().

        {
                $this->styles[$a_style_id] =
                        array("id" => $a_style_id,
                        "title" => ilObject::_lookupTitle($a_style_id));
        }

Here is the call graph for this function:

ilObjStyleSheetFolder::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 147 of file class.ilObjStyleSheetFolder.php.

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

ilObjStyleSheetFolder::getStyles ( )

get style ids

Returns:: array ids

Definition at line 134 of file class.ilObjStyleSheetFolder.php.

        {
                return $this->styles;
        }

ilObjStyleSheetFolder::ilObjStyleSheetFolder	(	$	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 45 of file class.ilObjStyleSheetFolder.php.

References ilObject::ilObject().

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

Here is the call graph for this function:

ilObjStyleSheetFolder::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 169 of file class.ilObjStyleSheetFolder.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();
        }

ilObjStyleSheetFolder::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 199 of file class.ilObjStyleSheetFolder.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:

ilObjStyleSheetFolder::read ( )

read style folder data

Definition at line 108 of file class.ilObjStyleSheetFolder.php.

References ilObject::getId().

        {
                global $ilDB;

                parent::read();

                // get styles of style folder
                $q = "SELECT * FROM style_folder_styles, object_data as obj WHERE folder_id = ".
                        $ilDB->quote($this->getId()).
                        " AND style_id = obj.obj_id";

                $style_set = $ilDB->query($q);
                while ($style_rec = $style_set->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $this->styles[$style_rec["style_id"]] =
                                array("id" => $style_rec["style_id"],
                                "title" => $style_rec["title"]);
                }
        }

Here is the call graph for this function:

ilObjStyleSheetFolder::removeStyle ( $ a_id )

remove Style from style list

Definition at line 69 of file class.ilObjStyleSheetFolder.php.

        {
                unset($a_id);
        }

ilObjStyleSheetFolder::update ( )

update object data

public

Returns:: boolean

Reimplemented from ilObject.

Definition at line 81 of file class.ilObjStyleSheetFolder.php.

References ilObject::getId().

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

                // save styles of style folder
                $q = "DELETE FROM style_folder_styles WHERE folder_id = ".
                        $ilDB->quote($this->getId());
                $ilDB->query($q);
                foreach($this->styles as $style)
                {
                        $q = "INSERT INTO style_folder_styles (folder_id, style_id) VALUES".
                                "(".$ilDB->quote($this->getId()).", ".
                                $ilDB->quote($style["id"]).")";
                        $ilDB->query($q);
                }
                
                return true;
        }

Here is the call graph for this function:

Field Documentation

ilObjStyleSheetFolder::$styles

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

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

classes/class.ilObjStyleSheetFolder.php

ilObjStyleSheetFolder Class Reference

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

Field Documentation