ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
ilRemoteObjectBase Class Reference
Services/WebServices/ECS

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 public. More...
 
 withReferences ()
 
 read ()
 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 ()
 
 setOwner ($a_owner)
 
 getCreateDate ()
 
 getLastUpdateDate ()
 
 create ($a_clone_mode=false)
 
 update ()
 
 MDUpdateListener ($a_element)
 
 createMetaData ()
 
 updateMetaData ()
 
 deleteMetaData ()
 
 updateOwner ()
 
 putInTree ($a_parent_ref)
 
 setPermissions ($a_parent_ref)
 
 createReference ()
 
 countReferences ()
 
 delete ()
 
 initDefaultRoles ()
 
 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
 __construct ($a_id=0, $a_reference=true)
 Constructor 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 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 ()
 
 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...
 
 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...
 
 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...
 
 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...
 
 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)
 
static _getIdForImportId ($a_import_id)
 
static _getAllReferences ($a_id)
 
static _lookupTitle ($a_id)
 
static _lookupOwner ($a_id)
 
static _getIdsForTitle ($title, $type='', $partialmatch=false)
 
static _lookupDescription ($a_id)
 
static _lookupLastUpdate ($a_id, $a_as_string=false)
 
static _getLastUpdateOfObjects ($a_objs)
 
static _lookupObjId ($a_id)
 
static _setDeletedDate ($a_ref_id)
 
static _resetDeletedDate ($a_ref_id)
 
static _lookupDeletedDate ($a_ref_id)
 
static _writeTitle ($a_obj_id, $a_title)
 
static _writeDescription ($a_obj_id, $a_desc)
 
static _writeImportId ($a_obj_id, $a_import_id)
 
static _lookupType ($a_id, $a_reference=false)
 
static _isInTrash ($a_ref_id)
 
static _hasUntrashedReference ($a_obj_id)
 
static _lookupObjectId ($a_ref_id)
 
static _getObjectsDataForType ($a_type, $a_omit_trash=false)
 
static _exists ($a_id, $a_reference=false, $a_type=null)
 
static _getObjectsByType ($a_obj_type="", $a_owner="")
 
static _prepareCloneSelection ($a_ref_ids, $new_type, $a_show_path=true)
 
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 _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 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 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
 
 $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
 

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 = ''
 

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

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

References $ilDB.

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

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 202 of file class.ilRemoteObjectBase.php.

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

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

203  {
204  global $ilDB;
205 
206  $query = "SELECT mid FROM ".static::DB_TABLE_NAME.
207  " WHERE obj_id = ".$ilDB->quote($a_obj_id ,'integer')." ";
208  $res = $ilDB->query($query);
209  while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
210  {
211  return $row->mid;
212  }
213  return 0;
214  }
$ilDB
global $ilDB
Definition: storeScorm2004.php:16
+ 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 113 of file class.ilRemoteObjectBase.php.

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

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

114  {
115  global $ilDB;
116 
117  $query = "SELECT organization FROM ".static::DB_TABLE_NAME.
118  " WHERE obj_id = ".$ilDB->quote($a_obj_id ,'integer')." ";
119  $res = $ilDB->query($query);
120  while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
121  {
122  return $row->organization;
123  }
124  return '';
125  }
$ilDB
global $ilDB
Definition: storeScorm2004.php:16
+ Here is the caller graph for this function:

◆ beforeCreate()

ilRemoteObjectBase::beforeCreate ( )

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

References getECSObjectType(), getTableName(), and ilObject2\setOwner().

88  {
89  $this->setOwner(self::OBJECT_OWNER);
90  return parent::beforeCreate();
91  }
ilObject2\setOwner
setOwner($a_owner)
Definition: class.ilObject2.php:64
+ 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 287 of file class.ilRemoteObjectBase.php.

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

Referenced by getFullRemoteLink().

288  {
289  global $ilLog;
290 
291  include_once './Services/WebServices/ECS/classes/class.ilECSAuth.php';
292  include_once './Services/WebServices/ECS/classes/class.ilECSConnector.php';
293  include_once './Services/WebServices/ECS/classes/class.ilECSImport.php';
294  include_once './Services/WebServices/ECS/classes/class.ilECSSetting.php';
295 
296  try
297  {
298  $server_id = ilECSImport::lookupServerId($this->getId());
299  $import_info = new ilECSImport($server_id, $this->getId());
300 
301  $connector = new ilECSConnector(ilECSSetting::getInstanceByServerId($server_id));
302  $auth = new ilECSAuth();
303  $auth->setPid($import_info->getMID());
304  // URL is deprecated
305  $auth->setUrl($this->getRemoteLink());
306  $realm = sha1($a_plain_realm);
307  $GLOBALS['ilLog']->write(__METHOD__.': Using realm '.$a_plain_realm);
308  $auth->setRealm($realm);
309  $GLOBALS['ilLog']->write(__METHOD__.' Mid is '.$this->getMID());
310  $this->auth_hash = $connector->addAuth(@json_encode($auth),$this->getMID());
311  return $this->auth_hash;
312  }
313  catch(ilECSConnectorException $exc)
314  {
315  $ilLog->write(__METHOD__.': Caught error from ECS Auth resource: '.$exc->getMessage());
316  return false;
317  }
318  }
ilECSSetting\getInstanceByServerId
static getInstanceByServerId($a_server_id)
Get singleton instance per server.
Definition: class.ilECSSetting.php:109
ilRemoteObjectBase\getRemoteLink
getRemoteLink()
get remote link
Definition: class.ilRemoteObjectBase.php:231
$GLOBALS
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
Definition: generate-standalone.php:18
ilECSImport
Storage of ECS imported objects.
Definition: class.ilECSImport.php:14
ilECSImport\lookupServerId
static lookupServerId($a_obj_id)
Lookup server id of imported content <type> $ilDB.
Definition: class.ilECSImport.php:221
$ilLog
$ilLog
Definition: inc.setup_header.php:130
+ 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 430 of file class.ilRemoteObjectBase.php.

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

Referenced by handleUpdate().

431  {
432  $this->create();
433 
434  // won't work for personal workspace
435  $this->createReference();
436  $this->setPermissions($a_server->getImportId());
437 
438  include_once './Services/WebServices/ECS/classes/class.ilECSUtils.php';
439  $matchable_content = ilECSUtils::getMatchableContent($this->getECSObjectType(),
440  $a_server->getServerId(), $a_ecs_content, $a_owner);
441 
442  include_once './Services/WebServices/ECS/classes/class.ilECSCategoryMapping.php';
443  $this->putInTree(ilECSCategoryMapping::getMatchingCategory($a_server->getServerId(),
444  $matchable_content));
445 
446  $this->updateFromECSContent($a_server, $a_ecs_content, $a_owner);
447  }
ilObject2\putInTree
putInTree($a_parent_ref)
Definition: class.ilObject2.php:208
ilECSSetting\getServerId
getServerId()
Get current server id.
Definition: class.ilECSSetting.php:202
ilECSSetting\getImportId
getImportId()
get import id
Definition: class.ilECSSetting.php:510
ilObject2\setPermissions
setPermissions($a_parent_ref)
Definition: class.ilObject2.php:209
ilRemoteObjectBase\getECSObjectType
getECSObjectType()
Get ECS resource identifier, e.g.
ilECSUtils\getMatchableContent
static getMatchableContent($a_resource_id, $a_server_id, $a_ecs_content, $a_owner)
Convert ECS content to rule matchable values.
Definition: class.ilECSUtils.php:192
ilObject\create
create()
create
Definition: class.ilObject.php:589
ilECSCategoryMapping\getMatchingCategory
static getMatchingCategory($a_server_id, $a_matchable_content)
get matching category
Definition: class.ilECSCategoryMapping.php:64
ilRemoteObjectBase\updateFromECSContent
updateFromECSContent(ilECSSetting $a_server, $a_ecs_content, $a_owner)
update remote object settings from ecs content
Definition: class.ilRemoteObjectBase.php:456
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ doCreate()

ilRemoteObjectBase::doCreate ( )

Create remote object.

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

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

324  {
325  global $ilDB;
326 
327  $fields = array(
328  "obj_id" => array("integer", $this->getId()),
329  "local_information" => array("text", ""),
330  "remote_link" => array("text", ""),
331  "mid" => array("integer", 0),
332  "organization" => array("text", "")
333  );
334 
335  $this->doCreateCustomFields($fields);
336 
337  $ilDB->insert($this->getTableName(), $fields);
338  }
ilRemoteObjectBase\getTableName
getTableName()
Get db table name.
ilRemoteObjectBase\doCreateCustomFields
doCreateCustomFields(array &$a_fields)
Add custom fields to db insert.
Definition: class.ilRemoteObjectBase.php:344
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
$ilDB
global $ilDB
Definition: storeScorm2004.php:16
+ 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

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

Referenced by doCreate().

345  {
346 
347  }
+ Here is the caller graph for this function:

◆ doDelete()

ilRemoteObjectBase::doDelete ( )

Delete remote object.

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

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

383  {
384  global $ilDB;
385 
386  //put here your module specific stuff
387  include_once('./Services/WebServices/ECS/classes/class.ilECSImport.php');
388  ilECSImport::_deleteByObjId($this->getId());
389 
390  $query = "DELETE FROM ".$this->getTableName().
391  " WHERE obj_id = ".$this->db->quote($this->getId() ,'integer')." ";
392  $ilDB->manipulate($query);
393  }
ilECSImport\_deleteByObjId
static _deleteByObjId($a_obj_id)
Delete by obj_id.
Definition: class.ilECSImport.php:340
$ilDB
global $ilDB
Definition: storeScorm2004.php:16
+ Here is the call graph for this function:

◆ doRead()

ilRemoteObjectBase::doRead ( )

read settings

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

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

399  {
400  $query = "SELECT * FROM ".$this->getTableName().
401  " WHERE obj_id = ".$this->db->quote($this->getId() ,'integer')." ";
402  $res = $this->db->query($query);
403  while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
404  {
405  $this->setLocalInformation($row->local_information);
406  $this->setRemoteLink($row->remote_link);
407  $this->setMID($row->mid);
408  $this->setOrganization($row->organization);
409 
410  $this->doReadCustomFields($row);
411  }
412  }
ilRemoteObjectBase\setRemoteLink
setRemoteLink($a_link)
set remote link
Definition: class.ilRemoteObjectBase.php:221
ilRemoteObjectBase\doReadCustomFields
doReadCustomFields($a_row)
Read custom fields from db row.
Definition: class.ilRemoteObjectBase.php:418
ilRemoteObjectBase\setOrganization
setOrganization($a_organization)
set organization
Definition: class.ilRemoteObjectBase.php:141
ilRemoteObjectBase\setLocalInformation
setLocalInformation($a_info)
set local information
Definition: class.ilRemoteObjectBase.php:171
+ Here is the call graph for this function:

◆ doReadCustomFields()

ilRemoteObjectBase::doReadCustomFields (   $a_row)
protected

Read custom fields from db row.

Parameters
object$a_row

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

Referenced by doRead().

419  {
420 
421  }
+ Here is the caller graph for this function:

◆ doUpdate()

ilRemoteObjectBase::doUpdate ( )

Update remote object.

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

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

353  {
354  global $ilDB;
355 
356  $fields = array(
357  "local_information" => array("text", $this->getLocalInformation()),
358  "remote_link" => array("text", $this->getRemoteLink()),
359  "mid" => array("integer", $this->getMID()),
360  "organization" => array("text", $this->getOrganization())
361  );
362 
363  $this->doUpdateCustomFields($fields);
364 
365  $where = array("obj_id" => array("integer", $this->getId()));
366 
367  $ilDB->update($this->getTableName(), $fields, $where);
368  }
ilRemoteObjectBase\getTableName
getTableName()
Get db table name.
ilRemoteObjectBase\getOrganization
getOrganization()
get organization
Definition: class.ilRemoteObjectBase.php:151
ilRemoteObjectBase\getRemoteLink
getRemoteLink()
get remote link
Definition: class.ilRemoteObjectBase.php:231
ilRemoteObjectBase\doUpdateCustomFields
doUpdateCustomFields(array &$a_fields)
Add custom fields to db update.
Definition: class.ilRemoteObjectBase.php:374
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
$ilDB
global $ilDB
Definition: storeScorm2004.php:16
ilRemoteObjectBase\getLocalInformation
getLocalInformation()
get local information
Definition: class.ilRemoteObjectBase.php:161
+ 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

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

Referenced by doUpdate().

375  {
376 
377  }
+ 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 830 of file class.ilRemoteObjectBase.php.

References $ilLog, and getECSObjectType().

831  {
832  global $ilLog;
833 
834  try
835  {
836  include_once './Services/WebServices/ECS/classes/class.ilECSConnector.php';
837  $connector = new ilECSConnector($a_server);
838  $connector->addHeader('X-EcsQueryStrings', $a_sender_only ? 'sender=true' : 'all=true'); // #11301
839  $list = $connector->getResourceList($this->getECSObjectType());
840  if($list instanceof ilECSResult)
841  {
842  return $list->getResult()->getLinkIds();
843  }
844  }
845  catch(ilECSConnectorException $exc)
846  {
847  $ilLog->write(__METHOD__ . ': Error getting resource list. '.$exc->getMessage());
848  }
849  }
ilRemoteObjectBase\getECSObjectType
getECSObjectType()
Get ECS resource identifier, e.g.
$ilLog
$ilLog
Definition: inc.setup_header.php:130
+ Here is the call graph for this function:

◆ getECSObjectType()

ilRemoteObjectBase::getECSObjectType ( )
abstractprotected

Get ECS resource identifier, e.g.

"/campusconnect/courselinks"

Returns
string

Referenced by beforeCreate(), 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 243 of file class.ilRemoteObjectBase.php.

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

244  {
245  global $ilUser;
246 
247 
248  include_once './Services/WebServices/ECS/classes/class.ilECSImport.php';
249  $server_id = ilECSImport::lookupServerId($this->getId());
250  $server = ilECSSetting::getInstanceByServerId($server_id);
251 
252  include_once('./Services/WebServices/ECS/classes/class.ilECSUser.php');
253  $user = new ilECSUser($ilUser);
254  $ecs_user_data = $user->toGET();
255  $GLOBALS['ilLog']->write(__METHOD__.': Using ecs user data '.$ecs_user_data);
256 
257  // check token mechanism enabled
258  include_once './Services/WebServices/ECS/classes/class.ilECSParticipantSetting.php';
259  $part = new ilECSParticipantSetting($server_id,$this->getMID());
260  if(!$part->isTokenEnabled())
261  {
262  return $this->getRemoteLink();
263  }
264 
265  $auth_hash = $this->createAuthResource($this->getRemoteLink().$user->toREALM());
266  $ecs_url_hash = 'ecs_hash_url='.urlencode($server->getServerURI().'/sys/auths/'.$auth_hash);
267 
268  if(strpos($this->getRemoteLink(), '?'))
269  {
270 
271  $link = $this->getRemoteLink().'&ecs_hash='.$auth_hash.$ecs_user_data.'&'.$ecs_url_hash;
272  }
273  else
274  {
275  $link = $this->getRemoteLink().'?ecs_hash='.$auth_hash.$ecs_user_data.'&'.$ecs_url_hash;
276  }
277  $GLOBALS['ilLog']->write(__METHOD__.': ECS full link: '. $link);
278  return $link;
279  }
ilECSSetting\getInstanceByServerId
static getInstanceByServerId($a_server_id)
Get singleton instance per server.
Definition: class.ilECSSetting.php:109
ilRemoteObjectBase\getRemoteLink
getRemoteLink()
get remote link
Definition: class.ilRemoteObjectBase.php:231
$GLOBALS
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
Definition: generate-standalone.php:18
$ilUser
$ilUser
Definition: imgupload.php:18
ilECSImport\lookupServerId
static lookupServerId($a_obj_id)
Lookup server id of imported content <type> $ilDB.
Definition: class.ilECSImport.php:221
ilRemoteObjectBase\createAuthResource
createAuthResource($a_plain_realm)
create authentication resource on ecs server
Definition: class.ilRemoteObjectBase.php:287
$server
$server
Definition: dummy_client.php:12
ilECSUser
Stores relevant user data.
Definition: class.ilECSUser.php:35
+ 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.

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

50  {
51  switch($a_type)
52  {
53  case ilECSEventQueueReader::TYPE_REMOTE_COURSE:
54  include_once 'Modules/RemoteCourse/classes/class.ilObjRemoteCourse.php';
55  return new ilObjRemoteCourse();
56 
57  case ilECSEventQueueReader::TYPE_REMOTE_CATEGORY:
58  include_once 'Modules/RemoteCategory/classes/class.ilObjRemoteCategory.php';
59  return new ilObjRemoteCategory();
60 
61  case ilECSEventQueueReader::TYPE_REMOTE_FILE:
62  include_once 'Modules/RemoteFile/classes/class.ilObjRemoteFile.php';
63  return new ilObjRemoteFile();
64 
65  case ilECSEventQueueReader::TYPE_REMOTE_GLOSSARY:
66  include_once 'Modules/RemoteGlossary/classes/class.ilObjRemoteGlossary.php';
67  return new ilObjRemoteGlossary();
68 
69  case ilECSEventQueueReader::TYPE_REMOTE_GROUP:
70  include_once 'Modules/RemoteGroup/classes/class.ilObjRemoteGroup.php';
71  return new ilObjRemoteGroup();
72 
73  case ilECSEventQueueReader::TYPE_REMOTE_LEARNING_MODULE:
74  include_once 'Modules/RemoteLearningModule/classes/class.ilObjRemoteLearningModule.php';
75  return new ilObjRemoteLearningModule();
76 
77  case ilECSEventQueueReader::TYPE_REMOTE_WIKI:
78  include_once 'Modules/RemoteWiki/classes/class.ilObjRemoteWiki.php';
79  return new ilObjRemoteWiki();
80 
81  case ilECSEventQueueReader::TYPE_REMOTE_TEST:
82  include_once 'Modules/RemoteTest/classes/class.ilObjRemoteTest.php';
83  return new ilObjRemoteTest();
84  }
85  }
ilObjRemoteTest
Remote test app class.
Definition: class.ilObjRemoteTest.php:15
ilObjRemoteFile
Remote file app class.
Definition: class.ilObjRemoteFile.php:15
ilObjRemoteGlossary
Remote glossary app class.
Definition: class.ilObjRemoteGlossary.php:15
ilObjRemoteLearningModule
Remote learning module app class.
Definition: class.ilObjRemoteLearningModule.php:15
ilObjRemoteWiki
Remote wiki app class.
Definition: class.ilObjRemoteWiki.php:15
$a_type
$a_type
Definition: workflow.php:93
ilObjRemoteCourse
Remote course app class.
Definition: class.ilObjRemoteCourse.php:15
ilObjRemoteGroup
Remote group app class.
Definition: class.ilObjRemoteGroup.php:15
ilObjRemoteCategory
Remote category app class.
Definition: class.ilObjRemoteCategory.php:15
+ Here is the caller graph for this function:

◆ getLocalInformation()

ilRemoteObjectBase::getLocalInformation ( )

get local information

Returns
string

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

References $local_information.

Referenced by doUpdate().

162  {
163  return $this->local_information;
164  }
+ Here is the caller graph for this function:

◆ getMID()

ilRemoteObjectBase::getMID ( )

get mid

Returns
int

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

References $mid.

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

182  {
183  return $this->mid;
184  }
+ Here is the caller graph for this function:

◆ getOrganization()

ilRemoteObjectBase::getOrganization ( )

get organization

Returns
string

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

References $organization.

Referenced by doUpdate().

152  {
153  return $this->organization;
154  }
+ Here is the caller graph for this function:

◆ getRealmPlain()

ilRemoteObjectBase::getRealmPlain ( )

Get realm plain.

Returns
type

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

References $realm_plain.

132  {
133  return $this->realm_plain;
134  }

◆ getRemoteLink()

ilRemoteObjectBase::getRemoteLink ( )

get remote link

Returns
string

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

References $remote_link.

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

232  {
233  return $this->remote_link;
234  }
+ Here is the caller graph for this function:

◆ getTableName()

ilRemoteObjectBase::getTableName ( )
abstractprotected

Get db table name.

Returns
string

Referenced by beforeCreate(), doCreate(), 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 635 of file class.ilRemoteObjectBase.php.

References handleUpdate().

636  {
637  return $this->handleUpdate($a_server, $a_econtent_id, $a_mids);
638  }
ilRemoteObjectBase\handleUpdate
handleUpdate(ilECSSetting $a_server, $a_econtent_id, array $a_mids)
Handle update event.
Definition: class.ilRemoteObjectBase.php:650
+ 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 794 of file class.ilRemoteObjectBase.php.

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

Referenced by handleUpdate().

795  {
796  global $tree, $ilLog;
797 
798 
799  include_once('./Services/WebServices/ECS/classes/class.ilECSImport.php');
800 
801  // there is no information about the original mid anymore.
802  // Therefor delete any remote objects with given econtent id
803  $obj_ids = ilECSImport::_lookupObjIds($a_server->getServerId(),$a_econtent_id);
804  $ilLog->write(__METHOD__.': Received obj_ids '.print_r($obj_ids,true));
805 
806  foreach($obj_ids as $obj_id)
807  {
808  $references = ilObject::_getAllReferences($obj_id);
809  foreach($references as $ref_id)
810  {
811  if($tmp_obj = ilObjectFactory::getInstanceByRefId($ref_id,false))
812  {
813  $ilLog->write(__METHOD__.': Deleting obsolete remote course: '.$tmp_obj->getTitle());
814  $tmp_obj->delete();
815  $tree->deleteTree($tree->getNodeData($ref_id));
816  }
817  unset($tmp_obj);
818  }
819  }
820  return true;
821  }
ilECSSetting\getServerId
getServerId()
Get current server id.
Definition: class.ilECSSetting.php:202
ilObject\_getAllReferences
static _getAllReferences($a_id)
get all reference ids of object
Definition: class.ilObject.php:902
$ilLog
$ilLog
Definition: inc.setup_header.php:130
ilECSImport\_lookupObjIds
static _lookupObjIds($a_server_id, $a_econtent_id)
Lookup obj_id.
Definition: class.ilECSImport.php:241
ilObjectFactory\getInstanceByRefId
static getInstanceByRefId($a_ref_id, $stop_on_error=true)
get an instance of an Ilias object by reference id
Definition: class.ilObjectFactory.php:142
+ 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 650 of file class.ilRemoteObjectBase.php.

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

Referenced by handleCreate().

651  {
652  global $ilLog;
653 
654  // get content details
655  include_once('./Services/WebServices/ECS/classes/class.ilECSEContentDetails.php');
656  $details = ilECSEContentDetails::getInstance($a_server->getServerId(),
657  $a_econtent_id, $this->getECSObjectType());
658  if(!$details instanceof ilECSEContentDetails)
659  {
660  $this->handleDelete($a_server, $a_econtent_id);
661  $ilLog->write(__METHOD__.': Handling delete of deprecated remote object. DONE');
662  return;
663  }
664 
665  $ilLog->write(__METHOD__.': Receivers are '. print_r($details->getReceivers(),true));
666  $ilLog->write(__METHOD__.': Senders are '. print_r($details->getSenders(),true));
667 
668  // check owner (sender mid)
669  include_once('./Services/WebServices/ECS/classes/class.ilECSParticipantSettings.php');
670  if(!ilECSParticipantSettings::getInstanceByServerId($a_server->getServerId())->isImportAllowed($details->getSenders()))
671  {
672  $ilLog->write('Ignoring disabled participant. MID: '.$details->getOwner());
673  return true;
674  }
675 
676  // new mids
677  include_once 'Services/WebServices/ECS/classes/class.ilECSImport.php';
678  include_once 'Services/WebServices/ECS/classes/class.ilECSConnector.php';
679  foreach(array_intersect($a_mids,$details->getReceivers()) as $mid)
680  {
681  try
682  {
683  $connector = new ilECSConnector($a_server);
684  $res = $connector->getResource($this->getECSObjectType(), $a_econtent_id);
685  if($res->getHTTPCode() == ilECSConnector::HTTP_CODE_NOT_FOUND)
686  {
687  continue;
688  }
689  $json = $res->getResult();
690  $GLOBALS['ilLog']->write(__METHOD__.': Received json: '.print_r($json,true));
691  if(!is_object($json))
692  {
693  // try as array (workaround for invalid content)
694  $json = $json[0];
695  if(!is_object($json))
696  {
697  throw new ilECSConnectorException('invalid json');
698  }
699  }
700  }
701  catch(ilECSConnectorException $exc)
702  {
703  $ilLog->write(__METHOD__ . ': Error parsing result. '.$exc->getMessage());
704  $ilLog->logStack();
705  return false;
706  }
707 
708  // Update existing
709 
710  // Check receiver mid
711  if($obj_id = ilECSImport::_isImported($a_server->getServerId(),$a_econtent_id,$mid))
712  {
713  $ilLog->write(__METHOD__.': Handling update for existing object');
714  $remote = ilObjectFactory::getInstanceByObjId($obj_id,false);
715  if(!$remote instanceof ilRemoteObjectBase)
716  {
717  $ilLog->write(__METHOD__.': Cannot instantiate remote object. Got object type '.$remote->getType());
718  continue;
719  }
720  $remote->updateFromECSContent($a_server,$json,$details->getMySender());
721  }
722  else
723  {
724  $GLOBALS['ilLog']->write(__METHOD__.': my sender '. $details->getMySender().'vs mid'. $mid);
725 
726  $ilLog->write(__METHOD__.': Handling create for non existing object');
727  $this->createFromECSEContent($a_server,$json,$details->getMySender());
728 
729  // update import status
730  $ilLog->write(__METHOD__.': Updating import status');
731  include_once('./Services/WebServices/ECS/classes/class.ilECSImport.php');
732  $import = new ilECSImport($a_server->getServerId(),$this->getId());
733  $import->setEContentId($a_econtent_id);
734  // Store receiver mid
735  $import->setMID($mid);
736  $import->save();
737 
738  $ilLog->write(__METHOD__.': Sending notification');
739  $this->sendNewContentNotification($a_server->getServerId());
740  }
741  }
742 
743  $ilLog->write(__METHOD__.': done');
744  return true;
745  }
ilRemoteObjectBase\sendNewContentNotification
sendNewContentNotification($a_server_id)
send notifications about new EContent
Definition: class.ilRemoteObjectBase.php:750
ilECSSetting\getServerId
getServerId()
Get current server id.
Definition: class.ilECSSetting.php:202
$GLOBALS
$GLOBALS['loaded']
Global hash that tracks already loaded includes.
Definition: generate-standalone.php:18
ilRemoteObjectBase\handleDelete
handleDelete(ilECSSetting $a_server, $a_econtent_id, $a_mid=0)
Handle delete event.
Definition: class.ilRemoteObjectBase.php:794
ilECSEContentDetails
Presentation of ecs content details (http://...campusconnect/courselinks/id/details) ...
Definition: class.ilECSEContentDetails.php:32
ilRemoteObjectBase\getECSObjectType
getECSObjectType()
Get ECS resource identifier, e.g.
ilECSParticipantSettings\getInstanceByServerId
static getInstanceByServerId($a_server_id)
Get instance by server id.
Definition: class.ilECSParticipantSettings.php:71
ilECSImport
Storage of ECS imported objects.
Definition: class.ilECSImport.php:14
ilECSImport\_isImported
static _isImported($a_server_id, $a_econtent_id, $a_mid, $a_sub_id=null)
check if econtent is imported for a specific mid
Definition: class.ilECSImport.php:394
ilRemoteObjectBase
Remote object app base class.
Definition: class.ilRemoteObjectBase.php:15
ilObjectFactory\getInstanceByObjId
static getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id
Definition: class.ilObjectFactory.php:72
$ilLog
$ilLog
Definition: inc.setup_header.php:130
ilECSImport\setEContentId
setEContentId($a_id)
set econtent id
Definition: class.ilECSImport.php:479
ilRemoteObjectBase\createFromECSEContent
createFromECSEContent(ilECSSetting $a_server, $a_ecs_content, $a_owner)
create remote object from ECSContent object
Definition: class.ilRemoteObjectBase.php:430
ilECSEContentDetails\getInstance
static getInstance($a_server_id, $a_econtent_id, $a_resource_type)
Get data from server.
Definition: class.ilECSEContentDetails.php:57
+ 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 503 of file class.ilRemoteObjectBase.php.

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

Referenced by ilObjRemoteCourse\updateCustomFromECSContent().

504  {
505  global $ilLog;
506 
507  $ilLog->write("importing metadata from json: ".print_r($a_json, true));
508 
509  include_once('./Services/WebServices/ECS/classes/class.ilECSDataMappingSettings.php');
510  include_once('./Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
511  include_once('./Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php');
512 
513  $mappings = ilECSDataMappingSettings::getInstanceByServerId($a_server->getServerId());
514  $values_records = ilAdvancedMDValues::getInstancesForObjectId($this->getId(), $this->getType());
515  foreach($values_records as $values_record)
516  {
517  // this correctly binds group and definitions
518  $values_record->read();
519  }
520 
521  $do_save = false;
522 
523  foreach($a_definition as $id => $type)
524  {
525  if(is_array($type))
526  {
527  $target = $type[1];
528  $type = $type[0];
529  }
530  else
531  {
532  $target = $id;
533  }
534 
535  $timePlace = null;
536  if($field = $mappings->getMappingByECSName($a_mapping_mode, $id))
537  {
538  // find element in records
539  $adv_md_def = null;
540  foreach($values_records as $values_record)
541  {
542  $adv_md_defs = $values_record->getDefinitions();
543  if(isset($adv_md_defs[$field]))
544  {
545  $adv_md_def = $adv_md_defs[$field];
546  break;
547  }
548  }
549  if(!$adv_md_def)
550  {
551  continue;
552  }
553 
554  $raw_value = $a_json->$target;
555 
556  if($type == ilECSUtils::TYPE_TIMEPLACE)
557  {
558  if(!is_object($timePlace))
559  {
560  include_once('./Services/WebServices/ECS/classes/class.ilECSTimePlace.php');
561  if(is_object($raw_value))
562  {
563  $timePlace = new ilECSTimePlace();
564  $timePlace->loadFromJSON($raw_value);
565  }
566  else
567  {
568  $timePlace = new ilECSTimePlace();
569  }
570  }
571  $raw_value = $timePlace;
572  }
573 
574  if($adv_md_def->importFromECS($type, $raw_value, $id))
575  {
576  $do_save = true;
577  }
578  }
579  }
580 
581  if($do_save)
582  {
583  foreach($values_records as $values_record)
584  {
585  $additional = array();
586  foreach($values_record->getADTGroup()->getElements() as $element_id => $element)
587  {
588  if(!$element->isNull())
589  {
590  $additional[$element_id] = array("disabled"=>array("integer", 1));
591  }
592  }
593  $values_record->write($additional);
594  }
595  }
596  }
ilAdvancedMDValues\getInstancesForObjectId
static getInstancesForObjectId($a_obj_id, $a_obj_type=null, $a_sub_type="-", $a_sub_id=0)
Get instances for given object id.
Definition: class.ilAdvancedMDValues.php:54
ilECSDataMappingSettings\getInstanceByServerId
static getInstanceByServerId($a_server_id)
Get singleton instance.
Definition: class.ilECSDataMappingSettings.php:74
ilECSTimePlace
Representation of ECS EContent Time Place.
Definition: class.ilECSTimePlace.php:34
ilECSSetting\getServerId
getServerId()
Get current server id.
Definition: class.ilECSSetting.php:202
ilECSUtils\TYPE_TIMEPLACE
const TYPE_TIMEPLACE
Definition: class.ilECSUtils.php:39
$additional
$additional
Definition: goto.php:52
$ilLog
$ilLog
Definition: inc.setup_header.php:130
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
+ 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 614 of file class.ilRemoteObjectBase.php.

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

615  {
616  include_once('./Services/WebServices/ECS/classes/class.ilECSExport.php');
617  include_once('./Services/WebServices/ECS/classes/class.ilECSImport.php');
618  if(ilECSExport::_isRemote(ilECSImport::lookupServerId($this->getId()),
619  ilECSImport::_lookupEContentId($this->getId())))
620  {
621  return false;
622  }
623  return true;
624  }
ilECSImport\_lookupEContentId
static _lookupEContentId($a_obj_id)
get econent_id
Definition: class.ilECSImport.php:202
ilECSExport\_isRemote
static _isRemote($a_server_id, $a_econtent_id)
is remote object
Definition: class.ilECSExport.php:265
ilECSImport\lookupServerId
static lookupServerId($a_obj_id)
Lookup server id of imported content <type> $ilDB.
Definition: class.ilECSImport.php:221
+ Here is the call graph for this function:

◆ sendNewContentNotification()

ilRemoteObjectBase::sendNewContentNotification (   $a_server_id)
protected

send notifications about new EContent

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

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

Referenced by handleUpdate().

751  {
752  include_once('Services/WebServices/ECS/classes/class.ilECSSetting.php');
753  $settings = ilECSSetting::getInstanceByServerId($a_server_id);
754  if(!count($rcps = $settings->getEContentRecipients()))
755  {
756  return;
757  }
758 
759  include_once('./Services/Mail/classes/class.ilMail.php');
760  include_once('./Services/Language/classes/class.ilLanguageFactory.php');
761 
762  $lang = ilLanguageFactory::_getLanguage();
763  $lang->loadLanguageModule('ecs');
764 
765  $mail = new ilMail(self::MAIL_SENDER);
766  $message = $lang->txt('ecs_'.$this->getType().'_created_body_a')."\n\n";
767  $message .= $lang->txt('title').': '.$this->getTitle()."\n";
768  if(strlen($desc = $this->getDescription()))
769  {
770  $message .= $lang->txt('desc').': '.$desc."\n";
771  }
772 
773  include_once('./Services/Link/classes/class.ilLink.php');
774  $href = ilLink::_getStaticLink($this->getRefId(),$this->getType(),true);
775  $message .= $lang->txt("perma_link").': '.$href."\n\n";
776  $message .= ilMail::_getAutoGeneratedMessageString();
777 
778  $mail->sendMail($settings->getEContentRecipientsAsString(),
779  '','',
780  $lang->txt('ecs_new_econtent_subject'),
781  $message,array(),array('normal'));
782  }
ilECSSetting\getInstanceByServerId
static getInstanceByServerId($a_server_id)
Get singleton instance per server.
Definition: class.ilECSSetting.php:109
ilLanguageFactory\_getLanguage
static _getLanguage($a_lang_key='')
Get langauge object.
Definition: class.ilLanguageFactory.php:44
ilMail
This class handles base functions for mail handling.
Definition: class.ilMail.php:66
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
$lang
for($i=1; $i<=count($kw_cases_sel); $i+=1) $lang
Definition: langwiz.php:349
+ 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 171 of file class.ilRemoteObjectBase.php.

Referenced by doRead().

172  {
173  $this->local_information = $a_info;
174  }
+ Here is the caller graph for this function:

◆ setMID()

ilRemoteObjectBase::setMID (   $a_mid)

set mid

Parameters
int$a_midmid

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

Referenced by doRead(), and updateFromECSContent().

192  {
193  $this->mid = $a_mid;
194  }
+ Here is the caller graph for this function:

◆ setOrganization()

ilRemoteObjectBase::setOrganization (   $a_organization)

set organization

Parameters
string$a_organization

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

Referenced by doRead(), and updateFromECSContent().

142  {
143  $this->organization = $a_organization;
144  }
+ 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 221 of file class.ilRemoteObjectBase.php.

Referenced by doRead(), and updateFromECSContent().

222  {
223  $this->remote_link = $a_link;
224  }
+ 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

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

Referenced by updateFromECSContent().

605  {
606 
607  }
+ 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 456 of file class.ilRemoteObjectBase.php.

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

457  {
458  global $ilLog;
459 
460  $ilLog->write('updateFromECSContent: '.print_r($a_ecs_content, true));
461 
462  // Get organisation for owner (ObjectListGUI performance)
463  $organisation = null;
464  if($a_owner)
465  {
466  include_once './Services/WebServices/ECS/classes/class.ilECSUtils.php';
467  $organisation = ilECSUtils::lookupParticipantName($a_owner, $a_server->getServerId());
468  $ilLog->write('found organisation: '.$organisation);
469  }
470 
471  $this->setMID($a_owner); // obsolete?
472  $this->setOrganization($organisation);
473  $this->setTitle($a_ecs_content->title);
474  $this->setDescription($a_ecs_content->abstract);
475  $this->setRemoteLink($a_ecs_content->url);
476 
477  $ilLog->write('updateCustomFromECSContent');
478  $this->updateCustomFromECSContent($a_server, $a_ecs_content);
479 
480  // we are updating late so custom values can be set
481 
482  $ilLog->write('ilObject->update()');
483  $this->update();
484 
485  include_once './Services/WebServices/ECS/classes/class.ilECSUtils.php';
486  $matchable_content = ilECSUtils::getMatchableContent($this->getECSObjectType(),
487  $a_server->getServerId(), $a_ecs_content, $a_owner);
488 
489  // rule-based category mapping
490  include_once './Services/WebServices/ECS/classes/class.ilECSCategoryMapping.php';
491  ilECSCategoryMapping::handleUpdate($this->getId(), $a_server->getServerId(),
492  $matchable_content);
493  }
ilECSUtils\lookupParticipantName
static lookupParticipantName($a_owner, $a_server_id)
Lookup participant name.
Definition: class.ilECSUtils.php:47
ilObject2\setDescription
setDescription($a_desc)
Definition: class.ilObject2.php:56
ilECSSetting\getServerId
getServerId()
Get current server id.
Definition: class.ilECSSetting.php:202
ilECSCategoryMapping\handleUpdate
static handleUpdate($a_obj_id, $a_server_id, $a_matchable_content)
Handle update of ecs content and create references.
Definition: class.ilECSCategoryMapping.php:93
ilRemoteObjectBase\setRemoteLink
setRemoteLink($a_link)
set remote link
Definition: class.ilRemoteObjectBase.php:221
ilRemoteObjectBase\updateCustomFromECSContent
updateCustomFromECSContent(ilECSSetting $a_server, $ecs_content)
update remote object settings from ecs content
Definition: class.ilRemoteObjectBase.php:604
ilRemoteObjectBase\getECSObjectType
getECSObjectType()
Get ECS resource identifier, e.g.
ilECSUtils\getMatchableContent
static getMatchableContent($a_resource_id, $a_server_id, $a_ecs_content, $a_owner)
Convert ECS content to rule matchable values.
Definition: class.ilECSUtils.php:192
ilRemoteObjectBase\setOrganization
setOrganization($a_organization)
set organization
Definition: class.ilRemoteObjectBase.php:141
ilObject2\setTitle
setTitle($a_title)
Definition: class.ilObject2.php:54
$ilLog
$ilLog
Definition: inc.setup_header.php:130
+ 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: