Inheritance diagram for ilObjGroup:

Collaboration diagram for ilObjGroup:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=true)

	setInformation (string $a_information)

	getInformation ()

	setGroupType (int $a_type)

	getGroupType ()

	setRegistrationType (int $a_type)

	getRegistrationType ()

	isRegistrationEnabled ()

	enableUnlimitedRegistration (bool $a_status)

	isRegistrationUnlimited ()

	setRegistrationStart (?ilDateTime $a_start)

	getRegistrationStart ()

	setRegistrationEnd (?ilDateTime $a_end)

	getRegistrationEnd ()

	setPassword (string $a_pass)

	getPassword ()

	enableMembershipLimitation (bool $a_status)

	isMembershipLimited ()

	setMinMembers (int $a_max)

	getMinMembers ()

	setMaxMembers (int $a_max)

	getMaxMembers ()

	enableWaitingList (bool $a_status)

	isWaitingListEnabled ()

	setWaitingListAutoFill (bool $a_value)

	hasWaitingListAutoFill ()

	setLatitude (string $a_latitude)

	getLatitude ()

	setLongitude (string $a_longitude)

	getLongitude ()

	setLocationZoom (int $a_locationzoom)

	getLocationZoom ()

	setEnableGroupMap (bool $a_enablemap)

	getEnableMap ()

	getEnableGroupMap ()

	getRegistrationAccessCode ()

	setRegistrationAccessCode (string $a_code)

	isRegistrationAccessCodeEnabled ()

	enableRegistrationAccessCode (bool $a_status)

	setMailToMembersType (int $a_type)

	getMailToMembersType ()

	setCancellationEnd (?ilDate $a_value)

	getCancellationEnd ()

	setShowMembers (bool $a_status)

	getShowMembers ()

	setAutoNotification (bool $a_status)

	getAutoNotification ()

	setPeriod (?\ilDateTime $start=null, ?\ilDateTime $end=null)

	getStartTimeIndication ()

	getStart ()

	getEnd ()

	enableSessionLimit (bool $a_status)

	isSessionLimitEnabled ()

	setNumberOfPreviousSessions (int $a_num)

	getNumberOfPreviousSessions ()

	setNumberOfNextSessions (int $a_num)

	getNumberOfNextSessions ()

	validate ()
	validate group settings More...

	create ()

	update ()

	delete ()

	read ()

	cloneDependencies (int $a_target_id, int $a_copy_id)

	cloneAutoGeneratedRoles (ilObjGroup $new_obj)
	Clone group admin and member role permissions. More...

	getDefaultMemberRole ()
	returns object id of created default member role More...

	getDefaultAdminRole ()
	returns object id of created default adminstrator role More...

	leaveGroup ()

	leave (int $a_user_id)
	deassign member from group role More...

	getGroupMemberIds ()
	get all group Member ids regardless of role More...

	getGroupMemberData (array $a_mem_ids, int $active=1)
	get all group Members regardless of group role. More...

	getCountMembers ()

	getGroupAdminIds (int $a_grpId=0)

	getLocalGroupRoles (bool $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 More...

	getGrpStatusOpenTemplateId ()
	get group status open template More...

	updateGroupType (int $a_group_type=ilGroupConstants::GRP_TYPE_OPEN)
	Change group type Revokes permissions of all parent non-protected roles and initiates these roles with the according il_grp_(open\|closed) template. More...

	setGroupStatus (int $a_status)

	getGroupStatus ()
	get group status More...

	readGroupStatus ()
	Read group type. More...

	getMemberRoles (int $a_user_id)

	isAdmin (int $a_userId)

	initDefaultRoles ()

	setParentRolePermissions (int $a_parent_ref)
	This method is called before "initDefaultRoles". More...

	applyDidacticTemplate (int $a_tpl_id)

	_isMember (int $a_user_id, int $a_ref_id, string $a_field='')

	_getMembers (int $a_obj_id)

	getViewMode ()
	Get effective container view mode. More...

	setViewMode (int $a_view_mode)

	addAdditionalSubItemInformation (array &$object)
	Add additional information to sub item, e.g. More...

	getMessage ()

	setMessage (string $a_message)

	appendMessage (string $a_message)

	getMembersObject ()

	register (int $a_user_id, int $a_role=ilParticipants::IL_GRP_MEMBER, bool $a_force_registration=false)

	handleAutoFill ()

Public Member Functions inherited from ilObject
	getObjectProperties ()

	flushObjectProperties ()

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

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

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

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

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

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

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

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

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

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

	selfOrParentWithRatingEnabled ()

	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Public Member Functions inherited from ilContainer
	getTileSizes ()

	getObjectTranslation ()

	setObjectTranslation (?ilObjectTranslation $obj_trans)

	createContainerDirectory ()

	getContainerDirectory ()

	setHiddenFilesFound (bool $a_hiddenfilesfound)

	getHiddenFilesFound ()

	getStyleSheetId ()

	setStyleSheetId (int $a_style_id)

	setNewsTimeline (bool $a_val)

	getNewsTimeline ()

	setNewsTimelineAutoEntries (bool $a_val)

	getNewsTimelineAutoEntries ()

	setNewsTimelineLandingPage (bool $a_val)

	getNewsTimelineLandingPage ()

	isNewsTimelineEffective ()

	isNewsTimelineLandingPageEffective ()

	setNewsBlockActivated (bool $a_val)

	getNewsBlockActivated ()

	setUseNews (bool $a_val)

	getUseNews ()

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies (container sorting) More...

	cloneAllObject (string $session_id, string $client_id, string $new_type, int $ref_id, int $clone_source, array $options, bool $soap_call=false, int $a_submode=1)

	delete ()
	delete category and all related data More...

	getViewMode ()

	getOrderType ()

	setOrderType (int $a_value)

	isClassificationFilterActive ()

	filteredSubtree ()
	Note grp/crs currently allow to filter in their whole subtrees Catetories only their direct childs. More...

	getSubItems (bool $a_admin_panel_enabled=false, bool $a_include_side_block=false, int $a_get_single=0, ?ilContainerUserFilter $container_user_filter=null)

	gotItems ()

	addAdditionalSubItemInformation (array &$object)
	Add additional information to sub item, e.g. More...

	getGroupedObjTypes ()

	enablePageEditing ()

	create ()

	putInTree (int $parent_ref_id)

	update ()

	read ()

	readContainerSettings ()

	removeTranslations ()

	deleteTranslation (string $a_lang)

	addTranslation (string $a_title, string $a_desc, string $a_lang, string $a_lang_default)

Public Member Functions inherited from ilMembershipRegistrationCodes
	register (int $a_user_id)
	Register an user. More...

Static Public Member Functions
static	lookupGroupTye (int $a_id)

static	lookupGroupStatusTemplateId (int $a_obj_id)

static	_lookupIdByTitle (string $a_title)

static	lookupViewMode ($a_obj_id)

static	translateViewMode (int $a_obj_id, int $a_view_mode, ?int $a_ref_id=null)

static	lookupObjectsByCode (string $a_code)

static	mayLeave (int $a_group_id, ?int $a_user_id=null, ?ilDate &$a_date=null)

static	findGroupsWithNotEnoughMembers ()

static	lookupShowMembersEnabled (int $a_obj_id)

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", ?int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	getIconForType (string $type)

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

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

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

Static Public Member Functions inherited from ilContainer
static	_getContainerDirectory (int $a_id)

static	_lookupContainerSetting (int $a_id, string $a_keyword, ?string $a_default_value=null)

static	_hasContainerSetting (int $a_id, string $a_keyword)

static	_writeContainerSetting (int $a_id, string $a_keyword, string $a_value)

static	_getContainerSettings (int $a_id)

static	_deleteContainerSettings (int $a_id, string $a_keyword="", bool $a_keyword_like=false)

static	_exportContainerSettings (ilXmlWriter $a_xml, int $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	CAL_START = 3

const	CAL_END = 4

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	ERR_MISSING_MIN_MAX_MEMBERS = 'grp_wrong_min_max_members'

const	ERR_WRONG_MIN_MAX_MEMBERS = 'grp_max_and_min_members_invalid'

const	ERR_WRONG_REGISTRATION_LIMITED = 'grp_err_registration_limited'

const	MAIL_ALLOWED_ALL = 1

const	MAIL_ALLOWED_TUTORS = 2

	$SHOW_MEMBERS_ENABLED = 1

	$SHOW_MEMBERS_DISABLED = 0

ilGroupParticipants	$members_obj

	$m_roleMemberId

	$m_roleAdminId

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

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

const	TILE_NORMAL = 0

const	TILE_SMALL = 1

const	TILE_LARGE = 2

const	TILE_EXTRA_LARGE = 3

const	TILE_FULL = 4

array	$items = []

Protected Member Functions
	toggleStartTimeIndication (bool $time_indication)

	setStart (?ilDateTime $a_value=null)

	setEnd (?ilDateTime $a_value=null)

	getDefaultGroupRoles ()
	get default group roles, returns the defaultlike create roles il_grp_member, il_grp_admin More...

	prepareAppointments ($a_mode='create')
	Prepare calendar appointments. More...

	initParticipants ()

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Protected Member Functions inherited from ilContainer
	getInitialSubitems ()

	applyContainerUserFilter (array $objects, ?ilContainerUserFilter $container_user_filter=null)

Private Attributes
string	$information = ''

int	$group_status = 0

int	$group_type = ilGroupConstants::GRP_TYPE_UNKNOWN

int	$reg_type = ilGroupConstants::GRP_REGISTRATION_DIRECT

bool	$reg_unlimited = true

ilDateTime	$reg_start = null

ilDateTime	$reg_end = null

string	$reg_password = ''

bool	$reg_membership_limitation = false

int	$reg_min_members = 0

int	$reg_max_members = 0

bool	$waiting_list = false

bool	$auto_fill_from_waiting = false

ilDate	$leave_end = null

bool	$show_members = true

bool	$session_limit = false

int	$session_prev = -1

int	$session_next = -1

bool	$start_time_indication = false

ilDateTime	$grp_start = null

ilDateTime	$grp_end = null

bool	$auto_notification = true

string	$latitude = ''

string	$longitude = ''

int	$locationzoom = 0

bool	$enablemap = false

string	$reg_access_code = ''

bool	$reg_access_code_enabled = false

int	$view_mode = ilContainer::VIEW_DEFAULT

int	$mail_members = self::MAIL_ALLOWED_ALL

ilLogger	$logger

string	$message = ''

array	$local_roles = []

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

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

LOMServices	$lom_services

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Protected Attributes inherited from ilContainer
News	$news

ILIAS Style Content DomainService	$content_style_domain

ILIAS Container InternalDomainService	$domain

ilAccessHandler	$access

ilRbacSystem	$rbacsystem

ilObjUser	$user

ilObjectDefinition	$obj_definition

int	$order_type = 0

bool	$hiddenfilesfound = false

bool	$news_timeline = false

bool	$news_timeline_auto_entries = false

ilSetting	$setting

ilObjectTranslation	$obj_trans = null

int	$style_id = 0

bool	$news_timeline_landing_page = false

bool	$news_block_activated = false

bool	$use_news = false

ilRecommendedContentManager	$recommended_content_manager

array	$type_grps = null

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 31 of file class.ilObjGroup.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

References $DIC, ilObject\$tree, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\logger().

     {
         global $DIC;
 
         $tree = $DIC['tree'];
 
         $this->tree = &$tree;
 
         $this->type = "grp";
         parent::__construct($a_id, $a_call_by_reference);
 
         $this->logger = $DIC->logger()->grp();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getMembers()

ilObjGroup::_getMembers ( int $a_obj_id )

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

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

Referenced by _isMember().

                                               : array
     {
         // get reference
         $ref_ids = ilObject::_getAllReferences($a_obj_id);
         $ref_id = current($ref_ids);
 
         $local_roles = $this->rbac_review->getRolesOfRoleFolder($ref_id, false);
 
         $users = array();
         foreach ($local_roles as $role_id) {
             $users = array_merge($users, $this->rbac_review->assignedUsers($role_id));
         }
         return array_unique($users);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _isMember()

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

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

References $res, _getMembers(), ilObject\_lookupObjId(), ilObjectFactory\getInstanceByObjId(), and ilArrayUtil\quoteArray().

Referenced by ilObjCourseGrouping\_checkGroupingDependencies().

                                                                                   : bool
     {
         $local_roles = $this->rbac_review->getRolesOfRoleFolder($a_ref_id, false);
         $user_roles = $this->rbac_review->assignedRoles($a_user_id);
 
         // Used for membership limitations -> check membership by given field
         if ($a_field) {
             $tmp_user = ilObjectFactory::getInstanceByObjId($a_user_id);
             if (!$tmp_user instanceof ilObjUser) {
                 throw new DomainException('Invalid user id given: ' . $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(ilObject::_lookupObjId($a_ref_id))) {
                 return false;
             }
             $query = "SELECT * FROM usr_data as ud " .
                 "WHERE usr_id IN (" . implode(",", ilArrayUtil::quoteArray($members)) . ") " .
                 $and;
             $res = $this->db->query($query);
             return (bool) $res->numRows();
         }
 
         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()

static ilObjGroup::_lookupIdByTitle ( string $a_title )

static

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

References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilMailAddressTypeHelperImpl\getGroupObjIdByTitle().

                                                             : int
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         $query = "SELECT * FROM object_data WHERE title = " .
             $ilDB->quote($a_title, 'text') . " AND type = 'grp'";
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return $row->obj_id;
         }
         return 0;
     }

Here is the caller graph for this function:

◆ addAdditionalSubItemInformation()

ilObjGroup::addAdditionalSubItemInformation ( array & $object )

Add additional information to sub item, e.g.

used in courses for timings information etc.

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

References ilObjectActivation\addAdditionalSubItemInformation().

                                                                    : void
     {
         ilObjectActivation::addAdditionalSubItemInformation($object);
     }

Here is the call graph for this function:

◆ appendMessage()

ilObjGroup::appendMessage ( string $a_message )

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

References getMessage().

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

Here is the call graph for this function:

◆ applyDidacticTemplate()

ilObjGroup::applyDidacticTemplate ( int $a_tpl_id )

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

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

Referenced by updateGroupType().

                                                         : void
     {
         parent::applyDidacticTemplate($a_tpl_id);
 
         if (!$a_tpl_id) {
             // init default type
             $this->setParentRolePermissions($this->getRefId());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneAutoGeneratedRoles()

ilObjGroup::cloneAutoGeneratedRoles ( ilObjGroup $new_obj )

Clone group admin and member role permissions.

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

References getDefaultAdminRole(), getDefaultMemberRole(), ilObject\getRefId(), and ILIAS\Repository\logger().

Referenced by read().

                                                                 : void
     {
         $admin = $this->getDefaultAdminRole();
         $new_admin = $new_obj->getDefaultAdminRole();
         if (!$admin || !$new_admin || !$this->getRefId() || !$new_obj->getRefId()) {
             $this->logger->warning('Error cloning auto generated rol: il_grp_admin');
         }
         $this->rbac_admin->copyRolePermissions($admin, $this->getRefId(), $new_obj->getRefId(), $new_admin, true);
         $this->logger->info('Finished copying of role il_grp_admin.');
 
         $member = $this->getDefaultMemberRole();
         $new_member = $new_obj->getDefaultMemberRole();
         if (!$member || !$new_member) {
             $this->logger->warning('Error cloning auto generated rol: il_grp_member');
         }
         $this->rbac_admin->copyRolePermissions($member, $this->getRefId(), $new_obj->getRefId(), $new_member, true);
         $this->logger->info('Finished copying of role il_grp_member.');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneDependencies()

ilObjGroup::cloneDependencies	(	int	$a_target_id,
		int	$a_copy_id
	)

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

References ilObjCourseGrouping\_getGroupings(), ilObjectActivation\cloneDependencies(), ilObject\getId(), ilObject\getRefId(), and ILIAS\Repository\logger().

                                                                        : bool
     {
         parent::cloneDependencies($a_target_id, $a_copy_id);
 
         ilObjectActivation::cloneDependencies($this->getRefId(), $a_target_id, $a_copy_id);
 
         // clone membership limitation
         foreach (\ilObjCourseGrouping::_getGroupings($this->getId()) as $grouping_id) {
             $this->logger->info('Handling grouping id: ' . $grouping_id);
             $grouping = new \ilObjCourseGrouping($grouping_id);
             $grouping->cloneGrouping($a_target_id, $a_copy_id);
         }
         return true;
     }

Here is the call graph for this function:

◆ create()

ilObjGroup::create ( )

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

References $res, ilObject\createMetaData(), getAutoNotification(), getCancellationEnd(), getEnableGroupMap(), getEnd(), getGroupType(), ilObject\getId(), getInformation(), getLatitude(), getLocationZoom(), getLongitude(), getMailToMembersType(), getMaxMembers(), getMinMembers(), getNumberOfNextSessions(), getNumberOfPreviousSessions(), getPassword(), getRegistrationAccessCode(), getRegistrationEnd(), getRegistrationStart(), getRegistrationType(), getStart(), hasWaitingListAutoFill(), IL_CAL_DATETIME, IL_CAL_UNIX, isMembershipLimited(), isRegistrationAccessCodeEnabled(), isRegistrationEnabled(), isRegistrationUnlimited(), isSessionLimitEnabled(), isWaitingListEnabled(), null, prepareAppointments(), and ilDBConstants\T_INTEGER.

                             : int
     {
         if (!parent::create()) {
             return 0;
         }
         $this->createMetaData();
 
         $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," .
             "leave_end,registration_min_members,auto_wait, grp_start, grp_end, auto_notification, session_limit, session_prev, session_next) " .
             "VALUES(" .
             $this->db->quote($this->getId(), 'integer') . ", " .
             $this->db->quote($this->getInformation(), 'text') . ", " .
             $this->db->quote($this->getGroupType(), 'integer') . ", " .
             $this->db->quote($this->getRegistrationType(), 'integer') . ", " .
             $this->db->quote(($this->isRegistrationEnabled() ? 1 : 0), 'integer') . ", " .
             $this->db->quote(($this->isRegistrationUnlimited() ? 1 : 0), 'integer') . ", " .
             $this->db->quote(($this->getRegistrationStart() && !$this->getRegistrationStart()->isNull()) ? $this->getRegistrationStart()->get(IL_CAL_DATETIME, '') : null, 'timestamp') . ", " .
             $this->db->quote(($this->getRegistrationEnd() && !$this->getRegistrationEnd()->isNull()) ? $this->getRegistrationEnd()->get(IL_CAL_DATETIME, '') : null, 'timestamp') . ", " .
             $this->db->quote($this->getPassword(), 'text') . ", " .
             $this->db->quote((int) $this->isMembershipLimited(), 'integer') . ", " .
             $this->db->quote($this->getMaxMembers(), 'integer') . ", " .
             $this->db->quote($this->isWaitingListEnabled() ? 1 : 0, 'integer') . ", " .
             $this->db->quote($this->getLatitude(), 'text') . ", " .
             $this->db->quote($this->getLongitude(), 'text') . ", " .
             $this->db->quote($this->getLocationZoom(), 'integer') . ", " .
             $this->db->quote((int) $this->getEnableGroupMap(), 'integer') . ", " .
             $this->db->quote($this->isRegistrationAccessCodeEnabled(), 'integer') . ', ' .
             $this->db->quote($this->getRegistrationAccessCode(), 'text') . ', ' .
             $this->db->quote($this->view_mode, 'integer') . ', ' .
             $this->db->quote($this->getMailToMembersType(), 'integer') . ', ' .
             $this->db->quote(($this->getCancellationEnd() && !$this->getCancellationEnd()->isNull()) ? $this->getCancellationEnd()->get(IL_CAL_UNIX) : null, 'integer') . ', ' .
             $this->db->quote($this->getMinMembers(), 'integer') . ', ' .
             $this->db->quote($this->hasWaitingListAutoFill(), 'integer') . ', ' .
             $this->db->quote($this->getStart() instanceof ilDate ? $this->getStart()->get(IL_CAL_UNIX) : null, 'integer') . ', ' .
             $this->db->quote($this->getEnd() instanceof ilDate ? $this->getEnd()->get(IL_CAL_UNIX) : null, 'integer') . ', ' .
             $this->db->quote($this->getAutoNotification(), \ilDBConstants::T_INTEGER) . ', ' .
             $this->db->quote($this->isSessionLimitEnabled(), ilDBConstants::T_INTEGER) . ', ' .
             $this->db->quote($this->getNumberOfPreviousSessions(), ilDBConstants::T_INTEGER) . ', ' .
             $this->db->quote($this->getNumberOfNextSessions(), ilDBConstants::T_INTEGER) .
             ')';
         $res = $this->db->manipulate($query);
 
         $this->app_event_handler->raise(
             'components/ILIAS/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 ( )

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

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

                             : bool
     {
         // always call parent delete function first!!
         if (!parent::delete()) {
             return false;
         }
 
         $this->deleteMetaData();
 
         $query = "DELETE FROM grp_settings " .
             "WHERE obj_id = " . $this->db->quote($this->getId(), 'integer');
         $res = $this->db->manipulate($query);
 
         ilGroupParticipants::_deleteAllEntries($this->getId());
 
         $this->app_event_handler->raise(
             'components/ILIAS/Group',
             'delete',
             array('object' => $this,
                 'obj_id' => $this->getId(),
                 'appointments' => $this->prepareAppointments('delete'))
         );
         return true;
     }

Here is the call graph for this function:

◆ enableMembershipLimitation()

ilObjGroup::enableMembershipLimitation ( bool $a_status )

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

Referenced by read().

                                                               : void
     {
         $this->reg_membership_limitation = $a_status;
     }

Here is the caller graph for this function:

◆ enableRegistrationAccessCode()

ilObjGroup::enableRegistrationAccessCode ( bool $a_status )

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

Referenced by read().

                                                                 : void
     {
         $this->reg_access_code_enabled = $a_status;
     }

Here is the caller graph for this function:

◆ enableSessionLimit()

ilObjGroup::enableSessionLimit ( bool $a_status )

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

Referenced by read().

                                                       : void
     {
         $this->session_limit = $a_status;
     }

Here is the caller graph for this function:

◆ enableUnlimitedRegistration()

ilObjGroup::enableUnlimitedRegistration ( bool $a_status )

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

Referenced by read().

                                                                : void
     {
         $this->reg_unlimited = $a_status;
     }

Here is the caller graph for this function:

◆ enableWaitingList()

ilObjGroup::enableWaitingList ( bool $a_status )

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

Referenced by read().

                                                      : void
     {
         $this->waiting_list = $a_status;
     }

Here is the caller graph for this function:

◆ findGroupsWithNotEnoughMembers()

static ilObjGroup::findGroupsWithNotEnoughMembers ( )

static

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

References $DIC, $ilDB, $q, $res, ilObject\$tree, ilObject\_getAllReferences(), IL_CAL_DATETIME, IL_CAL_UNIX, ILIAS\Repository\int(), ilTree\isDeleted(), ilDBConstants\T_TEXT, and ilTimeZone\UTC.

Referenced by ilMembershipCronMinMembers\getGroups().

                                                            : array
     {
         global $DIC;
         $ilDB = $DIC->database();
         $tree = $DIC->repositoryTree();
 
         $res = array();
         $before = new ilDateTime(time(), IL_CAL_UNIX);
         $now_date = $before->get(IL_CAL_DATETIME, '', ilTimeZone::UTC);
         /*
          * For groups, registration_start and registration_end are currently not
          * persisted in UTC but the local timezone, so when fetching the current time
          * here we need to do the same.
          */
         $now_date_local = $before->get(IL_CAL_DATETIME);
         $now = $before->get(IL_CAL_UNIX);
 
         $set = $ilDB->query($q = "SELECT obj_id, registration_min_members" .
             " FROM grp_settings" .
             " WHERE registration_min_members > " . $ilDB->quote(0, "integer") .
             " AND registration_mem_limit = " . $ilDB->quote(1, "integer") . // #17206
             " AND ((leave_end IS NOT NULL" .
                 " AND leave_end < " . $ilDB->quote($now, "integer") . ")" .
                 " OR (leave_end IS NULL" .
                 " AND registration_end IS NOT NULL" .
                 " AND registration_end < " . $ilDB->quote($now_date_local, "text") . "))" .
             " AND (period_start IS NULL OR period_start > " . $ilDB->quote($now_date, ilDBConstants::T_TEXT) . ")");
         while ($row = $ilDB->fetchAssoc($set)) {
             $refs = ilObject::_getAllReferences((int) $row['obj_id']);
             $ref = end($refs);
 
             if ($tree->isDeleted($ref)) {
                 continue;
             }
 
             $part = new ilGroupParticipants((int) $row["obj_id"]);
             $reci = $part->getNotificationRecipients();
             if (sizeof($reci)) {
                 $missing = (int) $row["registration_min_members"] - $part->getCountMembers();
                 if ($missing > 0) {
                     $res[(int) $row["obj_id"]] = array($missing, $reci);
                 }
             }
         }
         return $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAutoNotification()

ilObjGroup::getAutoNotification ( )

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

References $auto_notification.

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

                                          : bool
     {
         return $this->auto_notification;
     }

Here is the caller graph for this function:

◆ getCancellationEnd()

ilObjGroup::getCancellationEnd ( )

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

References $leave_end.

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

                                         : ?ilDate
     {
         return $this->leave_end;
     }

Here is the caller graph for this function:

◆ getCountMembers()

ilObjGroup::getCountMembers ( )

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

References getGroupMemberIds().

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

Here is the call graph for this function:

◆ getDefaultAdminRole()

ilObjGroup::getDefaultAdminRole ( )

returns object id of created default adminstrator role

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

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

Referenced by cloneAutoGeneratedRoles().

                                          : int
     {
         $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 ( )

protected

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

Parameters

array the obj_ids of group specific roles(il_grp_member,il_grp_admin)

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

References ilObjectFactory\getInstanceByObjId(), and ilObject\getRefId().

Referenced by getGroupAdminIds(), and isAdmin().

                                              : array
     {
         $grp_id = $this->getRefId();
         $role_arr = $this->rbac_review->getRolesOfRoleFolder($grp_id);
         $arr_grpDefaultRoles = [];
         foreach ($role_arr as $role_id) {
             $role = ilObjectFactory::getInstanceByObjId($role_id, false);
             $grp_Member = "il_grp_member_" . $grp_id;
             $grp_Admin = "il_grp_admin_" . $grp_id;
 
             if (strcmp($role->getTitle(), $grp_Member) == 0) {
                 $arr_grpDefaultRoles["grp_member_role"] = $role->getId();
             }
 
             if (strcmp($role->getTitle(), $grp_Admin) == 0) {
                 $arr_grpDefaultRoles["grp_admin_role"] = $role->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

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

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

Referenced by cloneAutoGeneratedRoles().

                                           : int
     {
         $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 ( )

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

References $enablemap.

Referenced by create(), getEnableMap(), read(), and update().

                                        : bool
     {
         return $this->enablemap;
     }

Here is the caller graph for this function:

◆ getEnableMap()

ilObjGroup::getEnableMap ( )

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

References getEnableGroupMap().

                                   : bool
     {
         return $this->getEnableGroupMap();
     }

Here is the call graph for this function:

◆ getEnd()

ilObjGroup::getEnd ( )

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

References $grp_end.

Referenced by create(), prepareAppointments(), read(), and update().

                             : ?\ilDateTime
     {
         return $this->grp_end;
     }

Here is the caller graph for this function:

◆ getGroupAdminIds()

ilObjGroup::getGroupAdminIds ( int $a_grpId = 0 )

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

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

Referenced by leaveGroup().

                                                       : array
     {
         if (!empty($a_grpId)) {
             $grp_id = $a_grpId;
         } else {
             $grp_id = $this->getRefId();
         }
 
         $usr_arr = array();
         $roles = $this->getDefaultGroupRoles();
 
         foreach ($this->rbac_review->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	(	array	$a_mem_ids,
		int	$active = `1`
	)

get all group Members regardless of group role.

fetch all users data in one shot to improve performance

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

References $q, $r, ilDBConstants\FETCHMODE_OBJECT, and ilArrayUtil\quoteArray().

                                                                          : array
     {
         $usr_arr = array();
         $q = "SELECT login,firstname,lastname,title,usr_id,last_login " .
              "FROM usr_data " .
              "WHERE usr_id IN (" . implode(',', ilArrayUtil::quoteArray($a_mem_ids)) . ") ";
 
         if (is_numeric($active) && $active > -1) {
             $q .= "AND active = '$active'";
         }
 
         $q .= 'ORDER BY lastname,firstname';
 
         $r = $this->db->query($q);
         $mem_arr = [];
         while ($row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $mem_arr[] = array("id" => (int) $row->usr_id,
                                 "login" => $row->login,
                                 "firstname" => $row->firstname,
                                 "lastname" => $row->lastname,
                                 "last_login" => $row->last_login
                                 );
         }
 
         return $mem_arr;
     }

Here is the call graph for this function:

◆ getGroupMemberIds()

ilObjGroup::getGroupMemberIds ( )

get all group Member ids regardless of role

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

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

References getLocalGroupRoles().

Referenced by getCountMembers(), and leaveGroup().

                                        : array
     {
         $usr_arr = array();
         $rol = $this->getLocalGroupRoles();
         $mem_arr = [];
         foreach ($rol as $value) {
             foreach ($this->rbac_review->assignedUsers($value) as $member_id) {
                 array_push($usr_arr, $member_id);
             }
         }
         return array_unique($usr_arr);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGroupStatus()

ilObjGroup::getGroupStatus ( )

get group status

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

References $group_status.

                                     : int
     {
         return $this->group_status;
     }

◆ getGroupType()

ilObjGroup::getGroupType ( )

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

References $group_type.

Referenced by create(), and update().

                                   : int
     {
         return $this->group_type;
     }

Here is the caller graph for this function:

◆ getGrpStatusClosedTemplateId()

ilObjGroup::getGrpStatusClosedTemplateId ( )

get group status closed template

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

References $q, $res, and ilDBConstants\FETCHMODE_ASSOC.

                                                   : int
     {
         $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(ilDBConstants::FETCHMODE_ASSOC);
 
         return (int) $row["obj_id"];
     }

◆ getGrpStatusOpenTemplateId()

ilObjGroup::getGrpStatusOpenTemplateId ( )

get group status open template

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

References $q, $res, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by setParentRolePermissions().

                                                 : int
     {
         $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(ilDBConstants::FETCHMODE_ASSOC);
 
         return (int) $row["obj_id"];
     }

Here is the caller graph for this function:

◆ getInformation()

ilObjGroup::getInformation ( )

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

References $information.

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

                                     : string
     {
         return $this->information;
     }

Here is the caller graph for this function:

◆ getLatitude()

ilObjGroup::getLatitude ( )

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

References $latitude.

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

                                  : string
     {
         return $this->latitude;
     }

Here is the caller graph for this function:

◆ getLocalGroupRoles()

ilObjGroup::getLocalGroupRoles ( bool $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

Returns: array [title|id] of roles...

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

References $local_roles, ilObjRole\_getTranslation(), ilObjectFactory\getInstanceByObjId(), and ilObject\getRefId().

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

                                                                  : array
     {
         if (empty($this->local_roles)) {
             $this->local_roles = array();
             $role_arr = $this->rbac_review->getRolesOfRoleFolder($this->getRefId());
 
             foreach ($role_arr as $role_id) {
                 if ($this->rbac_review->isAssignable($role_id, $this->getRefId()) == true) {
                     $role = ilObjectFactory::getInstanceByObjId($role_id, false);
                     if ($a_translate) {
                         $role_name = ilObjRole::_getTranslation($role->getTitle());
                     } else {
                         $role_name = $role->getTitle();
                     }
                     $this->local_roles[$role_name] = $role->getId();
                 }
             }
         }
         return $this->local_roles;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLocationZoom()

ilObjGroup::getLocationZoom ( )

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

References $locationzoom.

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

                                      : int
     {
         return $this->locationzoom;
     }

Here is the caller graph for this function:

◆ getLongitude()

ilObjGroup::getLongitude ( )

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

References $longitude.

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

                                   : string
     {
         return $this->longitude;
     }

Here is the caller graph for this function:

◆ getMailToMembersType()

ilObjGroup::getMailToMembersType ( )

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

References $mail_members.

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

                                           : int
     {
         return $this->mail_members;
     }

Here is the caller graph for this function:

◆ getMaxMembers()

ilObjGroup::getMaxMembers ( )

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

References $reg_max_members.

Referenced by create(), handleAutoFill(), read(), register(), update(), and validate().

                                    : int
     {
         return $this->reg_max_members;
     }

Here is the caller graph for this function:

◆ getMemberRoles()

ilObjGroup::getMemberRoles ( int $a_user_id )

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

References getLocalGroupRoles().

Referenced by leave().

                                                   : array
     {
         return array_intersect(
             $this->rbac_review->assignedRoles($a_user_id),
             $this->getLocalGroupRoles()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMembersObject()

ilObjGroup::getMembersObject ( )

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

References $members_obj, and initParticipants().

Referenced by handleAutoFill().

                                       : ilGroupParticipants
     {
         // #17886
         if (!$this->members_obj instanceof ilGroupParticipants) {
             $this->initParticipants();
         }
         return $this->members_obj;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMessage()

ilObjGroup::getMessage ( )

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

References $message.

Referenced by appendMessage().

                                 : string
     {
         return $this->message;
     }

Here is the caller graph for this function:

◆ getMinMembers()

ilObjGroup::getMinMembers ( )

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

References $reg_min_members.

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

                                    : int
     {
         return $this->reg_min_members;
     }

Here is the caller graph for this function:

◆ getNumberOfNextSessions()

ilObjGroup::getNumberOfNextSessions ( )

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

References $session_next.

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

                                              : int
     {
         return $this->session_next;
     }

Here is the caller graph for this function:

◆ getNumberOfPreviousSessions()

ilObjGroup::getNumberOfPreviousSessions ( )

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

References $session_prev.

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

                                                  : int
     {
         return $this->session_prev;
     }

Here is the caller graph for this function:

◆ getPassword()

ilObjGroup::getPassword ( )

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

References $reg_password.

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

                                  : string
     {
         return $this->reg_password;
     }

Here is the caller graph for this function:

◆ getRegistrationAccessCode()

ilObjGroup::getRegistrationAccessCode ( )

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

References $reg_access_code.

Referenced by create(), and update().

                                                : string
     {
         return $this->reg_access_code;
     }

Here is the caller graph for this function:

◆ getRegistrationEnd()

ilObjGroup::getRegistrationEnd ( )

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

References $reg_end.

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

                                         : ?ilDateTime
     {
         return $this->reg_end;
     }

Here is the caller graph for this function:

◆ getRegistrationStart()

ilObjGroup::getRegistrationStart ( )

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

References $reg_start.

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

                                           : ?ilDateTime
     {
         return $this->reg_start;
     }

Here is the caller graph for this function:

◆ getRegistrationType()

ilObjGroup::getRegistrationType ( )

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

References $reg_type.

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

                                          : int
     {
         return $this->reg_type;
     }

Here is the caller graph for this function:

◆ getShowMembers()

ilObjGroup::getShowMembers ( )

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

References $show_members.

Referenced by read(), and update().

                                     : bool
     {
         return $this->show_members;
     }

Here is the caller graph for this function:

◆ getStart()

ilObjGroup::getStart ( )

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

References $grp_start.

Referenced by create(), prepareAppointments(), read(), and update().

                               : ?\ilDateTime
     {
         return $this->grp_start;
     }

Here is the caller graph for this function:

◆ getStartTimeIndication()

ilObjGroup::getStartTimeIndication ( )

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

References $start_time_indication.

Referenced by prepareAppointments(), and update().

                                             : bool
     {
         return $this->start_time_indication;
     }

Here is the caller graph for this function:

◆ getViewMode()

ilObjGroup::getViewMode ( )

Get effective container view mode.

Returns: int

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

References ilObject\$tree, $view_mode, ilObject\_lookupObjId(), ilObjCourseAccess\_lookupViewMode(), ilTree\checkForParentType(), ilObject\getId(), ilContainer\VIEW_BY_TYPE, ilContainer\VIEW_DEFAULT, ilContainer\VIEW_INHERIT, ilContainer\VIEW_SESSIONS, and ilContainer\VIEW_SIMPLE.

                                  : int
     {
         $tree = $this->tree;
 
         // default: by type
         $view = self::lookupViewMode($this->getId());
 
         if ($view != ilContainer::VIEW_INHERIT) {
             return $view;
         }
 
         $container_ref_id = $tree->checkForParentType($this->ref_id, 'crs');
         if ($container_ref_id) {
             $view_mode = ilObjCourseAccess::_lookupViewMode(ilObject::_lookupObjId($container_ref_id));
             // these three are available...
             if (
                 $view_mode == ilContainer::VIEW_SESSIONS ||
                 $view_mode == ilContainer::VIEW_BY_TYPE ||
                 $view_mode == ilContainer::VIEW_SIMPLE) {
                 return $view_mode;
             }
         }
         return ilContainer::VIEW_DEFAULT;
     }

Here is the call graph for this function:

◆ handleAutoFill()

ilObjGroup::handleAutoFill ( )

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

References $user_id, ilObject\getId(), ilObjectFactory\getInstanceByObjId(), getMaxMembers(), getMembersObject(), ilObject\getRefId(), hasWaitingListAutoFill(), ilParticipants\IL_GRP_MEMBER, isWaitingListEnabled(), ilParticipants\lookupNumberOfMembers(), and ilGroupMembershipMailNotification\TYPE_ACCEPTED_SUBSCRIPTION_MEMBER.

                                     : void
     {
         if ($this->isWaitingListEnabled() &&
             $this->hasWaitingListAutoFill()) {
             $max = $this->getMaxMembers();
             $now = ilGroupParticipants::lookupNumberOfMembers($this->getRefId());
             if ($max > $now) {
                 // see assignFromWaitingListObject()
                 $waiting_list = new ilGroupWaitingList($this->getId());
 
                 foreach ($waiting_list->getUserIds() as $user_id) {
                     if (!$tmp_obj = ilObjectFactory::getInstanceByObjId($user_id, false)) {
                         continue;
                     }
                     if ($this->getMembersObject()->isAssigned($user_id)) {
                         continue;
                     }
                     $this->getMembersObject()->add($user_id, ilParticipants::IL_GRP_MEMBER); // #18213
                     $this->getMembersObject()->sendNotification(ilGroupMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER, $user_id, true);
                     $waiting_list->removeFromList($user_id);
 
                     $now++;
                     if ($now >= $max) {
                         break;
                     }
                 }
             }
         }
     }

Here is the call graph for this function:

◆ hasWaitingListAutoFill()

ilObjGroup::hasWaitingListAutoFill ( )

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

References $auto_fill_from_waiting.

Referenced by create(), handleAutoFill(), read(), and update().

                                             : bool
     {
         return $this->auto_fill_from_waiting;
     }

Here is the caller graph for this function:

◆ initDefaultRoles()

ilObjGroup::initDefaultRoles ( )

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

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

                                       : void
     {
         $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();
     }

Here is the call graph for this function:

◆ initParticipants()

ilObjGroup::initParticipants ( )

protected

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

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

Referenced by getMembersObject(), and read().

                                          : void
     {
         $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 ( int $a_userId )

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

References getDefaultGroupRoles().

Referenced by leaveGroup().

                                           : bool
     {
         $grp_Roles = $this->getDefaultGroupRoles();
         if (in_array($a_userId, $this->rbac_review->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:

◆ isMembershipLimited()

ilObjGroup::isMembershipLimited ( )

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

References $reg_membership_limitation.

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

                                          : bool
     {
         return $this->reg_membership_limitation;
     }

Here is the caller graph for this function:

◆ isRegistrationAccessCodeEnabled()

ilObjGroup::isRegistrationAccessCodeEnabled ( )

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

References $reg_access_code_enabled.

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

                                                      : bool
     {
         return $this->reg_access_code_enabled;
     }

Here is the caller graph for this function:

◆ isRegistrationEnabled()

ilObjGroup::isRegistrationEnabled ( )

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

References getRegistrationType(), and ilGroupConstants\GRP_REGISTRATION_DEACTIVATED.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRegistrationUnlimited()

ilObjGroup::isRegistrationUnlimited ( )

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

References $reg_unlimited.

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

                                              : bool
     {
         return $this->reg_unlimited;
     }

Here is the caller graph for this function:

◆ isSessionLimitEnabled()

ilObjGroup::isSessionLimitEnabled ( )

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

References $session_limit.

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

                                            : bool
     {
         return $this->session_limit;
     }

Here is the caller graph for this function:

◆ isWaitingListEnabled()

ilObjGroup::isWaitingListEnabled ( )

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

References $waiting_list.

Referenced by create(), handleAutoFill(), read(), register(), update(), and validate().

                                           : bool
     {
         return $this->waiting_list;
     }

Here is the caller graph for this function:

◆ leave()

ilObjGroup::leave ( int $a_user_id )

deassign member from group role

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

References getMemberRoles().

Referenced by leaveGroup().

                                          : bool
     {
         $arr_groupRoles = $this->getMemberRoles($a_user_id);
         foreach ($arr_groupRoles as $groupRole) {
             $this->rbac_admin->deassignUser($groupRole, $a_user_id);
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ leaveGroup()

ilObjGroup::leaveGroup ( )

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

References getGroupAdminIds(), getGroupMemberIds(), ilObject\getRefId(), isAdmin(), leave(), and ILIAS\Repository\user().

                                 : int
     {
         $member_ids = $this->getGroupMemberIds();
         if (count($member_ids) <= 1 || !in_array($this->user->getId(), $member_ids)) {
             return 2;
         } elseif (!$this->isAdmin($this->user->getId())) {
             $this->leave($this->user->getId());
             $this->recommended_content_manager->removeObjectRecommendation($this->user->getId(), $this->getRefId());
             return 0;
         } elseif (count($this->getGroupAdminIds()) == 1) {
             return 1;
         }
         return 1;
     }

Here is the call graph for this function:

◆ lookupGroupStatusTemplateId()

static ilObjGroup::lookupGroupStatusTemplateId ( int $a_obj_id )

static

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

References $DIC, $ilDB, $res, ilObject\$type, ilDBConstants\FETCHMODE_ASSOC, ilGroupConstants\GRP_TYPE_CLOSED, and ILIAS\Repository\int().

Referenced by ilRbacAdmin\adjustMovedObjectPermissions().

                                                                      : int
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $type = self::lookupGroupTye($a_obj_id);
         if ($type == ilGroupConstants::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(ilDBConstants::FETCHMODE_ASSOC);
         return $row['obj_id'] ? (int) $row['obj_id'] : 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupGroupTye()

static ilObjGroup::lookupGroupTye ( int $a_id )

static

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

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ilGroupConstants\GRP_TYPE_UNKNOWN.

Referenced by ilObjRole\createPermissionIntersection().

                                                     : int
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = "SELECT grp_type FROM grp_settings " .
             "WHERE obj_id = " . $ilDB->quote($a_id, 'integer');
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return (int) $row->grp_type;
         }
         return ilGroupConstants::GRP_TYPE_UNKNOWN;
     }

Here is the caller graph for this function:

◆ lookupObjectsByCode()

static ilObjGroup::lookupObjectsByCode ( string $a_code )

static

Returns: int[]

See also: interface.ilMembershipRegistrationCodes

Implements ilMembershipRegistrationCodes.

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

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by ilMembershipRegistrationCodeUtils\lookupObjectsByCode().

                                                               : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $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(ilDBConstants::FETCHMODE_OBJECT)) {
             $obj_ids[] = (int) $row->obj_id;
         }
         return $obj_ids;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupShowMembersEnabled()

static ilObjGroup::lookupShowMembersEnabled ( int $a_obj_id )

static

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

References $DIC, $ilDB, and $res.

Referenced by ilParticipants\hasParticipantListAccess().

                                                                   : bool
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $query = 'SELECT show_members FROM grp_settings'
             . ' WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer');
         $res = $ilDB->query($query);
         if ($ilDB->numRows($res) == 0) {
             return false;
         }
         $row = $ilDB->fetchAssoc($res);
         return (bool) $row['show_members'];
     }

Here is the caller graph for this function:

◆ lookupViewMode()

static ilObjGroup::lookupViewMode ( $a_obj_id )

static

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

References $DIC, $ilDB, $res, $view_mode, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), and null.

Referenced by ilGroupXMLWriter\__buildExtraSettings(), ilObjFolder\getViewMode(), and ilObjGroupGUI\initForm().

                                                     : int
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $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(ilDBConstants::FETCHMODE_OBJECT)) {
             $view_mode = (int) $row->view_mode;
         }
         return $view_mode;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mayLeave()

static ilObjGroup::mayLeave	(	int	$a_group_id,
		?int	$a_user_id = `null`,
		?ilDate &	$a_date = `null`
	)

static

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

References $DIC, $ilDB, and IL_CAL_DATE.

Referenced by ilObjGroupAccess\_checkAccess().

                                                                                                      : bool
     {
         global $DIC;
 
         $ilUser = $DIC->user();
         $ilDB = $DIC->database();
 
         if (!$a_user_id) {
             $a_user_id = $ilUser->getId();
         }
 
         $set = $ilDB->query("SELECT leave_end" .
             " FROM grp_settings" .
             " WHERE obj_id = " . $ilDB->quote($a_group_id, "integer"));
         $row = $ilDB->fetchAssoc($set);
         if ($row && isset($row["leave_end"]) && is_numeric($row["leave_end"])) {
             // timestamp to date
             $limit = date("Ymd", (int) $row["leave_end"]);
             if ($limit < date("Ymd")) {
                 $a_date = new ilDate(date("Y-m-d", (int) $row["leave_end"]), IL_CAL_DATE);
                 return false;
             }
         }
         return true;
     }

Here is the caller graph for this function:

◆ prepareAppointments()

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

protected

Prepare calendar appointments.

Returns: ilCalendarAppointmentTemplate[]

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

References getEnd(), ilObject\getLongDescription(), getRegistrationEnd(), getRegistrationStart(), getStart(), getStartTimeIndication(), ilObject\getTitle(), isRegistrationUnlimited(), and ilCalendarEntry\TRANSLATION_SYSTEM.

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

                                                               : array
     {
         switch ($a_mode) {
             case 'create':
             case 'update':
 
                 $apps = array();
                 if ($this->getStart() && $this->getEnd()) {
                     $app = new ilCalendarAppointmentTemplate(self::CAL_START);
                     $app->setTitle($this->getTitle());
                     $app->setSubtitle('grp_cal_start');
                     $app->setTranslationType(ilCalendarEntry::TRANSLATION_SYSTEM);
                     $app->setDescription($this->getLongDescription());
                     $app->setStart($this->getStart());
                     $app->setFullday(!$this->getStartTimeIndication());
                     $apps[] = $app;
 
                     $app = new ilCalendarAppointmentTemplate(self::CAL_END);
                     $app->setTitle($this->getTitle());
                     $app->setSubtitle('grp_cal_end');
                     $app->setTranslationType(ilCalendarEntry::TRANSLATION_SYSTEM);
                     $app->setDescription($this->getLongDescription());
                     $app->setStart($this->getEnd());
                     $app->setFullday(!$this->getStartTimeIndication());
                     $apps[] = $app;
                 }
                 if ($this->isRegistrationUnlimited()) {
                     return $apps;
                 }
 
                 $app = new ilCalendarAppointmentTemplate(self::CAL_REG_START);
                 $app->setTitle($this->getTitle());
                 $app->setSubtitle('grp_cal_reg_start');
                 $app->setTranslationType(ilCalendarEntry::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(ilCalendarEntry::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();
         }
         return [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilObjGroup::read ( )

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

References $res, ilCourseDefinedFieldDefinition\_clone(), ilGroupParticipants\_getInstanceByObjId(), ilContainerSortingSettings\_lookupSortMode(), cloneAutoGeneratedRoles(), ilObject\cloneMetaData(), enableMembershipLimitation(), enableRegistrationAccessCode(), enableSessionLimit(), enableUnlimitedRegistration(), enableWaitingList(), ilDBConstants\FETCHMODE_OBJECT, ilMembershipRegistrationCodeUtils\generateCode(), getAutoNotification(), getCancellationEnd(), getEnableGroupMap(), getEnd(), ilObject\getId(), getInformation(), getLatitude(), getLocationZoom(), getLongitude(), getMailToMembersType(), getMaxMembers(), getMinMembers(), getNumberOfNextSessions(), getNumberOfPreviousSessions(), getPassword(), ilObject\getRefId(), getRegistrationEnd(), getRegistrationStart(), getRegistrationType(), getShowMembers(), getStart(), hasWaitingListAutoFill(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_UNIX, ilParticipants\IL_GRP_ADMIN, initParticipants(), isMembershipLimited(), isRegistrationAccessCodeEnabled(), isRegistrationUnlimited(), isSessionLimitEnabled(), isWaitingListEnabled(), ilDidacticTemplateObjSettings\lookupTemplateId(), null, setAutoNotification(), setCancellationEnd(), setEnableGroupMap(), setGroupType(), setInformation(), setLatitude(), setLocationZoom(), setLongitude(), setMailToMembersType(), setMaxMembers(), setMinMembers(), setNumberOfNextSessions(), setNumberOfPreviousSessions(), ilContainer\setOrderType(), setPassword(), setPeriod(), setRegistrationAccessCode(), setRegistrationEnd(), setRegistrationStart(), setRegistrationType(), setShowMembers(), setViewMode(), setWaitingListAutoFill(), toggleStartTimeIndication(), ILIAS\Repository\user(), and ilTimeZone\UTC.

                           : void
     {
         parent::read();
 
         $query = "SELECT * FROM grp_settings " .
             "WHERE obj_id = " . $this->db->quote($this->getId(), 'integer');
 
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->setInformation((string) $row->information);
             $this->setGroupType((int) $row->grp_type);
             $this->setRegistrationType((int) $row->registration_type);
             $this->enableUnlimitedRegistration((bool) $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((string) $row->registration_password);
             $this->enableMembershipLimitation((bool) $row->registration_mem_limit);
             $this->setMaxMembers((int) $row->registration_max_members);
             $this->enableWaitingList((bool) $row->waiting_list);
             $this->setLatitude((string) $row->latitude);
             $this->setLongitude((string) $row->longitude);
             $this->setLocationZoom((int) $row->location_zoom);
             $this->setEnableGroupMap((bool) $row->enablemap);
             $this->enableRegistrationAccessCode((bool) $row->reg_ac_enabled);
             $this->setRegistrationAccessCode((string) $row->reg_ac);
             $this->setViewMode((int) $row->view_mode);
             $this->setMailToMembersType((int) $row->mail_members_type);
             $this->setCancellationEnd($row->leave_end ? new ilDate((int) $row->leave_end, IL_CAL_UNIX) : null);
             $this->setMinMembers((int) $row->registration_min_members);
             $this->setWaitingListAutoFill((bool) $row->auto_wait);
             $this->setShowMembers((bool) $row->show_members);
             $this->setAutoNotification((bool) $row->auto_notification);
             if ($row->period_time_indication) {
                 $this->setPeriod(
                     new \ilDateTime($row->period_start, IL_CAL_DATETIME, \ilTimeZone::UTC),
                     new \ilDateTime($row->period_end, IL_CAL_DATETIME, \ilTimeZone::UTC)
                 );
             } elseif (!is_null($row->period_start) && !is_null($row->period_end)) {
                 $this->setPeriod(
                     new \ilDate($row->period_start, IL_CAL_DATE),
                     new \ilDate($row->period_end, IL_CAL_DATE)
                 );
             }
             $this->toggleStartTimeIndication((bool) $row->period_time_indication);
             $this->enableSessionLimit((bool) $row->session_limit);
             $this->setNumberOfPreviousSessions((int) $row->session_prev);
             $this->setNumberOfNextSessions((int) $row->session_next);
         }
         $this->initParticipants();
 
         // Inherit order type from parent course (if exists)
         $this->setOrderType(ilContainerSortingSettings::_lookupSortMode($this->getId()));
     }

Here is the call graph for this function:

◆ readGroupStatus()

ilObjGroup::readGroupStatus ( )

Read group type.

Returns: int

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

References ilObject\getRefId(), ilGroupConstants\GRP_TYPE_CLOSED, ilGroupConstants\GRP_TYPE_OPEN, and ilDidacticTemplateObjSettings\lookupTemplateId().

                                      : int
     {
         $tpl_id = ilDidacticTemplateObjSettings::lookupTemplateId($this->getRefId());
         if (!$tpl_id) {
             return ilGroupConstants::GRP_TYPE_OPEN;
         }
         return ilGroupConstants::GRP_TYPE_CLOSED;
     }

Here is the call graph for this function:

◆ register()

ilObjGroup::register	(	int	$a_user_id,
		int	$a_role = `ilParticipants::IL_GRP_MEMBER`,
		bool	$a_force_registration = `false`
	)

See also: ilMembershipRegistrationCodes::register()

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

References ilDateTime\_after(), ilDateTime\_before(), ilGroupParticipants\_getInstanceByObjId(), ilObjGroupAccess\_usingRegistrationCode(), ilMembershipRegistrationException\ADDED_TO_WAITINGLIST, ilObject\getId(), getMaxMembers(), getRegistrationEnd(), getRegistrationStart(), ilObject\getTitle(), IL_CAL_UNIX, isMembershipLimited(), isRegistrationEnabled(), isRegistrationUnlimited(), isWaitingListEnabled(), ILIAS\Repository\lng(), ilMembershipRegistrationException\OBJECT_IS_FULL, ilMembershipRegistrationException\OUT_OF_REGISTRATION_PERIOD, ilMembershipRegistrationException\REGISTRATION_CODE_DISABLED, ilGroupMembershipMailNotification\TYPE_ADMISSION_MEMBER, ilGroupMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION, and ilGroupMembershipMailNotification\TYPE_WAITING_LIST_MEMBER.

      : void {
         $part = ilGroupParticipants::_getInstanceByObjId($this->getId());
 
         if ($part->isAssigned($a_user_id)) {
             return;
         }
 
         if (!$a_force_registration) {
             // Availability
             if (!$this->isRegistrationEnabled()) {
                 if (!ilObjGroupAccess::_usingRegistrationCode()) {
                     throw new ilMembershipRegistrationException('Cannot registrate to group ' . $this->getId() .
                         ', group subscription is deactivated.', ilMembershipRegistrationException::REGISTRATION_CODE_DISABLED);
                 }
             }
 
             // 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('Cannot registrate to group ' . $this->getId() .
                     ', group is out of registration time.', ilMembershipRegistrationException::OUT_OF_REGISTRATION_PERIOD);
                 }
             }
 
             // Max members
             if ($this->isMembershipLimited()) {
                 $free = max(0, $this->getMaxMembers() - $part->getCountMembers());
                 $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)
                     );
 
                     $participants = ilGroupParticipants::_getInstanceByObjId($this->getId());
                     $participants->sendNotification(ilGroupMembershipMailNotification::TYPE_WAITING_LIST_MEMBER, $a_user_id);
 
                     throw new ilMembershipRegistrationException($info, ilMembershipRegistrationException::ADDED_TO_WAITINGLIST);
                 }
 
                 if (!$free or $waiting_list->getCountUsers()) {
                     throw new ilMembershipRegistrationException('Cannot registrate to group ' . $this->getId() .
                         ', membership is limited.', ilMembershipRegistrationException::OBJECT_IS_FULL);
                 }
             }
         }
 
         $part->add($a_user_id, $a_role);
         $part->sendNotification(ilGroupMembershipMailNotification::TYPE_ADMISSION_MEMBER, $a_user_id);
         $part->sendNotification(ilGroupMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION, $a_user_id);
     }

Here is the call graph for this function:

◆ setAutoNotification()

ilObjGroup::setAutoNotification ( bool $a_status )

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

Referenced by read().

                                                        : void
     {
         $this->auto_notification = $a_status;
     }

Here is the caller graph for this function:

◆ setCancellationEnd()

ilObjGroup::setCancellationEnd ( ?ilDate $a_value )

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

Referenced by read().

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

Here is the caller graph for this function:

◆ setEnableGroupMap()

ilObjGroup::setEnableGroupMap ( bool $a_enablemap )

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

Referenced by read().

                                                         : void
     {
         $this->enablemap = $a_enablemap;
     }

Here is the caller graph for this function:

◆ setEnd()

ilObjGroup::setEnd ( ?ilDateTime $a_value = null )

protected

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

Referenced by setPeriod().

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

Here is the caller graph for this function:

◆ setGroupStatus()

ilObjGroup::setGroupStatus ( int $a_status )

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

                                                  : void
     {
         $this->group_status = $a_status;
     }

◆ setGroupType()

ilObjGroup::setGroupType ( int $a_type )

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

Referenced by read().

                                              : void
     {
         $this->group_type = $a_type;
     }

Here is the caller graph for this function:

◆ setInformation()

ilObjGroup::setInformation ( string $a_information )

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

Referenced by read().

                                                          : void
     {
         $this->information = $a_information;
     }

Here is the caller graph for this function:

◆ setLatitude()

ilObjGroup::setLatitude ( string $a_latitude )

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

Referenced by read().

                                                    : void
     {
         $this->latitude = $a_latitude;
     }

Here is the caller graph for this function:

◆ setLocationZoom()

ilObjGroup::setLocationZoom ( int $a_locationzoom )

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

Referenced by read().

                                                         : void
     {
         $this->locationzoom = $a_locationzoom;
     }

Here is the caller graph for this function:

◆ setLongitude()

ilObjGroup::setLongitude ( string $a_longitude )

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

Referenced by read().

                                                      : void
     {
         $this->longitude = $a_longitude;
     }

Here is the caller graph for this function:

◆ setMailToMembersType()

ilObjGroup::setMailToMembersType ( int $a_type )

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

Referenced by read().

                                                      : void
     {
         $this->mail_members = $a_type;
     }

Here is the caller graph for this function:

◆ setMaxMembers()

ilObjGroup::setMaxMembers ( int $a_max )

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

Referenced by read().

                                              : void
     {
         $this->reg_max_members = $a_max;
     }

Here is the caller graph for this function:

◆ setMessage()

ilObjGroup::setMessage ( string $a_message )

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

                                                  : void
     {
         $this->message = $a_message;
     }

◆ setMinMembers()

ilObjGroup::setMinMembers ( int $a_max )

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

Referenced by read().

                                              : void
     {
         $this->reg_min_members = $a_max;
     }

Here is the caller graph for this function:

◆ setNumberOfNextSessions()

ilObjGroup::setNumberOfNextSessions ( int $a_num )

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

Referenced by read().

                                                        : void
     {
         $this->session_next = $a_num;
     }

Here is the caller graph for this function:

◆ setNumberOfPreviousSessions()

ilObjGroup::setNumberOfPreviousSessions ( int $a_num )

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

Referenced by read().

                                                            : void
     {
         $this->session_prev = $a_num;
     }

Here is the caller graph for this function:

◆ setParentRolePermissions()

ilObjGroup::setParentRolePermissions ( int $a_parent_ref )

This method is called before "initDefaultRoles".

Therefore no local group roles are created.

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

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

References getGrpStatusOpenTemplateId(), ilObject\getRefId(), ilObject\getType(), and ROLE_FOLDER_ID.

Referenced by applyDidacticTemplate().

                                                                : bool
     {
         $parent_roles = $this->rbac_review->getParentRoleIds($a_parent_ref);
         foreach ($parent_roles as $parent_role) {
             if ($parent_role['parent'] == $this->getRefId()) {
                 continue;
             }
             if ($this->rbac_review->isProtected((int) $parent_role['parent'], (int) $parent_role['rol_id'])) {
                 $operations = $this->rbac_review->getOperationsOfRole(
                     (int) $parent_role['obj_id'],
                     $this->getType(),
                     (int) $parent_role['parent']
                 );
                 $this->rbac_admin->grantPermission(
                     (int) $parent_role['obj_id'],
                     $operations,
                     $this->getRefId()
                 );
                 continue;
             }
 
             $this->rbac_admin->initIntersectionPermissions(
                 $this->getRefId(),
                 (int) $parent_role['obj_id'],
                 (int) $parent_role['parent'],
                 $this->getGrpStatusOpenTemplateId(),
                 ROLE_FOLDER_ID
             );
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPassword()

ilObjGroup::setPassword ( string $a_pass )

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

Referenced by read().

                                                : void
     {
         $this->reg_password = $a_pass;
     }

Here is the caller graph for this function:

◆ setPeriod()

ilObjGroup::setPeriod	(	?\ilDateTime	$start = `null`,
		?\ilDateTime	$end = `null`
	)

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

References setEnd(), setStart(), and toggleStartTimeIndication().

Referenced by read().

                                                                                    : void
     {
         if (
             ($start instanceof \ilDate && !$end instanceof ilDate) ||
             ($end instanceof \ilDate && !$start instanceof ilDate)
         ) {
             throw new InvalidArgumentException('Different date types not supported.');
         }
 
         if ($start instanceof \ilDate) {
             $this->toggleStartTimeIndication(false);
         } else {
             $this->toggleStartTimeIndication(true);
         }
         $this->setStart($start);
         $this->setEnd($end);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRegistrationAccessCode()

ilObjGroup::setRegistrationAccessCode ( string $a_code )

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

Referenced by read().

                                                              : void
     {
         $this->reg_access_code = $a_code;
     }

Here is the caller graph for this function:

◆ setRegistrationEnd()

ilObjGroup::setRegistrationEnd ( ?ilDateTime $a_end )

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

Referenced by read().

                                                           : void
     {
         $this->reg_end = $a_end;
     }

Here is the caller graph for this function:

◆ setRegistrationStart()

ilObjGroup::setRegistrationStart ( ?ilDateTime $a_start )

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

Referenced by read().

                                                               : void
     {
         $this->reg_start = $a_start;
     }

Here is the caller graph for this function:

◆ setRegistrationType()

ilObjGroup::setRegistrationType ( int $a_type )

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

Referenced by read().

                                                     : void
     {
         $this->reg_type = $a_type;
     }

Here is the caller graph for this function:

◆ setShowMembers()

ilObjGroup::setShowMembers ( bool $a_status )

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

Referenced by read().

                                                   : void
     {
         $this->show_members = $a_status;
     }

Here is the caller graph for this function:

◆ setStart()

ilObjGroup::setStart ( ?ilDateTime $a_value = null )

protected

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

Referenced by setPeriod().

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

Here is the caller graph for this function:

◆ setViewMode()

ilObjGroup::setViewMode ( int $a_view_mode )

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

Referenced by read().

                                                  : void
     {
         $this->view_mode = $a_view_mode;
     }

Here is the caller graph for this function:

◆ setWaitingListAutoFill()

ilObjGroup::setWaitingListAutoFill ( bool $a_value )

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

Referenced by read().

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

Here is the caller graph for this function:

◆ toggleStartTimeIndication()

ilObjGroup::toggleStartTimeIndication ( bool $time_indication )

protected

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

Referenced by read(), and setPeriod().

                                                                        : void
     {
         $this->start_time_indication = $time_indication;
     }

Here is the caller graph for this function:

◆ translateViewMode()

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

static

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

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

                                                                                                     : int
     {
         global $DIC;
 
         $tree = $DIC['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;
             }
 
             $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 ( )

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

References $res, ilCalendarUtil\convertDateToUtcDBTimestamp(), getAutoNotification(), getCancellationEnd(), getEnableGroupMap(), getEnd(), getGroupType(), ilObject\getId(), getInformation(), getLatitude(), getLocationZoom(), getLongitude(), getMailToMembersType(), getMaxMembers(), getMinMembers(), getNumberOfNextSessions(), getNumberOfPreviousSessions(), getPassword(), getRegistrationAccessCode(), getRegistrationEnd(), getRegistrationStart(), getRegistrationType(), getShowMembers(), getStart(), getStartTimeIndication(), hasWaitingListAutoFill(), IL_CAL_DATETIME, IL_CAL_UNIX, isMembershipLimited(), isRegistrationAccessCodeEnabled(), isRegistrationEnabled(), isRegistrationUnlimited(), isSessionLimitEnabled(), isWaitingListEnabled(), null, prepareAppointments(), ilDBConstants\T_INTEGER, ilDBConstants\T_TIMESTAMP, and ilObject\updateMetaData().

                             : bool
     {
         if (!parent::update()) {
             return false;
         }
 
         $this->updateMetaData();
 
         $query = "UPDATE grp_settings " .
             "SET information = " . $this->db->quote($this->getInformation(), 'text') . ", " .
             "grp_type = " . $this->db->quote($this->getGroupType(), 'integer') . ", " .
             "registration_type = " . $this->db->quote($this->getRegistrationType(), 'integer') . ", " .
             "registration_enabled = " . $this->db->quote($this->isRegistrationEnabled() ? 1 : 0, 'integer') . ", " .
             "registration_unlimited = " . $this->db->quote($this->isRegistrationUnlimited() ? 1 : 0, 'integer') . ", " .
             "registration_start = " . $this->db->quote(($this->getRegistrationStart() && !$this->getRegistrationStart()->isNull()) ? $this->getRegistrationStart()->get(IL_CAL_DATETIME, '') : null, 'timestamp') . ", " .
             "registration_end = " . $this->db->quote(($this->getRegistrationEnd() && !$this->getRegistrationEnd()->isNull()) ? $this->getRegistrationEnd()->get(IL_CAL_DATETIME, '') : null, 'timestamp') . ", " .
             "registration_password = " . $this->db->quote($this->getPassword(), 'text') . ", " .
 //                      "registration_membership_limited = ".$this->db->quote((int) $this->isMembershipLimited() ,'integer').", ".
             "registration_mem_limit = " . $this->db->quote((int) $this->isMembershipLimited(), 'integer') . ", " .
             "registration_max_members = " . $this->db->quote($this->getMaxMembers(), 'integer') . ", " .
             "waiting_list = " . $this->db->quote($this->isWaitingListEnabled() ? 1 : 0, 'integer') . ", " .
             "latitude = " . $this->db->quote($this->getLatitude(), 'text') . ", " .
             "longitude = " . $this->db->quote($this->getLongitude(), 'text') . ", " .
             "location_zoom = " . $this->db->quote($this->getLocationZoom(), 'integer') . ", " .
             "enablemap = " . $this->db->quote((int) $this->getEnableGroupMap(), 'integer') . ", " .
             'reg_ac_enabled = ' . $this->db->quote($this->isRegistrationAccessCodeEnabled(), 'integer') . ', ' .
             'reg_ac = ' . $this->db->quote($this->getRegistrationAccessCode(), 'text') . ', ' .
             'view_mode = ' . $this->db->quote($this->view_mode, 'integer') . ', ' .
             'mail_members_type = ' . $this->db->quote($this->getMailToMembersType(), 'integer') . ', ' .
             'leave_end = ' . $this->db->quote(($this->getCancellationEnd() && !$this->getCancellationEnd()->isNull()) ? $this->getCancellationEnd()->get(IL_CAL_UNIX) : null, 'integer') . ', ' .
             "registration_min_members = " . $this->db->quote($this->getMinMembers(), 'integer') . ", " .
             "auto_wait = " . $this->db->quote($this->hasWaitingListAutoFill(), 'integer') . ", " .
             "show_members = " . $this->db->quote((int) $this->getShowMembers(), 'integer') . ", " .
             'period_start = ' . $this->db->quote(\ilCalendarUtil::convertDateToUtcDBTimestamp($this->getStart()), \ilDBConstants::T_TIMESTAMP) . ', ' .
             'period_end = ' . $this->db->quote(\ilCalendarUtil::convertDateToUtcDBTimestamp($this->getEnd()), \ilDBConstants::T_TIMESTAMP) . ', ' .
             'period_time_indication = ' . $this->db->quote($this->getStartTimeIndication() ? 1 : 0, \ilDBConstants::T_INTEGER) . ', ' .
             'auto_notification = ' . $this->db->quote($this->getAutoNotification(), \ilDBConstants::T_INTEGER) . ', ' .
             'session_limit = ' . $this->db->quote($this->isSessionLimitEnabled(), ilDBConstants::T_INTEGER) . ', ' .
             'session_prev = ' . $this->db->quote($this->getNumberOfPreviousSessions(), ilDBConstants::T_INTEGER) . ', ' .
             'session_next = ' . $this->db->quote($this->getNumberOfNextSessions(), ilDBConstants::T_INTEGER) . ' ' .
             "WHERE obj_id = " . $this->db->quote($this->getId(), 'integer');
         $res = $this->db->manipulate($query);
 
         $this->app_event_handler->raise(
             'components/ILIAS/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 ( int $a_group_type = ilGroupConstants::GRP_TYPE_OPEN )

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

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

References applyDidacticTemplate(), ilDidacticTemplateSettings\getInstanceByObjectType(), ilObject\getType(), ilGroupConstants\GRP_TYPE_OPEN, and ILIAS\Repository\logger().

      : void {
         if ($a_group_type == ilGroupConstants::GRP_TYPE_OPEN) {
             $this->applyDidacticTemplate(0);
             return;
         }
         $templates = ilDidacticTemplateSettings::getInstanceByObjectType($this->getType())->getTemplates();
         foreach ($templates as $template) {
             // the closed template
             if ($template->isAutoGenerated()) {
                 $this->logger->info('Appying default closed template');
                 $this->applyDidacticTemplate($template->getId());
                 return;
             }
         }
         $this->logger->warning('No closed didactic template available.');
     }

Here is the call graph for this function:

◆ validate()

ilObjGroup::validate ( )

validate group settings

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

References getMaxMembers(), getMinMembers(), getPassword(), getRegistrationEnd(), getRegistrationStart(), getRegistrationType(), ilObject\getTitle(), ilGroupConstants\GRP_REGISTRATION_PASSWORD, isMembershipLimited(), isWaitingListEnabled(), and ILIAS\Repository\lng().

                               : bool
     {
         if (!$this->getTitle()) {
             $this->title = '';
             $this->error->appendMessage($this->lng->txt(self::ERR_MISSING_TITLE));
         }
         if ($this->getRegistrationType() == ilGroupConstants::GRP_REGISTRATION_PASSWORD and !strlen($this->getPassword())) {
             $this->error->appendMessage($this->lng->txt(self::ERR_MISSING_PASSWORD));
         }
         if ($this->isMembershipLimited()) {
             if ($this->getMinMembers() <= 0 && $this->getMaxMembers() <= 0) {
                 $this->error->appendMessage($this->lng->txt(self::ERR_MISSING_MIN_MAX_MEMBERS));
             }
             if ($this->getMaxMembers() <= 0 && $this->isWaitingListEnabled()) {
                 $this->error->appendMessage($this->lng->txt(self::ERR_WRONG_MAX_MEMBERS));
             }
             if ($this->getMaxMembers() > 0 && $this->getMinMembers() > $this->getMaxMembers()) {
                 $this->error->appendMessage($this->lng->txt(self::ERR_WRONG_MIN_MAX_MEMBERS));
             }
         }
         if (
             ($this->getRegistrationStart() && !$this->getRegistrationEnd()) ||
             (!$this->getRegistrationStart() && $this->getRegistrationEnd()) ||
             $this->getRegistrationEnd() <= $this->getRegistrationStart()
         ) {
             $this->error->appendMessage($this->lng->txt((self::ERR_WRONG_REGISTRATION_LIMITED)));
         }
         return strlen($this->error->getMessage()) == 0;
     }

Here is the call graph for this function:

Field Documentation

◆ $auto_fill_from_waiting

bool ilObjGroup::$auto_fill_from_waiting = false

private

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

Referenced by hasWaitingListAutoFill().

◆ $auto_notification

bool ilObjGroup::$auto_notification = true

private

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

Referenced by getAutoNotification().

◆ $enablemap

bool ilObjGroup::$enablemap = false

private

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

Referenced by getEnableGroupMap().

◆ $group_status

int ilObjGroup::$group_status = 0

private

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

Referenced by getGroupStatus().

◆ $group_type

int ilObjGroup::$group_type = ilGroupConstants::GRP_TYPE_UNKNOWN

private

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

Referenced by getGroupType().

◆ $grp_end

ilDateTime ilObjGroup::$grp_end = null

private

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

Referenced by getEnd().

◆ $grp_start

ilDateTime ilObjGroup::$grp_start = null

private

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

Referenced by getStart().

◆ $information

string ilObjGroup::$information = ''

private

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

Referenced by getInformation().

◆ $latitude

string ilObjGroup::$latitude = ''

private

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

Referenced by getLatitude().

◆ $leave_end

ilDate ilObjGroup::$leave_end = null

private

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

Referenced by getCancellationEnd().

◆ $local_roles

array ilObjGroup::$local_roles = []

private

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

Referenced by getLocalGroupRoles().

◆ $locationzoom

int ilObjGroup::$locationzoom = 0

private

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

Referenced by getLocationZoom().

◆ $logger

ilLogger ilObjGroup::$logger

private

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

◆ $longitude

string ilObjGroup::$longitude = ''

private

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

Referenced by getLongitude().

◆ $m_roleAdminId

ilObjGroup::$m_roleAdminId

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

◆ $m_roleMemberId

ilObjGroup::$m_roleMemberId

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

◆ $mail_members

int ilObjGroup::$mail_members = self::MAIL_ALLOWED_ALL

private

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

Referenced by getMailToMembersType().

◆ $members_obj

ilGroupParticipants ilObjGroup::$members_obj

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

Referenced by getMembersObject().

◆ $message

string ilObjGroup::$message = ''

private

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

Referenced by getMessage().

◆ $reg_access_code

string ilObjGroup::$reg_access_code = ''

private

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

Referenced by getRegistrationAccessCode().

◆ $reg_access_code_enabled

bool ilObjGroup::$reg_access_code_enabled = false

private

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

Referenced by isRegistrationAccessCodeEnabled().

◆ $reg_end

ilDateTime ilObjGroup::$reg_end = null

private

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

Referenced by getRegistrationEnd().

◆ $reg_max_members

int ilObjGroup::$reg_max_members = 0

private

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

Referenced by getMaxMembers().

◆ $reg_membership_limitation

bool ilObjGroup::$reg_membership_limitation = false

private

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

Referenced by isMembershipLimited().

◆ $reg_min_members

int ilObjGroup::$reg_min_members = 0

private

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

Referenced by getMinMembers().

◆ $reg_password

string ilObjGroup::$reg_password = ''

private

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

Referenced by getPassword().

◆ $reg_start

ilDateTime ilObjGroup::$reg_start = null

private

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

Referenced by getRegistrationStart().

◆ $reg_type

int ilObjGroup::$reg_type = ilGroupConstants::GRP_REGISTRATION_DIRECT

private

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

Referenced by getRegistrationType().

◆ $reg_unlimited

bool ilObjGroup::$reg_unlimited = true

private

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

Referenced by isRegistrationUnlimited().

◆ $session_limit

bool ilObjGroup::$session_limit = false

private

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

Referenced by isSessionLimitEnabled().

◆ $session_next

int ilObjGroup::$session_next = -1

private

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

Referenced by getNumberOfNextSessions().

◆ $session_prev

int ilObjGroup::$session_prev = -1

private

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

Referenced by getNumberOfPreviousSessions().

◆ $show_members

bool ilObjGroup::$show_members = true

private

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

Referenced by getShowMembers().

◆ $SHOW_MEMBERS_DISABLED

ilObjGroup::$SHOW_MEMBERS_DISABLED = 0

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

◆ $SHOW_MEMBERS_ENABLED

ilObjGroup::$SHOW_MEMBERS_ENABLED = 1

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

◆ $start_time_indication

bool ilObjGroup::$start_time_indication = false

private

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

Referenced by getStartTimeIndication().

◆ $view_mode

int ilObjGroup::$view_mode = ilContainer::VIEW_DEFAULT

private

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

Referenced by getViewMode(), lookupViewMode(), and translateViewMode().

◆ $waiting_list

bool ilObjGroup::$waiting_list = false

private

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

Referenced by isWaitingListEnabled().

◆ CAL_END

const ilObjGroup::CAL_END = 4

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

◆ CAL_REG_END

const ilObjGroup::CAL_REG_END = 2

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

◆ CAL_REG_START

const ilObjGroup::CAL_REG_START = 1

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

◆ CAL_START

const ilObjGroup::CAL_START = 3

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_MIN_MAX_MEMBERS

const ilObjGroup::ERR_MISSING_MIN_MAX_MEMBERS = 'grp_wrong_min_max_members'

Definition at line 46 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_MIN_MAX_MEMBERS

const ilObjGroup::ERR_WRONG_MIN_MAX_MEMBERS = 'grp_max_and_min_members_invalid'

Definition at line 47 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.

◆ ERR_WRONG_REGISTRATION_LIMITED

const ilObjGroup::ERR_WRONG_REGISTRATION_LIMITED = 'grp_err_registration_limited'

Definition at line 48 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 50 of file class.ilObjGroup.php.

Referenced by ilParticipants\canSendMailToMembers(), ilObjGroupGUI\executeCommand(), and ilObjGroupGUI\initForm().

◆ MAIL_ALLOWED_TUTORS

const ilObjGroup::MAIL_ALLOWED_TUTORS = 2

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

Referenced by ilObjGroupGUI\initForm().

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

components/ILIAS/Group/classes/class.ilObjGroup.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getMembers()

◆ _isMember()

◆ _lookupIdByTitle()

◆ addAdditionalSubItemInformation()

◆ appendMessage()

◆ applyDidacticTemplate()

◆ cloneAutoGeneratedRoles()

◆ cloneDependencies()

◆ create()

◆ delete()

◆ enableMembershipLimitation()

◆ enableRegistrationAccessCode()

◆ enableSessionLimit()

◆ enableUnlimitedRegistration()

◆ enableWaitingList()

◆ findGroupsWithNotEnoughMembers()

◆ getAutoNotification()

◆ getCancellationEnd()

◆ getCountMembers()

◆ getDefaultAdminRole()

◆ getDefaultGroupRoles()

◆ getDefaultMemberRole()

◆ getEnableGroupMap()

◆ getEnableMap()

◆ getEnd()

◆ getGroupAdminIds()

◆ getGroupMemberData()

◆ getGroupMemberIds()

◆ getGroupStatus()

◆ getGroupType()

◆ getGrpStatusClosedTemplateId()

◆ getGrpStatusOpenTemplateId()

◆ getInformation()

◆ getLatitude()

◆ getLocalGroupRoles()

◆ getLocationZoom()

◆ getLongitude()

◆ getMailToMembersType()

◆ getMaxMembers()

◆ getMemberRoles()

◆ getMembersObject()

◆ getMessage()

◆ getMinMembers()

◆ getNumberOfNextSessions()

◆ getNumberOfPreviousSessions()

◆ getPassword()

◆ getRegistrationAccessCode()

◆ getRegistrationEnd()

◆ getRegistrationStart()

◆ getRegistrationType()

◆ getShowMembers()

◆ getStart()

◆ getStartTimeIndication()

◆ getViewMode()

◆ handleAutoFill()

◆ hasWaitingListAutoFill()

◆ initDefaultRoles()

◆ initParticipants()

◆ isAdmin()

◆ isMembershipLimited()

◆ isRegistrationAccessCodeEnabled()

◆ isRegistrationEnabled()

◆ isRegistrationUnlimited()

◆ isSessionLimitEnabled()

◆ isWaitingListEnabled()

◆ leave()

◆ leaveGroup()

◆ lookupGroupStatusTemplateId()

◆ lookupGroupTye()

◆ lookupObjectsByCode()