Remote wiki app class. More...

Inheritance diagram for ilObjRemoteWiki:

Collaboration diagram for ilObjRemoteWiki:

Public Member Functions
	initType ()

	setAvailabilityType ($a_type)
	Set Availability type. More...

	getAvailabilityType ()
	get availability type 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 @access public. More...

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

	read ($a_force_db=false)
	Read data from db. More...

	getId ()
	get object id @access public More...

	setId ($a_id)
	set object id @access public More...

	setRefId ($a_id)
	set reference id @access public More...

	getRefId ()
	get reference id @access public More...

	getType ()
	get object type @access public More...

	setType ($a_type)
	set object type @access public More...

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

	getTitle ()
	get object title @access public More...

	getUntranslatedTitle ()
	get untranslated object title @access public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

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

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date @access public More...

	getLastUpdateDate ()
	get last update date @access public More...

	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class) More...

	create ($a_clone_mode=false)

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

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

	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

	_lookupOwner ($a_id)
	lookup object owner More...

	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

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

	setPermissions ($a_parent_ref)
	set permissions of object More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object More...

	delete ()
	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) @access public More...

	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

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

	cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)
	Clone object permissions, put in tree ... More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor @access public. More...

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

	read ($a_force_db=false)
	read object data from db into object More...

	getId ()
	get object id @access public More...

	setId ($a_id)
	set object id @access public More...

	setRefId ($a_id)
	set reference id @access public More...

	getRefId ()
	get reference id @access public More...

	getType ()
	get object type @access public More...

	setType ($a_type)
	set object type @access public More...

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

	getTitle ()
	get object title @access public More...

	getUntranslatedTitle ()
	get untranslated object title @access public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

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

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date @access public More...

	getLastUpdateDate ()
	get last update date @access public More...

	getDiskUsage ()

	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class) 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...

	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

	_lookupOwner ($a_id)
	lookup object owner More...

	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type 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) @access public More...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts. 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...

	_lookupCreationDate ($a_id)
	Lookup creation date. 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	_lookupOnline ($a_obj_id)
	Lookup online. More...

static	_lookupMID ($a_obj_id)

static	_lookupOrganization ($a_obj_id)

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

static	_lookupOrganization ($a_obj_id, $a_table)
	lookup organization More...

static	_lookupMID ($a_obj_id, $a_table)
	lookup owner mid More...

Static Public Member Functions inherited from ilObject2
static	_lookupObjIdByImportId ($a_import_id)

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupObjId ($a_id)

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_exists ($a_id, $a_reference=false)

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type)

static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupObjId ($a_id)

static	setDeletedDates ($a_ref_ids)
	Set deleted date @global type $ilDB. More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

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

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields
const	DB_TABLE_NAME = "rwik_settings"

const	ACTIVATION_OFFLINE = 0

const	ACTIVATION_ONLINE = 1

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

	$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

	$obj_data_record
	object_data record More...

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

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

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

Protected Attributes inherited from ilRemoteObjectBase
	$local_information

	$remote_link

	$organization

	$mid

	$auth_hash = ''

	$realm_plain = ''

Detailed Description

Remote wiki 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.ilObjRemoteWiki.php.

Member Function Documentation

◆ _lookupMID()

static ilObjRemoteWiki::_lookupMID ( $a_obj_id )

static

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

        {
                return ilRemoteObjectBase::_lookupMID($a_obj_id, self::DB_TABLE_NAME);
        }

References ilRemoteObjectBase\_lookupMID().

Here is the call graph for this function:

◆ _lookupOnline()

static ilObjRemoteWiki::_lookupOnline ( $a_obj_id )

static

Lookup online.

Parameters

int $a_obj_id obj_id

Returns: bool

Definition at line 65 of file class.ilObjRemoteWiki.php.

        {
                global $ilDB;
                
                $query = "SELECT * FROM ".self::DB_TABLE_NAME.
                        " WHERE obj_id = ".$ilDB->quote($a_obj_id ,'integer')." ";
                $res = $ilDB->query($query);
                $row = $res->fetchRow(DB_FETCHMODE_OBJECT);
                switch($row->availability_type)
                {
                        case self::ACTIVATION_ONLINE:
                                return true;
                                
                        case self::ACTIVATION_OFFLINE:
                                return false;
                
                        default:
                                return false;
                }
                
                return false;
        }

References $ilDB, $query, $res, $row, ACTIVATION_OFFLINE, ACTIVATION_ONLINE, and DB_FETCHMODE_OBJECT.

Referenced by ilObjRemoteWikiAccess\_checkAccess(), and ilObjRemoteWikiListGUI\getProperties().

Here is the caller graph for this function:

◆ _lookupOrganization()

static ilObjRemoteWiki::_lookupOrganization ( $a_obj_id )

static

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

        {
                return ilRemoteObjectBase::_lookupOrganization($a_obj_id, self::DB_TABLE_NAME);
        }

References ilRemoteObjectBase\_lookupOrganization().

Referenced by ilObjRemoteWikiListGUI\getProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doCreateCustomFields()

ilObjRemoteWiki::doCreateCustomFields ( array & $a_fields )

protected

Add custom fields to db insert.

Parameters

array $a_fields

Reimplemented from ilRemoteObjectBase.

Definition at line 88 of file class.ilObjRemoteWiki.php.

        {
                $a_fields["availability_type"] = array("integer", 0);   
        }

◆ doReadCustomFields()

ilObjRemoteWiki::doReadCustomFields ( $a_row )

protected

Read custom fields from db row.

Parameters

object $a_row

Reimplemented from ilRemoteObjectBase.

Definition at line 98 of file class.ilObjRemoteWiki.php.

        {                               
                $this->setAvailabilityType($a_row->availability_type);
        }

References setAvailabilityType().

Here is the call graph for this function:

◆ doUpdateCustomFields()

ilObjRemoteWiki::doUpdateCustomFields ( array & $a_fields )

protected

Add custom fields to db update.

Parameters

array $a_fields

Reimplemented from ilRemoteObjectBase.

Definition at line 93 of file class.ilObjRemoteWiki.php.

        {               
                $a_fields["availability_type"] = array("integer", $this->getAvailabilityType());                        
        }

References getAvailabilityType().

Here is the call graph for this function:

◆ getAvailabilityType()

ilObjRemoteWiki::getAvailabilityType ( )

get availability type

Returns: int

Definition at line 54 of file class.ilObjRemoteWiki.php.

        {
                return $this->availability_type;
        }

References $availability_type.

Referenced by doUpdateCustomFields().

Here is the caller graph for this function:

◆ getECSObjectType()

ilObjRemoteWiki::getECSObjectType ( )

protected

Get ECS resource identifier, e.g.

"/campusconnect/courselinks"

Returns: string

Reimplemented from ilRemoteObjectBase.

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

        {
                return "/campusconnect/wikis";
        }

◆ getTableName()

ilObjRemoteWiki::getTableName ( )

protected

Get db table name.

Returns: string

Reimplemented from ilRemoteObjectBase.

Definition at line 29 of file class.ilObjRemoteWiki.php.

        {
                return self::DB_TABLE_NAME;
        }

References DB_TABLE_NAME.

◆ initType()

ilObjRemoteWiki::initType ( )

Reimplemented from ilObject2.

Definition at line 24 of file class.ilObjRemoteWiki.php.

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

◆ setAvailabilityType()

ilObjRemoteWiki::setAvailabilityType ( $a_type )

Set Availability type.

Parameters

int $a_type availability type

Definition at line 44 of file class.ilObjRemoteWiki.php.

        {
                $this->availability_type = $a_type;
        }

Referenced by doReadCustomFields(), and updateCustomFromECSContent().

Here is the caller graph for this function:

◆ updateCustomFromECSContent()

ilObjRemoteWiki::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 from ilRemoteObjectBase.

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

        {                               
                $this->setAvailabilityType($a_ecs_content->availability == 'online' ? self::ACTIVATION_ONLINE : self::ACTIVATION_OFFLINE);                              
        }

References setAvailabilityType().

Here is the call graph for this function:

Field Documentation

◆ $availability_type

ilObjRemoteWiki::$availability_type

protected

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

Referenced by getAvailabilityType().

◆ ACTIVATION_OFFLINE

const ilObjRemoteWiki::ACTIVATION_OFFLINE = 0

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

Referenced by _lookupOnline(), ilObjRemoteWikiGUI\addCustomEditForm(), and ilObjRemoteWikiGUI\availabilityToString().

◆ ACTIVATION_ONLINE

const ilObjRemoteWiki::ACTIVATION_ONLINE = 1

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

Referenced by _lookupOnline(), ilObjRemoteWikiGUI\addCustomEditForm(), and ilObjRemoteWikiGUI\availabilityToString().

◆ DB_TABLE_NAME

const ilObjRemoteWiki::DB_TABLE_NAME = "rwik_settings"

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

Referenced by getTableName().

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

Modules/RemoteWiki/classes/class.ilObjRemoteWiki.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ _lookupMID()

◆ _lookupOnline()

◆ _lookupOrganization()

◆ doCreateCustomFields()

◆ doReadCustomFields()

◆ doUpdateCustomFields()

◆ getAvailabilityType()

◆ getECSObjectType()

◆ getTableName()

◆ initType()

◆ setAvailabilityType()

◆ updateCustomFromECSContent()

Field Documentation

◆ $availability_type

◆ ACTIVATION_OFFLINE

◆ ACTIVATION_ONLINE

◆ DB_TABLE_NAME