Remote file app class. More...

Inheritance diagram for ilObjRemoteFile:

Collaboration diagram for ilObjRemoteFile:

Public Member Functions
	initType ()

	setVersion ($a_version)
	Set version. More...

	getVersion ()
	get version More...

	setVersionDateTime ($a_tstamp)
	Set version timestamp. More...

	getVersionDateTime ()
	get version timestamp More...

Public Member Functions inherited from ilRemoteObjectBase
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor. More...

	beforeCreate ()

	getRealmPlain ()
	Get realm plain. More...

	setOrganization ($a_organization)
	set organization More...

	getOrganization ()
	get organization More...

	getLocalInformation ()
	get local information More...

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

	getMID ()
	get mid More...

	setMID ($a_mid)
	set mid More...

	setRemoteLink ($a_link)
	set remote link More...

	getRemoteLink ()
	get remote link More...

	getFullRemoteLink ()
	get full remote link Including ecs generated hash and auth mode More...

	createAuthResource ($a_plain_realm)
	create authentication resource on ecs server More...

	doCreate ()
	Create remote object. More...

	doUpdate ()
	Update remote object. More...

	doDelete ()
	Delete remote object. More...

	doRead ()
	read settings More...

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

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

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

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

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

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

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

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

	withReferences ()

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

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

	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	_lookupVersionInfo ($a_obj_id)
	Get version info. More...

Static Public Member Functions inherited from ilRemoteObjectBase
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	DB_TABLE_NAME = "rfil_settings"

Data Fields inherited from ilRemoteObjectBase
const	MAIL_SENDER = 6

const	OBJECT_OWNER = 6

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

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

	getECSObjectType ()

	doCreateCustomFields (array &$a_fields)

	doUpdateCustomFields (array &$a_fields)

	doReadCustomFields ($a_row)

	updateCustomFromECSContent (ilECSSetting $a_server, $a_ecs_content)

Protected Member Functions inherited from ilRemoteObjectBase
	getTableName ()
	Get db table name. More...

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

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

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

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

	importMetadataFromJson ($a_json, ilECSSetting $a_server, array $a_definition, $a_mapping_mode)
	Add advanced metadata to json (export) More...

	updateCustomFromECSContent (ilECSSetting $a_server, $ecs_content)
	update remote object settings from ecs content More...

	sendNewContentNotification ($a_server_id)
	send notifications about new EContent More...

Protected Member Functions inherited from ilObject2
	initType ()

	doRead ()

	doCreate ()

	beforeCreate ()

	doUpdate ()

	beforeUpdate ()

	doMDUpdateListener ($a_element)

	beforeMDUpdateListener ($a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDelete ()

	beforeDelete ()

	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)

	beforeCloneObject ()

Protected Attributes
	$version

	$version_tstamp

Protected Attributes inherited from ilRemoteObjectBase
	$local_information

	$remote_link

	$organization

	$mid

	$auth_hash = ''

	$realm_plain = ''

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Detailed Description

Remote file app class.

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

Version: $Id$

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

Member Function Documentation

◆ _lookupVersionInfo()

static ilObjRemoteFile::_lookupVersionInfo ( $a_obj_id )

static

Get version info.

used in ilRemoteFileListGUI

Parameters

int $a_obj_id

Returns: string

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

References $ilDB, $res, $row, ilDatePresentation\formatDate(), and IL_CAL_UNIX.

Referenced by ilObjRemoteFileListGUI\getProperties().

     {
         global $ilDB;
         
         $set = $ilDB->query("SELECT version, version_tstamp" .
             " FROM " . self::DB_TABLE_NAME .
             " WHERE obj_id = " . $ilDB->quote($a_obj_id, "integer"));
         $row = $ilDB->fetchAssoc($set);
         $res = (int) $row["version"];
         
         if ($row["version_tstamp"]) {
             $res .= " (" . ilDatePresentation::formatDate(new ilDateTime($row["version_tstamp"], IL_CAL_UNIX)) . ")";
         }
         
         return $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doCreateCustomFields()

ilObjRemoteFile::doCreateCustomFields ( array & $a_fields )

protected

Definition at line 77 of file class.ilObjRemoteFile.php.

References array, and time.

     {
         $a_fields["version"] = array("integer", 1);
         $a_fields["version_tstamp"] = array("integer", time());
     }

◆ doReadCustomFields()

ilObjRemoteFile::doReadCustomFields ( $a_row )

protected

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

References setVersion(), and setVersionDateTime().

     {
         $this->setVersion($a_row->version);
         $this->setVersionDateTime($a_row->version_tstamp);
     }

Here is the call graph for this function:

◆ doUpdateCustomFields()

ilObjRemoteFile::doUpdateCustomFields ( array & $a_fields )

protected

Definition at line 83 of file class.ilObjRemoteFile.php.

References array, getVersion(), and getVersionDateTime().

     {
         $a_fields["version"] = array("integer", $this->getVersion());
         $a_fields["version_tstamp"] = array("integer", $this->getVersionDateTime());
     }

Here is the call graph for this function:

◆ getECSObjectType()

ilObjRemoteFile::getECSObjectType ( )

protected

Definition at line 32 of file class.ilObjRemoteFile.php.

     {
         return "/campusconnect/files";
     }

◆ getTableName()

ilObjRemoteFile::getTableName ( )

protected

Definition at line 27 of file class.ilObjRemoteFile.php.

     {
         return self::DB_TABLE_NAME;
     }

◆ getVersion()

ilObjRemoteFile::getVersion ( )

get version

Returns: int

Definition at line 52 of file class.ilObjRemoteFile.php.

References $version.

Referenced by doUpdateCustomFields().

     {
         return $this->version;
     }

Here is the caller graph for this function:

◆ getVersionDateTime()

ilObjRemoteFile::getVersionDateTime ( )

get version timestamp

Returns: int

Definition at line 72 of file class.ilObjRemoteFile.php.

References $version_tstamp.

Referenced by doUpdateCustomFields().

     {
         return $this->version_tstamp;
     }

Here is the caller graph for this function:

◆ initType()

ilObjRemoteFile::initType ( )

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

     {
         $this->type = "rfil";
     }

◆ setVersion()

ilObjRemoteFile::setVersion ( $a_version )

Set version.

Parameters

int $a_version

Definition at line 42 of file class.ilObjRemoteFile.php.

Referenced by doReadCustomFields(), and updateCustomFromECSContent().

     {
         $this->version = (int) $a_version;
     }

Here is the caller graph for this function:

◆ setVersionDateTime()

ilObjRemoteFile::setVersionDateTime ( $a_tstamp )

Set version timestamp.

Parameters

int $a_version

Definition at line 62 of file class.ilObjRemoteFile.php.

Referenced by doReadCustomFields(), and updateCustomFromECSContent().

     {
         $this->version_tstamp = (int) $a_tstamp;
     }

Here is the caller graph for this function:

◆ updateCustomFromECSContent()

ilObjRemoteFile::updateCustomFromECSContent	(	ilECSSetting	$a_server,
			$a_ecs_content
	)

protected

Definition at line 95 of file class.ilObjRemoteFile.php.

References setVersion(), and setVersionDateTime().

     {
         $this->setVersion($a_ecs_content->version);
         $this->setVersionDateTime($a_ecs_content->version_date);
     }

Here is the call graph for this function:

Field Documentation

◆ $version

ilObjRemoteFile::$version

protected

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

Referenced by getVersion().

◆ $version_tstamp

ilObjRemoteFile::$version_tstamp

protected

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

Referenced by getVersionDateTime().

◆ DB_TABLE_NAME

const ilObjRemoteFile::DB_TABLE_NAME = "rfil_settings"

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

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

Modules/RemoteFile/classes/class.ilObjRemoteFile.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _lookupVersionInfo()

◆ doCreateCustomFields()

◆ doReadCustomFields()

◆ doUpdateCustomFields()

◆ getECSObjectType()

◆ getTableName()

◆ getVersion()

◆ getVersionDateTime()

◆ initType()

◆ setVersion()

◆ setVersionDateTime()

◆ updateCustomFromECSContent()

Field Documentation

◆ $version

◆ $version_tstamp

◆ DB_TABLE_NAME