Inheritance diagram for ilObjStyleSettings:
Collaboration diagram for ilObjStyleSettings:
Public Member Functions | |
| ilObjStyleSettings ($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 | |
| _lookupActivatedStyle ($a_skin, $a_style) | |
| lookup if a style is activated | |
| _deactivateStyle ($a_skin, $a_style) | |
| deactivate style | |
| _activateStyle ($a_skin, $a_style) | |
| activate style | |
| getStyles () | |
| get style ids | |
| ilClone ($a_parent_ref) | |
| copy all entries of your object. | |
| 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
Definition at line 36 of file class.ilObjStyleSettings.php.
Member Function Documentation
| ilObjStyleSettings::_activateStyle | ( | $ | a_skin, | |
| $ | a_style | |||
| ) |
activate style
Definition at line 174 of file class.ilObjStyleSettings.php.
References $q.
Referenced by ilObjStyleSettingsGUI::saveStyleSettingsObject().
{
global $ilDB;
$q = "DELETE FROM settings_deactivated_styles".
" WHERE skin = ".$ilDB->quote($a_skin).
" AND style = ".$ilDB->quote($a_style);
$ilDB->query($q);
}
Here is the caller graph for this function:
| ilObjStyleSettings::_deactivateStyle | ( | $ | a_skin, | |
| $ | a_style | |||
| ) |
deactivate style
Definition at line 159 of file class.ilObjStyleSettings.php.
References $q.
Referenced by ilObjStyleSettingsGUI::saveStyleSettingsObject().
{
global $ilDB;
$q = "REPLACE into settings_deactivated_styles".
" (skin, style) VALUES ".
" (".$ilDB->quote($a_skin).",".
" ".$ilDB->quote($a_style).")";
$ilDB->query($q);
}
Here is the caller graph for this function:
| ilObjStyleSettings::_lookupActivatedStyle | ( | $ | a_skin, | |
| $ | a_style | |||
| ) |
lookup if a style is activated
Definition at line 135 of file class.ilObjStyleSettings.php.
References $q.
Referenced by ilObjUserGUI::createObject(), ilObjUserGUI::editObject(), ilObjStyleSettingsGUI::editSystemStylesObject(), ilInitialisation::handleStyle(), and ilPersonalProfileGUI::showProfile().
{
global $ilDB;
$q = "SELECT count(*) AS cnt FROM settings_deactivated_styles".
" WHERE skin = ".$ilDB->quote($a_skin).
" AND style = ".$ilDB->quote($a_style);
$cnt_set = $ilDB->query($q);
$cnt_rec = $cnt_set->fetchRow(DB_FETCHMODE_ASSOC);
if ($cnt_rec["cnt"] > 0)
{
return false;
}
else
{
return true;
}
}
Here is the caller graph for this function:
| ilObjStyleSettings::addStyle | ( | $ | a_style_id | ) |
add style to style folder
- Parameters:
-
int $a_style_id style id
Definition at line 59 of file class.ilObjStyleSettings.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:
| ilObjStyleSettings::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 232 of file class.ilObjStyleSettings.php.
{
// always call parent delete function first!!
if (!parent::delete())
{
return false;
}
//put here your module specific stuff
return true;
}
| ilObjStyleSettings::getStyles | ( | ) |
get style ids
- Returns:
- array ids
Definition at line 190 of file class.ilObjStyleSettings.php.
{
return $this->styles;
}
| ilObjStyleSettings::ilClone | ( | $ | a_parent_ref | ) |
copy all entries of your object.
public
- Parameters:
-
integer ref_id of parent object
- Returns:
- integer new ref id
Reimplemented from ilObject.
Definition at line 203 of file class.ilObjStyleSettings.php.
References $rbacadmin.
{
global $rbacadmin;
// always call parent clone function first!!
$new_ref_id = parent::ilClone($a_parent_ref);
// get object instance of cloned object
//$newObj =& $this->ilias->obj_factory->getInstanceByRefId($new_ref_id);
// create a local role folder & default roles
//$roles = $newObj->initDefaultRoles();
// ...finally assign role to creator of object
//$rbacadmin->assignUser($roles[0], $newObj->getOwner(), "n");
// always destroy objects in clone method because clone() is recursive and creates instances for each object in subtree!
//unset($newObj);
// ... and finally always return new reference ID!!
return $new_ref_id;
}
| ilObjStyleSettings::ilObjStyleSettings | ( | $ | 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 46 of file class.ilObjStyleSettings.php.
References ilObject::ilObject().
{
$this->type = "stys";
$this->ilObject($a_id,$a_call_by_reference);
$this->styles = array();
}
Here is the call graph for this function:
| ilObjStyleSettings::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 254 of file class.ilObjStyleSettings.php.
References $rbacadmin.
{
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();
}
| ilObjStyleSettings::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 284 of file class.ilObjStyleSettings.php.
References $_GET, $tree, 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:
| ilObjStyleSettings::read | ( | ) |
read style folder data
Definition at line 109 of file class.ilObjStyleSettings.php.
References $q, and ilObject::getId().
{
global $ilDB;
parent::read();
// get styles of style folder
$q = "SELECT * FROM style_folder_styles, object_data as obj, style_data WHERE folder_id = ".
$ilDB->quote($this->getId()).
" AND style_id = obj.obj_id".
" AND style_data.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"],
"category" => $style_rec["category"]);
//echo "<br>-".$style_rec["category"]."-";
}
}
Here is the call graph for this function:
| ilObjStyleSettings::removeStyle | ( | $ | a_id | ) |
remove Style from style list
Definition at line 70 of file class.ilObjStyleSettings.php.
{
unset($a_id);
}
| ilObjStyleSettings::update | ( | ) |
update object data
public
- Returns:
- boolean
Reimplemented from ilObject.
Definition at line 82 of file class.ilObjStyleSettings.php.
References $q, and 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
| ilObjStyleSettings::$styles |
Definition at line 38 of file class.ilObjStyleSettings.php.
The documentation for this class was generated from the following file:
- classes/class.ilObjStyleSettings.php
