ilObjChatroom Class Reference

Class ilObjChatroom. More...

Inheritance diagram for ilObjChatroom:

Collaboration diagram for ilObjChatroom:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	{} More...
	setAccessVisibility ($a_value)
	getAccessVisibility ()
	getAccessType ()
	setAccessType ($access_type)
	getAccessBegin ()
	setAccessBegin ($access_begin)
	getAccessEnd ()
	setAccessEnd ($access_end)
	update ()
	read ()
	getPersonalInformation (ilChatroomUser $user)
	Prepares and returns $userInfo using given $user object. More...
	initDefaultRoles ()
	{} More...
	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	{} More...
	delete ()
	{} More...
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	_getPublicRefId ()
static	_getPublicObjId ()
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...

Protected Member Functions
	createDefaultRole ()

Protected Attributes
	$access_type
	$access_begin
	$access_end
	$access_visibility
Protected Attributes inherited from ilObject
	$objDefinition
	$db
	$log
	$error
	$tree
	$app_event_handler
	$rbacadmin
	$rbacreview

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

Detailed Description

Class ilObjChatroom.

Author

Jan Posselt <jposselt at databay.de>

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilObjChatroom::__construct	(		$a_id = 0,
			$a_call_by_reference = true
	)

{}

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

References setAccessType(), and ilObjectActivation\TIMINGS_DEACTIVATED.

    {
        $this->setAccessType(ilObjectActivation::TIMINGS_DEACTIVATED);

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

Here is the call graph for this function:

Member Function Documentation

_getPublicObjId()

static ilObjChatroom::_getPublicObjId ( )

static

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

References $DIC, and $row.

Referenced by ilObjChatroomListGUI\__construct().

    {
        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 $row['object_id'];
        }
        return 0;
    }

Here is the caller graph for this function:

_getPublicRefId()

static ilObjChatroom::_getPublicRefId ( )

static

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

Referenced by ilChatUserActionProvider\__construct(), ilUsersOnlineBlockGUI\__showChatInvitation(), ilChatroom\checkPermissions(), ilUsersOnlineBlockGUI\fillRow(), ilChatroomAdminViewGUI\forcePublicRoom(), and ilOnScreenChatMenuGUI\init().

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

Here is the caller graph for this function:

cloneObject()

ilObjChatroom::cloneObject	(		$a_target_id,
			$a_copy_id = 0,
			$a_omit_tree = false
	)

{}

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

References $DIC, ilRbacLog\add(), ilChatroom\byObjectId(), ilRbacLog\CREATE_OBJECT, ilRbacLog\gatherFaPa(), ilChatroomAdmin\getDefaultConfiguration(), and ilObject\getId().

    {
        global $DIC;

        require_once 'Modules/Chatroom/classes/class.ilChatroom.php';
        $original_room = ilChatroom::byObjectId($this->getId());

        $newObj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);

        $objId = $newObj->getId();

        $original_settings = $original_room->getSettings();
        $room              = new ilChatroom();

        $original_settings['object_id'] = $objId;

        $room->saveSettings($original_settings);

        include_once "Services/AccessControl/classes/class.ilRbacLog.php";
        $rbac_log_roles = $DIC->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);

        require_once 'Modules/Chatroom/classes/class.ilChatroomServerConnector.php';
        require_once 'Modules/Chatroom/classes/class.ilChatroomServerSettings.php';
        require_once 'Modules/Chatroom/classes/class.ilChatroomAdmin.php';

        $settings  = ilChatroomAdmin::getDefaultConfiguration()->getServerSettings();
        $connector = new ilChatroomServerConnector($settings);

        $connector->sendCreatePrivateRoom($room->getRoomId(), 0, $newObj->getOwner(), $newObj->getTitle());

        return $newObj;
    }

Here is the call graph for this function:

createDefaultRole()

ilObjChatroom::createDefaultRole ( )

protected

Returns

ilObjRole

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

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

Referenced by initDefaultRoles().

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

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilObjChatroom::delete

(

)

{}

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

References $DIC, array, ilObjectActivation\deleteAllEntries(), and ilObject\getId().

    {
        global $DIC;

        $DIC->database()->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)',
            array('integer'),
            array($this->getId())
        );

        $DIC->database()->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)',
            array('integer'),
            array($this->getId())
        );

        $DIC->database()->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)',
            array('integer'),
            array($this->getId())
        );

        $DIC->database()->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)',
            array('integer'),
            array($this->getId())
        );

        $DIC->database()->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
                                )
                        )',
            array('integer'),
            array($this->getId())
        );

        $DIC->database()->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
                                )
                        )',
            array('integer'),
            array($this->getId())
        );

        $DIC->database()->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)',
            array('integer'),
            array($this->getId())
        );

        // Finally delete rooms
        $DIC->database()->manipulateF(
            'DELETE FROM chatroom_settings WHERE object_id = %s',
            array('integer'),
            array($this->getId())
        );

        if ($this->getId()) {
            if ($this->ref_id) {
                ilObjectActivation::deleteAllEntries($this->ref_id);
            }
        }

        return parent::delete();
    }

Here is the call graph for this function:

getAccessBegin()

ilObjChatroom::getAccessBegin

(

)

Returns

int

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

References $access_begin.

Referenced by update().

    {
        return $this->access_begin;
    }

Here is the caller graph for this function:

getAccessEnd()

ilObjChatroom::getAccessEnd

(

)

Returns

int

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

References $access_end.

Referenced by update().

    {
        return $this->access_end;
    }

Here is the caller graph for this function:

getAccessType()

ilObjChatroom::getAccessType

(

)

Returns

int

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

References $access_type.

Referenced by read(), and update().

    {
        return $this->access_type;
    }

Here is the caller graph for this function:

getAccessVisibility()

ilObjChatroom::getAccessVisibility

(

)

Returns

int

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

References $access_visibility.

Referenced by update().

    {
        return $this->access_visibility;
    }

Here is the caller graph for this function:

getPersonalInformation()

ilObjChatroom::getPersonalInformation

(

ilChatroomUser

$user

)

Prepares and returns $userInfo using given $user object.

Parameters

ilChatroomUser

$user

Returns

stdClass

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

References ilChatroomUser\getUserId(), and ilChatroomUser\getUsername().

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

        return $userInfo;
    }

Here is the call graph for this function:

initDefaultRoles()

ilObjChatroom::initDefaultRoles

(

)

{}

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

References array, and createDefaultRole().

    {
        include_once './Services/AccessControl/classes/class.ilObjRole.php';

        $role = $this->createDefaultRole();

        return array();
    }

Here is the call graph for this function:

read()

ilObjChatroom::read

(

)

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

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

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

        parent::read();
    }

Here is the call graph for this function:

setAccessBegin()

ilObjChatroom::setAccessBegin

(

$access_begin

)

Parameters

int

$access_begin

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

References $access_begin.

Referenced by read().

    {
        $this->access_begin = $access_begin;
    }

Here is the caller graph for this function:

setAccessEnd()

ilObjChatroom::setAccessEnd

(

$access_end

)

Parameters

int

$access_end

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

References $access_end.

Referenced by read().

    {
        $this->access_end = $access_end;
    }

Here is the caller graph for this function:

setAccessType()

ilObjChatroom::setAccessType

(

$access_type

)

Parameters

int

$access_type

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

References $access_type.

Referenced by __construct(), and read().

    {
        $this->access_type = $access_type;
    }

Here is the caller graph for this function:

setAccessVisibility()

ilObjChatroom::setAccessVisibility

(

$a_value

)

Parameters

int

$a_value

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

Referenced by read().

    {
        $this->access_visibility = (bool) $a_value;
    }

Here is the caller graph for this function:

update()

ilObjChatroom::update

(

)

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

References getAccessBegin(), getAccessEnd(), getAccessType(), getAccessVisibility(), and League\Flysystem\Adapter\Polyfill\update().

    {
        if ($this->ref_id) {
            $activation = new ilObjectActivation();
            $activation->setTimingType($this->getAccessType());
            $activation->setTimingStart($this->getAccessBegin());
            $activation->setTimingEnd($this->getAccessEnd());
            $activation->toggleVisible($this->getAccessVisibility());
            $activation->update($this->ref_id);
        }

        return parent::update();
    }

Here is the call graph for this function:

Field Documentation

$access_begin

ilObjChatroom::$access_begin

protected

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

Referenced by getAccessBegin(), and setAccessBegin().

$access_end

ilObjChatroom::$access_end

protected

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

Referenced by getAccessEnd(), and setAccessEnd().

$access_type

ilObjChatroom::$access_type

protected

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

Referenced by getAccessType(), and setAccessType().

$access_visibility

ilObjChatroom::$access_visibility

protected

Definition at line 33 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