Remote object app base class. More...

Inheritance diagram for ilRemoteObjectBase:

Collaboration diagram for ilRemoteObjectBase:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=true)
	Constructor. More...

	getRealmPlain ()
	Get realm plain. More...

	setOrganization (string $a_organization)
	set organization More...

	getOrganization ()
	get organization More...

	getLocalInformation ()
	get local information More...

	setLocalInformation (string $a_info)
	set local information More...

	getMID ()
	get mid More...

	setMID (int $a_mid)
	set mid More...

	setRemoteLink (string $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 (string $a_plain_realm)
	create authentication resource on ecs server More...

	createFromECSEContent (ilECSSetting $a_server, object $a_ecs_content, int $a_owner)
	create remote object from ECSContent object More...

	updateFromECSContent (ilECSSetting $a_server, object $a_ecs_content, int $a_owner)
	update remote object settings from ecs content More...

	isLocalObject ()
	Is remote object from same installation? More...

	handleCreate (ilECSSetting $a_server, int $a_econtent_id, array $a_mids)
	Handle creation. More...

	handleUpdate (ilECSSetting $a_server, int $a_econtent_id, array $a_mids)
	Handle update event. More...

	handleDelete (ilECSSetting $a_server, int $a_econtent_id, $a_mid=0)
	Handle delete event. More...

	getAllResourceIds (ilECSSetting $a_server, bool $a_sender_only=false)
	Get all available resources. More...

Public Member Functions inherited from ilObject2
	__construct (int $a_id=0, bool $a_reference=true)
	Constructor. More...

	read ()

	create (bool $a_clone_mode=false)

	update ()

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

	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...

	cloneObject (int $target_id, int $copy_id=0, bool $omit_tree=false)

Public Member Functions inherited from ilObject
	getObjectProperties ()

	flushObjectProperties ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()
	update owner of object in db More...

	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

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

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id, int $new_obj_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...

	selfOrParentWithRatingEnabled ()

	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	getInstanceByEventType (string $a_type)
	Get instance by ilECSEvent(QueueReader) type. More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", ?int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	getIconForType (string $type)

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

Data Fields
const	MAIL_SENDER = 6

const	OBJECT_OWNER = 6

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Protected Member Functions
	beforeCreate ()
	If overwritten this method should return true, there is currently no "abort" handling for cases where "false" is returned. More...

	getTableName ()
	Get db table name. More...

	getECSObjectType ()
	Get ECS resource identifier, e.g. More...

	doCreate (bool $clone_mode=false)

	doCreateCustomFields (array &$a_fields)
	Add custom fields to db insert. More...

	doUpdate ()
	Update remote object. More...

	doUpdateCustomFields (array &$a_fields)
	Add custom fields to db update. More...

	doDelete ()
	Delete remote object. More...

	doRead ()

	doReadCustomFields (object $a_row)
	Read custom fields from db row. More...

	importMetadataFromJson (object $a_json, ilECSSetting $a_server, array $a_definition, int $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 (bool $clone_mode=false)

	beforeCreate ()
	If overwritten this method should return true, there is currently no "abort" handling for cases where "false" is returned. More...

	doUpdate ()

	beforeUpdate ()

	doDelete ()

	beforeDelete ()

	doCloneObject (ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id=null)

	beforeCloneObject ()

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Protected Attributes
string	$local_information = null

string	$remote_link = null

string	$organization = null

int	$mid = null

string	$auth_hash = ''

string	$realm_plain = ''

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

LOMServices	$lom_services

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Private Attributes
ilLogger	$logger

Detailed Description

Remote object app base class.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilRemoteObjectBase::__construct	(	int	$a_id = `0`,
		bool	$a_reference = `true`
	)

Constructor.

Parameters

int	$a_id	reference_id or object_id
bool	$a_reference	treat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject2.

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

    {
        global $DIC;
 
        parent::__construct($a_id, $a_call_by_reference);
 
        $this->logger = $DIC->logger()->wsrv();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\logger().

Here is the call graph for this function:

Member Function Documentation

◆ beforeCreate()

ilRemoteObjectBase::beforeCreate ( )

protected

If overwritten this method should return true, there is currently no "abort" handling for cases where "false" is returned.

Returns: bool

Reimplemented from ilObject2.

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

                                     : bool
    {
        $this->setOwner(self::OBJECT_OWNER);
        return parent::beforeCreate();
    }

References ilObject\setOwner().

Here is the call graph for this function:

◆ createAuthResource()

ilRemoteObjectBase::createAuthResource ( string $a_plain_realm )

create authentication resource on ecs server

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

    {
        try {
            $server_id = ilECSImportManager::getInstance()->lookupServerId($this->getId());
            $import_info = new ilECSImport($server_id, $this->getId());
 
            $connector = new ilECSConnector(ilECSSetting::getInstanceByServerId($server_id));
            $auth = new ilECSAuth();
            $auth->setPid($import_info->getMID());
            //TODO URL is deprecated
            $auth->setUrl($this->getRemoteLink());
            $realm = sha1($a_plain_realm);
            $this->logger->info(__METHOD__ . ': Using realm ' . $a_plain_realm);
            $auth->setRealm($realm);
            $this->logger->info(__METHOD__ . ' Mid is ' . $this->getMID());
            //TODO remove @
            $this->auth_hash = $connector->addAuth(json_encode($auth, JSON_THROW_ON_ERROR), $this->getMID());
            return $this->auth_hash;
        } catch (ilECSConnectorException $exc) {
            $this->logger->info(__METHOD__ . ': Caught error from ECS Auth resource: ' . $exc->getMessage());
            return false;
        }
    }

References $auth_hash, ilObject\getId(), ilECSImportManager\getInstance(), ilECSSetting\getInstanceByServerId(), getMID(), getRemoteLink(), and ILIAS\Repository\logger().

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,
		object	$a_ecs_content,
		int	$a_owner
	)

create remote object from ECSContent object

Parameters

ilECSSetting	$a_server
object	$a_ecs_content	object with object settings
int	$a_owner

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

                                                                                                      : void
    {
        $this->create();
        $this->log->info("Done calling create, creating reference");
        // won't work for personal workspace
        $this->createReference();
        $this->log->info("Done creating reference, setting permissions");
        $this->setPermissions($a_server->getImportId());
        $this->log->info("Done setting permissions, putting object in tree");
 
        $matchable_content = ilECSUtils::getMatchableContent(
            $this->getECSObjectType(),
            $a_server->getServerId(),
            $a_ecs_content,
            $a_owner
        );
 
        $this->putInTree(ilECSCategoryMapping::getMatchingCategory(
            $a_server->getServerId(),
            $matchable_content
        ));
        $this->log->info("Done putting object in tree, updateing object");
 
        $this->updateFromECSContent($a_server, $a_ecs_content, $a_owner);
    }

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

Here is the call graph for this function:

◆ doCreate()

ilRemoteObjectBase::doCreate ( bool $clone_mode = false )

protected

Reimplemented from ilObject2.

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

                                                         : void
    {
        $fields = array(
            "obj_id" => array("integer", $this->getId()),
            "local_information" => array("text", ""),
            "remote_link" => array("text", ""),
            "mid" => array("integer", 0),
            "organization" => array("text", "")
        );
 
        $this->doCreateCustomFields($fields);
 
        $this->db->insert($this->getTableName(), $fields);
    }

References doCreateCustomFields(), ilObject\getId(), and getTableName().

Here is the call graph for this function:

◆ doCreateCustomFields()

ilRemoteObjectBase::doCreateCustomFields ( array & $a_fields )

protected

Add custom fields to db insert.

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

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

                                                             : void
    {
    }

Referenced by doCreate().

Here is the caller graph for this function:

◆ doDelete()

ilRemoteObjectBase::doDelete ( )

protected

Delete remote object.

Reimplemented from ilObject2.

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

                                 : void
    {
        //put here your module specific stuff
        ilECSImportManager::getInstance()->_deleteByObjId($this->getId());
 
        $query = "DELETE FROM " . $this->getTableName() .
            " WHERE obj_id = " . $this->db->quote($this->getId(), 'integer') . " ";
        $this->db->manipulate($query);
    }

References ilObject\getId(), ilECSImportManager\getInstance(), and getTableName().

Here is the call graph for this function:

◆ doRead()

ilRemoteObjectBase::doRead ( )

protected

Reimplemented from ilObject2.

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

                               : void
    {
        $query = "SELECT * FROM " . $this->getTableName() .
            " WHERE obj_id = " . $this->db->quote($this->getId(), 'integer') . " ";
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            if (!is_null($row->local_information)) {
                $this->setLocalInformation($row->local_information);
            }
            if (!is_null($row->remote_link)) {
                $this->setRemoteLink($row->remote_link);
            }
            $this->setMID((int) $row->mid);
            if (!is_null($row->organization)) {
                $this->setOrganization($row->organization);
            }
            $this->doReadCustomFields($row);
        }
    }

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

Here is the call graph for this function:

◆ doReadCustomFields()

ilRemoteObjectBase::doReadCustomFields ( object $a_row )

protected

Read custom fields from db row.

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

                                                        : void
    {
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ doUpdate()

ilRemoteObjectBase::doUpdate ( )

protected

Update remote object.

Reimplemented from ilObject2.

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

                                 : void
    {
        $fields = array(
            "local_information" => array("text", $this->getLocalInformation()),
            "remote_link" => array("text", $this->getRemoteLink()),
            "mid" => array("integer", $this->getMID()),
            "organization" => array("text", $this->getOrganization())
        );
 
        $this->doUpdateCustomFields($fields);
 
        $where = array("obj_id" => array("integer", $this->getId()));
 
        $this->db->update($this->getTableName(), $fields, $where);
    }

References doUpdateCustomFields(), ilObject\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.

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

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

                                                             : void
    {
    }

Referenced by doUpdate().

Here is the caller graph for this function:

◆ getAllResourceIds()

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

Get all available resources.

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

                                                                                          : array
    {
        try {
            $connector = new ilECSConnector($a_server);
            $connector->addHeader('X-EcsQueryStrings', $a_sender_only ? 'sender=true' : 'all=true'); // #11301
            $list = $connector->getResourceList($this->getECSObjectType());
            if ($list instanceof ilECSResult) {
                return $list->getResult()->getLinkIds();
            }
        } catch (ilECSConnectorException $exc) {
            $this->logger->error(__METHOD__ . ': Error getting resource list for type . ' . $this->getECSObjectType() . ' with message: ' . $exc->getMessage());
        }
 
        return [];
    }

References ILIAS\Repository\logger().

Here is the call graph for this function:

◆ getECSObjectType()

ilRemoteObjectBase::getECSObjectType ( )

abstractprotected

Get ECS resource identifier, e.g.

"/campusconnect/courselinks"

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

Referenced by createFromECSEContent(), and updateFromECSContent().

Here is the caller graph for this function:

◆ getFullRemoteLink()

ilRemoteObjectBase::getFullRemoteLink ( )

get full remote link Including ecs generated hash and auth mode

Exceptions

ilECSConnectorException

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

                                       : string
    {
        $server_id = ilECSImportManager::getInstance()->lookupServerId($this->getId());
        $server = ilECSSetting::getInstanceByServerId($server_id);
        $setting = ilECSParticipantSetting::getInstance($server_id, $this->mid);
        $user = new ilECSUser($this->user);
        $ecs_user_data = $user->toGET($setting);
        $this->logger->info(__METHOD__ . ': Using ecs user data ' . $ecs_user_data);
 
        // check token mechanism enabled
        $part = new ilECSParticipantSetting($server_id, $this->getMID());
        if (!$part->isTokenEnabled()) {
            return $this->getRemoteLink();
        }
 
        $auth_hash = $this->createAuthResource($this->getRemoteLink() . $user->toREALM());
        $ecs_url_hash = 'ecs_hash_url=' . urlencode($server->getServerURI() . '/sys/auths/' . $auth_hash);
 
        if (strpos($this->getRemoteLink(), '?')) {
            $link = $this->getRemoteLink() . '&ecs_hash=' . $auth_hash . $ecs_user_data . '&' . $ecs_url_hash;
        } else {
            $link = $this->getRemoteLink() . '?ecs_hash=' . $auth_hash . $ecs_user_data . '&' . $ecs_url_hash;
        }
        $this->logger->info(__METHOD__ . ': ECS full link: ' . $link);
        return $link;
    }

References $auth_hash, $server, ilObject\$user, createAuthResource(), ilObject\getId(), ilECSImportManager\getInstance(), ilECSParticipantSetting\getInstance(), ilECSSetting\getInstanceByServerId(), getMID(), getRemoteLink(), ILIAS\Repository\logger(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ getInstanceByEventType()

static ilRemoteObjectBase::getInstanceByEventType ( string $a_type )

static

Get instance by ilECSEvent(QueueReader) type.

Returns: ?ilRemoteObjectBase

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

    {
        switch ($a_type) {
            case ilECSEventQueueReader::TYPE_REMOTE_COURSE:
                return new ilObjRemoteCourse();
 
            case ilECSEventQueueReader::TYPE_REMOTE_CATEGORY:
                return new ilObjRemoteCategory();
 
            case ilECSEventQueueReader::TYPE_REMOTE_FILE:
                return new ilObjRemoteFile();
 
            case ilECSEventQueueReader::TYPE_REMOTE_GLOSSARY:
                return new ilObjRemoteGlossary();
 
            case ilECSEventQueueReader::TYPE_REMOTE_GROUP:
                return new ilObjRemoteGroup();
 
            case ilECSEventQueueReader::TYPE_REMOTE_LEARNING_MODULE:
                return new ilObjRemoteLearningModule();
 
            case ilECSEventQueueReader::TYPE_REMOTE_WIKI:
                return new ilObjRemoteWiki();
 
            case ilECSEventQueueReader::TYPE_REMOTE_TEST:
                return new ilObjRemoteTest();
 
            default:
                return null;
        }
    }

References 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

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

                                         : string
    {
        return $this->local_information ?? '';
    }

Referenced by doUpdate().

Here is the caller graph for this function:

◆ getMID()

ilRemoteObjectBase::getMID ( )

get mid

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

                            : int
    {
        return $this->mid;
    }

References $mid.

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

Here is the caller graph for this function:

◆ getOrganization()

ilRemoteObjectBase::getOrganization ( )

get organization

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

                                     : string
    {
        return $this->organization ?? '';
    }

Referenced by doUpdate().

Here is the caller graph for this function:

◆ getRealmPlain()

ilRemoteObjectBase::getRealmPlain ( )

Get realm plain.

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

                                   : string
    {
        return $this->realm_plain;
    }

References $realm_plain.

◆ getRemoteLink()

ilRemoteObjectBase::getRemoteLink ( )

get remote link

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

                                   : string
    {
        return $this->remote_link;
    }

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.

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,
		int	$a_econtent_id,
		array	$a_mids
	)

Handle creation.

called by ilTaskScheduler

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

                                                                                           : bool
    {
        return $this->handleUpdate($a_server, $a_econtent_id, $a_mids);
    }

◆ handleDelete()

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

Handle delete event.

called by ilTaskScheduler

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

                                                                                        : bool
    {
        // there is no information about the original mid anymore.
        // Therefor delete any remote objects with given econtent id
        $obj_ids = ilECSImportManager::getInstance()->_lookupObjIds($a_server->getServerId(), $a_econtent_id);
        $this->logger->info(__METHOD__ . ': Received obj_ids ' . print_r($obj_ids, true));
 
        foreach ($obj_ids as $obj_id) {
            $references = ilObject::_getAllReferences($obj_id);
            foreach ($references as $ref_id) {
                if ($tmp_obj = ilObjectFactory::getInstanceByRefId($ref_id, false)) {
                    $this->logger->info(__METHOD__ . ': Deleting obsolete remote course: ' . $tmp_obj->getTitle());
                    $this->logger->info(print_r($this->tree->getNodeData($ref_id), true));
                    $this->logger->info(print_r($this->tree->getNodeData($tmp_obj->getId()), true));
                    $this->tree->deleteTree($this->tree->getNodeData($ref_id));
                    $tmp_obj->delete();
                }
                unset($tmp_obj);
            }
        }
        return true;
    }

References ilObject\_getAllReferences(), ilECSImportManager\getInstance(), ilObjectFactory\getInstanceByRefId(), ilECSSetting\getServerId(), and ILIAS\Repository\logger().

Here is the call graph for this function:

◆ handleUpdate()

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

Handle update event.

called by ilTaskScheduler

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

                                                                                           : bool
    {
        // get content details
        $details = ilECSEContentDetails::getInstanceFromServer(
            $a_server->getServerId(),
            $a_econtent_id,
            $this->getECSObjectType()
        );
        if (!$details instanceof ilECSEContentDetails) {
            $this->handleDelete($a_server, $a_econtent_id);
            $this->logger->info(__METHOD__ . ': Handling delete of deprecated remote object. DONE');
            return true;
        }
 
        $this->logger->info(__METHOD__ . ': Receivers are ' . print_r($details->getReceivers(), true));
        $this->logger->info(__METHOD__ . ': Senders are ' . print_r($details->getSenders(), true));
 
        // check owner (sender mid)
        if (!ilECSParticipantSettings::getInstanceByServerId($a_server->getServerId())->isImportAllowed($details->getSenders())) {
            $this->logger->info('Ignoring disabled participant. MID: ' . $details->getOwner());
            return true;
        }
 
        // new mids
        foreach (array_intersect($a_mids, $details->getReceivers()) as $mid) {
            try {
                $connector = new ilECSConnector($a_server);
                $res = $connector->getResource($this->getECSObjectType(), $a_econtent_id);
                if ($res->getHTTPCode() === ilECSConnector::HTTP_CODE_NOT_FOUND) {
                    continue;
                }
                $json = $res->getResult();
                $this->logger->info(__METHOD__ . ': Received json: ' . print_r($json, true));
                if (!is_object($json)) {
                    // try as array (workaround for invalid content)
                    $json = $json[0];
                    if (!is_object($json)) {
                        throw new ilECSConnectorException('invalid json');
                    }
                }
            } catch (ilECSConnectorException $exc) {
                $this->logger->error(__METHOD__ . ': Error parsing result. ' . $exc->getMessage());
                $this->logger->logStack(ilLogLevel::ERROR);
                return false;
            }
 
            // Update existing
 
            // Check receiver mid
            if ($obj_id = ilECSImportManager::getInstance()->_isImported($a_server->getServerId(), (string) $a_econtent_id, $mid)) {
                $this->logger->info(__METHOD__ . ': Handling update for existing object');
                $remote = ilObjectFactory::getInstanceByObjId($obj_id, false);
                if (!$remote instanceof self) {
                    $this->logger->info(__METHOD__ . ': Cannot instantiate remote object. Got object type ' . $remote->getType());
                    continue;
                }
                $remote->updateFromECSContent($a_server, $json, $details->getMySender());
            } else {
                $this->logger->info(__METHOD__ . ': my sender ' . $details->getMySender() . 'vs mid' . $mid);
 
                $this->logger->info(__METHOD__ . ': Handling create for non existing object');
                $this->createFromECSEContent($a_server, $json, $details->getMySender());
 
                // update import status
                $this->logger->info(__METHOD__ . ': Updating import status');
                $import = new ilECSImport($a_server->getServerId(), $this->getId());
                $import->setEContentId((string) $a_econtent_id);
                // Store receiver mid
                $import->setMID($mid);
                $import->save();
 
                $this->logger->info(__METHOD__ . ': Sending notification');
                $this->sendNewContentNotification($a_server->getServerId());
            }
        }
 
        $this->logger->info(__METHOD__ . ': done');
        return true;
    }

References $res, ilLogLevel\ERROR, ilECSImportManager\getInstance(), ilObjectFactory\getInstanceByObjId(), ilECSParticipantSettings\getInstanceByServerId(), ilECSEContentDetails\getInstanceFromServer(), ilECSSetting\getServerId(), ilECSConnector\HTTP_CODE_NOT_FOUND, and ILIAS\Repository\logger().

Here is the call graph for this function:

◆ importMetadataFromJson()

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

protected

Add advanced metadata to json (export)

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

                                                                                                                               : void
    {
        $this->logger->info("importing metadata from json: " . print_r($a_json, true));
 
        $mappings = ilECSDataMappingSettings::getInstanceByServerId($a_server->getServerId());
        $values_records = ilAdvancedMDValues::getInstancesForObjectId($this->getId(), $this->getType());
        foreach ($values_records as $values_record) {
            // this correctly binds group and definitions
            $values_record->read();
        }
 
        $do_save = false;
 
        foreach ($a_definition as $id => $type) {
            if (is_array($type)) {
                [$type, $target] = $type;
            } else {
                $target = $id;
            }
 
            $timePlace = null;
            if ($field = $mappings->getMappingByECSName($a_mapping_mode, $id)) {
                // find element in records
                $adv_md_def = null;
                foreach ($values_records as $values_record) {
                    $adv_md_defs = $values_record->getDefinitions();
                    if (isset($adv_md_defs[$field])) {
                        $adv_md_def = $adv_md_defs[$field];
                        break;
                    }
                }
                if (!$adv_md_def) {
                    continue;
                }
                if (property_exists($a_json, $target)) {
                    $raw_value = $a_json->{$target};
                } else {
                    $raw_value = '';
                }
 
                if ($type === ilECSUtils::TYPE_TIMEPLACE) {
                    if (!is_object($timePlace)) {
                        $timePlace = new ilECSTimePlace();
                        if (is_object($raw_value)) {
                            $timePlace->loadFromJSON($raw_value);
                        }
                    }
                    $raw_value = $timePlace;
                }
                if (is_string($raw_value) && $adv_md_def->importFromECS((string) $type, (string) $raw_value, $id)) {
                    $do_save = true;
                }
            }
        }
 
        if ($do_save) {
            foreach ($values_records as $values_record) {
                $additional = array();
                foreach ($values_record->getADTGroup()->getElements() as $element_id => $element) {
                    if (!$element->isNull()) {
                        $additional[$element_id] = array("disabled" => array("integer", 1));
                    }
                }
                $values_record->write($additional);
            }
        }
    }

References $id, ILIAS\Scripts\PHPStan\$target, ilObject\$type, ilObject\getId(), ilECSDataMappingSettings\getInstanceByServerId(), ilAdvancedMDValues\getInstancesForObjectId(), ilECSSetting\getServerId(), ilObject\getType(), ILIAS\Repository\logger(), 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 498 of file class.ilRemoteObjectBase.php.

                                   : bool
    {
        if (ilECSExportManager::getInstance()->_isRemote(
            ilECSImportManager::getInstance()->lookupServerId($this->getId()),
            (int) ilECSImportManager::getInstance()->_lookupEContentId($this->getId())
        )) {
            return false;
        }
        return true;
    }

References ILIAS\Survey\Mode\getId(), ilECSExportManager\getInstance(), and ilECSImportManager\getInstance().

Here is the call graph for this function:

◆ sendNewContentNotification()

ilRemoteObjectBase::sendNewContentNotification ( $a_server_id )

protected

send notifications about new EContent

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

                                                               : void
    {
        $settings = ilECSSetting::getInstanceByServerId($a_server_id);
        if (!count($settings->getEContentRecipients())) {
            return;
        }
 
        $lang = ilLanguageFactory::_getLanguage();
        $lang->loadLanguageModule('ecs');
 
        $mail = new ilMail(self::MAIL_SENDER);
        $message = $lang->txt('ecs_' . $this->getType() . '_created_body_a') . "\n\n";
        $message .= $lang->txt('title') . ': ' . $this->getTitle() . "\n";
        if ($desc = ($this->getDescription() !== '')) {
            $message .= $lang->txt('desc') . ': ' . $desc . "\n";
        }
 
        $href = ilLink::_getStaticLink($this->getRefId(), $this->getType(), true);
        $message .= $lang->txt("perma_link") . ': ' . $href . "\n\n";
        $message .= ilMail::_getAutoGeneratedMessageString();
 
        $mail->enqueue(
            $settings->getEContentRecipientsAsString(),
            '',
            '',
            $lang->txt('ecs_new_econtent_subject'),
            $message,
            MailAttachments::empty()
        );
    }

References $message, $settings, ilMail\_getAutoGeneratedMessageString(), ilLanguageFactory\_getLanguage(), ilLink\_getStaticLink(), ilECSSetting\getInstanceByServerId(), and ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle().

Here is the call graph for this function:

◆ setLocalInformation()

ilRemoteObjectBase::setLocalInformation ( string $a_info )

set local information

Parameters

string $a_info

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

                                                       : void
    {
        $this->local_information = $a_info;
    }

Referenced by doRead().

Here is the caller graph for this function:

◆ setMID()

ilRemoteObjectBase::setMID ( int $a_mid )

set mid

Parameters

int $a_mid mid

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

                                      : void
    {
        $this->mid = $a_mid;
    }

Referenced by doRead(), and updateFromECSContent().

Here is the caller graph for this function:

◆ setOrganization()

ilRemoteObjectBase::setOrganization ( string $a_organization )

set organization

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

                                                           : void
    {
        $this->organization = $a_organization;
    }

Referenced by doRead(), and updateFromECSContent().

Here is the caller graph for this function:

◆ setRemoteLink()

ilRemoteObjectBase::setRemoteLink ( string $a_link )

set remote link

Parameters

string $a_link link to original object

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

                                                 : void
    {
        $this->remote_link = $a_link;
    }

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_content	object with object settings

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

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

                                                                                       : void
    {
    }

Referenced by updateFromECSContent().

Here is the caller graph for this function:

◆ updateFromECSContent()

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

update remote object settings from ecs content

Parameters

object $a_ecs_content object with object settings

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

                                                                                                     : void
    {
        $this->logger->info('updateFromECSContent: ' . print_r($a_ecs_content, true));
 
        // Get organisation for owner (ObjectListGUI performance)
        $organisation = null;
        if ($a_owner) {
            $organisation = ilECSCommunityReader::getInstanceByServerId($a_server->getServerId())
                ->getParticipantNameByMid($a_owner);
            $this->logger->info('found organisation: ' . $organisation);
        }
 
        $this->setMID($a_owner); // obsolete?
        $this->setOrganization($organisation);
        $this->setTitle($a_ecs_content->title);
        $this->setDescription($a_ecs_content->abstract ?? '');
        $this->setRemoteLink($a_ecs_content->url);
 
        $this->logger->info('updateCustomFromECSContent');
        $this->updateCustomFromECSContent($a_server, $a_ecs_content);
 
        // we are updating late so custom values can be set
 
        $this->logger->info('ilObject->update()');
        $this->update();
 
        $matchable_content = ilECSUtils::getMatchableContent(
            $this->getECSObjectType(),
            $a_server->getServerId(),
            $a_ecs_content,
            $a_owner
        );
 
        // rule-based category mapping
        ilECSCategoryMapping::handleUpdate(
            $this->getId(),
            $a_server->getServerId(),
            $matchable_content
        );
    }