ilObjGroup Class Reference

Class ilObjGroup. More...

Inheritance diagram for ilObjGroup:

Collaboration diagram for ilObjGroup:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...
	setInformation ($a_information)
	set information More...
	getInformation ()
	get Information More...
	setGroupType ($a_type)
	set group type More...
	getGroupType ()
	get group type More...
	isGroupTypeModified ($a_old_type)
	check if group type is modified More...
	setRegistrationType ($a_type)
	set registration type More...
	getRegistrationType ()
	get registration type More...
	isRegistrationEnabled ()
	is registration enabled More...
	enableUnlimitedRegistration ($a_status)
	enable unlimited registration More...
	isRegistrationUnlimited ()
	is registration unlimited More...
	setRegistrationStart ($a_start)
	set registration start More...
	getRegistrationStart ()
	get registration start More...
	setRegistrationEnd ($a_end)
	set registration end More...
	getRegistrationEnd ()
	get registration end More...
	setPassword ($a_pass)
	set password More...
	getPassword ()
	get password More...
	enableMembershipLimitation ($a_status)
	enable max member limitation More...
	isMembershipLimited ()
	is max member limited More...
	setMaxMembers ($a_max)
	set max members More...
	getMaxMembers ()
	get max members More...
	enableWaitingList ($a_status)
	enable waiting list More...
	isWaitingListEnabled ()
	is waiting list enabled More...
	setLatitude ($a_latitude)
	Set Latitude. More...
	getLatitude ()
	Get Latitude. More...
	setLongitude ($a_longitude)
	Set Longitude. More...
	getLongitude ()
	Get Longitude. More...
	setLocationZoom ($a_locationzoom)
	Set LocationZoom. More...
	getLocationZoom ()
	Get LocationZoom. More...
	setEnableGroupMap ($a_enablemap)
	Set Enable Group Map. More...
	getEnableGroupMap ()
	Get Enable Group Map. More...
	getRegistrationAccessCode ()
	get access code More...
	setRegistrationAccessCode ($a_code)
	Set refistration access code. More...
	isRegistrationAccessCodeEnabled ()
	Check if access code is enabled. More...
	enableRegistrationAccessCode ($a_status)
	En/disable registration access code. More...
	setMailToMembersType ($a_type)
	Set mail to members type. More...
	getMailToMembersType ()
	Get mail to members type. More...
	validate ()
	validate group settings More...
	create ()
	Create group. More...
	update ()
	Update group. More...
	delete ()
	delete group and all related data More...
	read ()
	Read group. More...
	cloneObject ($a_target_id, $a_copy_id=0)
	Clone group (no member data) More...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies (crs items, preconditions) More...
	cloneAutoGeneratedRoles ($new_obj)
	Clone group admin and member role permissions. More...
	join ($a_user_id, $a_mem_role="")
	join Group, assigns user to role private More...
	getDefaultMemberRole ()
	returns object id of created default member role public More...
	getDefaultAdminRole ()
	returns object id of created default adminstrator role public More...
	addMember ($a_user_id, $a_mem_role)
	add Member to Group public More...
	leaveGroup ()
	is called when a member decides to leave group public More...
	leave ($a_user_id)
	deassign member from group role private More...
	getGroupMemberIds ()
	get all group Member ids regardless of role public More...
	getGroupMemberData ($a_mem_ids, $active=1)
	get all group Members regardless of group role. More...
	getCountMembers ()
	getGroupAdminIds ($a_grpId="")
	get Group Admin Id public More...
	getDefaultGroupRoles ($a_grp_id="")
	get default group roles, returns the defaultlike create roles il_grp_member, il_grp_admin public More...
	getLocalGroupRoles ($a_translate=false)
	get ALL local roles of group, also those created and defined afterwards only fetch data once from database. More...
	getGrpStatusClosedTemplateId ()
	get group status closed template public More...
	getGrpStatusOpenTemplateId ()
	get group status open template public More...
	updateGroupType ()
	Change group type. More...
	initGroupStatus ($a_grpStatus=GRP_TYPE_PUBLIC)
	set group status More...
	setGroupStatus ($a_status)
	Set group status. More...
	getGroupStatus ()
	get group status More...
	readGroupStatus ()
	get group status, redundant method because public More...
	getMemberRoles ($a_user_id)
	get group member status public More...
	isAdmin ($a_userId)
	is Admin public More...
	initDefaultRoles ()
	init default roles settings 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 happend, each object may decide how it reacts. More...
	exportXML ()
	deleteExportFiles ($a_files)
	downloadExportFile ($file)
	_lookupIdByTitle ($a_title)
	_isMember ($a_user_id, $a_ref_id, $a_field='')
	_getMembers ($a_obj_id)
	getViewMode ($a_translate_inherit=true)
	get view mode More...
	setViewMode ($a_view_mode)
	Set group view mode. More...
	addAdditionalSubItemInformation (&$a_item_data)
	Add additional information to sub item, e.g. More...
	__initFileObject ()
	getMessage ()
	setMessage ($a_message)
	appendMessage ($a_message)
	register ($a_user_id, $a_role=IL_GRP_MEMBER, $a_force_registration=false)
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor 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 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 ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...
	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...
	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) 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...
Public Member Functions inherited from ilContainer
	ilContainer ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...
	createContainerDirectory ()
	Create directory for the container. More...
	getContainerDirectory ()
	Get the container directory. More...
	_getContainerDirectory ($a_id)
	Get the container directory. More...
	getBigIconPath ()
	Get path for big icon. More...
	getSmallIconPath ()
	Get path for small icon. More...
	getTinyIconPath ()
	Get path for tiny icon. More...
	getCustomIconPath ()
	Get path for custom icon. More...
	setHiddenFilesFound ($a_hiddenfilesfound)
	Set Found hidden files (set by getSubItems). More...
	getHiddenFilesFound ()
	Get Found hidden files (set by getSubItems). More...
	getStyleSheetId ()
	get ID of assigned style sheet object More...
	setStyleSheetId ($a_style_id)
	set ID of assigned style sheet object More...
	_lookupContainerSetting ($a_id, $a_keyword, $a_default_value=NULL)
	Lookup a container setting. More...
	_writeContainerSetting ($a_id, $a_keyword, $a_value)
	_lookupIconPath ($a_id, $a_size="big")
	lookup icon path More...
	saveIcons ($a_custom_icon)
	save container icons More...
	removeCustomIcon ()
	remove small icon More...
	cloneObject ($a_target_id, $a_copy_id=0)
	Clone container settings. More...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies (container sorting) More...
	cloneAllObject ($session_id, $client_id, $new_type, $ref_id, $clone_source, $options, $soap_call=false)
	clone all objects according to this container More...
	getViewMode ()
	Get container view mode. More...
	getOrderType ()
	Get order type default implementation. More...
	setOrderType ($a_value)
	getSubItems ($a_admin_panel_enabled=false, $a_include_side_block=false, $a_get_single=0)
	Get subitems of container. More...
	gotItems ()
	Check whether we got any items. More...
	addAdditionalSubItemInformation (&$object)
	Add additional information to sub item, e.g. More...
	getGroupedObjTypes ()
	Get grouped repository object types. More...
	enablePageEditing ()
	Check whether page editing is allowed for container. More...
	create ()
	Create. More...
	update ()
	Update. More...
	read ()
	read More...
Public Member Functions inherited from ilMembershipRegistrationCodes
	register ($a_user_id)
	Register an user. More...

Static Public Member Functions
static	lookupGroupTye ($a_id)
	Lookup group type. More...
static	lookupGroupStatusTemplateId ($a_obj_id)
	$ilDB $ilDB More...
	_importFromXMLString ($xml, $parent_id)
	Static used for importing a group from xml string. More...
	_importFromFile ($file, $parent_id)
	Static used for importing an group from xml zip file. More...
static	lookupViewMode ($a_obj_id)
	lookup view mode $ilDB More...
static	lookupObjectsByCode ($a_code)
Static Public Member Functions inherited from ilObject
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	setDeletedDates ($a_ref_ids)
	Set deleted date 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 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	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...
Static Public Member Functions inherited from ilContainer
static	_getContainerSettings ($a_id)
static	_deleteContainerSettings ($a_id, $a_keyword=null, $a_keyword_like=false)
static	_exportContainerSettings (ilXmlWriter $a_xml, $a_obj_id)
static	getCompleteDescriptions (array $objects)
	overwrites description fields to long or short description in an assoc array keys needed (obj_id and description) More...

Data Fields
const	CAL_REG_START = 1
const	CAL_REG_END = 2
const	GRP_MEMBER = 1
const	GRP_ADMIN = 2
const	ERR_MISSING_TITLE = 'msg_no_title'
const	ERR_MISSING_GROUP_TYPE = 'grp_missing_grp_type'
const	ERR_MISSING_PASSWORD = 'grp_missing_password'
const	ERR_WRONG_MAX_MEMBERS = 'grp_wrong_max_members'
const	ERR_WRONG_REG_TIME_LIMIT = 'grp_wrong_reg_time_limit'
const	MAIL_ALLOWED_ALL = 1
const	MAIL_ALLOWED_TUTORS = 2
	$members_obj
	$file_obj = null
	Group file object for handling of export files. More...
	$m_grpStatus
	$m_roleMemberId
	$m_roleAdminId
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...
Data Fields inherited from ilContainer
const	VIEW_SESSIONS = 0
const	VIEW_OBJECTIVE = 1
const	VIEW_TIMING = 2
const	VIEW_ARCHIVE = 3
const	VIEW_SIMPLE = 4
const	VIEW_BY_TYPE = 5
const	VIEW_INHERIT = 6
const	VIEW_ILINC = 7
const	VIEW_DEFAULT = self::VIEW_BY_TYPE
const	SORT_TITLE = 0
const	SORT_MANUAL = 1
const	SORT_ACTIVATION = 2
const	SORT_INHERIT = 3
const	SORT_CREATION = 4
const	SORT_DIRECTION_ASC = 0
const	SORT_DIRECTION_DESC = 1
const	SORT_NEW_ITEMS_POSITION_TOP = 0
const	SORT_NEW_ITEMS_POSITION_BOTTOM = 1
const	SORT_NEW_ITEMS_ORDER_TITLE = 0
const	SORT_NEW_ITEMS_ORDER_CREATION = 1
const	SORT_NEW_ITEMS_ORDER_ACTIVATION = 2

Protected Member Functions
	prepareAppointments ($a_mode='create')
	Prepare calendar appointments. More...
	initParticipants ()
	init participants object More...

Static Protected Member Functions
static	translateViewMode ($a_obj_id, $a_view_mode, $a_ref_id=null)
	translate view mode More...

Protected Attributes
	$information
	$group_type = null
	$reg_type = GRP_REGISTRATION_DIRECT
	$reg_enabled = true
	$reg_unlimited = true
	$reg_start = null
	$reg_end = null
	$reg_password = ''
	$reg_membership_limitation = false
	$reg_max_members = 0
	$waiting_list = false
Protected Attributes inherited from ilContainer
	$order_type = 0
	$hiddenfilesfound = false

Private Attributes
	$latitude = ''
	$longitude = ''
	$locationzoom = 0
	$enablemap = 0
	$reg_access_code = ''
	$reg_access_code_enabled = false
	$view_mode = NULL
	$mail_members = self::MAIL_ALLOWED_ALL

Additional Inherited Members
Static Public Attributes inherited from ilContainer
static	$data_preloaded = false

Detailed Description

Class ilObjGroup.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

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

Constructor public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

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

References ilObject\ilObject(), and ilObject\setRegisterMode().

        {
                global $tree;

                $this->tree =& $tree;

                $this->type = "grp";
                $this->ilObject($a_id,$a_call_by_reference);
                $this->setRegisterMode(true); // ???
        }

Here is the call graph for this function:

Member Function Documentation

__initFileObject()

ilObjGroup::__initFileObject

(

)

Definition at line 1824 of file class.ilObjGroup.php.

References $file_obj.

Referenced by deleteExportFiles(), downloadExportFile(), and exportXML().

        {
                if($this->file_obj)
                {
                        return $this->file_obj;
                }
                else
                {
                        include_once './Modules/Group/classes/class.ilFileDataGroup.php';

                        return $this->file_obj = new ilFileDataGroup($this);
                }
        }

Here is the caller graph for this function:

_getMembers()

ilObjGroup::_getMembers

(

$a_obj_id

)

Definition at line 1694 of file class.ilObjGroup.php.

References ilObject\$ref_id, and ilObject\_getAllReferences().

Referenced by _isMember(), and ilLPStatusManualByTutor\getMembers().

        {
                global $rbacreview;

                // get reference
                $ref_ids = ilObject::_getAllReferences($a_obj_id);
                $ref_id = current($ref_ids);

                $local_roles = $rbacreview->getRolesOfRoleFolder($ref_id,false);

                $users = array();
                foreach($local_roles as $role_id)
                {
                        $users = array_merge($users,$rbacreview->assignedUsers($role_id));
                }

                return array_unique($users);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

_importFromFile()

ilObjGroup::_importFromFile (   $file,   $parent_id  )

static

Static used for importing an group from xml zip file.

Parameters

xml	file array structure like $_FILE from upload public

Definition at line 1612 of file class.ilObjGroup.php.

References ilObject\$lng, and _importFromXMLString().

Referenced by ilObjGroupGUI\importFileObject2().

        {
                global $lng;

                include_once './Modules/Group/classes/class.ilFileDataGroup.php';

                $file_obj = new ilFileDataGroup(null);
                $file_obj->addImportDirectory();
                $file_obj->createImportFile($_FILES["xmldoc"]["tmp_name"],$_FILES['xmldoc']['name']);
                $file_obj->unpackImportFile();

                if(!$file_obj->validateImportFile())
                {
                        return false;
                }
                return ilObjGroup::_importFromXMLString(file_get_contents($file_obj->getImportFile()),$parent_id);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

_importFromXMLString()

ilObjGroup::_importFromXMLString (   $xml,   $parent_id  )

static

Static used for importing a group from xml string.

Parameters

xml	string public

Definition at line 1596 of file class.ilObjGroup.php.

Referenced by _importFromFile().

        {
                include_once 'Modules/Group/classes/class.ilGroupXMLParser.php';

                $import_parser = new ilGroupXMLParser($xml,$parent_id);

                return $import_parser->startParsing();
        }

Here is the caller graph for this function:

_isMember()

ilObjGroup::_isMember	(		$a_user_id,
			$a_ref_id,
			$a_field = ''
	)

Definition at line 1645 of file class.ilObjGroup.php.

References $ilDB, $query, $res, _getMembers(), ilObjectFactory\getInstanceByObjId(), and ilUtil\quoteArray().

Referenced by ilObjCourseGrouping\_checkGroupingDependencies().

        {
                global $rbacreview,$ilObjDataCache,$ilDB;

                $local_roles = $rbacreview->getRolesOfRoleFolder($a_ref_id,false);
                $user_roles = $rbacreview->assignedRoles($a_user_id);

                // Used for membership limitations -> check membership by given field
                if($a_field)
                {
                        include_once './Services/User/classes/class.ilObjUser.php';

                        $tmp_user =& ilObjectFactory::getInstanceByObjId($a_user_id);
                        switch($a_field)
                        {
                                case 'login':
                                        $and = "AND login = '".$tmp_user->getLogin()."' ";
                                        break;
                                case 'email':
                                        $and = "AND email = '".$tmp_user->getEmail()."' ";
                                        break;
                                case 'matriculation':
                                        $and = "AND matriculation = '".$tmp_user->getMatriculation()."' ";
                                        break;

                                default:
                                        $and = "AND usr_id = '".$a_user_id."'";
                                        break;
                        }
                        if(!$members = ilObjGroup::_getMembers($ilObjDataCache->lookupObjId($a_ref_id)))
                        {
                                return false;
                        }
                        $query = "SELECT * FROM usr_data as ud ".
                                "WHERE usr_id IN (".implode(",",ilUtil::quoteArray($members)).") ".
                                $and;
                        $res = $ilDB->query($query);

                        return $res->numRows() ? true : false;
                }

                if (!array_intersect($local_roles,$user_roles))
                {
                        return false;
                }

                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupIdByTitle()

ilObjGroup::_lookupIdByTitle

(

$a_title

)

Definition at line 1630 of file class.ilObjGroup.php.

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

Referenced by ilMail\getEmailsOfRecipients(), and ilMail\getUserIds().

        {
                global $ilDB;

                $query = "SELECT * FROM object_data WHERE title = ".
                        $ilDB->quote($a_title ,'text')." AND type = 'grp'";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return $row->obj_id;
                }
                return 0;
        }

Here is the caller graph for this function:

addAdditionalSubItemInformation()

ilObjGroup::addAdditionalSubItemInformation

(

&

$a_item_data

)

Add additional information to sub item, e.g.

used in courses for timings information etc.

Definition at line 1817 of file class.ilObjGroup.php.

References ilObjectActivation\addAdditionalSubItemInformation().

        {               
                include_once './Services/Object/classes/class.ilObjectActivation.php';
                ilObjectActivation::addAdditionalSubItemInformation($a_item_data);
        }       

Here is the call graph for this function:

addMember()

ilObjGroup::addMember	(		$a_user_id,
			$a_mem_role
	)

add Member to Group public

Parameters

integer	user_id
integer	member role_id of local group_role

Definition at line 907 of file class.ilObjGroup.php.

References join().

        {
                global $rbacadmin;

                if (isset($a_user_id) && isset($a_mem_role) )
                {
                        $this->join($a_user_id,$a_mem_role);
                        return true;
                }
                else
                {
                        $this->ilias->raiseError(get_class($this)."::addMember(): Missing parameters !",$this->ilias->error_obj->WARNING);
                        return false;
                }
        }

Here is the call graph for this function:

appendMessage()

ilObjGroup::appendMessage

(

$a_message

)

Definition at line 1846 of file class.ilObjGroup.php.

References getMessage().

        {
                if($this->getMessage())
                {
                        $this->message .= "<br /> ";
                }
                $this->message .= $a_message;
        }

Here is the call graph for this function:

cloneAutoGeneratedRoles()

ilObjGroup::cloneAutoGeneratedRoles

(

$new_obj

)

Clone group admin and member role permissions.

public

Parameters

object

new group object

Definition at line 831 of file class.ilObjGroup.php.

References $ilLog, getDefaultAdminRole(), getDefaultMemberRole(), and ilObject\getRefId().

Referenced by cloneObject().

        {
                global $ilLog,$rbacadmin,$rbacreview;

                $admin = $this->getDefaultAdminRole();
                $new_admin = $new_obj->getDefaultAdminRole();
                if(!$admin || !$new_admin || !$this->getRefId() || !$new_obj->getRefId())
                {
                        $ilLog->write(__METHOD__.' : Error cloning auto generated role: il_grp_admin');
                }
                $rbacadmin->copyRolePermissions($admin,$this->getRefId(),$new_obj->getRefId(),$new_admin,true);
                $ilLog->write(__METHOD__.' : Finished copying of role il_grp_admin.');

                $member = $this->getDefaultMemberRole();
                $new_member = $new_obj->getDefaultMemberRole();
                if(!$member || !$new_member)
                {
                        $ilLog->write(__METHOD__.' : Error cloning auto generated role: il_grp_member');
                }
                $rbacadmin->copyRolePermissions($member,$this->getRefId(),$new_obj->getRefId(),$new_member,true);
                $ilLog->write(__METHOD__.' : Finished copying of role grp_member.');
        }

Here is the call graph for this function:

Here is the caller graph for this function:

cloneDependencies()

ilObjGroup::cloneDependencies	(		$a_target_id,
			$a_copy_id
	)

Clone object dependencies (crs items, preconditions)

public

Parameters

int	target ref id of new course
int	copy id

Definition at line 812 of file class.ilObjGroup.php.

References ilObjectActivation\cloneDependencies(), and ilObject\getRefId().

        {
                global $tree;

                parent::cloneDependencies($a_target_id,$a_copy_id);

                include_once('Services/Object/classes/class.ilObjectActivation.php');
                ilObjectActivation::cloneDependencies($this->getRefId(), $a_target_id, $a_copy_id);

                return true;
        }

Here is the call graph for this function:

cloneObject()

ilObjGroup::cloneObject	(		$a_target_id,
			$a_copy_id = 0
	)

Clone group (no member data)

public

Parameters

int	target ref_id
int	copy id

Definition at line 743 of file class.ilObjGroup.php.

References $ilDB, $ilLog, $ilUser, ilCourseDefinedFieldDefinition\_clone(), ilGroupParticipants\_getInstanceByObjId(), cloneAutoGeneratedRoles(), ilMembershipRegistrationCodeUtils\generateCode(), ilContainer\getBigIconPath(), getEnableGroupMap(), getGroupType(), ilObject\getId(), getInformation(), getLatitude(), getLocationZoom(), getLongitude(), getMailToMembersType(), getMaxMembers(), getPassword(), getRegistrationEnd(), getRegistrationStart(), getRegistrationType(), ilContainer\getSmallIconPath(), ilContainer\getTinyIconPath(), ilContainer\getViewMode(), IL_GRP_ADMIN, isMembershipLimited(), isRegistrationAccessCodeEnabled(), isRegistrationUnlimited(), isWaitingListEnabled(), and readGroupStatus().

        {
                global $ilDB,$ilUser;

                $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
                $new_obj->setGroupType($this->getGroupType());
                $new_obj->initGroupStatus($this->getGroupType() ? $this->getGroupType() : $this->readGroupStatus());

                $this->cloneAutoGeneratedRoles($new_obj);

                $new_obj->setRegistrationType($this->getRegistrationType());
                $new_obj->setInformation($this->getInformation());
                $new_obj->setRegistrationStart($this->getRegistrationStart());
                $new_obj->setRegistrationEnd($this->getRegistrationEnd());
                $new_obj->enableUnlimitedRegistration($this->isRegistrationUnlimited());
                $new_obj->setPassword($this->getPassword());
                $new_obj->enableMembershipLimitation($this->isMembershipLimited());
                $new_obj->setMaxMembers($this->getMaxMembers());
                $new_obj->enableWaitingList($this->isWaitingListEnabled());
                
                // map
                $new_obj->setLatitude($this->getLatitude());
                $new_obj->setLongitude($this->getLongitude());
                $new_obj->setLocationZoom($this->getLocationZoom());
                $new_obj->setEnableGroupMap($this->getEnableGroupMap());
                $new_obj->enableRegistrationAccessCode($this->isRegistrationAccessCodeEnabled());
                include_once './Services/Membership/classes/class.ilMembershipRegistrationCodeUtils.php';
                $new_obj->setRegistrationAccessCode(ilMembershipRegistrationCodeUtils::generateCode());

                $new_obj->setViewMode($this->getViewMode());
                $new_obj->setMailToMembersType($this->getMailToMembersType());
                
                $new_obj->update();
                
                // #13008 - Group Defined Fields
                include_once('Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php');
                ilCourseDefinedFieldDefinition::_clone($this->getId(),$new_obj->getId());
                
                global $ilLog;
                $ilLog->write(__METHOD__.': Starting add user');
                
                // Assign user as admin
                include_once('./Modules/Group/classes/class.ilGroupParticipants.php');
                $part = ilGroupParticipants::_getInstanceByObjId($new_obj->getId());
                $part->add($ilUser->getId(),IL_GRP_ADMIN);
                $part->updateNotification($ilUser->getId(),1);

                // Copy learning progress settings
                include_once('Services/Tracking/classes/class.ilLPObjSettings.php');
                $obj_settings = new ilLPObjSettings($this->getId());
                $obj_settings->cloneSettings($new_obj->getId());
                unset($obj_settings);
                
                // clone icons
                $new_obj->saveIcons($this->getBigIconPath(),
                        $this->getSmallIconPath(),
                        $this->getTinyIconPath());

                return $new_obj;
        }

Here is the call graph for this function:

create()

ilObjGroup::create

(

)

Create group.

Definition at line 569 of file class.ilObjGroup.php.

References $ilDB, $query, $res, getEnableGroupMap(), getGroupType(), ilObject\getId(), getInformation(), getLatitude(), getLocationZoom(), getLongitude(), getMailToMembersType(), getMaxMembers(), getPassword(), getRegistrationAccessCode(), getRegistrationEnd(), getRegistrationStart(), getRegistrationType(), ilContainer\getViewMode(), IL_CAL_DATETIME, isMembershipLimited(), isRegistrationAccessCodeEnabled(), isRegistrationEnabled(), isRegistrationUnlimited(), isWaitingListEnabled(), and prepareAppointments().

        {
                global $ilDB,$ilAppEventHandler;

                if(!parent::create())
                {
                        return false;
                }

                $query = "INSERT INTO grp_settings (obj_id,information,grp_type,registration_type,registration_enabled,".
                        "registration_unlimited,registration_start,registration_end,registration_password,registration_mem_limit,".
                        "registration_max_members,waiting_list,latitude,longitude,location_zoom,enablemap,reg_ac_enabled,reg_ac,view_mode,mail_members_type) ".
                        "VALUES(".
                        $ilDB->quote($this->getId() ,'integer').", ".
                        $ilDB->quote($this->getInformation() ,'text').", ".
                        $ilDB->quote((int) $this->getGroupType() ,'integer').", ".
                        $ilDB->quote($this->getRegistrationType() ,'integer').", ".
                        $ilDB->quote(($this->isRegistrationEnabled() ? 1 : 0) ,'integer').", ".
                        $ilDB->quote(($this->isRegistrationUnlimited() ? 1 : 0) ,'integer').", ".
                        $ilDB->quote($this->getRegistrationStart()->get(IL_CAL_DATETIME,'') ,'timestamp').", ".
                        $ilDB->quote($this->getRegistrationEnd()->get(IL_CAL_DATETIME,'') ,'timestamp').", ".
                        $ilDB->quote($this->getPassword() ,'text').", ".
                        $ilDB->quote((int) $this->isMembershipLimited() ,'integer').", ".
                        $ilDB->quote($this->getMaxMembers() ,'integer').", ".
                        $ilDB->quote($this->isWaitingListEnabled() ? 1 : 0 ,'integer').", ".
                        $ilDB->quote($this->getLatitude() ,'text').", ".
                        $ilDB->quote($this->getLongitude() ,'text').", ".
                        $ilDB->quote($this->getLocationZoom() ,'integer').", ".
                        $ilDB->quote((int) $this->getEnableGroupMap() ,'integer').", ".
                        $ilDB->quote($this->isRegistrationAccessCodeEnabled(),'integer').', '.
                        $ilDB->quote($this->getRegistrationAccessCode(),'text').', '.
                        $ilDB->quote($this->getViewMode(false),'integer').', '.
                        $ilDB->quote($this->getMailToMembersType(),'integer').' '.
                        ")";
                $res = $ilDB->manipulate($query);

                $ilAppEventHandler->raise('Modules/Group',
                        'create',
                        array('object' => $this,
                                'obj_id' => $this->getId(),
                                'appointments' => $this->prepareAppointments('create')));
                
                return $this->getId();
        }

Here is the call graph for this function:

delete()

ilObjGroup::delete

(

)

delete group and all related data

public

Returns

boolean true if all object data were removed; false if only a references were removed

Definition at line 666 of file class.ilObjGroup.php.

References $ilDB, $query, $res, ilParticipants\_deleteAllEntries(), ilObject\getId(), and prepareAppointments().

        {
                global $ilDB,$ilAppEventHandler;

                // always call parent delete function first!!
                if (!parent::delete())
                {
                        return false;
                }

                $query = "DELETE FROM grp_settings ".
                        "WHERE obj_id = ".$ilDB->quote($this->getId() ,'integer');
                $res = $ilDB->manipulate($query);
                
                include_once('./Modules/Group/classes/class.ilGroupParticipants.php');
                ilGroupParticipants::_deleteAllEntries($this->getId());
                
                $ilAppEventHandler->raise('Modules/Group',
                        'delete',
                        array('object' => $this,
                                'obj_id' => $this->getId(),
                                'appointments' => $this->prepareAppointments('delete')));
                
                
                return true;
        }

Here is the call graph for this function:

deleteExportFiles()

ilObjGroup::deleteExportFiles

(

$a_files

)

Definition at line 1565 of file class.ilObjGroup.php.

References $file, and __initFileObject().

        {
                $this->__initFileObject();

                foreach($a_files as $file)
                {
                        $this->file_obj->deleteFile($file);
                }
                return true;
        }

Here is the call graph for this function:

downloadExportFile()

ilObjGroup::downloadExportFile

(

$file

)

Definition at line 1576 of file class.ilObjGroup.php.

References $file, __initFileObject(), and ilUtil\deliverFile().

        {
                $this->__initFileObject();

                if($abs_name = $this->file_obj->getExportFile($file))
                {
                        ilUtil::deliverFile($abs_name,$file);
                        // Not reached
                }
                return false;
        }

Here is the call graph for this function:

enableMembershipLimitation()

ilObjGroup::enableMembershipLimitation

(

$a_status

)

enable max member limitation

public

Parameters

bool

status

Returns

Definition at line 327 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->reg_membership_limitation = $a_status;
        }

Here is the caller graph for this function:

enableRegistrationAccessCode()

ilObjGroup::enableRegistrationAccessCode

(

$a_status

)

En/disable registration access code.

Parameters

object

$a_status

Returns

Definition at line 502 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->reg_access_code_enabled = $a_status;
        }

Here is the caller graph for this function:

enableUnlimitedRegistration()

ilObjGroup::enableUnlimitedRegistration

(

$a_status

)

enable unlimited registration

public

Parameters

bool

Returns

Definition at line 235 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->reg_unlimited = $a_status;
        }

Here is the caller graph for this function:

enableWaitingList()

ilObjGroup::enableWaitingList

(

$a_status

)

enable waiting list

public

Parameters

bool

Returns

Definition at line 372 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->waiting_list = $a_status;
        }

Here is the caller graph for this function:

exportXML()

ilObjGroup::exportXML

(

)

Definition at line 1543 of file class.ilObjGroup.php.

References __initFileObject(), and ilObject\getId().

        {
                include_once 'Modules/Group/classes/class.ilGroupXMLWriter.php';

                $xml_writer = new ilGroupXMLWriter($this);
                $xml_writer->start();

                $xml = $xml_writer->getXML();
                
                $name = time().'__'.$this->ilias->getSetting('inst_id').'__grp_'.$this->getId();

                $this->__initFileObject();

                $this->file_obj->addGroupDirectory();
                $this->file_obj->addDirectory($name);
                $this->file_obj->writeToFile($xml,$name.'/'.$name.'.xml');
                $this->file_obj->zipFile($name,$name.'.zip');
                $this->file_obj->deleteDirectory($name);

                return true;
        }

Here is the call graph for this function:

getCountMembers()

ilObjGroup::getCountMembers

(

)

Definition at line 1046 of file class.ilObjGroup.php.

References getGroupMemberIds().

        {
                return count($this->getGroupMemberIds());
        }

Here is the call graph for this function:

getDefaultAdminRole()

ilObjGroup::getDefaultAdminRole

(

)

returns object id of created default adminstrator role public

Definition at line 894 of file class.ilObjGroup.php.

References getLocalGroupRoles().

Referenced by cloneAutoGeneratedRoles().

        {
                $local_group_Roles = $this->getLocalGroupRoles();

                return $local_group_Roles["il_grp_admin_".$this->getRefId()];
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultGroupRoles()

ilObjGroup::getDefaultGroupRoles

(

$a_grp_id = ""

)

get default group roles, returns the defaultlike create roles il_grp_member, il_grp_admin public

Parameters

returns

the obj_ids of group specific roles(il_grp_member,il_grp_admin)

Definition at line 1086 of file class.ilObjGroup.php.

References ilObject\getRefId().

Referenced by getGroupAdminIds(), isAdmin(), readGroupStatus(), and updateGroupType().

        {
                global $rbacadmin, $rbacreview;

                if (strlen($a_grp_id) > 0)
                {
                        $grp_id = $a_grp_id;
                }
                else
                {
                        $grp_id = $this->getRefId();
                }

                $role_arr  = $rbacreview->getRolesOfRoleFolder($grp_id);

                foreach ($role_arr as $role_id)
                {
                        $role_Obj =& $this->ilias->obj_factory->getInstanceByObjId($role_id);

                        $grp_Member ="il_grp_member_".$grp_id;
                        $grp_Admin  ="il_grp_admin_".$grp_id;

                        if (strcmp($role_Obj->getTitle(), $grp_Member) == 0 )
                        {
                                $arr_grpDefaultRoles["grp_member_role"] = $role_Obj->getId();
                        }

                        if (strcmp($role_Obj->getTitle(), $grp_Admin) == 0)
                        {
                                $arr_grpDefaultRoles["grp_admin_role"] = $role_Obj->getId();
                        }
                }

                return $arr_grpDefaultRoles;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultMemberRole()

ilObjGroup::getDefaultMemberRole

(

)

returns object id of created default member role public

Definition at line 883 of file class.ilObjGroup.php.

References getLocalGroupRoles().

Referenced by cloneAutoGeneratedRoles().

        {
                $local_group_Roles = $this->getLocalGroupRoles();

                return $local_group_Roles["il_grp_member_".$this->getRefId()];
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getEnableGroupMap()

ilObjGroup::getEnableGroupMap

(

)

Get Enable Group Map.

Returns

boolean Enable Group Map

Definition at line 464 of file class.ilObjGroup.php.

References $enablemap.

Referenced by cloneObject(), create(), and update().

        {
                return (bool) $this->enablemap;
        }

Here is the caller graph for this function:

getGroupAdminIds()

ilObjGroup::getGroupAdminIds

(

$a_grpId = ""

)

get Group Admin Id public

Parameters

integer	group id
returns	userids that are assigned to a group administrator! role

Definition at line 1057 of file class.ilObjGroup.php.

References getDefaultGroupRoles(), and ilObject\getRefId().

Referenced by leaveGroup().

        {
                global $rbacreview;

                if (!empty($a_grpId))
                {
                        $grp_id = $a_grpId;
                }
                else
                {
                        $grp_id = $this->getRefId();
                }

                $usr_arr = array();
                $roles = $this->getDefaultGroupRoles($this->getRefId());

                foreach ($rbacreview->assignedUsers($this->getDefaultAdminRole()) as $member_id)
                {
                        array_push($usr_arr,$member_id);
                }

                return $usr_arr;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getGroupMemberData()

ilObjGroup::getGroupMemberData	(		$a_mem_ids,
			$active = 1
	)

get all group Members regardless of group role.

fetch all users data in one shot to improve performance public

Parameters

array

of user ids

Returns

return array of userdata

Definition at line 1016 of file class.ilObjGroup.php.

References $ilBench, $ilDB, $r, $row, DB_FETCHMODE_OBJECT, and ilUtil\quoteArray().

        {
                global $rbacadmin, $rbacreview, $ilBench, $ilDB;

                $usr_arr= array();

                $q = "SELECT login,firstname,lastname,title,usr_id,last_login ".
                         "FROM usr_data ".
                         "WHERE usr_id IN (".implode(',',ilUtil::quoteArray($a_mem_ids)).") ";

                if (is_numeric($active) && $active > -1)
                        $q .= "AND active = '$active'";
                        
                $q .= 'ORDER BY lastname,firstname';

                $r = $ilDB->query($q);
                
                while($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $mem_arr[] = array("id" => $row->usr_id,
                                                                "login" => $row->login,
                                                                "firstname" => $row->firstname,
                                                                "lastname" => $row->lastname,
                                                                "last_login" => $row->last_login
                                                                );
                }

                return $mem_arr ? $mem_arr : array();
        }

Here is the call graph for this function:

getGroupMemberIds()

ilObjGroup::getGroupMemberIds

(

)

get all group Member ids regardless of role public

Returns

return array of users (obj_ids) that are assigned to the groupspecific roles (grp_member,grp_admin)

Definition at line 988 of file class.ilObjGroup.php.

References getLocalGroupRoles().

Referenced by getCountMembers(), and leaveGroup().

        {
                global $rbacadmin, $rbacreview;

                $usr_arr= array();

                $rol  = $this->getLocalGroupRoles();

                foreach ($rol as $value)
                {
                        foreach ($rbacreview->assignedUsers($value) as $member_id)
                        {
                                array_push($usr_arr,$member_id);
                        }
                }

                $mem_arr = array_unique($usr_arr);

                return $mem_arr ? $mem_arr : array();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getGroupStatus()

ilObjGroup::getGroupStatus

(

)

get group status

public

Parameters

int	group status

Definition at line 1414 of file class.ilObjGroup.php.

        {
                return $this->group_status;
        }

getGroupType()

ilObjGroup::getGroupType

(

)

get group type

public

Returns

int group type

Definition at line 169 of file class.ilObjGroup.php.

References $group_type.

Referenced by cloneObject(), create(), isGroupTypeModified(), update(), updateGroupType(), and validate().

        {
                return $this->group_type;
        }

Here is the caller graph for this function:

getGrpStatusClosedTemplateId()

ilObjGroup::getGrpStatusClosedTemplateId

(

)

get group status closed template public

Parameters

return

obj_id of roletemplate containing permissionsettings for a closed group

Definition at line 1165 of file class.ilObjGroup.php.

References $res, $row, and DB_FETCHMODE_ASSOC.

Referenced by initGroupStatus(), and updateGroupType().

        {
                $q = "SELECT obj_id FROM object_data WHERE type='rolt' AND title='il_grp_status_closed'";
                $res = $this->ilias->db->query($q);
                $row = $res->fetchRow(DB_FETCHMODE_ASSOC);

                return $row["obj_id"];
        }

Here is the caller graph for this function:

getGrpStatusOpenTemplateId()

ilObjGroup::getGrpStatusOpenTemplateId

(

)

get group status open template public

Parameters

return

obj_id of roletemplate containing permissionsettings for an open group

Definition at line 1179 of file class.ilObjGroup.php.

References $res, $row, and DB_FETCHMODE_ASSOC.

Referenced by initGroupStatus(), and updateGroupType().

        {
                $q = "SELECT obj_id FROM object_data WHERE type='rolt' AND title='il_grp_status_open'";
                $res = $this->ilias->db->query($q);
                $row = $res->fetchRow(DB_FETCHMODE_ASSOC);

                return $row["obj_id"];
        }

Here is the caller graph for this function:

getInformation()

ilObjGroup::getInformation

(

)

get Information

public

Parameters

Definition at line 147 of file class.ilObjGroup.php.

References $information.

Referenced by cloneObject(), create(), and update().

        {
                return $this->information;
        }

Here is the caller graph for this function:

getLatitude()

ilObjGroup::getLatitude

(

)

Get Latitude.

Returns

string Latitude

Definition at line 404 of file class.ilObjGroup.php.

References $latitude.

Referenced by cloneObject(), create(), and update().

        {
                return $this->latitude;
        }

Here is the caller graph for this function:

getLocalGroupRoles()

ilObjGroup::getLocalGroupRoles

(

$a_translate = false

)

get ALL local roles of group, also those created and defined afterwards only fetch data once from database.

info is stored in object variable public

Returns

return array [title|id] of roles...

Definition at line 1128 of file class.ilObjGroup.php.

References ilObjRole\_getTranslation(), and ilObject\getRefId().

Referenced by getDefaultAdminRole(), getDefaultMemberRole(), getGroupMemberIds(), and getMemberRoles().

        {
                global $rbacadmin,$rbacreview;

                if (empty($this->local_roles))
                {
                        $this->local_roles = array();
                        $role_arr  = $rbacreview->getRolesOfRoleFolder($this->getRefId());

                        foreach ($role_arr as $role_id)
                        {
                                if ($rbacreview->isAssignable($role_id,$this->getRefId()) == true)
                                {
                                        $role_Obj =& $this->ilias->obj_factory->getInstanceByObjId($role_id);

                                        if ($a_translate)
                                        {
                                                $role_name = ilObjRole::_getTranslation($role_Obj->getTitle());
                                        }
                                        else
                                        {
                                                $role_name = $role_Obj->getTitle();
                                        }

                                        $this->local_roles[$role_name] = $role_Obj->getId();
                                }
                        }
                }

                return $this->local_roles;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getLocationZoom()

ilObjGroup::getLocationZoom

(

)

Get LocationZoom.

Returns

int LocationZoom

Definition at line 444 of file class.ilObjGroup.php.

References $locationzoom.

Referenced by cloneObject(), create(), and update().

        {
                return $this->locationzoom;
        }

Here is the caller graph for this function:

getLongitude()

ilObjGroup::getLongitude

(

)

Get Longitude.

Returns

string Longitude

Definition at line 424 of file class.ilObjGroup.php.

References $longitude.

Referenced by cloneObject(), create(), and update().

        {
                return $this->longitude;
        }

Here is the caller graph for this function:

getMailToMembersType()

ilObjGroup::getMailToMembersType

(

)

Get mail to members type.

Returns

int

Definition at line 521 of file class.ilObjGroup.php.

References $mail_members.

Referenced by cloneObject(), create(), and update().

        {
                return $this->mail_members;
        }

Here is the caller graph for this function:

getMaxMembers()

ilObjGroup::getMaxMembers

(

)

get max members

public

Returns

Definition at line 360 of file class.ilObjGroup.php.

References $reg_max_members.

Referenced by cloneObject(), create(), register(), update(), and validate().

        {
                return $this->reg_max_members;
        }

Here is the caller graph for this function:

getMemberRoles()

ilObjGroup::getMemberRoles

(

$a_user_id

)

get group member status public

Parameters

integer

user_id

Returns

returns array of obj_ids of assigned local roles

Definition at line 1451 of file class.ilObjGroup.php.

References $ilBench, and getLocalGroupRoles().

Referenced by leave().

        {
                global $rbacadmin, $rbacreview,$ilBench;

                $ilBench->start("Group", "getMemberRoles");

                $arr_assignedRoles = array();

                $arr_assignedRoles = array_intersect($rbacreview->assignedRoles($a_user_id),$this->getLocalGroupRoles());

                $ilBench->stop("Group", "getMemberRoles");

                return $arr_assignedRoles;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getMessage()

ilObjGroup::getMessage

(

)

Definition at line 1838 of file class.ilObjGroup.php.

Referenced by appendMessage().

        {
                return $this->message;
        }

Here is the caller graph for this function:

getPassword()

ilObjGroup::getPassword

(

)

get password

public

Returns

string password

Definition at line 315 of file class.ilObjGroup.php.

References $reg_password.

Referenced by cloneObject(), create(), update(), and validate().

        {
                return $this->reg_password;
        }

Here is the caller graph for this function:

getRegistrationAccessCode()

ilObjGroup::getRegistrationAccessCode

(

)

get access code

Returns

Definition at line 473 of file class.ilObjGroup.php.

References $reg_access_code.

Referenced by create(), and update().

        {
                return $this->reg_access_code;
        }

Here is the caller graph for this function:

getRegistrationEnd()

ilObjGroup::getRegistrationEnd

(

)

get registration end

public

Returns

int registration end

Definition at line 293 of file class.ilObjGroup.php.

References IL_CAL_DATETIME.

Referenced by cloneObject(), create(), prepareAppointments(), register(), update(), and validate().

        {
                return $this->reg_end ? $this->reg_end : $this->reg_end = new ilDateTime(date('Y-m-d').' 16:00:00',IL_CAL_DATETIME);
        }

Here is the caller graph for this function:

getRegistrationStart()

ilObjGroup::getRegistrationStart

(

)

get registration start

public

Returns

int registration start

Definition at line 269 of file class.ilObjGroup.php.

References IL_CAL_DATETIME.

Referenced by cloneObject(), create(), prepareAppointments(), register(), update(), and validate().

        {
                return $this->reg_start ? $this->reg_start : $this->reg_start = new ilDateTime(date('Y-m-d').' 08:00:00',IL_CAL_DATETIME);
        }

Here is the caller graph for this function:

getRegistrationType()

ilObjGroup::getRegistrationType

(

)

get registration type

public

Returns

int registration type

Definition at line 212 of file class.ilObjGroup.php.

References $reg_type.

Referenced by cloneObject(), create(), isRegistrationEnabled(), update(), and validate().

        {
                return $this->reg_type;
        }

Here is the caller graph for this function:

getViewMode()

ilObjGroup::getViewMode

(

$a_translate_inherit = true

)

get view mode

public

Parameters

bool

$a_translate_inherit

Returns

int view mode

Definition at line 1720 of file class.ilObjGroup.php.

References ilContainer\VIEW_DEFAULT.

        {               
                $view = (int) $this->view_mode;
                
                if(!$view)
                {
                        $view = ilContainer::VIEW_DEFAULT;
                }
                
                if($a_translate_inherit)
                {
                        $view = self::translateViewMode($this->id, $view, $this->ref_id);
                }
                
                return $view;
        }

initDefaultRoles()

ilObjGroup::initDefaultRoles

(

)

init default roles settings public

Returns

array object IDs of created local roles.

Definition at line 1495 of file class.ilObjGroup.php.

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

        {
                include_once './Services/AccessControl/classes/class.ilObjRole.php';
                $role = ilObjRole::createDefaultRole(
                                'il_grp_admin_'.$this->getRefId(),
                                "Groupadmin group obj_no.".$this->getId(),
                                'il_grp_admin',
                                $this->getRefId()
                );
                $this->m_roleAdminId = $role->getId();
                
                $role = ilObjRole::createDefaultRole(
                                'il_grp_member_'.$this->getRefId(),
                                "Groupmember of group obj_no.".$this->getId(),
                                'il_grp_member',
                                $this->getRefId()
                );
                $this->m_roleMemberId = $role->getId();
                
                return array();
        }

Here is the call graph for this function:

initGroupStatus()

ilObjGroup::initGroupStatus

(

$a_grpStatus = GRP_TYPE_PUBLIC

)

set group status

Grants permissions on the group object for all parent roles. Each permission is granted by computing the intersection of the role template il_grp_status_open/_closed and the permission template of the parent role.

Creates linked roles in the local role folder object for all parent roles and initializes their permission templates. Each permission template is initialized by computing the intersection of the role template il_grp_status_open/_closed and the permission template of the parent role.

public

Parameters

integer

group status GRP_TYPE_PUBLIC or GRP_TYPE_CLOSED

Definition at line 1319 of file class.ilObjGroup.php.

References getGrpStatusClosedTemplateId(), getGrpStatusOpenTemplateId(), ilObject\getRefId(), GRP_TYPE_CLOSED, and GRP_TYPE_PUBLIC.

        {
                global $rbacadmin, $rbacreview, $rbacsystem;

                //define all relevant roles that rights are needed to be changed
                $arr_parentRoles = $rbacreview->getParentRoleIds($this->getRefId());

                $real_local_roles = $rbacreview->getRolesOfRoleFolder($this->getRefId(),false);
                $arr_relevantParentRoleIds = array_diff(array_keys($arr_parentRoles),$real_local_roles);

                //group status open (aka public) or group status closed
                if ($a_grpStatus == GRP_TYPE_PUBLIC || $a_grpStatus == GRP_TYPE_CLOSED)
                {
                        if ($a_grpStatus == GRP_TYPE_PUBLIC)
                        {
                                $template_id = $this->getGrpStatusOpenTemplateId();
                        } 
                        else 
                        {
                                $template_id = $this->getGrpStatusClosedTemplateId();
                        }
                        //get defined operations from template
                        $template_ops = $rbacreview->getOperationsOfRole($template_id, 'grp', ROLE_FOLDER_ID);

                        foreach ($arr_relevantParentRoleIds as $parentRole)
                        {
                                if ($rbacreview->isProtected($arr_parentRoles[$parentRole]['parent'],$parentRole))
                                {
                                        continue;
                                }

                                $granted_permissions = array();

                                // Delete the linked role for the parent role
                                // (just in case if it already exists).
                                
                                // Added additional check, since this operation is very dangerous.
                                // If there is no role folder ALL parent roles are deleted. 

                                // @todo refactor rolf
                                $rbacadmin->deleteLocalRole($parentRole,$this->getRefId());

                                // Grant permissions on the group object for
                                // the parent role. In the foreach loop we
                                // compute the intersection of the role
                                // template il_grp_status_open/_closed and the
                                // permission template of the parent role.
                                $current_ops = $rbacreview->getRoleOperationsOnObject($parentRole, $this->getRefId());
                                $rbacadmin->revokePermission($this->getRefId(), $parentRole);
                                foreach ($template_ops as $template_op)
                                {
                                        if (in_array($template_op,$current_ops))
                                        {
                                                array_push($granted_permissions,$template_op);
                                        }
                                }
                                if (!empty($granted_permissions))
                                {
                                        $rbacadmin->grantPermission($parentRole, $granted_permissions, $this->getRefId());
                                }

                                // Create a linked role for the parent role and
                                // initialize it with the intersection of
                                // il_grp_status_open/_closed and the permission
                                // template of the parent role
                                
                                $rbacadmin->copyRolePermissionIntersection(
                                        $template_id, ROLE_FOLDER_ID,
                                        $parentRole, $arr_parentRoles[$parentRole]['parent'],
                                        $this->getRefId(), $parentRole
                                );
                                $rbacadmin->assignRoleToFolder($parentRole,$this->getRefId(),"false");
                        }//END foreach
                }
        }

Here is the call graph for this function:

initParticipants()

ilObjGroup::initParticipants ( )

protected

init participants object

protected

Returns

Definition at line 1905 of file class.ilObjGroup.php.

References ilGroupParticipants\_getInstanceByObjId(), and ilObject\getId().

Referenced by read().

        {
                include_once('./Modules/Group/classes/class.ilGroupParticipants.php');
                $this->members_obj = ilGroupParticipants::_getInstanceByObjId($this->getId());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

isAdmin()

ilObjGroup::isAdmin

(

$a_userId

)

is Admin public

Parameters

integer	user_id
boolean,true	if user is group administrator

Definition at line 1472 of file class.ilObjGroup.php.

References getDefaultGroupRoles().

Referenced by leaveGroup().

        {
                global $rbacreview;

                $grp_Roles = $this->getDefaultGroupRoles();

                if (in_array($a_userId,$rbacreview->assignedUsers($grp_Roles["grp_admin_role"])))
                {
                        return true;
                }
                else
                {
                        return false;
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

isGroupTypeModified()

ilObjGroup::isGroupTypeModified

(

$a_old_type

)

check if group type is modified

public

Parameters

Definition at line 181 of file class.ilObjGroup.php.

References $group_type, getGroupType(), GRP_TYPE_UNKNOWN, and readGroupStatus().

        {
                if($a_old_type == GRP_TYPE_UNKNOWN)
                {
                        $group_type = $this->readGroupStatus();
                }
                else
                {
                        $group_type = $a_old_type;
                }
                return $group_type != $this->getGroupType(); 
        }

Here is the call graph for this function:

isMembershipLimited()

ilObjGroup::isMembershipLimited

(

)

is max member limited

public

Returns

Definition at line 338 of file class.ilObjGroup.php.

References $reg_membership_limitation.

Referenced by cloneObject(), create(), register(), update(), and validate().

        {
                return (bool) $this->reg_membership_limitation;
        }

Here is the caller graph for this function:

isRegistrationAccessCodeEnabled()

ilObjGroup::isRegistrationAccessCodeEnabled

(

)

Check if access code is enabled.

Returns

Definition at line 492 of file class.ilObjGroup.php.

References $reg_access_code_enabled.

Referenced by cloneObject(), create(), and update().

        {
                return (bool) $this->reg_access_code_enabled;
        }

Here is the caller graph for this function:

isRegistrationEnabled()

ilObjGroup::isRegistrationEnabled

(

)

is registration enabled

public

Returns

bool

Definition at line 223 of file class.ilObjGroup.php.

References getRegistrationType(), and GRP_REGISTRATION_DEACTIVATED.

Referenced by create(), register(), and update().

        {
                return $this->getRegistrationType() != GRP_REGISTRATION_DEACTIVATED;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

isRegistrationUnlimited()

ilObjGroup::isRegistrationUnlimited

(

)

is registration unlimited

public

Returns

bool

Definition at line 246 of file class.ilObjGroup.php.

References $reg_unlimited.

Referenced by cloneObject(), create(), prepareAppointments(), register(), and update().

        {
                return $this->reg_unlimited;
        }

Here is the caller graph for this function:

isWaitingListEnabled()

ilObjGroup::isWaitingListEnabled

(

)

is waiting list enabled

public

Parameters

Definition at line 384 of file class.ilObjGroup.php.

References $waiting_list.

Referenced by cloneObject(), create(), register(), and update().

        {
                return $this->waiting_list;
        }

Here is the caller graph for this function:

join()

ilObjGroup::join	(		$a_user_id,
			$a_mem_role = ""
	)

join Group, assigns user to role private

Parameters

integer

member status = obj_id of local_group_role

Definition at line 860 of file class.ilObjGroup.php.

Referenced by addMember().

        {
                global $rbacadmin;

                if (is_array($a_mem_role))
                {
                        foreach ($a_mem_role as $role)
                        {
                                $rbacadmin->assignUser($role,$a_user_id, false);
                        }
                }
                else
                {
                        $rbacadmin->assignUser($a_mem_role,$a_user_id, false);
                }

                return true;
        }

Here is the caller graph for this function:

leave()

ilObjGroup::leave

(

$a_user_id

)

deassign member from group role private

Definition at line 961 of file class.ilObjGroup.php.

References getMemberRoles().

Referenced by leaveGroup().

        {
                global $rbacadmin;

                $arr_groupRoles = $this->getMemberRoles($a_user_id);

                if (is_array($arr_groupRoles))
                {
                        foreach ($arr_groupRoles as $groupRole)
                        {
                                $rbacadmin->deassignUser($groupRole, $a_user_id);
                        }
                }
                else
                {
                        $rbacadmin->deassignUser($arr_groupRoles, $a_user_id);
                }

                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

leaveGroup()

ilObjGroup::leaveGroup

(

)

is called when a member decides to leave group public

Parameters

integer	user-Id
integer	group-Id

Definition at line 930 of file class.ilObjGroup.php.

References ilObjUser\dropDesktopItem(), getGroupAdminIds(), getGroupMemberIds(), ilObject\getRefId(), isAdmin(), and leave().

        {
                global $rbacadmin, $rbacreview;

                $member_ids = $this->getGroupMemberIds();

                if (count($member_ids) <= 1 || !in_array($this->ilias->account->getId(), $member_ids))
                {
                        return 2;
                }
                else
                {
                        if (!$this->isAdmin($this->ilias->account->getId()))
                        {
                                $this->leave($this->ilias->account->getId());
                                $member = new ilObjUser($this->ilias->account->getId());
                                $member->dropDesktopItem($this->getRefId(), "grp");

                                return 0;
                        }
                        else if (count($this->getGroupAdminIds()) == 1)
                        {
                                return 1;
                        }
                }
        }

Here is the call graph for this function:

lookupGroupStatusTemplateId()

static ilObjGroup::lookupGroupStatusTemplateId (   $a_obj_id )

static

$ilDB $ilDB

Parameters

int

$a_obj_id

Returns

int

Definition at line 1194 of file class.ilObjGroup.php.

References $ilDB, $query, $res, $row, ilObject\$type, DB_FETCHMODE_ASSOC, and GRP_TYPE_CLOSED.

Referenced by ilRbacAdmin\adjustMovedObjectPermissions().

        {
                global $ilDB;
                
                $type = self::lookupGroupTye($a_obj_id);
                if($type == GRP_TYPE_CLOSED)
                {
                        $query = 'SELECT obj_id FROM object_data WHERE type = '.$ilDB->quote('rolt','text').' AND title = '.$ilDB->quote('il_grp_status_closed','text');
                }
                else
                {
                        $query = 'SELECT obj_id FROM object_data WHERE type = '.$ilDB->quote('rolt','text').' AND title = '.$ilDB->quote('il_grp_status_open','text');
                }
                $res = $ilDB->query($query);
                $row = $res->fetchRow(DB_FETCHMODE_ASSOC);
                
                return isset($row['obj_id']) ? $row['obj_id'] : 0;
        }

Here is the caller graph for this function:

lookupGroupTye()

static ilObjGroup::lookupGroupTye (   $a_id )

static

Lookup group type.

Parameters

object

$a_id

Returns

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

References $ilDB, $query, $res, $row, DB_FETCHMODE_OBJECT, and GRP_TYPE_UNKNOWN.

Referenced by ilObjRole\createPermissionIntersection().

        {
                global $ilDB;
                
                $query = "SELECT grp_type FROM grp_settings ".
                        "WHERE obj_id = ".$ilDB->quote($a_id,'integer');
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return $row->grp_type;
                }
                return GRP_TYPE_UNKNOWN;
        }

Here is the caller graph for this function:

lookupObjectsByCode()

static ilObjGroup::lookupObjectsByCode (   $a_code )

static

See also

interface.ilMembershipRegistrationCodes

Returns

array obj ids

Implements ilMembershipRegistrationCodes.

Definition at line 1915 of file class.ilObjGroup.php.

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

Referenced by ilMembershipRegistrationCodeUtils\lookupObjectsByCode().

        {
                global $ilDB;
                
                $query = "SELECT obj_id FROM grp_settings ".
                        "WHERE reg_ac_enabled = ".$ilDB->quote(1,'integer')." ".
                        "AND reg_ac = ".$ilDB->quote($a_code,'text');
                $res = $ilDB->query($query);
                
                $obj_ids = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $obj_ids[] = $row->obj_id;
                }
                return $obj_ids;
        }

Here is the caller graph for this function:

lookupViewMode()

static ilObjGroup::lookupViewMode (   $a_obj_id )

static

lookup view mode $ilDB

Definition at line 1750 of file class.ilObjGroup.php.

References $ilDB, $query, $res, $row, $view_mode, and DB_FETCHMODE_OBJECT.

        {
                global $ilDB;

                $query = 'SELECT view_mode FROM grp_settings '.
                        'WHERE obj_id = '.$ilDB->quote($a_obj_id,'integer');
                $res = $ilDB->query($query);

                $view_mode = NULL;
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $view_mode = $row->view_mode;
                }
                return self::translateViewMode($a_obj_id,$view_mode);
        }

notify()

ilObjGroup::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 happend, each object may decide how it reacts.

public

Parameters

string	event
integer	reference id of object where the event occured
array	passes optional parameters if required

Returns

boolean

Definition at line 1527 of file class.ilObjGroup.php.

        {
                global $tree;

                $parent_id = (int) $tree->getParentId($a_node_id);

                if ($parent_id != 0)
                {
                        $obj_data =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
                        $obj_data->notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$parent_id,$a_params);
                }

                return true;
        }

prepareAppointments()

ilObjGroup::prepareAppointments (   $a_mode = 'create' )

protected

Prepare calendar appointments.

protected

Parameters

string

mode UPDATE|CREATE|DELETE

Returns

Definition at line 1862 of file class.ilObjGroup.php.

References ilObject\getLongDescription(), getRegistrationEnd(), getRegistrationStart(), ilObject\getTitle(), IL_CAL_TRANSLATION_SYSTEM, and isRegistrationUnlimited().

Referenced by create(), delete(), and update().

        {
                include_once('./Services/Calendar/classes/class.ilCalendarAppointmentTemplate.php');
                
                switch($a_mode)
                {
                        case 'create':
                        case 'update':
                                if($this->isRegistrationUnlimited())
                                {
                                        return array();
                                }
                                $app = new ilCalendarAppointmentTemplate(self::CAL_REG_START);
                                $app->setTitle($this->getTitle());
                                $app->setSubtitle('grp_cal_reg_start');
                                $app->setTranslationType(IL_CAL_TRANSLATION_SYSTEM);
                                $app->setDescription($this->getLongDescription());      
                                $app->setStart($this->getRegistrationStart());
                                $apps[] = $app;

                                $app = new ilCalendarAppointmentTemplate(self::CAL_REG_END);
                                $app->setTitle($this->getTitle());
                                $app->setSubtitle('grp_cal_reg_end');
                                $app->setTranslationType(IL_CAL_TRANSLATION_SYSTEM);
                                $app->setDescription($this->getLongDescription());
                                $app->setStart($this->getRegistrationEnd());
                                $apps[] = $app;
                                
                                return $apps;
                                
                        case 'delete':
                                // Nothing to do: The category and all assigned appointments will be deleted.
                                return array();
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilObjGroup::read

(

)

Read group.

Definition at line 697 of file class.ilObjGroup.php.

References $ilDB, $query, $res, $row, ilContainerSortingSettings\_lookupSortMode(), DB_FETCHMODE_OBJECT, enableMembershipLimitation(), enableRegistrationAccessCode(), enableUnlimitedRegistration(), enableWaitingList(), ilObject\getId(), IL_CAL_DATETIME, initParticipants(), setEnableGroupMap(), setGroupType(), setInformation(), setLatitude(), setLocationZoom(), setLongitude(), setMailToMembersType(), setMaxMembers(), ilContainer\setOrderType(), setPassword(), setRegistrationAccessCode(), setRegistrationEnd(), setRegistrationStart(), setRegistrationType(), and setViewMode().

        {
                global $ilDB;

                parent::read();

                $query = "SELECT * FROM grp_settings ".
                        "WHERE obj_id = ".$ilDB->quote($this->getId() ,'integer');
                
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $this->setInformation($row->information);
                        $this->setGroupType($row->grp_type);
                        $this->setRegistrationType($row->registration_type);
                        $this->enableUnlimitedRegistration($row->registration_unlimited);
                        $this->setRegistrationStart(new ilDateTime($row->registration_start,IL_CAL_DATETIME));
                        $this->setRegistrationEnd(new ilDateTime($row->registration_end,IL_CAL_DATETIME));
                        $this->setPassword($row->registration_password);
                        $this->enableMembershipLimitation((bool) $row->registration_mem_limit);
                        $this->setMaxMembers($row->registration_max_members);
                        $this->enableWaitingList($row->waiting_list);
                        $this->setLatitude($row->latitude);
                        $this->setLongitude($row->longitude);
                        $this->setLocationZoom($row->location_zoom);
                        $this->setEnableGroupMap($row->enablemap);
                        $this->enableRegistrationAccessCode($row->reg_ac_enabled);
                        $this->setRegistrationAccessCode($row->reg_ac);
                        $this->setViewMode($row->view_mode);
                        $this->setMailToMembersType($row->mail_members_type);
                }
                $this->initParticipants();
                
                // Inherit order type from parent course (if exists)
                include_once('./Services/Container/classes/class.ilContainerSortingSettings.php');
                $this->setOrderType(ilContainerSortingSettings::_lookupSortMode($this->getId()));
        }

Here is the call graph for this function:

readGroupStatus()

ilObjGroup::readGroupStatus

(

)

get group status, redundant method because public

Parameters

return

group status[0=public|2=closed]

Definition at line 1424 of file class.ilObjGroup.php.

References getDefaultGroupRoles(), ilObject\getRefId(), GRP_TYPE_CLOSED, and GRP_TYPE_PUBLIC.

Referenced by cloneObject(), and isGroupTypeModified().

        {
                global $rbacsystem,$rbacreview;

                $local_roles = $rbacreview->getRolesOfRoleFolder($this->getRefId());

                //get all relevant roles
                $arr_globalRoles = array_diff($local_roles, $this->getDefaultGroupRoles());

                //if one global role has no permission to join the group is officially closed !
                foreach ($arr_globalRoles as $globalRole)
                {
                        if ($rbacsystem->checkPermission($this->getRefId(), $globalRole ,"join"))
                        {
                                return $this->group_status = GRP_TYPE_PUBLIC;
                        }
                }

                return $this->group_status = GRP_TYPE_CLOSED;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

register()

ilObjGroup::register	(		$a_user_id,
			$a_role = IL_GRP_MEMBER,
			$a_force_registration = false
	)

See also

ilMembershipRegistrationCodes::register()

Parameters

int	user_id
int	role
bool	force registration and do not check registration constraints.

Definition at line 1938 of file class.ilObjGroup.php.

References $waiting_list, ilDateTime\_after(), ilDateTime\_before(), ilGroupParticipants\_getInstanceByObjId(), ilObjGroupAccess\_usingRegistrationCode(), ilObject\getId(), getMaxMembers(), getRegistrationEnd(), getRegistrationStart(), ilObject\getTitle(), IL_CAL_UNIX, isMembershipLimited(), isRegistrationEnabled(), isRegistrationUnlimited(), isWaitingListEnabled(), and ilGroupMembershipMailNotification\TYPE_WAITING_LIST_MEMBER.

        {
                include_once './Services/Membership/exceptions/class.ilMembershipRegistrationException.php';
                include_once "./Modules/Group/classes/class.ilGroupParticipants.php";
                $part = ilGroupParticipants::_getInstanceByObjId($this->getId());

                if($part->isAssigned($a_user_id))
                {
                        return true;
                }
                
                if(!$a_force_registration)
                {
                        // Availability
                        if(!$this->isRegistrationEnabled())
                        {
                                include_once './Modules/Group/classes/class.ilObjGroupAccess.php';

                                if(!ilObjGroupAccess::_usingRegistrationCode())
                                {
                                        throw new ilMembershipRegistrationException('Cant registrate to group '.$this->getId().
                                                ', group subscription is deactivated.', '456');
                                }
                        }

                        // Time Limitation
                        if(!$this->isRegistrationUnlimited())
                        {
                                $start = $this->getRegistrationStart();
                                $end = $this->getRegistrationEnd();
                                $time = new ilDateTime(time(),IL_CAL_UNIX);

                                if( !(ilDateTime::_after($time, $start) and ilDateTime::_before($time,$end)) )
                                {
                                        throw new ilMembershipRegistrationException('Cant registrate to group '.$this->getId().
                                        ', group is out of registration time.', '789');
                                }
                        }

                        // Max members
                        if($this->isMembershipLimited())
                        {
                                $free = max(0,$this->getMaxMembers() - $part->getCountMembers());
                                include_once('./Modules/Group/classes/class.ilGroupWaitingList.php');
                                $waiting_list = new ilGroupWaitingList($this->getId());
                                if($this->isWaitingListEnabled() and (!$free or $waiting_list->getCountUsers()))
                                {
                                        $this->lng->loadLanguageModule("grp");
                                        $waiting_list->addToList($a_user_id);

                                        $info = sprintf($this->lng->txt('grp_added_to_list'),
                                                $this->getTitle(),
                                                $waiting_list->getPosition($a_user_id));

                                        include_once('./Modules/Group/classes/class.ilGroupParticipants.php');
                                        include_once('./Modules/Group/classes/class.ilGroupMembershipMailNotification.php');
                                        $participants = ilGroupParticipants::_getInstanceByObjId($this->getId());
                                        $participants->sendNotification(ilGroupMembershipMailNotification::TYPE_WAITING_LIST_MEMBER,$a_user_id);

                                        throw new ilMembershipRegistrationException($info, '124');
                                }

                                if(!$free or $waiting_list->getCountUsers())
                                {
                                        throw new ilMembershipRegistrationException('Cant registrate to group '.$this->getId().
                                                ', membership is limited.', '123');
                                }
                        }
                }
                
                $part->add($a_user_id,$a_role);
                $part->sendNotification($part->TYPE_NOTIFICATION_REGISTRATION, $a_user_id);
                return true;
        }       

Here is the call graph for this function:

setEnableGroupMap()

ilObjGroup::setEnableGroupMap

(

$a_enablemap

)

Set Enable Group Map.

Parameters

boolean

$a_enablemap

Enable Group Map

Definition at line 454 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->enablemap = $a_enablemap;
        }

Here is the caller graph for this function:

setGroupStatus()

ilObjGroup::setGroupStatus

(

$a_status

)

Set group status.

public

Parameters

int	group status[0=public|2=closed]

Definition at line 1402 of file class.ilObjGroup.php.

        {
                $this->group_status = $a_status;
        }

setGroupType()

ilObjGroup::setGroupType

(

$a_type

)

set group type

public

Parameters

int

type

Definition at line 158 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->group_type = $a_type;
        }

Here is the caller graph for this function:

setInformation()

ilObjGroup::setInformation

(

$a_information

)

set information

public

Parameters

string

information

Returns

Definition at line 135 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->information = $a_information;
        }

Here is the caller graph for this function:

setLatitude()

ilObjGroup::setLatitude

(

$a_latitude

)

Set Latitude.

Parameters

string

$a_latitude

Latitude

Definition at line 394 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->latitude = $a_latitude;
        }

Here is the caller graph for this function:

setLocationZoom()

ilObjGroup::setLocationZoom

(

$a_locationzoom

)

Set LocationZoom.

Parameters

int

$a_locationzoom

LocationZoom

Definition at line 434 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->locationzoom = $a_locationzoom;
        }

Here is the caller graph for this function:

setLongitude()

ilObjGroup::setLongitude

(

$a_longitude

)

Set Longitude.

Parameters

string

$a_longitude

Longitude

Definition at line 414 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->longitude = $a_longitude;
        }

Here is the caller graph for this function:

setMailToMembersType()

ilObjGroup::setMailToMembersType

(

$a_type

)

Set mail to members type.

See also

ilCourseConstants

Parameters

type

$a_type

Definition at line 512 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->mail_members = $a_type;
        }

Here is the caller graph for this function:

setMaxMembers()

ilObjGroup::setMaxMembers

(

$a_max

)

set max members

public

Parameters

int	max members

Definition at line 349 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->reg_max_members = $a_max;
        }

Here is the caller graph for this function:

setMessage()

ilObjGroup::setMessage

(

$a_message

)

Definition at line 1842 of file class.ilObjGroup.php.

        {
                $this->message = $a_message;
        }

setPassword()

ilObjGroup::setPassword

(

$a_pass

)

set password

public

Parameters

string

password

Definition at line 304 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->reg_password = $a_pass;
        }

Here is the caller graph for this function:

setRegistrationAccessCode()

ilObjGroup::setRegistrationAccessCode

(

$a_code

)

Set refistration access code.

Parameters

string

$a_code

Returns

Definition at line 483 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->reg_access_code = $a_code;
        }

Here is the caller graph for this function:

setRegistrationEnd()

ilObjGroup::setRegistrationEnd

(

$a_end

)

set registration end

public

Parameters

int

unix time

Returns

Definition at line 282 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->reg_end = $a_end;
        }

Here is the caller graph for this function:

setRegistrationStart()

ilObjGroup::setRegistrationStart

(

$a_start

)

set registration start

public

Parameters

object

ilDateTime

Returns

Definition at line 258 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->reg_start = $a_start;
        }

Here is the caller graph for this function:

setRegistrationType()

ilObjGroup::setRegistrationType

(

$a_type

)

set registration type

public

Parameters

int	registration type

Returns

Definition at line 201 of file class.ilObjGroup.php.

Referenced by read().

        {
                $this->reg_type = $a_type;
        }

Here is the caller graph for this function:

setViewMode()

ilObjGroup::setViewMode

(

$a_view_mode

)

Set group view mode.

Parameters

int

$a_view_mode

Definition at line 1741 of file class.ilObjGroup.php.

Referenced by read().

        {               
                $this->view_mode = $a_view_mode;
        }

Here is the caller graph for this function:

translateViewMode()

static ilObjGroup::translateViewMode (   $a_obj_id,   $a_view_mode,   $a_ref_id = null  )

staticprotected

translate view mode

Parameters

int	$a_obj_id
int	$a_view_mode
int	$a_ref_id

Returns

int

Definition at line 1773 of file class.ilObjGroup.php.

References $view_mode, ilObject\_getAllReferences(), ilObject\_lookupObjId(), ilObjCourse\_lookupViewMode(), ilContainer\VIEW_BY_TYPE, ilContainer\VIEW_DEFAULT, ilContainer\VIEW_INHERIT, ilContainer\VIEW_SESSIONS, and ilContainer\VIEW_SIMPLE.

        {
                global $tree;
                
                if(!$a_view_mode)
                {
                        $a_view_mode = ilContainer::VIEW_DEFAULT;
                }
                
                // view mode is inherit => check for parent course
                if($a_view_mode == ilContainer::VIEW_INHERIT)
                {
                        if(!$a_ref_id)
                        {
                                $ref = ilObject::_getAllReferences($a_obj_id);
                                $a_ref_id = end($ref);
                        }                       

                        $crs_ref = $tree->checkForParentType($a_ref_id, 'crs');
                        if(!$crs_ref)
                        {
                                return ilContainer::VIEW_DEFAULT;
                        }

                        include_once './Modules/Course/classes/class.ilObjCourse.php';
                        $view_mode = ilObjCourse::_lookupViewMode(ilObject::_lookupObjId($crs_ref));
                        
                        // validate course view mode
                        if(!in_array($view_mode, array(ilContainer::VIEW_SESSIONS, 
                                ilContainer::VIEW_BY_TYPE, ilContainer::VIEW_SIMPLE)))
                        {
                                return ilContainer::VIEW_DEFAULT;
                        }
                        
                        return $view_mode;
                }
                                                
                return $a_view_mode;
        }                       

Here is the call graph for this function:

update()

ilObjGroup::update

(

)

Update group.

Definition at line 617 of file class.ilObjGroup.php.

References $ilDB, $query, $res, getEnableGroupMap(), getGroupType(), ilObject\getId(), getInformation(), getLatitude(), getLocationZoom(), getLongitude(), getMailToMembersType(), getMaxMembers(), getPassword(), getRegistrationAccessCode(), getRegistrationEnd(), getRegistrationStart(), getRegistrationType(), ilContainer\getViewMode(), IL_CAL_DATETIME, isMembershipLimited(), isRegistrationAccessCodeEnabled(), isRegistrationEnabled(), isRegistrationUnlimited(), isWaitingListEnabled(), and prepareAppointments().

        {
                global $ilDB,$ilAppEventHandler;

                if (!parent::update())
                {
                        return false;
                }

                $query = "UPDATE grp_settings ".
                        "SET information = ".$ilDB->quote($this->getInformation() ,'text').", ".
                        "grp_type = ".$ilDB->quote((int) $this->getGroupType() ,'integer').", ".
                        "registration_type = ".$ilDB->quote($this->getRegistrationType() ,'integer').", ".
                        "registration_enabled = ".$ilDB->quote($this->isRegistrationEnabled() ? 1 : 0 ,'integer').", ".
                        "registration_unlimited = ".$ilDB->quote($this->isRegistrationUnlimited() ? 1 : 0 ,'integer').", ".
                        "registration_start = ".$ilDB->quote($this->getRegistrationStart()->get(IL_CAL_DATETIME,'') ,'timestamp').", ".
                        "registration_end = ".$ilDB->quote($this->getRegistrationEnd()->get(IL_CAL_DATETIME,'') ,'timestamp').", ".
                        "registration_password = ".$ilDB->quote($this->getPassword() ,'text').", ".
//                      "registration_membership_limited = ".$ilDB->quote((int) $this->isMembershipLimited() ,'integer').", ".
                        "registration_mem_limit = ".$ilDB->quote((int) $this->isMembershipLimited() ,'integer').", ".
                        "registration_max_members = ".$ilDB->quote($this->getMaxMembers() ,'integer').", ".
                        "waiting_list = ".$ilDB->quote($this->isWaitingListEnabled() ? 1 : 0 ,'integer').", ".
                        "latitude = ".$ilDB->quote($this->getLatitude() ,'text').", ".
                        "longitude = ".$ilDB->quote($this->getLongitude() ,'text').", ".
                        "location_zoom = ".$ilDB->quote($this->getLocationZoom() ,'integer').", ".
                        "enablemap = ".$ilDB->quote((int) $this->getEnableGroupMap() ,'integer').", ".
                        'reg_ac_enabled = '.$ilDB->quote($this->isRegistrationAccessCodeEnabled(),'integer').', '.
                        'reg_ac = '.$ilDB->quote($this->getRegistrationAccessCode(),'text').', '.
                        'view_mode = '.$ilDB->quote($this->getViewMode(false),'integer').', '.
                        'mail_members_type = '.$ilDB->quote($this->getMailToMembersType(),'integer').' '.
                        "WHERE obj_id = ".$ilDB->quote($this->getId() ,'integer')." ";
                $res = $ilDB->manipulate($query);
                
                $ilAppEventHandler->raise('Modules/Group',
                        'update',
                        array('object' => $this,
                                'obj_id' => $this->getId(),
                                'appointments' => $this->prepareAppointments('update')));
                                
                
                return true;
        }

Here is the call graph for this function:

updateGroupType()

ilObjGroup::updateGroupType

(

)

Change group type.

Revokes permissions of all parent non-protected roles and initiates these roles with the according il_grp_(open|closed) template.

public

Returns

Definition at line 1224 of file class.ilObjGroup.php.

References getDefaultGroupRoles(), getGroupType(), getGrpStatusClosedTemplateId(), getGrpStatusOpenTemplateId(), ilObject\getRefId(), GRP_TYPE_CLOSED, and GRP_TYPE_PUBLIC.

        {
                global $tree,$rbacreview,$rbacadmin;
                
                $parent_roles = $rbacreview->getParentRoleIds($this->getRefId());
                $real_parent_roles = array_diff(array_keys($parent_roles),$this->getDefaultGroupRoles());
                
                // Delete parent roles with stopped inheritance
                foreach($real_parent_roles as $role_id)
                {
                        // Delete local role
                        $rbacadmin->deleteLocalRole($role_id,$this->getRefId());
                }
                $parent_roles = $rbacreview->getParentRoleIds($this->getRefId());
                $real_parent_roles = array_diff(array_keys($parent_roles),$this->getDefaultGroupRoles());
                
                switch($this->getGroupType())
                {
                        case GRP_TYPE_PUBLIC:
                                $template_id = $this->getGrpStatusOpenTemplateId();
                                break;
                                
                        case GRP_TYPE_CLOSED:
                                $template_id = $this->getGrpStatusClosedTemplateId();
                                break;
                }
                
                $first = true;
                foreach($tree->getFilteredSubTree($this->getRefId(),array('grp')) as $subnode)
                {
                        // Read template operations
                        $template_ops = $rbacreview->getOperationsOfRole($template_id,$subnode['type'], ROLE_FOLDER_ID);
                        
                        // for all parent roles
                        foreach($real_parent_roles as $role_id)
                        {
                                if($rbacreview->isProtected($parent_roles[$role_id]['parent'],$role_id))
                                {
                                        continue;
                                }

                                $rbacadmin->deleteLocalRole($role_id,$subnode['child']);
                                
                                // Store current operations
                                $current_ops = $rbacreview->getOperationsOfRole($role_id,$subnode['type'],$parent_roles[$role_id]['parent']);

                                // Revoke permissions
                                $rbacadmin->revokePermission($subnode['child'],$role_id);

                                // Grant permissions
                                $granted = array();
                                foreach($template_ops as $operation)
                                {
                                        if(in_array($operation,$current_ops))
                                        {
                                                $granted[] = $operation;
                                        }
                                }
                                if($granted)
                                {
                                        $rbacadmin->grantPermission($role_id, $granted,$subnode['child']);
                                }
                                
                                if($first)
                                {
                                        // This is the group itself
                                        $rbacadmin->copyRolePermissionIntersection(
                                                $template_id, ROLE_FOLDER_ID,
                                                $role_id, $parent_roles[$role_id]['parent'],
                                                $subnode["child"],$role_id);
                                        $rbacadmin->assignRoleToFolder($role_id,$subnode['child'],"n");
                                        
                                }
                        }
                        $first = false;
                }
        }

Here is the call graph for this function:

validate()

ilObjGroup::validate

(

)

validate group settings

public

Returns

bool

Definition at line 535 of file class.ilObjGroup.php.

References $ilErr, ilDateTime\_before(), getGroupType(), getMaxMembers(), getPassword(), getRegistrationEnd(), getRegistrationStart(), getRegistrationType(), ilObject\getTitle(), GRP_REGISTRATION_PASSWORD, and isMembershipLimited().

        {
                global $ilErr;
                
                if(!$this->getTitle())
                {
                        $this->title = '';
                        $ilErr->appendMessage($this->lng->txt(self::ERR_MISSING_TITLE));
                }
                if(!$this->getGroupType())
                {
                        $ilErr->appendMessage($this->lng->txt(self::ERR_MISSING_GROUP_TYPE));
                }
                if($this->getRegistrationType() == GRP_REGISTRATION_PASSWORD and !strlen($this->getPassword()))
                {
                        $ilErr->appendMessage($this->lng->txt(self::ERR_MISSING_PASSWORD));
                }
                if(ilDateTime::_before($this->getRegistrationEnd(),$this->getRegistrationStart()))
                {
                        $ilErr->appendMessage($this->lng->txt(self::ERR_WRONG_REG_TIME_LIMIT));
                }
                if($this->isMembershipLimited() and (!is_numeric($this->getMaxMembers()) or $this->getMaxMembers() <= 0))
                {
                        $ilErr->appendMessage($this->lng->txt(self::ERR_WRONG_MAX_MEMBERS));
                }
                return strlen($ilErr->getMessage()) == 0;
        }

Here is the call graph for this function:

Field Documentation

$enablemap

ilObjGroup::$enablemap = 0

private

Definition at line 67 of file class.ilObjGroup.php.

Referenced by getEnableGroupMap().

$file_obj

ilObjGroup::$file_obj = null

Group file object for handling of export files.

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

Referenced by __initFileObject().

$group_type

ilObjGroup::$group_type = null

protected

Definition at line 51 of file class.ilObjGroup.php.

Referenced by getGroupType(), and isGroupTypeModified().

$information

ilObjGroup::$information

protected

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

Referenced by getInformation().

$latitude

ilObjGroup::$latitude = ''

private

Definition at line 64 of file class.ilObjGroup.php.

Referenced by getLatitude().

$locationzoom

ilObjGroup::$locationzoom = 0

private

Definition at line 66 of file class.ilObjGroup.php.

Referenced by getLocationZoom().

$longitude

ilObjGroup::$longitude = ''

private

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

Referenced by getLongitude().

$m_grpStatus

ilObjGroup::$m_grpStatus

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

$m_roleAdminId

ilObjGroup::$m_roleAdminId

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

$m_roleMemberId

ilObjGroup::$m_roleMemberId

Definition at line 87 of file class.ilObjGroup.php.

$mail_members

ilObjGroup::$mail_members = self::MAIL_ALLOWED_ALL

private

Definition at line 74 of file class.ilObjGroup.php.

Referenced by getMailToMembersType().

$members_obj

ilObjGroup::$members_obj

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

$reg_access_code

ilObjGroup::$reg_access_code = ''

private

Definition at line 69 of file class.ilObjGroup.php.

Referenced by getRegistrationAccessCode().

$reg_access_code_enabled

ilObjGroup::$reg_access_code_enabled = false

private

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

Referenced by isRegistrationAccessCodeEnabled().

$reg_enabled

ilObjGroup::$reg_enabled = true

protected

Definition at line 53 of file class.ilObjGroup.php.

$reg_end

ilObjGroup::$reg_end = null

protected

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

$reg_max_members

ilObjGroup::$reg_max_members = 0

protected

Definition at line 59 of file class.ilObjGroup.php.

Referenced by getMaxMembers().

$reg_membership_limitation

ilObjGroup::$reg_membership_limitation = false

protected

Definition at line 58 of file class.ilObjGroup.php.

Referenced by isMembershipLimited().

$reg_password

ilObjGroup::$reg_password = ''

protected

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

Referenced by getPassword().

$reg_start

ilObjGroup::$reg_start = null

protected

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

$reg_type

ilObjGroup::$reg_type = GRP_REGISTRATION_DIRECT

protected

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

Referenced by getRegistrationType().

$reg_unlimited

ilObjGroup::$reg_unlimited = true

protected

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

Referenced by isRegistrationUnlimited().

$view_mode

ilObjGroup::$view_mode = NULL

private

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

Referenced by lookupViewMode(), and translateViewMode().

$waiting_list

ilObjGroup::$waiting_list = false

protected

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

Referenced by isWaitingListEnabled(), and register().

CAL_REG_END

const ilObjGroup::CAL_REG_END = 2

Definition at line 36 of file class.ilObjGroup.php.

CAL_REG_START

const ilObjGroup::CAL_REG_START = 1

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

ERR_MISSING_GROUP_TYPE

const ilObjGroup::ERR_MISSING_GROUP_TYPE = 'grp_missing_grp_type'

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

ERR_MISSING_PASSWORD

const ilObjGroup::ERR_MISSING_PASSWORD = 'grp_missing_password'

Definition at line 43 of file class.ilObjGroup.php.

ERR_MISSING_TITLE

const ilObjGroup::ERR_MISSING_TITLE = 'msg_no_title'

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

ERR_WRONG_MAX_MEMBERS

const ilObjGroup::ERR_WRONG_MAX_MEMBERS = 'grp_wrong_max_members'

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

ERR_WRONG_REG_TIME_LIMIT

const ilObjGroup::ERR_WRONG_REG_TIME_LIMIT = 'grp_wrong_reg_time_limit'

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

GRP_ADMIN

const ilObjGroup::GRP_ADMIN = 2

Definition at line 39 of file class.ilObjGroup.php.

GRP_MEMBER

const ilObjGroup::GRP_MEMBER = 1

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

MAIL_ALLOWED_ALL

const ilObjGroup::MAIL_ALLOWED_ALL = 1

Definition at line 47 of file class.ilObjGroup.php.

Referenced by ilObjGroupGUI\addMailToMemberButton(), and ilObjGroupGUI\initForm().

MAIL_ALLOWED_TUTORS

const ilObjGroup::MAIL_ALLOWED_TUTORS = 2

Definition at line 48 of file class.ilObjGroup.php.

Referenced by ilObjGroupGUI\initForm().

---

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

• Modules/Group/classes/class.ilObjGroup.php