ilObjChatroom Class Reference

Class ilObjChatroom. More...

Inheritance diagram for ilObjChatroom:

Collaboration diagram for ilObjChatroom:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=true)
	setAccessVisibility (int $a_value)
	getAccessVisibility ()
	getAccessType ()
	setAccessType (int $access_type)
	getAccessBegin ()
	setAccessBegin (?int $access_begin)
	getAccessEnd ()
	setAccessEnd (?int $access_end)
	update ()
	read ()
	getPersonalInformation (ilChatroomUser $user)
	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...
	cloneObject (int $target_id, int $copy_id=0, bool $omit_tree=false)
	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...
Public Member Functions inherited from ilObject
	__construct (int $id=0, bool $reference=true)
	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 $desc)
	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	_getPublicRefId ()
static	_getPublicObjId ()
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	_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)

Protected Member Functions
	createDefaultRole ()
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)
	beforeMDUpdateListener (string $a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDeleteMetaData ()
	beforeDeleteMetaData ()
	handleAutoRating ()
	hasAutoRating ()

Protected Attributes
int	$access_type = null
int	$access_begin = null
int	$access_end = null
int	$access_visibility = null
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
int	$id
bool	$referenced
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 = ""
bool	$offline = false
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Additional Inherited Members
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

Detailed Description

Class ilObjChatroom.

Author

Jan Posselt <jposselt at databay.de>

Version

$Id$

Definition at line 30 of file class.ilObjChatroom.php.

Constructor & Destructor Documentation

__construct()

ilObjChatroom::__construct	(	int	$id = 0,
		bool	$reference = true
	)

Parameters

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

Reimplemented from ilObject.

Definition at line 37 of file class.ilObjChatroom.php.

    {
        $this->setAccessType(ilObjectActivation::TIMINGS_DEACTIVATED);
 
        $this->type = 'chtr';
        parent::__construct($a_id, $a_call_by_reference);
    }

References ILIAS\GlobalScreen\Provider\__construct(), setAccessType(), and ilObjectActivation\TIMINGS_DEACTIVATED.

Here is the call graph for this function:

Member Function Documentation

_getPublicObjId()

static ilObjChatroom::_getPublicObjId ( )

static

Definition at line 122 of file class.ilObjChatroom.php.

                                            : int
    {
        global $DIC;
 
        $rset = $DIC->database()->query(
            'SELECT object_id FROM chatroom_settings WHERE room_type = ' . $DIC->database()->quote('default', 'text')
        );
        if ($row = $DIC->database()->fetchAssoc($rset)) {
            return (int) $row['object_id'];
        }
 
        return 0;
    }

References $DIC.

Referenced by ilObjChatroomListGUI\__construct().

Here is the caller graph for this function:

_getPublicRefId()

static ilObjChatroom::_getPublicRefId ( )

static

Definition at line 115 of file class.ilObjChatroom.php.

                                            : int
    {
        $settings = new ilSetting('chatroom');
 
        return (int) $settings->get('public_room_ref', '0');
    }

References ILIAS\LTI\ToolProvider\$settings.

Referenced by ilChatUserActionProvider\__construct(), ilChatroom\checkPermissions(), ilChatroomAdminViewGUI\forcePublicRoom(), and ILIAS\Chatroom\Provider\ChatMainBarProvider\getStaticSubItems().

Here is the caller graph for this function:

cloneObject()

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

Definition at line 160 of file class.ilObjChatroom.php.

                                                                                          : ?ilObject
    {
        $original_room = ilChatroom::byObjectId($this->getId());
 
        $newObj = parent::cloneObject($target_id, $copy_id, $omit_tree);
 
        $objId = $newObj->getId();
 
        $original_settings = $original_room->getSettings();
        $room = new ilChatroom();
 
        $original_settings['object_id'] = $objId;
 
        $room->saveSettings($original_settings);
 
        $rbac_log_roles = $this->rbac_review->getParentRoleIds($newObj->getRefId(), false);
        $rbac_log = ilRbacLog::gatherFaPa($newObj->getRefId(), array_keys($rbac_log_roles), true);
        ilRbacLog::add(ilRbacLog::CREATE_OBJECT, $newObj->getRefId(), $rbac_log);
 
        $settings = ilChatroomAdmin::getDefaultConfiguration()->getServerSettings();
        $connector = new ilChatroomServerConnector($settings);
 
        $connector->sendCreatePrivateRoom($room->getRoomId(), 0, $newObj->getOwner(), $newObj->getTitle());
 
        return $newObj;
    }

References $objId, ILIAS\LTI\ToolProvider\$settings, $target_id, ilRbacLog\add(), ilChatroom\byObjectId(), ilRbacLog\CREATE_OBJECT, ilRbacLog\gatherFaPa(), ilChatroomAdmin\getDefaultConfiguration(), and ilObject\getId().

Here is the call graph for this function:

createDefaultRole()

ilObjChatroom::createDefaultRole ( )

protected

Definition at line 150 of file class.ilObjChatroom.php.

                                          : ilObjRole
    {
        return ilObjRole::createDefaultRole(
            'il_chat_moderator_' . $this->getRefId(),
            'Moderator of chat obj_no.' . $this->getId(),
            'il_chat_moderator',
            $this->getRefId()
        );
    }

References ilObjRole\createDefaultRole(), ilObject\getId(), and ilObject\getRefId().

Referenced by initDefaultRoles().

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilObjChatroom::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!!

Returns

bool true if object was removed completely; false if only a references was removed

Reimplemented from ilObject.

Definition at line 187 of file class.ilObjChatroom.php.

                            : bool
    {
        $this->db->manipulateF(
            'DELETE FROM chatroom_users WHERE chatroom_users.room_id IN (SELECT chatroom_settings.room_id FROM chatroom_settings WHERE chatroom_settings.object_id = %s)',
            ['integer'],
            [$this->getId()]
        );
 
        $this->db->manipulateF(
            'DELETE FROM chatroom_history WHERE chatroom_history.room_id IN (SELECT chatroom_settings.room_id FROM chatroom_settings WHERE chatroom_settings.object_id = %s)',
            ['integer'],
            [$this->getId()]
        );
 
        $this->db->manipulateF(
            'DELETE FROM chatroom_bans WHERE chatroom_bans.room_id IN (SELECT chatroom_settings.room_id FROM chatroom_settings WHERE chatroom_settings.object_id = %s)',
            ['integer'],
            [$this->getId()]
        );
 
        $this->db->manipulateF(
            'DELETE FROM chatroom_sessions WHERE chatroom_sessions.room_id IN (SELECT chatroom_settings.room_id FROM chatroom_settings WHERE chatroom_settings.object_id = %s)',
            ['integer'],
            [$this->getId()]
        );
 
        $this->db->manipulateF(
            '
                        DELETE FROM chatroom_proomaccess
                        WHERE chatroom_proomaccess.proom_id IN (
                                SELECT chatroom_prooms.proom_id
                                FROM chatroom_prooms WHERE chatroom_prooms.parent_id IN (
                                        SELECT chatroom_settings.room_id
                                        FROM chatroom_settings
                                        WHERE chatroom_settings.object_id = %s
                                )
                        )',
            ['integer'],
            [$this->getId()]
        );
 
        $this->db->manipulateF(
            '
                        DELETE FROM chatroom_psessions
                        WHERE chatroom_psessions.proom_id IN (
                                SELECT chatroom_prooms.proom_id
                                FROM chatroom_prooms WHERE chatroom_prooms.parent_id IN (
                                        SELECT chatroom_settings.room_id
                                        FROM chatroom_settings
                                        WHERE chatroom_settings.object_id = %s
                                )
                        )',
            ['integer'],
            [$this->getId()]
        );
 
        $this->db->manipulateF(
            'DELETE FROM chatroom_prooms WHERE chatroom_prooms.parent_id IN (SELECT chatroom_settings.room_id FROM chatroom_settings WHERE chatroom_settings.object_id = %s)',
            ['integer'],
            [$this->getId()]
        );
 
        // Finally delete rooms
        $this->db->manipulateF(
            'DELETE FROM chatroom_settings WHERE object_id = %s',
            ['integer'],
            [$this->getId()]
        );
 
        if ($this->ref_id && $this->getId()) {
            ilObjectActivation::deleteAllEntries($this->ref_id);
        }
 
        return parent::delete();
    }

References ilObjectActivation\deleteAllEntries(), and ilObject\getId().

Here is the call graph for this function:

getAccessBegin()

ilObjChatroom::getAccessBegin

(

)

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

                                    : ?int
    {
        return $this->access_begin;
    }

References $access_begin.

Referenced by update().

Here is the caller graph for this function:

getAccessEnd()

ilObjChatroom::getAccessEnd

(

)

Definition at line 75 of file class.ilObjChatroom.php.

                                  : ?int
    {
        return $this->access_end;
    }

References $access_end.

Referenced by update().

Here is the caller graph for this function:

getAccessType()

ilObjChatroom::getAccessType

(

)

Definition at line 55 of file class.ilObjChatroom.php.

                                   : ?int
    {
        return $this->access_type;
    }

References $access_type.

Referenced by read(), and update().

Here is the caller graph for this function:

getAccessVisibility()

ilObjChatroom::getAccessVisibility

(

)

Definition at line 50 of file class.ilObjChatroom.php.

                                         : ?int
    {
        return $this->access_visibility;
    }

References $access_visibility.

Referenced by update().

Here is the caller graph for this function:

getPersonalInformation()

ilObjChatroom::getPersonalInformation

(

ilChatroomUser

$user

)

Definition at line 136 of file class.ilObjChatroom.php.

                                                                : stdClass
    {
        $userInfo = new stdClass();
        $userInfo->username = $user->getUsername();
        $userInfo->id = $user->getUserId();
 
        return $userInfo;
    }

References ilObject\$user.

initDefaultRoles()

ilObjChatroom::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 set up default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example).

Reimplemented from ilObject.

Definition at line 145 of file class.ilObjChatroom.php.

                                      : void
    {
        $this->createDefaultRole();
    }

References createDefaultRole().

Here is the call graph for this function:

read()

ilObjChatroom::read

(

)

Reimplemented from ilObject.

Definition at line 100 of file class.ilObjChatroom.php.

                          : void
    {
        if ($this->referenced && $this->ref_id) {
            $activation = ilObjectActivation::getItem($this->ref_id);
            $this->setAccessType((int) $activation['timing_type']);
            if ($this->getAccessType() === ilObjectActivation::TIMINGS_ACTIVATION) {
                $this->setAccessBegin((int) $activation['timing_start']);
                $this->setAccessEnd((int) $activation['timing_end']);
                $this->setAccessVisibility((int) $activation['visible']);
            }
        }
 
        parent::read();
    }

References getAccessType(), ilObjectActivation\getItem(), setAccessBegin(), setAccessEnd(), setAccessType(), setAccessVisibility(), and ilObjectActivation\TIMINGS_ACTIVATION.

Here is the call graph for this function:

setAccessBegin()

ilObjChatroom::setAccessBegin

(

?int

$access_begin

)

Definition at line 70 of file class.ilObjChatroom.php.

                                                      : void
    {
        $this->access_begin = $access_begin;
    }

References $access_begin.

Referenced by read().

Here is the caller graph for this function:

setAccessEnd()

ilObjChatroom::setAccessEnd

(

?int

$access_end

)

Definition at line 80 of file class.ilObjChatroom.php.

                                                  : void
    {
        $this->access_end = $access_end;
    }

References $access_end.

Referenced by read().

Here is the caller graph for this function:

setAccessType()

ilObjChatroom::setAccessType

(

int

$access_type

)

Definition at line 60 of file class.ilObjChatroom.php.

                                                   : void
    {
        $this->access_type = $access_type;
    }

References $access_type.

Referenced by __construct(), and read().

Here is the caller graph for this function:

setAccessVisibility()

ilObjChatroom::setAccessVisibility

(

int

$a_value

)

Definition at line 45 of file class.ilObjChatroom.php.

                                                     : void
    {
        $this->access_visibility = $a_value;
    }

Referenced by read().

Here is the caller graph for this function:

update()

ilObjChatroom::update

(

)

Reimplemented from ilObject.

Definition at line 85 of file class.ilObjChatroom.php.

                            : bool
    {
        if ($this->referenced && $this->ref_id) {
            $activation = new ilObjectActivation();
            $activation->setTimingType($this->getAccessType());
            $activation->setTimingStart($this->getAccessBegin());
            $activation->setTimingEnd($this->getAccessEnd());
            $activation->toggleVisible((bool) $this->getAccessVisibility());
            $activation->toggleChangeable(true);
            $activation->update($this->ref_id);
        }
 
        return parent::update();
    }

References getAccessBegin(), getAccessEnd(), getAccessType(), and getAccessVisibility().

Here is the call graph for this function:

Field Documentation

$access_begin

int ilObjChatroom::$access_begin = null

protected

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

Referenced by getAccessBegin(), and setAccessBegin().

$access_end

int ilObjChatroom::$access_end = null

protected

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

Referenced by getAccessEnd(), and setAccessEnd().

$access_type

int ilObjChatroom::$access_type = null

protected

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

Referenced by getAccessType(), and setAccessType().

$access_visibility

int ilObjChatroom::$access_visibility = null

protected

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

Referenced by getAccessVisibility().

---

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

• Modules/Chatroom/classes/class.ilObjChatroom.php