ILIAS  release_4-4 Revision
ilObjAuthSettings Class Reference

Class ilObjAuthSettings. More...

+ Inheritance diagram for ilObjAuthSettings:
+ Collaboration diagram for ilObjAuthSettings:

Public Member Functions

 ilObjAuthSettings ($a_id=0, $a_call_by_reference=true)
 Constructor public. More...
 
 checkAuthLDAP ()
 
 checkAuthSHIB ()
 
 checkAuthRADIUS ()
 
 checkAuthScript ()
 
 update ()
 update object data More...
 
 delete ()
 delete object and all related data More...
 
 initDefaultRoles ()
 init default roles settings 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...
 
 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...
 
 createRoleFolder ()
 creates a local role folder 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...
 

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

Detailed Description

Class ilObjAuthSettings.

Author
Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de
Version
$Id$

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

Member Function Documentation

◆ checkAuthLDAP()

ilObjAuthSettings::checkAuthLDAP ( )

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

50  {
51  $settings = $this->ilias->getAllSettings();
52 
53  if (!$settings["ldap_server"] or !$settings["ldap_basedn"] or !$settings["ldap_port"])
54  {
55  return false;
56  }
57 
58  $this->ilias->setSetting('ldap_active',true);
59 
60  return true;
61  }
redirection script todo: (a better solution should control the processing via a xml file) ...

◆ checkAuthRADIUS()

ilObjAuthSettings::checkAuthRADIUS ( )

Definition at line 78 of file class.ilObjAuthSettings.php.

79  {
80  $settings = $this->ilias->getAllSettings();
81 
82  if (!$settings["radius_server"] or !$settings["radius_shared_secret"] or !$settings["radius_port"])
83  {
84  return false;
85  }
86 
87  $this->ilias->setSetting('radius_active',true);
88 
89  return true;
90  }
redirection script todo: (a better solution should control the processing via a xml file) ...

◆ checkAuthScript()

ilObjAuthSettings::checkAuthScript ( )

Definition at line 92 of file class.ilObjAuthSettings.php.

93  {
94  $settings = $this->ilias->getAllSettings();
95 
96  if (!$settings["auth_script_name"])
97  {
98  return false;
99  }
100 
101  $this->ilias->setSetting('script_active',true);
102 
103  return true;
104  }
redirection script todo: (a better solution should control the processing via a xml file) ...

◆ checkAuthSHIB()

ilObjAuthSettings::checkAuthSHIB ( )

Definition at line 63 of file class.ilObjAuthSettings.php.

64  {
65  $settings = $this->ilias->getAllSettings();
66 
67  if (!$settings["hos_type"] or !$settings["shib_user_default_role"] or !$settings["shib_login"]
68  or !$settings["shib_firstname"] or !$settings["shib_lastname"])
69  {
70  return false;
71  }
72 
73  $this->ilias->setSetting('shibboleth_active',true);
74 
75  return true;
76  }
redirection script todo: (a better solution should control the processing via a xml file) ...

◆ delete()

ilObjAuthSettings::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 131 of file class.ilObjAuthSettings.php.

132  {
133  // always call parent delete function first!!
134  if (!parent::delete())
135  {
136  return false;
137  }
138 
139  //put here your module specific stuff
140 
141  return true;
142  }

◆ ilObjAuthSettings()

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

References ilObject\ilObject().

44  {
45  $this->type = "auth";
46  $this->ilObject($a_id,$a_call_by_reference);
47  }
ilObject($a_id=0, $a_reference=true)
Constructor public.
+ Here is the call graph for this function:

◆ initDefaultRoles()

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

Definition at line 153 of file class.ilObjAuthSettings.php.

154  {
155  global $rbacadmin;
156 
157  // create a local role folder
158  //$rfoldObj = $this->createRoleFolder("Local roles","Role Folder of forum obj_no.".$this->getId());
159 
160  // create moderator role and assign role to rolefolder...
161  //$roleObj = $rfoldObj->createRole("Moderator","Moderator of forum obj_no.".$this->getId());
162  //$roles[] = $roleObj->getId();
163 
164  //unset($rfoldObj);
165  //unset($roleObj);
166 
167  return $roles ? $roles : array();
168  }

◆ notify()

ilObjAuthSettings::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 183 of file class.ilObjAuthSettings.php.

References $_GET, and ilObject\getType().

184  {
185  global $tree;
186 
187  switch ($a_event)
188  {
189  case "link":
190 
191  //var_dump("<pre>",$a_params,"</pre>");
192  //echo "Module name ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
193  //exit;
194  break;
195 
196  case "cut":
197 
198  //echo "Module name ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
199  //exit;
200  break;
201 
202  case "copy":
203 
204  //var_dump("<pre>",$a_params,"</pre>");
205  //echo "Module name ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
206  //exit;
207  break;
208 
209  case "paste":
210 
211  //echo "Module name ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
212  //exit;
213  break;
214 
215  case "new":
216 
217  //echo "Module name ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
218  //exit;
219  break;
220  }
221 
222  // At the beginning of the recursive process it avoids second call of the notify function with the same parameter
223  if ($a_node_id==$_GET["ref_id"])
224  {
225  $parent_obj =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
226  $parent_type = $parent_obj->getType();
227  if($parent_type == $this->getType())
228  {
229  $a_node_id = (int) $tree->getParentId($a_node_id);
230  }
231  }
232 
233  parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params);
234  }
$_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:

◆ update()

ilObjAuthSettings::update ( )

update object data

public

Returns
boolean

Definition at line 112 of file class.ilObjAuthSettings.php.

113  {
114  if (!parent::update())
115  {
116  return false;
117  }
118 
119  // put here object specific stuff
120 
121  return true;
122  }

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