ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f87
ilObjStyleSettings Class Reference

Class ilObjStyleSettings. More...

+ Inheritance diagram for ilObjStyleSettings:
+ Collaboration diagram for ilObjStyleSettings:

Public Member Functions

 ilObjStyleSettings ($a_id=0, $a_call_by_reference=true)
 Constructor public. More...
 
 addStyle ($a_style_id)
 add style to style folder More...
 
 removeStyle ($a_id)
 remove Style from style list More...
 
 update ()
 update object data More...
 
 read ()
 read style folder data More...
 
 _lookupActivatedStyle ($a_skin, $a_style)
 lookup if a style is activated More...
 
 _deactivateStyle ($a_skin, $a_style)
 deactivate style More...
 
 _activateStyle ($a_skin, $a_style)
 activate style More...
 
 getStyles ()
 get style ids More...
 
 delete ()
 delete object and all related data More...
 
 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. More...
 
- Public Member Functions inherited from ilObject
 ilObject ($a_id=0, $a_reference=true)
 Constructor public. More...
 
 withReferences ()
 determines wehter objects are referenced or not (got ref ids or not) More...
 
 read ($a_force_db=false)
 read object data from db into object More...
 
 getId ()
 get object id public More...
 
 setId ($a_id)
 set object id public More...
 
 setRefId ($a_id)
 set reference id public More...
 
 getRefId ()
 get reference id public More...
 
 getType ()
 get object type public More...
 
 setType ($a_type)
 set object type public More...
 
 getPresentationTitle ()
 get presentation title Normally same as title Overwritten for sessions More...
 
 getTitle ()
 get object title public More...
 
 getUntranslatedTitle ()
 get untranslated object title public More...
 
 setTitle ($a_title)
 set object title More...
 
 getDescription ()
 get object description More...
 
 setDescription ($a_desc)
 set object description More...
 
 getLongDescription ()
 get object long description (stored in object_description) More...
 
 getImportId ()
 get import id More...
 
 setImportId ($a_import_id)
 set import id More...
 
 getOwner ()
 get object owner More...
 
 getOwnerName ()
 
 _lookupOwnerName ($a_owner_id)
 lookup owner name for owner id More...
 
 setOwner ($a_owner)
 set object owner More...
 
 getCreateDate ()
 get create date public More...
 
 getLastUpdateDate ()
 get last update date public More...
 
 getDiskUsage ()
 Gets the disk usage of the object in bytes. More...
 
 setObjDataRecord ($a_record)
 set object_data record (note: this method should only be called from the ilObjectFactory class) More...
 
 create ()
 create More...
 
 update ()
 update object in db More...
 
 MDUpdateListener ($a_element)
 Meta data update listener. More...
 
 createMetaData ()
 create meta data entry More...
 
 updateMetaData ()
 update meta data entry More...
 
 deleteMetaData ()
 delete meta data entry More...
 
 updateOwner ()
 update owner of object in db More...
 
 _getIdForImportId ($a_import_id)
 get current object id for import id (static) More...
 
 _lookupOwner ($a_id)
 lookup object owner More...
 
 _lookupLastUpdate ($a_id, $a_as_string=false)
 lookup last update More...
 
 _getLastUpdateOfObjects ($a_objs)
 Get last update for a set of media objects. More...
 
 _setDeletedDate ($a_ref_id)
 only called in ilTree::saveSubTree More...
 
 _resetDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
 _lookupDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
 _writeTitle ($a_obj_id, $a_title)
 write title to db (static) More...
 
 _writeDescription ($a_obj_id, $a_desc)
 write description to db (static) More...
 
 _writeImportId ($a_obj_id, $a_import_id)
 write import id to db (static) More...
 
 _isInTrash ($a_ref_id)
 checks wether object is in trash More...
 
 _hasUntrashedReference ($a_obj_id)
 checks wether an object has at least one reference that is not in trash More...
 
 _getObjectsDataForType ($a_type, $a_omit_trash=false)
 get all objects of a certain type More...
 
 putInTree ($a_parent_ref)
 maybe this method should be in tree object!? More...
 
 setPermissions ($a_parent_ref)
 set permissions of object More...
 
 setParentRolePermissions ($a_parent_ref)
 Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...
 
 createReference ()
 creates reference for object More...
 
 countReferences ()
 count references of object More...
 
 delete ()
 delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
 
 initDefaultRoles ()
 init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...
 
 applyDidacticTemplate ($a_tpl_id)
 Apply template. More...
 
 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 passed, each object may decide how it reacts. More...
 
 setRegisterMode ($a_bool)
 
 isUserRegistered ($a_user_id=0)
 
 requireRegistration ()
 
 getXMLZip ()
 
 getHTMLDirectory ()
 
 cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
 Clone object permissions, put in tree ... More...
 
 appendCopyInfo ($a_target_id, $a_copy_id)
 Prepend Copy info if object with same name exists in that container. More...
 
 cloneDependencies ($a_target_id, $a_copy_id)
 Clone object dependencies. More...
 
 cloneMetaData ($target_obj)
 Copy meta data. More...
 
 _lookupCreationDate ($a_id)
 Lookup creation date. More...
 

Data Fields

 $styles
 
- Data Fields inherited from ilObject
const TITLE_LENGTH = 255
 max length of object title More...
 
const DESC_LENGTH = 128
 
 $ilias
 
 $lng
 
 $id
 
 $ref_id
 
 $type
 
 $title
 
 $untranslatedTitle
 
 $desc
 
 $long_desc
 
 $owner
 
 $create_date
 
 $last_update
 
 $import_id
 
 $register = false
 
 $referenced
 
 $objectList
 
 $max_title
 
 $max_desc
 
 $add_dots
 
 $obj_data_record
 object_data record More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ilObject
static _lookupObjIdByImportId ($a_import_id)
 
static _getAllReferences ($a_id)
 get all reference ids of object More...
 
static _lookupTitle ($a_id)
 lookup object title More...
 
static _getIdsForTitle ($title, $type='', $partialmatch=false)
 
static _lookupDescription ($a_id)
 lookup object description More...
 
static _lookupObjId ($a_id)
 
static setDeletedDates ($a_ref_ids)
 Set deleted date type $ilDB. More...
 
static _lookupType ($a_id, $a_reference=false)
 lookup object type More...
 
static _lookupObjectId ($a_ref_id)
 lookup object id More...
 
static _exists ($a_id, $a_reference=false, $a_type=null)
 checks if an object exists in object_data More...
 
static _getObjectsByType ($a_obj_type="", $a_owner="")
 Get objects by type. More...
 
static _prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
 Prepare copy wizard object selection. More...
 
static _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
 Get icon for repository item. More...
 
static collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
 Collect deletion dependencies. More...
 
static getDeletionDependencies ($a_obj_id)
 Get deletion dependencies. More...
 
static getLongDescriptions (array $a_obj_ids)
 Get long description data. More...
 
static getAllOwnedRepositoryObjects ($a_user_id)
 Get all ids of objects user owns. More...
 
static hasAutoRating ($a_type, $a_ref_id)
 Check if auto rating is active for parent group/course. More...
 

Detailed Description

Class ilObjStyleSettings.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 15 of file class.ilObjStyleSettings.php.

Member Function Documentation

◆ _activateStyle()

ilObjStyleSettings::_activateStyle (   $a_skin,
  $a_style 
)

activate style

Definition at line 155 of file class.ilObjStyleSettings.php.

References $ilDB.

Referenced by _deactivateStyle(), and ilObjStyleSettingsGUI\saveStyleSettingsObject().

156  {
157  global $ilDB;
158 
159  $q = "DELETE FROM settings_deactivated_s".
160  " WHERE skin = ".$ilDB->quote($a_skin, "text").
161  " AND style = ".$ilDB->quote($a_style, "text");
162 
163  $ilDB->manipulate($q);
164  }
global $ilDB
+ Here is the caller graph for this function:

◆ _deactivateStyle()

ilObjStyleSettings::_deactivateStyle (   $a_skin,
  $a_style 
)

deactivate style

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

References $ilDB, and _activateStyle().

Referenced by ilObjStyleSettingsGUI\saveStyleSettingsObject().

140  {
141  global $ilDB;
142 
143  ilObjStyleSettings::_activateStyle($a_skin, $a_style);
144  $q = "INSERT into settings_deactivated_s".
145  " (skin, style) VALUES ".
146  " (".$ilDB->quote($a_skin, "text").",".
147  " ".$ilDB->quote($a_style, "text").")";
148 
149  $ilDB->manipulate($q);
150  }
_activateStyle($a_skin, $a_style)
activate style
global $ilDB
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _lookupActivatedStyle()

ilObjStyleSettings::_lookupActivatedStyle (   $a_skin,
  $a_style 
)

lookup if a style is activated

Definition at line 115 of file class.ilObjStyleSettings.php.

References $ilDB.

Referenced by ilSoapInstallationInfoXMLWriter\__buildClient(), ilSystemStylesTableGUI\fillRow(), ilUserImportParser\ilUserImportParser(), ilObjUserGUI\initForm(), and ilPersonalSettingsGUI\initGeneralSettingsForm().

116  {
117  global $ilDB;
118 
119  $q = "SELECT count(*) cnt FROM settings_deactivated_s".
120  " WHERE skin = ".$ilDB->quote($a_skin, "text").
121  " AND style = ".$ilDB->quote($a_style, "text")." ";
122 
123  $cnt_set = $ilDB->query($q);
124  $cnt_rec = $ilDB->fetchAssoc($cnt_set);
125 
126  if ($cnt_rec["cnt"] > 0)
127  {
128  return false;
129  }
130  else
131  {
132  return true;
133  }
134  }
global $ilDB
+ Here is the caller graph for this function:

◆ addStyle()

ilObjStyleSettings::addStyle (   $a_style_id)

add style to style folder

Parameters
int$a_style_idstyle id

Definition at line 38 of file class.ilObjStyleSettings.php.

References ilObject\_lookupTitle().

39  {
40  $this->styles[$a_style_id] =
41  array("id" => $a_style_id,
42  "title" => ilObject::_lookupTitle($a_style_id));
43  }
static _lookupTitle($a_id)
lookup object title
+ Here is the call graph for this function:

◆ delete()

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

Definition at line 183 of file class.ilObjStyleSettings.php.

184  {
185  // always call parent delete function first!!
186  if (!parent::delete())
187  {
188  return false;
189  }
190 
191  //put here your module specific stuff
192 
193  return true;
194  }

◆ getStyles()

ilObjStyleSettings::getStyles ( )

get style ids

Returns
array ids

Definition at line 171 of file class.ilObjStyleSettings.php.

References $styles.

172  {
173  return $this->styles;
174  }

◆ ilObjStyleSettings()

ilObjStyleSettings::ilObjStyleSettings (   $a_id = 0,
  $a_call_by_reference = true 
)

Constructor public.

Parameters
integerreference_id or object_id
booleantreat the id as reference_id (true) or object_id (false)

Definition at line 25 of file class.ilObjStyleSettings.php.

References ilObject\ilObject().

26  {
27  $this->type = "stys";
28  $this->ilObject($a_id,$a_call_by_reference);
29 
30  $this->styles = array();
31  }
ilObject($a_id=0, $a_reference=true)
Constructor public.
+ Here is the call graph for this function:

◆ notify()

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
stringevent
integerreference id of object where the event occured
arraypasses optional parameters if required
Returns
boolean

Definition at line 210 of file class.ilObjStyleSettings.php.

References $_GET, and ilObject\getType().

211  {
212  global $tree;
213 
214  switch ($a_event)
215  {
216  case "link":
217 
218  //var_dump("<pre>",$a_params,"</pre>");
219  //echo "Module name ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
220  //exit;
221  break;
222 
223  case "cut":
224 
225  //echo "Module name ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
226  //exit;
227  break;
228 
229  case "copy":
230 
231  //var_dump("<pre>",$a_params,"</pre>");
232  //echo "Module name ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
233  //exit;
234  break;
235 
236  case "paste":
237 
238  //echo "Module name ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
239  //exit;
240  break;
241 
242  case "new":
243 
244  //echo "Module name ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
245  //exit;
246  break;
247  }
248 
249  // At the beginning of the recursive process it avoids second call of the notify function with the same parameter
250  if ($a_node_id==$_GET["ref_id"])
251  {
252  $parent_obj =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
253  $parent_type = $parent_obj->getType();
254  if($parent_type == $this->getType())
255  {
256  $a_node_id = (int) $tree->getParentId($a_node_id);
257  }
258  }
259 
260  parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params);
261  }
$_GET["client_id"]
redirection script todo: (a better solution should control the processing via a xml file) ...
getType()
get object type public
+ Here is the call graph for this function:

◆ read()

ilObjStyleSettings::read ( )

read style folder data

Definition at line 88 of file class.ilObjStyleSettings.php.

References $ilDB, ilObject\_lookupTitle(), ilObject\getId(), and ilUtil\sortArray().

89  {
90  global $ilDB;
91 
92  parent::read();
93 
94  // get styles of style folder
95  $q = "SELECT * FROM style_folder_styles, style_data WHERE folder_id = ".
96  $ilDB->quote($this->getId(), "integer").
97  " AND style_id = style_data.id";
98 
99  $style_set = $ilDB->query($q);
100  $this->styles = array();
101  while ($style_rec = $ilDB->fetchAssoc($style_set))
102  {
103  $this->styles[$style_rec["style_id"]] =
104  array("id" => $style_rec["style_id"],
105  "title" => ilObject::_lookupTitle($style_rec["style_id"]),
106  "category" => $style_rec["category"]);
107  }
108  $this->styles =
109  ilUtil::sortArray($this->styles, "title", "asc", false, true);
110  }
static _lookupTitle($a_id)
lookup object title
static sortArray($array, $a_array_sortby, $a_array_sortorder=0, $a_numeric=false, $a_keep_keys=false)
sortArray
getId()
get object id public
global $ilDB
+ Here is the call graph for this function:

◆ removeStyle()

ilObjStyleSettings::removeStyle (   $a_id)

remove Style from style list

Definition at line 49 of file class.ilObjStyleSettings.php.

50  {
51  unset($a_id);
52  }

◆ update()

ilObjStyleSettings::update ( )

update object data

public

Returns
boolean

Definition at line 61 of file class.ilObjStyleSettings.php.

References $ilDB, and ilObject\getId().

62  {
63  global $ilDB;
64 
65  if (!parent::update())
66  {
67  return false;
68  }
69 
70  // save styles of style folder
71  $q = "DELETE FROM style_folder_styles WHERE folder_id = ".
72  $ilDB->quote($this->getId(), "integer");
73  $ilDB->manipulate($q);
74  foreach($this->styles as $style)
75  {
76  $q = "INSERT INTO style_folder_styles (folder_id, style_id) VALUES".
77  "(".$ilDB->quote((int) $this->getId(), "integer").", ".
78  $ilDB->quote((int) $style["id"], "integer").")";
79  $ilDB->manipulate($q);
80  }
81 
82  return true;
83  }
getId()
get object id public
global $ilDB
+ Here is the call graph for this function:

Field Documentation

◆ $styles

ilObjStyleSettings::$styles

Definition at line 17 of file class.ilObjStyleSettings.php.

Referenced by getStyles().


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