ILIAS  release_4-4 Revision
ilObjRemoteGlossary Class Reference

Remote glossary app class. More...

+ Inheritance diagram for ilObjRemoteGlossary:
+ Collaboration diagram for ilObjRemoteGlossary:

Public Member Functions

 initType ()
 
 setAvailabilityType ($a_type)
 Set Availability type. More...
 
 getAvailabilityType ()
 get availability type More...
 
- Public Member Functions inherited from ilRemoteObjectBase
 __construct ($a_id=0, $a_call_by_reference=true)
 Constructor. More...
 
 beforeCreate ()
 
 getRealmPlain ()
 Get realm plain. More...
 
 setOrganization ($a_organization)
 set organization More...
 
 getOrganization ()
 get organization More...
 
 getLocalInformation ()
 get local information More...
 
 setLocalInformation ($a_info)
 set local information More...
 
 getMID ()
 get mid More...
 
 setMID ($a_mid)
 set mid More...
 
 setRemoteLink ($a_link)
 set remote link More...
 
 getRemoteLink ()
 get remote link More...
 
 getFullRemoteLink ()
 get full remote link Including ecs generated hash and auth mode More...
 
 createAuthResource ($a_plain_realm)
 create authentication resource on ecs server More...
 
 doCreate ()
 Create remote object. More...
 
 doUpdate ()
 Update remote object. More...
 
 doDelete ()
 Delete remote object. More...
 
 doRead ()
 read settings More...
 
 createFromECSEContent (ilECSSetting $a_server, $a_ecs_content, $a_owner)
 create remote object from ECSContent object More...
 
 updateFromECSContent (ilECSSetting $a_server, $a_ecs_content, $a_owner)
 update remote object settings from ecs content More...
 
 isLocalObject ()
 Is remote object from same installation? More...
 
 handleCreate (ilECSSetting $a_server, $a_econtent_id, array $a_mids)
 Handle creation. More...
 
 handleUpdate (ilECSSetting $a_server, $a_econtent_id, array $a_mids)
 Handle update event. More...
 
 handleDelete (ilECSSetting $a_server, $a_econtent_id, $a_mid=0)
 Handle delete event. More...
 
 getAllResourceIds (ilECSSetting $a_server, $a_sender_only=false)
 Get all available resources. More...
 
- Public Member Functions inherited from ilObject2
 __construct ($a_id=0, $a_reference=true)
 Constructor public. More...
 
 withReferences ()
 
 read ($a_force_db=false)
 Read data from db. More...
 
 getId ()
 
 setId ($a_id)
 
 setRefId ($a_id)
 
 getRefId ()
 
 getType ()
 
 setType ($a_type)
 
 getPresentationTitle ()
 
 getTitle ()
 
 getUntranslatedTitle ()
 
 setTitle ($a_title)
 
 getDescription ()
 
 setDescription ($a_desc)
 
 getLongDescription ()
 
 getImportId ()
 
 setImportId ($a_import_id)
 
 getOwner ()
 
 getOwnerName ()
 
 _lookupOwnerName ($a_owner_id)
 
 setOwner ($a_owner)
 
 getCreateDate ()
 
 getLastUpdateDate ()
 
 setObjDataRecord ($a_record)
 
 create ($a_clone_mode=false)
 
 update ()
 
 MDUpdateListener ($a_element)
 
 createMetaData ()
 
 updateMetaData ()
 
 deleteMetaData ()
 
 updateOwner ()
 
 _getIdForImportId ($a_import_id)
 
 _lookupOwner ($a_id)
 
 _lookupLastUpdate ($a_id, $a_as_string=false)
 
 _getLastUpdateOfObjects ($a_objs)
 
 _setDeletedDate ($a_ref_id)
 
 _resetDeletedDate ($a_ref_id)
 
 _lookupDeletedDate ($a_ref_id)
 
 _writeTitle ($a_obj_id, $a_title)
 
 _writeDescription ($a_obj_id, $a_desc)
 
 _writeImportId ($a_obj_id, $a_import_id)
 
 _isInTrash ($a_ref_id)
 
 _hasUntrashedReference ($a_obj_id)
 
 _getObjectsDataForType ($a_type, $a_omit_trash=false)
 
 putInTree ($a_parent_ref)
 
 setPermissions ($a_parent_ref)
 
 createReference ()
 
 countReferences ()
 
 delete ()
 
 initDefaultRoles ()
 
 createRoleFolder ()
 
 notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
 
 setRegisterMode ($a_bool)
 
 isUserRegistered ($a_user_id=0)
 
 requireRegistration ()
 
 appendCopyInfo ($a_target_id, $a_copy_id)
 
 cloneMetaData ($target_obj)
 
 cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)
 
 cloneDependencies ($a_target_id, $a_copy_id)
 
- 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...
 

Static Public Member Functions

static _lookupOnline ($a_obj_id)
 Lookup online. More...
 
static _lookupMID ($a_obj_id)
 
static _lookupOrganization ($a_obj_id)
 
- Static Public Member Functions inherited from ilRemoteObjectBase
static getInstanceByEventType ($a_type)
 Get instance by ilECSEvent(QueueReader) type. More...
 
static _lookupOrganization ($a_obj_id, $a_table)
 lookup organization More...
 
static _lookupMID ($a_obj_id, $a_table)
 lookup owner mid More...
 
- Static Public Member Functions inherited from ilObject2
static _lookupObjIdByImportId ($a_import_id)
 
static _getAllReferences ($a_id)
 
static _lookupTitle ($a_id)
 
static _getIdsForTitle ($title, $type='', $partialmatch=false)
 
static _lookupDescription ($a_id)
 
static _lookupObjId ($a_id)
 
static _lookupType ($a_id, $a_reference=false)
 
static _lookupObjectId ($a_ref_id)
 
static _exists ($a_id, $a_reference=false)
 
static _getObjectsByType ($a_obj_type="", $a_owner="")
 
static _prepareCloneSelection ($a_ref_ids, $new_type)
 
static _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
 
- 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

const DB_TABLE_NAME = "rglo_settings"
 
const ACTIVATION_OFFLINE = 0
 
const ACTIVATION_ONLINE = 1
 
- Data Fields inherited from ilRemoteObjectBase
const MAIL_SENDER = 6
 
const OBJECT_OWNER = 6
 
- 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...
 

Protected Member Functions

 getTableName ()
 
 getECSObjectType ()
 
 doCreateCustomFields (array &$a_fields)
 
 doUpdateCustomFields (array &$a_fields)
 
 doReadCustomFields ($a_row)
 
 updateCustomFromECSContent (ilECSSetting $a_server, $a_ecs_content)
 
- Protected Member Functions inherited from ilRemoteObjectBase
 getTableName ()
 Get db table name. More...
 
 getECSObjectType ()
 Get ECS resource identifier, e.g. More...
 
 doCreateCustomFields (array &$a_fields)
 Add custom fields to db insert. More...
 
 doUpdateCustomFields (array &$a_fields)
 Add custom fields to db update. More...
 
 doReadCustomFields ($a_row)
 Read custom fields from db row. More...
 
 importMetadataFromJson ($a_json, ilECSSetting $a_server, array $a_definition, $a_mapping_mode)
 Add advanced metadata to json (export) More...
 
 updateCustomFromECSContent (ilECSSetting $a_server, $ecs_content)
 update remote object settings from ecs content More...
 
 sendNewContentNotification ($a_server_id)
 send notifications about new EContent More...
 
- Protected Member Functions inherited from ilObject2
 initType ()
 
 doRead ()
 
 doCreate ()
 
 beforeCreate ()
 
 doUpdate ()
 
 beforeUpdate ()
 
 doMDUpdateListener ($a_element)
 
 beforeMDUpdateListener ($a_element)
 
 doCreateMetaData ()
 
 beforeCreateMetaData ()
 
 doUpdateMetaData ()
 
 beforeUpdateMetaData ()
 
 doDelete ()
 
 beforeDelete ()
 
 doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)
 
 beforeCloneObject ()
 

Protected Attributes

 $availability_type
 
- Protected Attributes inherited from ilRemoteObjectBase
 $local_information
 
 $remote_link
 
 $organization
 
 $mid
 
 $auth_hash = ''
 
 $realm_plain = ''
 

Detailed Description

Remote glossary app class.

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

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

Member Function Documentation

◆ _lookupMID()

static ilObjRemoteGlossary::_lookupMID (   $a_obj_id)
static

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

References ilRemoteObjectBase\_lookupMID().

113  {
114  return ilRemoteObjectBase::_lookupMID($a_obj_id, self::DB_TABLE_NAME);
115  }
static _lookupMID($a_obj_id, $a_table)
lookup owner mid
+ Here is the call graph for this function:

◆ _lookupOnline()

static ilObjRemoteGlossary::_lookupOnline (   $a_obj_id)
static

Lookup online.

Parameters
int$a_obj_idobj_id
Returns
bool

Definition at line 65 of file class.ilObjRemoteGlossary.php.

References $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilObjRemoteGlossaryAccess\_checkAccess(), and ilObjRemoteGlossaryListGUI\getProperties().

66  {
67  global $ilDB;
68 
69  $query = "SELECT * FROM ".self::DB_TABLE_NAME.
70  " WHERE obj_id = ".$ilDB->quote($a_obj_id ,'integer')." ";
71  $res = $ilDB->query($query);
72  $row = $res->fetchRow(DB_FETCHMODE_OBJECT);
73  switch($row->availability_type)
74  {
75  case self::ACTIVATION_ONLINE:
76  return true;
77 
78  case self::ACTIVATION_OFFLINE:
79  return false;
80 
81  default:
82  return false;
83  }
84 
85  return false;
86  }
const DB_FETCHMODE_OBJECT
Definition: class.ilDB.php:11
+ Here is the caller graph for this function:

◆ _lookupOrganization()

static ilObjRemoteGlossary::_lookupOrganization (   $a_obj_id)
static

Definition at line 117 of file class.ilObjRemoteGlossary.php.

References ilRemoteObjectBase\_lookupOrganization().

Referenced by ilObjRemoteGlossaryListGUI\getProperties().

118  {
119  return ilRemoteObjectBase::_lookupOrganization($a_obj_id, self::DB_TABLE_NAME);
120  }
static _lookupOrganization($a_obj_id, $a_table)
lookup organization
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ doCreateCustomFields()

ilObjRemoteGlossary::doCreateCustomFields ( array &  $a_fields)
protected

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

89  {
90  $a_fields["availability_type"] = array("integer", 0);
91  }

◆ doReadCustomFields()

ilObjRemoteGlossary::doReadCustomFields (   $a_row)
protected

Definition at line 98 of file class.ilObjRemoteGlossary.php.

References setAvailabilityType().

99  {
100  $this->setAvailabilityType($a_row->availability_type);
101  }
setAvailabilityType($a_type)
Set Availability type.
+ Here is the call graph for this function:

◆ doUpdateCustomFields()

ilObjRemoteGlossary::doUpdateCustomFields ( array &  $a_fields)
protected

Definition at line 93 of file class.ilObjRemoteGlossary.php.

References getAvailabilityType().

94  {
95  $a_fields["availability_type"] = array("integer", $this->getAvailabilityType());
96  }
getAvailabilityType()
get availability type
+ Here is the call graph for this function:

◆ getAvailabilityType()

ilObjRemoteGlossary::getAvailabilityType ( )

get availability type

Returns
int

Definition at line 54 of file class.ilObjRemoteGlossary.php.

References $availability_type.

Referenced by doUpdateCustomFields().

+ Here is the caller graph for this function:

◆ getECSObjectType()

ilObjRemoteGlossary::getECSObjectType ( )
protected

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

35  {
36  return "/campusconnect/glossaries";
37  }

◆ getTableName()

ilObjRemoteGlossary::getTableName ( )
protected

Definition at line 29 of file class.ilObjRemoteGlossary.php.

30  {
31  return self::DB_TABLE_NAME;
32  }

◆ initType()

ilObjRemoteGlossary::initType ( )

Definition at line 24 of file class.ilObjRemoteGlossary.php.

25  {
26  $this->type = "rglo";
27  }

◆ setAvailabilityType()

ilObjRemoteGlossary::setAvailabilityType (   $a_type)

Set Availability type.

Parameters
int$a_typeavailability type

Definition at line 44 of file class.ilObjRemoteGlossary.php.

Referenced by doReadCustomFields(), and updateCustomFromECSContent().

45  {
46  $this->availability_type = $a_type;
47  }
+ Here is the caller graph for this function:

◆ updateCustomFromECSContent()

ilObjRemoteGlossary::updateCustomFromECSContent ( ilECSSetting  $a_server,
  $a_ecs_content 
)
protected

Definition at line 103 of file class.ilObjRemoteGlossary.php.

References setAvailabilityType().

104  {
105  $this->setAvailabilityType($a_ecs_content->availability == 'online' ? self::ACTIVATION_ONLINE : self::ACTIVATION_OFFLINE);
106  }
setAvailabilityType($a_type)
Set Availability type.
+ Here is the call graph for this function:

Field Documentation

◆ $availability_type

ilObjRemoteGlossary::$availability_type
protected

Definition at line 22 of file class.ilObjRemoteGlossary.php.

Referenced by getAvailabilityType().

◆ ACTIVATION_OFFLINE

const ilObjRemoteGlossary::ACTIVATION_OFFLINE = 0

◆ ACTIVATION_ONLINE

const ilObjRemoteGlossary::ACTIVATION_ONLINE = 1

◆ DB_TABLE_NAME

const ilObjRemoteGlossary::DB_TABLE_NAME = "rglo_settings"

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


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