ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
ilRemoteObjectBase Class Reference

Remote object app base class. More...

+ Inheritance diagram for ilRemoteObjectBase:
+ Collaboration diagram for ilRemoteObjectBase:

Public Member Functions

 __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 @access public. More...
 
 withReferences ()
 determines wehter objects are referenced or not (got ref ids or not) More...
 
 read ()
 Read data from db. More...
 
 getId ()
 get object id @access public More...
 
 setId ($a_id)
 set object id @access public More...
 
 setRefId ($a_id)
 set reference id @access public More...
 
 getRefId ()
 get reference id @access public More...
 
 getType ()
 get object type @access public More...
 
 setType ($a_type)
 set object type @access public More...
 
 getPresentationTitle ()
 get presentation title Normally same as title Overwritten for sessions More...
 
 getTitle ()
 get object title @access public More...
 
 getUntranslatedTitle ()
 get untranslated object title @access 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 ()
 
 setOwner ($a_owner)
 set object owner More...
 
 getCreateDate ()
 get create date @access public More...
 
 getLastUpdateDate ()
 get last update date @access public More...
 
 create ($a_clone_mode=false)
 
 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...
 
 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 ()
 
 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) @access public More...
 
 setRegisterMode ($a_bool)
 
 isUserRegistered ($a_user_id=0)
 
 requireRegistration ()
 
 appendCopyInfo ($a_target_id, $a_copy_id)
 Prepend Copy info if object with same name exists in that container. More...
 
 cloneMetaData ($target_obj)
 Copy meta data. More...
 
 cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)
 
 cloneDependencies ($a_target_id, $a_copy_id)
 Clone object dependencies. More...
 
- Public Member Functions inherited from ilObject
 __construct ($a_id=0, $a_reference=true)
 Constructor @access public. More...
 
 withReferences ()
 determines wehter objects are referenced or not (got ref ids or not) More...
 
 read ()
 read object data from db into object More...
 
 getId ()
 get object id @access public More...
 
 setId ($a_id)
 set object id @access public More...
 
 setRefId ($a_id)
 set reference id @access public More...
 
 getRefId ()
 get reference id @access public More...
 
 getType ()
 get object type @access public More...
 
 setType ($a_type)
 set object type @access public More...
 
 getPresentationTitle ()
 get presentation title Normally same as title Overwritten for sessions More...
 
 getTitle ()
 get object title @access public More...
 
 getUntranslatedTitle ()
 get untranslated object title @access 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 ()
 
 setOwner ($a_owner)
 set object owner More...
 
 getCreateDate ()
 get create date @access public More...
 
 getLastUpdateDate ()
 get last update date @access public More...
 
 getDiskUsage ()
 Gets the disk usage of the object in bytes. 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...
 
 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...
 
 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) @access public More...
 
 applyDidacticTemplate ($a_tpl_id)
 Apply template. More...
 
 setRegisterMode ($a_bool)
 
 isUserRegistered ($a_user_id=0)
 
 requireRegistration ()
 
 getXMLZip ()
 
 getHTMLDirectory ()
 
 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...
 
 getPossibleSubObjects ($a_filter=true)
 get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...
 

Static Public Member Functions

static getInstanceByEventType ($a_type)
 Get instance by ilECSEvent(QueueReader) type. More...
 
static _lookupOrganization ($a_obj_id)
 lookup organization More...
 
static _lookupMID ($a_obj_id)
 lookup owner mid More...
 
- Static Public Member Functions inherited from ilObject2
static _lookupObjIdByImportId ($a_import_id)
 
static _lookupOwnerName ($a_owner_id)
 lookup owner name for owner id More...
 
static _getIdForImportId ($a_import_id)
 get current object id for import id (static) More...
 
static _getAllReferences ($a_id)
 get all reference ids of object More...
 
static _lookupTitle ($a_id)
 lookup object title More...
 
static _lookupOwner ($a_id)
 lookup object owner More...
 
static _getIdsForTitle ($title, $type='', $partialmatch=false)
 
static _lookupDescription ($a_id)
 lookup object description More...
 
static _lookupLastUpdate ($a_id, $a_as_string=false)
 lookup last update More...
 
static _getLastUpdateOfObjects ($a_objs)
 Get last update for a set of media objects. More...
 
static _lookupObjId ($a_id)
 
static _setDeletedDate ($a_ref_id)
 only called in ilTree::saveSubTree More...
 
static _resetDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
static _lookupDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
static _writeTitle ($a_obj_id, $a_title)
 write title to db (static) More...
 
static _writeDescription ($a_obj_id, $a_desc)
 write description to db (static) More...
 
static _writeImportId ($a_obj_id, $a_import_id)
 write import id to db (static) More...
 
static _lookupType ($a_id, $a_reference=false)
 lookup object type More...
 
static _isInTrash ($a_ref_id)
 checks wether object is in trash More...
 
static _hasUntrashedReference ($a_obj_id)
 checks wether an object has at least one reference that is not in trash More...
 
static _lookupObjectId ($a_ref_id)
 lookup object id More...
 
static _getObjectsDataForType ($a_type, $a_omit_trash=false)
 get all objects of a certain type More...
 
static _exists ($a_id, $a_reference=false, $a_type=null)
 checks if an object exists in object_data@access public More...
 
static _getObjectsByType ($a_obj_type="", $a_owner="")
 Get objects by type. More...
 
static _prepareCloneSelection ($a_ref_ids, $new_type, $a_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 Public Member Functions inherited from ilObject
static _lookupObjIdByImportId ($a_import_id)
 
static _lookupImportId ($a_obj_id)
 
static _lookupOwnerName ($a_owner_id)
 lookup owner name for owner id More...
 
static _getIdForImportId ($a_import_id)
 get current object id for import id (static) More...
 
static _getAllReferences ($a_id)
 get all reference ids of object More...
 
static _lookupTitle ($a_id)
 lookup object title More...
 
static _lookupOwner ($a_id)
 lookup object owner More...
 
static _getIdsForTitle ($title, $type='', $partialmatch=false)
 
static _lookupDescription ($a_id)
 lookup object description More...
 
static _lookupLastUpdate ($a_id, $a_as_string=false)
 lookup last update More...
 
static _getLastUpdateOfObjects ($a_objs)
 Get last update for a set of media objects. More...
 
static _lookupObjId ($a_id)
 
static _setDeletedDate ($a_ref_id)
 only called in ilTree::saveSubTree More...
 
static setDeletedDates ($a_ref_ids)
 Set deleted date @global type $ilDB. More...
 
static _resetDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
static _lookupDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
static _writeTitle ($a_obj_id, $a_title)
 write title to db (static) More...
 
static _writeDescription ($a_obj_id, $a_desc)
 write description to db (static) More...
 
static _writeImportId ($a_obj_id, $a_import_id)
 write import id to db (static) More...
 
static _lookupType ($a_id, $a_reference=false)
 lookup object type More...
 
static _isInTrash ($a_ref_id)
 checks wether object is in trash More...
 
static _hasUntrashedReference ($a_obj_id)
 checks wether an object has at least one reference that is not in trash More...
 
static _lookupObjectId ($a_ref_id)
 lookup object id More...
 
static _getObjectsDataForType ($a_type, $a_omit_trash=false)
 get all objects of a certain type More...
 
static _exists ($a_id, $a_reference=false, $a_type=null)
 checks if an object exists in object_data@access public 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 fixMissingTitles ($a_type, array &$a_obj_title_map)
 Try to fix missing object titles. More...
 
static _lookupCreationDate ($a_id)
 Lookup creation date. More...
 
static hasAutoRating ($a_type, $a_ref_id)
 Check if auto rating is active for parent group/course. More...
 

Data Fields

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

Protected Member Functions

 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

 $local_information
 
 $remote_link
 
 $organization
 
 $mid
 
 $auth_hash = ''
 
 $realm_plain = ''
 
- Protected Attributes inherited from ilObject
 $objDefinition
 
 $db
 
 $log
 
 $error
 
 $tree
 
 $app_event_handler
 
 $rbacadmin
 
 $rbacreview
 

Detailed Description

Remote object app base class.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilRemoteObjectBase::__construct (   $a_id = 0,
  $a_call_by_reference = true 
)

Constructor.

Parameters
int$a_id
bool$a_call_by_reference
Returns
ilObject

Reimplemented from ilObject2.

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

36 {
37 global $ilDB;
38
39 parent::__construct($a_id, $a_call_by_reference);
40 $this->db = $ilDB;
41 }
global $ilDB

References $ilDB.

Member Function Documentation

◆ _lookupMID()

static ilRemoteObjectBase::_lookupMID (   $a_obj_id)
static

lookup owner mid

Parameters
int$a_obj_idobj_id
Returns
int

Definition at line 200 of file class.ilRemoteObjectBase.php.

201 {
202 global $ilDB;
203
204 $query = "SELECT mid FROM " . static::DB_TABLE_NAME .
205 " WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
206 $res = $ilDB->query($query);
207 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
208 return $row->mid;
209 }
210 return 0;
211 }
$query
foreach($_POST as $key=> $value) $res

References $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilECSSettingsGUI\exportImported(), and ilECSImportedContentTableGUI\parse().

+ Here is the caller graph for this function:

◆ _lookupOrganization()

static ilRemoteObjectBase::_lookupOrganization (   $a_obj_id)
static

lookup organization

Parameters
int$a_obj_id
Returns
string

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

113 {
114 global $ilDB;
115
116 $query = "SELECT organization FROM " . static::DB_TABLE_NAME .
117 " WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
118 $res = $ilDB->query($query);
119 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
120 return $row->organization;
121 }
122 return '';
123 }

References $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilObjRemoteCategoryListGUI\getProperties(), ilObjRemoteCourseListGUI\getProperties(), ilObjRemoteFileListGUI\getProperties(), ilObjRemoteGlossaryListGUI\getProperties(), ilObjRemoteGroupListGUI\getProperties(), ilObjRemoteLearningModuleListGUI\getProperties(), ilObjRemoteTestListGUI\getProperties(), and ilObjRemoteWikiListGUI\getProperties().

+ Here is the caller graph for this function:

◆ beforeCreate()

ilRemoteObjectBase::beforeCreate ( )

Reimplemented from ilObject2.

Definition at line 86 of file class.ilRemoteObjectBase.php.

87 {
88 $this->setOwner(self::OBJECT_OWNER);
89 return parent::beforeCreate();
90 }
setOwner($a_owner)
set object owner

References ilObject2\setOwner().

+ Here is the call graph for this function:

◆ createAuthResource()

ilRemoteObjectBase::createAuthResource (   $a_plain_realm)

create authentication resource on ecs server

Returns
bool
Exceptions
ilECSConnectorException

Definition at line 279 of file class.ilRemoteObjectBase.php.

280 {
281 global $ilLog;
282
283 include_once './Services/WebServices/ECS/classes/class.ilECSAuth.php';
284 include_once './Services/WebServices/ECS/classes/class.ilECSConnector.php';
285 include_once './Services/WebServices/ECS/classes/class.ilECSImport.php';
286 include_once './Services/WebServices/ECS/classes/class.ilECSSetting.php';
287
288 try {
289 $server_id = ilECSImport::lookupServerId($this->getId());
290 $import_info = new ilECSImport($server_id, $this->getId());
291
292 $connector = new ilECSConnector(ilECSSetting::getInstanceByServerId($server_id));
293 $auth = new ilECSAuth();
294 $auth->setPid($import_info->getMID());
295 // URL is deprecated
296 $auth->setUrl($this->getRemoteLink());
297 $realm = sha1($a_plain_realm);
298 $GLOBALS['ilLog']->write(__METHOD__ . ': Using realm ' . $a_plain_realm);
299 $auth->setRealm($realm);
300 $GLOBALS['ilLog']->write(__METHOD__ . ' Mid is ' . $this->getMID());
301 $this->auth_hash = $connector->addAuth(@json_encode($auth), $this->getMID());
302 return $this->auth_hash;
303 } catch (ilECSConnectorException $exc) {
304 $ilLog->write(__METHOD__ . ': Caught error from ECS Auth resource: ' . $exc->getMessage());
305 return false;
306 }
307 }
$auth
Definition: metadata.php:48
Storage of ECS imported objects.
static lookupServerId($a_obj_id)
Lookup server id of imported content @global <type> $ilDB.
static getInstanceByServerId($a_server_id)
Get singleton instance per server.
getId()
get object id @access public
$GLOBALS['loaded']
Global hash that tracks already loaded includes.

References $auth, $auth_hash, $GLOBALS, $ilLog, ilObject2\getId(), ilECSSetting\getInstanceByServerId(), getMID(), getRemoteLink(), and ilECSImport\lookupServerId().

Referenced by getFullRemoteLink().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ createFromECSEContent()

ilRemoteObjectBase::createFromECSEContent ( ilECSSetting  $a_server,
  $a_ecs_content,
  $a_owner 
)

create remote object from ECSContent object

Parameters
ilECSSetting$a_server
object$a_ecs_contentobject with object settings
int$a_owner

Definition at line 415 of file class.ilRemoteObjectBase.php.

416 {
417 $this->create();
418
419 // won't work for personal workspace
420 $this->createReference();
421 $this->setPermissions($a_server->getImportId());
422
423 include_once './Services/WebServices/ECS/classes/class.ilECSUtils.php';
424 $matchable_content = ilECSUtils::getMatchableContent(
425 $this->getECSObjectType(),
426 $a_server->getServerId(),
427 $a_ecs_content,
428 $a_owner
429 );
430
431 include_once './Services/WebServices/ECS/classes/class.ilECSCategoryMapping.php';
433 $a_server->getServerId(),
434 $matchable_content
435 ));
436
437 $this->updateFromECSContent($a_server, $a_ecs_content, $a_owner);
438 }
static getMatchingCategory($a_server_id, $a_matchable_content)
get matching category
getServerId()
Get current server id.
getImportId()
get import id
static getMatchableContent($a_resource_id, $a_server_id, $a_ecs_content, $a_owner)
Convert ECS content to rule matchable values.
putInTree($a_parent_ref)
maybe this method should be in tree object!?
setPermissions($a_parent_ref)
set permissions of object
createReference()
creates reference for object
create()
create
getECSObjectType()
Get ECS resource identifier, e.g.
updateFromECSContent(ilECSSetting $a_server, $a_ecs_content, $a_owner)
update remote object settings from ecs content

References ilObject\create(), ilObject2\createReference(), getECSObjectType(), ilECSSetting\getImportId(), ilECSUtils\getMatchableContent(), ilECSCategoryMapping\getMatchingCategory(), ilECSSetting\getServerId(), ilObject2\putInTree(), ilObject2\setPermissions(), and updateFromECSContent().

Referenced by handleUpdate().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ doCreate()

ilRemoteObjectBase::doCreate ( )

Create remote object.

Reimplemented from ilObject2.

Definition at line 312 of file class.ilRemoteObjectBase.php.

313 {
314 global $ilDB;
315
316 $fields = array(
317 "obj_id" => array("integer", $this->getId()),
318 "local_information" => array("text", ""),
319 "remote_link" => array("text", ""),
320 "mid" => array("integer", 0),
321 "organization" => array("text", "")
322 );
323
324 $this->doCreateCustomFields($fields);
325
326 $ilDB->insert($this->getTableName(), $fields);
327 }
getTableName()
Get db table name.
doCreateCustomFields(array &$a_fields)
Add custom fields to db insert.

References $ilDB, doCreateCustomFields(), ilObject2\getId(), and getTableName().

+ Here is the call graph for this function:

◆ doCreateCustomFields()

ilRemoteObjectBase::doCreateCustomFields ( array &  $a_fields)
protected

Add custom fields to db insert.

Parameters
array$a_fields

Reimplemented in ilObjRemoteCourse, ilObjRemoteFile, ilObjRemoteGlossary, ilObjRemoteGroup, ilObjRemoteLearningModule, ilObjRemoteTest, and ilObjRemoteWiki.

Definition at line 333 of file class.ilRemoteObjectBase.php.

334 {
335 }

Referenced by doCreate().

+ Here is the caller graph for this function:

◆ doDelete()

ilRemoteObjectBase::doDelete ( )

Delete remote object.

Reimplemented from ilObject2.

Definition at line 369 of file class.ilRemoteObjectBase.php.

370 {
371 global $ilDB;
372
373 //put here your module specific stuff
374 include_once('./Services/WebServices/ECS/classes/class.ilECSImport.php');
376
377 $query = "DELETE FROM " . $this->getTableName() .
378 " WHERE obj_id = " . $this->db->quote($this->getId(), 'integer') . " ";
379 $ilDB->manipulate($query);
380 }
static _deleteByObjId($a_obj_id)
Delete by obj_id.

References $ilDB, $query, ilECSImport\_deleteByObjId(), ilObject2\getId(), and getTableName().

+ Here is the call graph for this function:

◆ doRead()

ilRemoteObjectBase::doRead ( )

read settings

Reimplemented from ilObject2.

Definition at line 385 of file class.ilRemoteObjectBase.php.

386 {
387 $query = "SELECT * FROM " . $this->getTableName() .
388 " WHERE obj_id = " . $this->db->quote($this->getId(), 'integer') . " ";
389 $res = $this->db->query($query);
390 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
391 $this->setLocalInformation($row->local_information);
392 $this->setRemoteLink($row->remote_link);
393 $this->setMID($row->mid);
394 $this->setOrganization($row->organization);
395
396 $this->doReadCustomFields($row);
397 }
398 }
setRemoteLink($a_link)
set remote link
doReadCustomFields($a_row)
Read custom fields from db row.
setOrganization($a_organization)
set organization
setLocalInformation($a_info)
set local information

References $query, $res, $row, doReadCustomFields(), ilDBConstants\FETCHMODE_OBJECT, ilObject2\getId(), getTableName(), setLocalInformation(), setMID(), setOrganization(), and setRemoteLink().

+ Here is the call graph for this function:

◆ doReadCustomFields()

ilRemoteObjectBase::doReadCustomFields (   $a_row)
protected

Read custom fields from db row.

Parameters
object$a_row

Reimplemented in ilObjRemoteCourse, ilObjRemoteFile, ilObjRemoteGlossary, ilObjRemoteGroup, ilObjRemoteLearningModule, ilObjRemoteTest, and ilObjRemoteWiki.

Definition at line 404 of file class.ilRemoteObjectBase.php.

405 {
406 }

Referenced by doRead().

+ Here is the caller graph for this function:

◆ doUpdate()

ilRemoteObjectBase::doUpdate ( )

Update remote object.

Reimplemented from ilObject2.

Definition at line 340 of file class.ilRemoteObjectBase.php.

341 {
342 global $ilDB;
343
344 $fields = array(
345 "local_information" => array("text", $this->getLocalInformation()),
346 "remote_link" => array("text", $this->getRemoteLink()),
347 "mid" => array("integer", $this->getMID()),
348 "organization" => array("text", $this->getOrganization())
349 );
350
351 $this->doUpdateCustomFields($fields);
352
353 $where = array("obj_id" => array("integer", $this->getId()));
354
355 $ilDB->update($this->getTableName(), $fields, $where);
356 }
doUpdateCustomFields(array &$a_fields)
Add custom fields to db update.
getOrganization()
get organization
getLocalInformation()
get local information

References $ilDB, doUpdateCustomFields(), ilObject2\getId(), getLocalInformation(), getMID(), getOrganization(), getRemoteLink(), and getTableName().

+ Here is the call graph for this function:

◆ doUpdateCustomFields()

ilRemoteObjectBase::doUpdateCustomFields ( array &  $a_fields)
protected

Add custom fields to db update.

Parameters
array$a_fields

Reimplemented in ilObjRemoteCourse, ilObjRemoteFile, ilObjRemoteGlossary, ilObjRemoteGroup, ilObjRemoteLearningModule, ilObjRemoteTest, and ilObjRemoteWiki.

Definition at line 362 of file class.ilRemoteObjectBase.php.

363 {
364 }

Referenced by doUpdate().

+ Here is the caller graph for this function:

◆ getAllResourceIds()

ilRemoteObjectBase::getAllResourceIds ( ilECSSetting  $a_server,
  $a_sender_only = false 
)

Get all available resources.

Parameters
ilECSSetting$a_server
bool$a_sender_only
Returns
array

Definition at line 798 of file class.ilRemoteObjectBase.php.

799 {
800 global $ilLog;
801
802 try {
803 include_once './Services/WebServices/ECS/classes/class.ilECSConnector.php';
804 $connector = new ilECSConnector($a_server);
805 $connector->addHeader('X-EcsQueryStrings', $a_sender_only ? 'sender=true' : 'all=true'); // #11301
806 $list = $connector->getResourceList($this->getECSObjectType());
807 if ($list instanceof ilECSResult) {
808 return $list->getResult()->getLinkIds();
809 }
810 } catch (ilECSConnectorException $exc) {
811 $ilLog->write(__METHOD__ . ': Error getting resource list. ' . $exc->getMessage());
812 }
813 }
if(isset($_REQUEST['delete'])) $list
Definition: registry.php:41

References $ilLog, $list, and getECSObjectType().

+ Here is the call graph for this function:

◆ getECSObjectType()

ilRemoteObjectBase::getECSObjectType ( )
abstractprotected

Get ECS resource identifier, e.g.

"/campusconnect/courselinks"

Returns
string

Reimplemented in ilObjRemoteCategory, ilObjRemoteCourse, ilObjRemoteFile, ilObjRemoteGlossary, ilObjRemoteGroup, ilObjRemoteLearningModule, ilObjRemoteTest, and ilObjRemoteWiki.

Referenced by createFromECSEContent(), getAllResourceIds(), handleUpdate(), and updateFromECSContent().

+ Here is the caller graph for this function:

◆ getFullRemoteLink()

ilRemoteObjectBase::getFullRemoteLink ( )

get full remote link Including ecs generated hash and auth mode

Returns
string
Exceptions
ilECSConnectorException

Definition at line 240 of file class.ilRemoteObjectBase.php.

241 {
242 global $ilUser;
243
244
245 include_once './Services/WebServices/ECS/classes/class.ilECSImport.php';
246 $server_id = ilECSImport::lookupServerId($this->getId());
248
249 include_once('./Services/WebServices/ECS/classes/class.ilECSUser.php');
250 $user = new ilECSUser($ilUser);
251 $ecs_user_data = $user->toGET();
252 $GLOBALS['ilLog']->write(__METHOD__ . ': Using ecs user data ' . $ecs_user_data);
253
254 // check token mechanism enabled
255 include_once './Services/WebServices/ECS/classes/class.ilECSParticipantSetting.php';
256 $part = new ilECSParticipantSetting($server_id, $this->getMID());
257 if (!$part->isTokenEnabled()) {
258 return $this->getRemoteLink();
259 }
260
261 $auth_hash = $this->createAuthResource($this->getRemoteLink() . $user->toREALM());
262 $ecs_url_hash = 'ecs_hash_url=' . urlencode($server->getServerURI() . '/sys/auths/' . $auth_hash);
263
264 if (strpos($this->getRemoteLink(), '?')) {
265 $link = $this->getRemoteLink() . '&ecs_hash=' . $auth_hash . $ecs_user_data . '&' . $ecs_url_hash;
266 } else {
267 $link = $this->getRemoteLink() . '?ecs_hash=' . $auth_hash . $ecs_user_data . '&' . $ecs_url_hash;
268 }
269 $GLOBALS['ilLog']->write(__METHOD__ . ': ECS full link: ' . $link);
270 return $link;
271 }
Stores relevant user data.
createAuthResource($a_plain_realm)
create authentication resource on ecs server
$server
Definition: getUserInfo.php:12
$ilUser
Definition: imgupload.php:18

References $auth_hash, $GLOBALS, $ilUser, $server, createAuthResource(), ilObject2\getId(), ilECSSetting\getInstanceByServerId(), getMID(), getRemoteLink(), and ilECSImport\lookupServerId().

+ Here is the call graph for this function:

◆ getInstanceByEventType()

static ilRemoteObjectBase::getInstanceByEventType (   $a_type)
static

Get instance by ilECSEvent(QueueReader) type.

Parameters
int$a_type
Returns
ilRemoteObjectBase

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

50 {
51 switch ($a_type) {
53 include_once 'Modules/RemoteCourse/classes/class.ilObjRemoteCourse.php';
54 return new ilObjRemoteCourse();
55
57 include_once 'Modules/RemoteCategory/classes/class.ilObjRemoteCategory.php';
58 return new ilObjRemoteCategory();
59
61 include_once 'Modules/RemoteFile/classes/class.ilObjRemoteFile.php';
62 return new ilObjRemoteFile();
63
65 include_once 'Modules/RemoteGlossary/classes/class.ilObjRemoteGlossary.php';
66 return new ilObjRemoteGlossary();
67
69 include_once 'Modules/RemoteGroup/classes/class.ilObjRemoteGroup.php';
70 return new ilObjRemoteGroup();
71
73 include_once 'Modules/RemoteLearningModule/classes/class.ilObjRemoteLearningModule.php';
74 return new ilObjRemoteLearningModule();
75
77 include_once 'Modules/RemoteWiki/classes/class.ilObjRemoteWiki.php';
78 return new ilObjRemoteWiki();
79
81 include_once 'Modules/RemoteTest/classes/class.ilObjRemoteTest.php';
82 return new ilObjRemoteTest();
83 }
84 }
Remote category app class.
Remote course app class.
Remote file app class.
Remote glossary app class.
Remote group app class.
Remote learning module app class.
Remote test app class.
Remote wiki app class.
$a_type
Definition: workflow.php:92

References $a_type, ilECSEventQueueReader\TYPE_REMOTE_CATEGORY, ilECSEventQueueReader\TYPE_REMOTE_COURSE, ilECSEventQueueReader\TYPE_REMOTE_FILE, ilECSEventQueueReader\TYPE_REMOTE_GLOSSARY, ilECSEventQueueReader\TYPE_REMOTE_GROUP, ilECSEventQueueReader\TYPE_REMOTE_LEARNING_MODULE, ilECSEventQueueReader\TYPE_REMOTE_TEST, and ilECSEventQueueReader\TYPE_REMOTE_WIKI.

Referenced by ilECSEventQueueReader\getAllResourceIds(), and ilECSTaskScheduler\handleEvents().

+ Here is the caller graph for this function:

◆ getLocalInformation()

ilRemoteObjectBase::getLocalInformation ( )

get local information

Returns
string

Definition at line 159 of file class.ilRemoteObjectBase.php.

References $local_information.

Referenced by doUpdate().

+ Here is the caller graph for this function:

◆ getMID()

ilRemoteObjectBase::getMID ( )

get mid

Returns
int

Definition at line 179 of file class.ilRemoteObjectBase.php.

180 {
181 return $this->mid;
182 }

References $mid.

Referenced by createAuthResource(), doUpdate(), and getFullRemoteLink().

+ Here is the caller graph for this function:

◆ getOrganization()

ilRemoteObjectBase::getOrganization ( )

get organization

Returns
string

Definition at line 149 of file class.ilRemoteObjectBase.php.

References $organization.

Referenced by doUpdate().

+ Here is the caller graph for this function:

◆ getRealmPlain()

ilRemoteObjectBase::getRealmPlain ( )

Get realm plain.

Returns
type

Definition at line 129 of file class.ilRemoteObjectBase.php.

References $realm_plain.

◆ getRemoteLink()

ilRemoteObjectBase::getRemoteLink ( )

get remote link

Returns
string

Definition at line 228 of file class.ilRemoteObjectBase.php.

References $remote_link.

Referenced by createAuthResource(), doUpdate(), and getFullRemoteLink().

+ Here is the caller graph for this function:

◆ getTableName()

ilRemoteObjectBase::getTableName ( )
abstractprotected

Get db table name.

Returns
string

Reimplemented in ilObjRemoteCategory, ilObjRemoteCourse, ilObjRemoteFile, ilObjRemoteGlossary, ilObjRemoteGroup, ilObjRemoteLearningModule, ilObjRemoteTest, and ilObjRemoteWiki.

Referenced by doCreate(), doDelete(), doRead(), and doUpdate().

+ Here is the caller graph for this function:

◆ handleCreate()

ilRemoteObjectBase::handleCreate ( ilECSSetting  $a_server,
  $a_econtent_id,
array  $a_mids 
)

Handle creation.

called by ilTaskScheduler

Parameters
ilECSSetting$a_server
type$a_econtent_id
array$a_mids

Definition at line 613 of file class.ilRemoteObjectBase.php.

614 {
615 return $this->handleUpdate($a_server, $a_econtent_id, $a_mids);
616 }
handleUpdate(ilECSSetting $a_server, $a_econtent_id, array $a_mids)
Handle update event.

References handleUpdate().

+ Here is the call graph for this function:

◆ handleDelete()

ilRemoteObjectBase::handleDelete ( ilECSSetting  $a_server,
  $a_econtent_id,
  $a_mid = 0 
)

Handle delete event.

called by ilTaskScheduler

Parameters
ilECSSetting$a_server
int$a_econtent_id
int$a_mid
Returns
boolean

Definition at line 765 of file class.ilRemoteObjectBase.php.

766 {
767 global $tree, $ilLog;
768
769
770 include_once('./Services/WebServices/ECS/classes/class.ilECSImport.php');
771
772 // there is no information about the original mid anymore.
773 // Therefor delete any remote objects with given econtent id
774 $obj_ids = ilECSImport::_lookupObjIds($a_server->getServerId(), $a_econtent_id);
775 $ilLog->write(__METHOD__ . ': Received obj_ids ' . print_r($obj_ids, true));
776
777 foreach ($obj_ids as $obj_id) {
778 $references = ilObject::_getAllReferences($obj_id);
779 foreach ($references as $ref_id) {
780 if ($tmp_obj = ilObjectFactory::getInstanceByRefId($ref_id, false)) {
781 $ilLog->write(__METHOD__ . ': Deleting obsolete remote course: ' . $tmp_obj->getTitle());
782 $tmp_obj->delete();
783 $tree->deleteTree($tree->getNodeData($ref_id));
784 }
785 unset($tmp_obj);
786 }
787 }
788 return true;
789 }
static _lookupObjIds($a_server_id, $a_econtent_id)
Lookup obj_id.
static getInstanceByRefId($a_ref_id, $stop_on_error=true)
get an instance of an Ilias object by reference id
static _getAllReferences($a_id)
get all reference ids of object

References $ilLog, ilObject\$ref_id, ilObject\$tree, ilObject\_getAllReferences(), ilECSImport\_lookupObjIds(), ilObjectFactory\getInstanceByRefId(), and ilECSSetting\getServerId().

Referenced by handleUpdate().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ handleUpdate()

ilRemoteObjectBase::handleUpdate ( ilECSSetting  $a_server,
  $a_econtent_id,
array  $a_mids 
)

Handle update event.

called by ilTaskScheduler

Parameters
ilECSSetting$a_server
int$a_econtent_id
array$a_mids
Returns
boolean

Definition at line 628 of file class.ilRemoteObjectBase.php.

629 {
630 global $ilLog;
631
632 // get content details
633 include_once('./Services/WebServices/ECS/classes/class.ilECSEContentDetails.php');
635 $a_server->getServerId(),
636 $a_econtent_id,
637 $this->getECSObjectType()
638 );
639 if (!$details instanceof ilECSEContentDetails) {
640 $this->handleDelete($a_server, $a_econtent_id);
641 $ilLog->write(__METHOD__ . ': Handling delete of deprecated remote object. DONE');
642 return;
643 }
644
645 $ilLog->write(__METHOD__ . ': Receivers are ' . print_r($details->getReceivers(), true));
646 $ilLog->write(__METHOD__ . ': Senders are ' . print_r($details->getSenders(), true));
647
648 // check owner (sender mid)
649 include_once('./Services/WebServices/ECS/classes/class.ilECSParticipantSettings.php');
650 if (!ilECSParticipantSettings::getInstanceByServerId($a_server->getServerId())->isImportAllowed($details->getSenders())) {
651 $ilLog->write('Ignoring disabled participant. MID: ' . $details->getOwner());
652 return true;
653 }
654
655 // new mids
656 include_once 'Services/WebServices/ECS/classes/class.ilECSImport.php';
657 include_once 'Services/WebServices/ECS/classes/class.ilECSConnector.php';
658 foreach (array_intersect($a_mids, $details->getReceivers()) as $mid) {
659 try {
660 $connector = new ilECSConnector($a_server);
661 $res = $connector->getResource($this->getECSObjectType(), $a_econtent_id);
662 if ($res->getHTTPCode() == ilECSConnector::HTTP_CODE_NOT_FOUND) {
663 continue;
664 }
665 $json = $res->getResult();
666 $GLOBALS['ilLog']->write(__METHOD__ . ': Received json: ' . print_r($json, true));
667 if (!is_object($json)) {
668 // try as array (workaround for invalid content)
669 $json = $json[0];
670 if (!is_object($json)) {
671 throw new ilECSConnectorException('invalid json');
672 }
673 }
674 } catch (ilECSConnectorException $exc) {
675 $ilLog->write(__METHOD__ . ': Error parsing result. ' . $exc->getMessage());
676 $ilLog->logStack();
677 return false;
678 }
679
680 // Update existing
681
682 // Check receiver mid
683 if ($obj_id = ilECSImport::_isImported($a_server->getServerId(), $a_econtent_id, $mid)) {
684 $ilLog->write(__METHOD__ . ': Handling update for existing object');
685 $remote = ilObjectFactory::getInstanceByObjId($obj_id, false);
686 if (!$remote instanceof ilRemoteObjectBase) {
687 $ilLog->write(__METHOD__ . ': Cannot instantiate remote object. Got object type ' . $remote->getType());
688 continue;
689 }
690 $remote->updateFromECSContent($a_server, $json, $details->getMySender());
691 } else {
692 $GLOBALS['ilLog']->write(__METHOD__ . ': my sender ' . $details->getMySender() . 'vs mid' . $mid);
693
694 $ilLog->write(__METHOD__ . ': Handling create for non existing object');
695 $this->createFromECSEContent($a_server, $json, $details->getMySender());
696
697 // update import status
698 $ilLog->write(__METHOD__ . ': Updating import status');
699 include_once('./Services/WebServices/ECS/classes/class.ilECSImport.php');
700 $import = new ilECSImport($a_server->getServerId(), $this->getId());
701 $import->setEContentId($a_econtent_id);
702 // Store receiver mid
703 $import->setMID($mid);
704 $import->save();
705
706 $ilLog->write(__METHOD__ . ': Sending notification');
707 $this->sendNewContentNotification($a_server->getServerId());
708 }
709 }
710
711 $ilLog->write(__METHOD__ . ': done');
712 return true;
713 }
Presentation of ecs content details (http://...campusconnect/courselinks/id/details)
static getInstance($a_server_id, $a_econtent_id, $a_resource_type)
Get data from server.
static _isImported($a_server_id, $a_econtent_id, $a_mid, $a_sub_id=null)
check if econtent is imported for a specific mid
static getInstanceByServerId($a_server_id)
Get instance by server id.
static getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id
Remote object app base class.
createFromECSEContent(ilECSSetting $a_server, $a_ecs_content, $a_owner)
create remote object from ECSContent object
handleDelete(ilECSSetting $a_server, $a_econtent_id, $a_mid=0)
Handle delete event.
sendNewContentNotification($a_server_id)
send notifications about new EContent

References $GLOBALS, $ilLog, $mid, $res, ilECSImport\_isImported(), createFromECSEContent(), getECSObjectType(), ilECSEContentDetails\getInstance(), ilObjectFactory\getInstanceByObjId(), ilECSParticipantSettings\getInstanceByServerId(), ilECSSetting\getServerId(), handleDelete(), ilECSConnector\HTTP_CODE_NOT_FOUND, and sendNewContentNotification().

Referenced by handleCreate().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ importMetadataFromJson()

ilRemoteObjectBase::importMetadataFromJson (   $a_json,
ilECSSetting  $a_server,
array  $a_definition,
  $a_mapping_mode 
)
protected

Add advanced metadata to json (export)

Parameters
object$a_json
ilECSSetting$a_server
array$a_definition
int$a_mapping_mode

Definition at line 500 of file class.ilRemoteObjectBase.php.

501 {
502 global $ilLog;
503
504 $ilLog->write("importing metadata from json: " . print_r($a_json, true));
505
506 include_once('./Services/WebServices/ECS/classes/class.ilECSDataMappingSettings.php');
507 include_once('./Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
508 include_once('./Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php');
509
511 $values_records = ilAdvancedMDValues::getInstancesForObjectId($this->getId(), $this->getType());
512 foreach ($values_records as $values_record) {
513 // this correctly binds group and definitions
514 $values_record->read();
515 }
516
517 $do_save = false;
518
519 foreach ($a_definition as $id => $type) {
520 if (is_array($type)) {
521 $target = $type[1];
522 $type = $type[0];
523 } else {
524 $target = $id;
525 }
526
527 $timePlace = null;
528 if ($field = $mappings->getMappingByECSName($a_mapping_mode, $id)) {
529 // find element in records
530 $adv_md_def = null;
531 foreach ($values_records as $values_record) {
532 $adv_md_defs = $values_record->getDefinitions();
533 if (isset($adv_md_defs[$field])) {
534 $adv_md_def = $adv_md_defs[$field];
535 break;
536 }
537 }
538 if (!$adv_md_def) {
539 continue;
540 }
541
542 $raw_value = $a_json->$target;
543
545 if (!is_object($timePlace)) {
546 include_once('./Services/WebServices/ECS/classes/class.ilECSTimePlace.php');
547 if (is_object($raw_value)) {
548 $timePlace = new ilECSTimePlace();
549 $timePlace->loadFromJSON($raw_value);
550 } else {
551 $timePlace = new ilECSTimePlace();
552 }
553 }
554 $raw_value = $timePlace;
555 }
556
557 if ($adv_md_def->importFromECS($type, $raw_value, $id)) {
558 $do_save = true;
559 }
560 }
561 }
562
563 if ($do_save) {
564 foreach ($values_records as $values_record) {
565 $additional = array();
566 foreach ($values_record->getADTGroup()->getElements() as $element_id => $element) {
567 if (!$element->isNull()) {
568 $additional[$element_id] = array("disabled"=>array("integer", 1));
569 }
570 }
571 $values_record->write($additional);
572 }
573 }
574 }
static getInstancesForObjectId($a_obj_id, $a_obj_type=null, $a_sub_type="-", $a_sub_id=0)
Get instances for given object id.
static getInstanceByServerId($a_server_id)
Get singleton instance.
Representation of ECS EContent Time Place.
const TYPE_TIMEPLACE
getType()
get object type @access public
$additional
Definition: goto.php:50

References $additional, ilObject\$id, $ilLog, $target, ilObject\$type, ilObject2\getId(), ilECSDataMappingSettings\getInstanceByServerId(), ilAdvancedMDValues\getInstancesForObjectId(), ilECSSetting\getServerId(), ilObject2\getType(), and ilECSUtils\TYPE_TIMEPLACE.

Referenced by ilObjRemoteCourse\updateCustomFromECSContent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isLocalObject()

ilRemoteObjectBase::isLocalObject ( )

Is remote object from same installation?

Returns
boolean

Definition at line 591 of file class.ilRemoteObjectBase.php.

592 {
593 include_once('./Services/WebServices/ECS/classes/class.ilECSExport.php');
594 include_once('./Services/WebServices/ECS/classes/class.ilECSImport.php');
598 )) {
599 return false;
600 }
601 return true;
602 }
static _isRemote($a_server_id, $a_econtent_id)
is remote object
static _lookupEContentId($a_obj_id)
get econent_id

References ilECSExport\_isRemote(), ilECSImport\_lookupEContentId(), ilObject2\getId(), and ilECSImport\lookupServerId().

+ Here is the call graph for this function:

◆ sendNewContentNotification()

ilRemoteObjectBase::sendNewContentNotification (   $a_server_id)
protected

send notifications about new EContent

Definition at line 718 of file class.ilRemoteObjectBase.php.

719 {
720 include_once('Services/WebServices/ECS/classes/class.ilECSSetting.php');
721 $settings = ilECSSetting::getInstanceByServerId($a_server_id);
722 if (!count($rcps = $settings->getEContentRecipients())) {
723 return;
724 }
725
726 include_once('./Services/Mail/classes/class.ilMail.php');
727 include_once('./Services/Language/classes/class.ilLanguageFactory.php');
728
730 $lang->loadLanguageModule('ecs');
731
732 $mail = new ilMail(self::MAIL_SENDER);
733 $message = $lang->txt('ecs_' . $this->getType() . '_created_body_a') . "\n\n";
734 $message .= $lang->txt('title') . ': ' . $this->getTitle() . "\n";
735 if (strlen($desc = $this->getDescription())) {
736 $message .= $lang->txt('desc') . ': ' . $desc . "\n";
737 }
738
739 include_once('./Services/Link/classes/class.ilLink.php');
740 $href = ilLink::_getStaticLink($this->getRefId(), $this->getType(), true);
741 $message .= $lang->txt("perma_link") . ': ' . $href . "\n\n";
743
744 $mail->sendMail(
745 $settings->getEContentRecipientsAsString(),
746 '',
747 '',
748 $lang->txt('ecs_new_econtent_subject'),
749 $message,
750 array(),
751 array('normal')
752 );
753 }
static _getLanguage($a_lang_key='')
Get langauge object.
This class handles base functions for mail handling.
static _getAutoGeneratedMessageString(ilLanguage $lang=null)
Get auto generated info string.
getRefId()
get reference id @access public
getDescription()
get object description
getTitle()
get object title @access public
$lang
Definition: consent.php:3
catch(Exception $e) $message

References ilObject\$desc, $lang, $message, ilMail\_getAutoGeneratedMessageString(), ilLanguageFactory\_getLanguage(), ilLink\_getStaticLink(), ilObject2\getDescription(), ilECSSetting\getInstanceByServerId(), ilObject2\getRefId(), ilObject2\getTitle(), and ilObject2\getType().

Referenced by handleUpdate().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setLocalInformation()

ilRemoteObjectBase::setLocalInformation (   $a_info)

set local information

Parameters
string$a_info

Definition at line 169 of file class.ilRemoteObjectBase.php.

170 {
171 $this->local_information = $a_info;
172 }

Referenced by doRead().

+ Here is the caller graph for this function:

◆ setMID()

ilRemoteObjectBase::setMID (   $a_mid)

set mid

Parameters
int$a_midmid

Definition at line 189 of file class.ilRemoteObjectBase.php.

190 {
191 $this->mid = $a_mid;
192 }

Referenced by doRead(), and updateFromECSContent().

+ Here is the caller graph for this function:

◆ setOrganization()

ilRemoteObjectBase::setOrganization (   $a_organization)

set organization

Parameters
string$a_organization

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

140 {
141 $this->organization = $a_organization;
142 }

Referenced by doRead(), and updateFromECSContent().

+ Here is the caller graph for this function:

◆ setRemoteLink()

ilRemoteObjectBase::setRemoteLink (   $a_link)

set remote link

Parameters
string$a_linklink to original object

Definition at line 218 of file class.ilRemoteObjectBase.php.

219 {
220 $this->remote_link = $a_link;
221 }

Referenced by doRead(), and updateFromECSContent().

+ Here is the caller graph for this function:

◆ updateCustomFromECSContent()

ilRemoteObjectBase::updateCustomFromECSContent ( ilECSSetting  $a_server,
  $ecs_content 
)
protected

update remote object settings from ecs content

Parameters
ilECSSetting$a_server
object$a_ecs_contentobject with object settings

Reimplemented in ilObjRemoteCourse, ilObjRemoteFile, ilObjRemoteGlossary, ilObjRemoteGroup, ilObjRemoteLearningModule, ilObjRemoteTest, and ilObjRemoteWiki.

Definition at line 582 of file class.ilRemoteObjectBase.php.

583 {
584 }

Referenced by updateFromECSContent().

+ Here is the caller graph for this function:

◆ updateFromECSContent()

ilRemoteObjectBase::updateFromECSContent ( ilECSSetting  $a_server,
  $a_ecs_content,
  $a_owner 
)

update remote object settings from ecs content

Parameters
ilECSSetting$a_server
object$a_ecs_contentobject with object settings
int$a_owner

Definition at line 447 of file class.ilRemoteObjectBase.php.

448 {
449 global $ilLog;
450
451 $ilLog->write('updateFromECSContent: ' . print_r($a_ecs_content, true));
452
453 // Get organisation for owner (ObjectListGUI performance)
454 $organisation = null;
455 if ($a_owner) {
456 include_once './Services/WebServices/ECS/classes/class.ilECSUtils.php';
457 $organisation = ilECSUtils::lookupParticipantName($a_owner, $a_server->getServerId());
458 $ilLog->write('found organisation: ' . $organisation);
459 }
460
461 $this->setMID($a_owner); // obsolete?
462 $this->setOrganization($organisation);
463 $this->setTitle($a_ecs_content->title);
464 $this->setDescription($a_ecs_content->abstract);
465 $this->setRemoteLink($a_ecs_content->url);
466
467 $ilLog->write('updateCustomFromECSContent');
468 $this->updateCustomFromECSContent($a_server, $a_ecs_content);
469
470 // we are updating late so custom values can be set
471
472 $ilLog->write('ilObject->update()');
473 $this->update();
474
475 include_once './Services/WebServices/ECS/classes/class.ilECSUtils.php';
476 $matchable_content = ilECSUtils::getMatchableContent(
477 $this->getECSObjectType(),
478 $a_server->getServerId(),
479 $a_ecs_content,
480 $a_owner
481 );
482
483 // rule-based category mapping
484 include_once './Services/WebServices/ECS/classes/class.ilECSCategoryMapping.php';
486 $this->getId(),
487 $a_server->getServerId(),
488 $matchable_content
489 );
490 }
static handleUpdate($a_obj_id, $a_server_id, $a_matchable_content)
Handle update of ecs content and create references.
static lookupParticipantName($a_owner, $a_server_id)
Lookup participant name.
setTitle($a_title)
set object title
update()
update object in db
setDescription($a_desc)
set object description
updateCustomFromECSContent(ilECSSetting $a_server, $ecs_content)
update remote object settings from ecs content

References $ilLog, getECSObjectType(), ilObject2\getId(), ilECSUtils\getMatchableContent(), ilECSSetting\getServerId(), ilECSCategoryMapping\handleUpdate(), ilECSUtils\lookupParticipantName(), ilObject2\setDescription(), setMID(), setOrganization(), setRemoteLink(), ilObject2\setTitle(), ilObject2\update(), and updateCustomFromECSContent().

Referenced by createFromECSEContent().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $auth_hash

ilRemoteObjectBase::$auth_hash = ''
protected

Definition at line 21 of file class.ilRemoteObjectBase.php.

Referenced by createAuthResource(), and getFullRemoteLink().

◆ $local_information

ilRemoteObjectBase::$local_information
protected

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

Referenced by getLocalInformation().

◆ $mid

ilRemoteObjectBase::$mid
protected

Definition at line 20 of file class.ilRemoteObjectBase.php.

Referenced by getMID(), and handleUpdate().

◆ $organization

ilRemoteObjectBase::$organization
protected

Definition at line 19 of file class.ilRemoteObjectBase.php.

Referenced by getOrganization().

◆ $realm_plain

ilRemoteObjectBase::$realm_plain = ''
protected

Definition at line 23 of file class.ilRemoteObjectBase.php.

Referenced by getRealmPlain().

◆ $remote_link

ilRemoteObjectBase::$remote_link
protected

Definition at line 18 of file class.ilRemoteObjectBase.php.

Referenced by getRemoteLink().

◆ MAIL_SENDER

const ilRemoteObjectBase::MAIL_SENDER = 6

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

◆ OBJECT_OWNER

const ilRemoteObjectBase::OBJECT_OWNER = 6

Definition at line 26 of file class.ilRemoteObjectBase.php.


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