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 (int $a_id=0, bool $a_call_by_reference=true)

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

	cloneMetaData (ilObject $target_obj)

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

Static Public Member Functions inherited from ilRemoteObjectBase
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	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

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Protected Member Functions
	getTableName ()

	getECSObjectType ()

	doCreateCustomFields (array &$a_fields)

	doUpdateCustomFields (array &$a_fields)

	doReadCustomFields ($a_row)

	updateCustomFromECSContent (ilECSSetting $a_server, $ecs_content)

Protected Member Functions inherited from ilRemoteObjectBase
	beforeCreate ()

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

	$version_tstamp

Protected Attributes inherited from ilRemoteObjectBase
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

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 29 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 123 of file class.ilObjRemoteFile.php.

References $ilDB, $res, ilDatePresentation\formatDate(), IL_CAL_UNIX, and ILIAS\Repository\int().

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 91 of file class.ilObjRemoteFile.php.

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

◆ doReadCustomFields()

ilObjRemoteFile::doReadCustomFields ( $a_row )

protected

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

References setVersion(), and setVersionDateTime().

                                                  : void
     {
         $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 97 of file class.ilObjRemoteFile.php.

References getVersion(), and getVersionDateTime().

                                                              : void
     {
         $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 46 of file class.ilObjRemoteFile.php.

                                          : string
     {
         return "/campusconnect/files";
     }

◆ getTableName()

ilObjRemoteFile::getTableName ( )

protected

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

                                      : string
     {
         return self::DB_TABLE_NAME;
     }

◆ getVersion()

ilObjRemoteFile::getVersion ( )

get version

Returns: int

Definition at line 66 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 86 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 36 of file class.ilObjRemoteFile.php.

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

◆ setVersion()

ilObjRemoteFile::setVersion ( $a_version )

Set version.

Parameters

int $a_version

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

References ILIAS\Repository\int().

Referenced by doReadCustomFields(), and updateCustomFromECSContent().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setVersionDateTime()

ilObjRemoteFile::setVersionDateTime ( $a_tstamp )

Set version timestamp.

Parameters

int $a_version

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

References ILIAS\Repository\int().

Referenced by doReadCustomFields(), and updateCustomFromECSContent().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateCustomFromECSContent()

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

protected

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

References setVersion(), and setVersionDateTime().

                                                                                        : void
     {
         $this->setVersion($ecs_content->version);
         $this->setVersionDateTime($ecs_content->version_date);
     }

Here is the call graph for this function:

Field Documentation

◆ $version

ilObjRemoteFile::$version

protected

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

Referenced by getVersion().

◆ $version_tstamp

ilObjRemoteFile::$version_tstamp

protected

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

Referenced by getVersionDateTime().

◆ DB_TABLE_NAME

const ilObjRemoteFile::DB_TABLE_NAME = "rfil_settings"

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

Referenced by ilObjRemoteFileListGUI\getProperties().

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

components/ILIAS/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