Class ilObjGroup. More...

Inheritance diagram for ilObjGroup:

Collaboration diagram for ilObjGroup:

Public Member Functions

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

Constructor @access public. More...

setInformation ($a_information)

set information More...

getInformation ()

get Information More...

setGroupType ($a_type)

set group type More...

getGroupType ()

get group type More...

setRegistrationType ($a_type)

set registration type More...

getRegistrationType ()

get registration type More...

isRegistrationEnabled ()

is registration enabled More...

enableUnlimitedRegistration ($a_status)

enable unlimited registration More...

isRegistrationUnlimited ()

is registration unlimited More...

setRegistrationStart ($a_start)

set registration start More...

getRegistrationStart ()

get registration start More...

setRegistrationEnd ($a_end)

set registration end More...

getRegistrationEnd ()

get registration end More...

setPassword ($a_pass)

set password More...

getPassword ()

get password More...

enableMembershipLimitation ($a_status)

enable max member limitation More...

isMembershipLimited ()

is max member limited More...

setMinMembers ($a_max)

set min members More...

getMinMembers ()

get min members More...

setMaxMembers ($a_max)

set max members More...

getMaxMembers ()

get max members More...

enableWaitingList ($a_status)

enable waiting list More...

isWaitingListEnabled ()

is waiting list enabled More...

setWaitingListAutoFill ($a_value)

hasWaitingListAutoFill ()

setLatitude ($a_latitude)

Set Latitude. More...

getLatitude ()

Get Latitude. More...

setLongitude ($a_longitude)

Set Longitude. More...

getLongitude ()

Get Longitude. More...

setLocationZoom ($a_locationzoom)

Set LocationZoom. More...

getLocationZoom ()

Get LocationZoom. More...

setEnableGroupMap ($a_enablemap)

Set Enable Group Map. More...

getEnableMap ()

Type independent wrapper. More...

getEnableGroupMap ()

Get Enable Group Map. More...

getRegistrationAccessCode ()

get access code More...

setRegistrationAccessCode ($a_code)

Set refistration access code. More...

isRegistrationAccessCodeEnabled ()

Check if access code is enabled. More...

enableRegistrationAccessCode ($a_status)

En/disable registration access code. More...

setMailToMembersType ($a_type)

Set mail to members type. More...

getMailToMembersType ()

Get mail to members type. More...

setCancellationEnd (ilDate $a_value=null)

getCancellationEnd ()

setShowMembers ($a_status)

getShowMembers ()

setAutoNotification (bool $a_status)

getAutoNotification ()

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

getStartTimeIndication ()

getStart ()

getEnd ()

validate ()

validate group settings More...

create ()

Create group. More...

update ()

Update group. More...

delete ()

delete group and all related data More...

read ()

Read group. More...

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

Clone group (no member data) More...

cloneDependencies ($a_target_id, $a_copy_id)

Clone object dependencies (crs items, preconditions) More...

cloneAutoGeneratedRoles ($new_obj)

Clone group admin and member role permissions. More...

join ($a_user_id, $a_mem_role="")

join Group, assigns user to role @access private More...

getDefaultMemberRole ()

returns object id of created default member role @access public More...

getDefaultAdminRole ()

returns object id of created default adminstrator role @access public More...

addMember ($a_user_id, $a_mem_role)

add Member to Group @access public More...

leaveGroup ()

is called when a member decides to leave group @access public More...

leave ($a_user_id)

deassign member from group role @access private More...

getGroupMemberIds ()

get all group Member ids regardless of role @access public More...

getGroupMemberData ($a_mem_ids, $active=1)

get all group Members regardless of group role. More...

getCountMembers ()

getGroupAdminIds ($a_grpId="")

get Group Admin Id @access public More...

getDefaultGroupRoles ($a_grp_id="")

get default group roles, returns the defaultlike create roles il_grp_member, il_grp_admin @access public More...

getLocalGroupRoles ($a_translate=false)

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

getGrpStatusClosedTemplateId ()

get group status closed template @access public More...

getGrpStatusOpenTemplateId ()

get group status open template @access public More...

updateGroupType ($a_group_type=GRP_TYPE_OPEN)

Change group type. More...

setGroupStatus ($a_status)

Set group status. More...

getGroupStatus ()

get group status More...

readGroupStatus ()

Read group type. More...

getMemberRoles ($a_user_id)

get group member status @access public More...

isAdmin ($a_userId)

is Admin @access public More...

initDefaultRoles ()

init default roles settings @access public More...

setParentRolePermissions ($a_parent_ref)

This method is called before "initDefaultRoles". More...

applyDidacticTemplate ($a_tpl_id)

Apply template. More...

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

_getMembers ($a_obj_id)

getViewMode ()

Get effective container view mode. More...

setViewMode ($a_view_mode)

Set group view mode. More...

addAdditionalSubItemInformation (&$a_item_data)

Add additional information to sub item, e.g. More...

getMessage ()

setMessage ($a_message)

appendMessage ($a_message)

getMembersObject ()

Get members objects. More...

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

handleAutoFill ()

Public Member Functions inherited from ilObject

__construct ($a_id=0, $a_reference=true)

Constructor @access public. More...

withReferences ()

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

read ()

read object data from db into object More...

getId ()

get object id @access public More...

setId ($a_id)

set object id @access public More...

setRefId ($a_id)

set reference id @access public More...

getRefId ()

get reference id @access public More...

getType ()

get object type @access public More...

setType ($a_type)

set object type @access public More...

getPresentationTitle ()

get presentation title Normally same as title Overwritten for sessions More...

getTitle ()

get object title @access public More...

getUntranslatedTitle ()

get untranslated object title @access public More...

setTitle ($a_title)

set object title More...

getDescription ()

get object description More...

setDescription ($a_desc)

set object description More...

getLongDescription ()

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

getImportId ()

get import id More...

setImportId ($a_import_id)

set import id More...

setOfflineStatus ($a_status)

Set offline status. More...

getOfflineStatus ()

Get offline status. More...

supportsOfflineHandling ()

Check whether object supports offline handling. More...

getOwner ()

get object owner More...

getOwnerName ()

setOwner ($a_owner)

set object owner More...

getCreateDate ()

get create date @access public More...

getLastUpdateDate ()

get last update date @access public More...

getDiskUsage ()

Gets the disk usage of the object in bytes. More...

create ()

create More...

update ()

update object in db More...

MDUpdateListener ($a_element)

Meta data update listener. More...

createMetaData ()

create meta data entry More...

updateMetaData ()

update meta data entry More...

deleteMetaData ()

delete meta data entry More...

updateOwner ()

update owner of object in db More...

putInTree ($a_parent_ref)

maybe this method should be in tree object!? More...

setPermissions ($a_parent_ref)

set permissions of object More...

setParentRolePermissions ($a_parent_ref)

Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

createReference ()

creates reference for object More...

countReferences ()

count references of object More...

initDefaultRoles ()

init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public More...

applyDidacticTemplate ($a_tpl_id)

Apply template. More...

setRegisterMode ($a_bool)

isUserRegistered ($a_user_id=0)

requireRegistration ()

getXMLZip ()

getHTMLDirectory ()

appendCopyInfo ($a_target_id, $a_copy_id)

Prepend Copy info if object with same name exists in that container. More...

cloneDependencies ($a_target_id, $a_copy_id)

Clone object dependencies. More...

cloneMetaData ($target_obj)

Copy meta data. More...

getPossibleSubObjects ($a_filter=true)

get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Public Member Functions inherited from ilContainer

__construct ($a_id=0, $a_reference=true)

Constructor @access public. More...

getObjectTranslation ()

Get object translation. More...

setObjectTranslation (ilObjectTranslation $obj_trans)

Get object translation. More...

createContainerDirectory ()

Create directory for the container. More...

getContainerDirectory ()

Get the container directory. More...

setHiddenFilesFound ($a_hiddenfilesfound)

Set Found hidden files (set by getSubItems). More...

getHiddenFilesFound ()

Get Found hidden files (set by getSubItems). More...

getStyleSheetId ()

get ID of assigned style sheet object More...

setStyleSheetId ($a_style_id)

set ID of assigned style sheet object More...

setNewsTimeline ($a_val)

Set news timeline. More...

getNewsTimeline ()

Get news timeline. More...

setNewsTimelineAutoEntries ($a_val)

Set news timeline auto entries. More...

getNewsTimelineAutoEntries ()

Get news timeline auto entries. More...

setNewsTimelineLandingPage ($a_val)

Set news timline is landing page. More...

getNewsTimelineLandingPage ()

Get news timline is landing page. More...

isNewsTimelineEffective ()

Is news timeline effective? More...

isNewsTimelineLandingPageEffective ()

Is news timeline landing page effective? More...

setNewsBlockActivated ($a_val)

Set news block activated. More...

getNewsBlockActivated ()

Get news block activated. More...

setUseNews ($a_val)

Set use news. More...

getUseNews ()

Get use news. More...

cloneDependencies ($a_target_id, $a_copy_id)

Clone object dependencies (container sorting) More...

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

clone all objects according to this container More...

delete ()

delete category and all related data More...

getViewMode ()

Get container view mode. More...

getOrderType ()

Get order type default implementation. More...

setOrderType ($a_value)

isClassificationFilterActive ()

Is classification filter active? More...

filteredSubtree ()

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

getSubItems ( $a_admin_panel_enabled=false, $a_include_side_block=false, $a_get_single=0, \ilContainerUserFilter $container_user_filter=null)

Get subitems of container. More...

gotItems ()

Check whether we got any items. More...

addAdditionalSubItemInformation (&$object)

Add additional information to sub item, e.g. More...

getGroupedObjTypes ()

Get grouped repository object types. More...

enablePageEditing ()

Check whether page editing is allowed for container. More...

create ()

Create. More...

putInTree ($a_parent_ref)

maybe this method should be in tree object!?

Todo:: role/rbac stuff

Parameters

int $a_parent_ref Ref-ID of the parent object

More...

update ()

Update. More...

read ()

Detailed Description

Class ilObjGroup.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e; Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor @access public.

Parameters

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

Reimplemented from ilContainer.

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

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

References $DIC, ilContainer\$tree, ILIAS\GlobalScreen\Provider\__construct(), and ilObject\setRegisterMode().

Here is the call graph for this function:

Member Function Documentation

◆ _getMembers()

ilObjGroup::_getMembers ( $a_obj_id )

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

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

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

Referenced by _isMember().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _isMember()

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

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

    {
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
        $ilObjDataCache = $DIC['ilObjDataCache'];
        $ilDB = $DIC['ilDB'];
 
        $local_roles = $rbacreview->getRolesOfRoleFolder($a_ref_id, false);
        $user_roles = $rbacreview->assignedRoles($a_user_id);
 
        // Used for membership limitations -> check membership by given field
        if ($a_field) {
            include_once './Services/User/classes/class.ilObjUser.php';
 
            $tmp_user = &ilObjectFactory::getInstanceByObjId($a_user_id);
            switch ($a_field) {
                case 'login':
                    $and = "AND login = '" . $tmp_user->getLogin() . "' ";
                    break;
                case 'email':
                    $and = "AND email = '" . $tmp_user->getEmail() . "' ";
                    break;
                case 'matriculation':
                    $and = "AND matriculation = '" . $tmp_user->getMatriculation() . "' ";
                    break;
 
                default:
                    $and = "AND usr_id = '" . $a_user_id . "'";
                    break;
            }
            if (!$members = ilObjGroup::_getMembers($ilObjDataCache->lookupObjId($a_ref_id))) {
                return false;
            }
            $query = "SELECT * FROM usr_data as ud " .
                "WHERE usr_id IN (" . implode(",", ilUtil::quoteArray($members)) . ") " .
                $and;
            $res = $ilDB->query($query);
 
            return $res->numRows() ? true : false;
        }
 
        if (!array_intersect($local_roles, $user_roles)) {
            return false;
        }
 
        return true;
    }

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

Referenced by ilObjCourseGrouping\_checkGroupingDependencies().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupIdByTitle()

static ilObjGroup::_lookupIdByTitle ( $a_title )

static

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

    {
        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;
    }

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

Referenced by ilMailAddressTypeHelperImpl\getGroupObjIdByTitle().

Here is the caller graph for this function:

◆ addAdditionalSubItemInformation()

ilObjGroup::addAdditionalSubItemInformation ( & $a_item_data )

Add additional information to sub item, e.g.

used in courses for timings information etc.

Reimplemented from ilContainer.

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

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

References ilObjectActivation\addAdditionalSubItemInformation().

Here is the call graph for this function:

◆ addMember()

ilObjGroup::addMember	(	$a_user_id,
		$a_mem_role
	)

add Member to Group @access public

Parameters

integer	user_id
integer	member role_id of local group_role

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

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

References $DIC, ilObject\$rbacadmin, and join().

Here is the call graph for this function:

◆ appendMessage()

ilObjGroup::appendMessage ( $a_message )

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

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

References getMessage().

Here is the call graph for this function:

◆ applyDidacticTemplate()

ilObjGroup::applyDidacticTemplate ( $a_tpl_id )

Apply template.

Parameters

int $a_tpl_id

Reimplemented from ilObject.

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

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

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

Referenced by updateGroupType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneAutoGeneratedRoles()

ilObjGroup::cloneAutoGeneratedRoles ( $new_obj )

Clone group admin and member role permissions.

@access public

Parameters

object new group object

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

    {
        global $DIC;
 
        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];
 
        $admin = $this->getDefaultAdminRole();
        $new_admin = $new_obj->getDefaultAdminRole();
        if (!$admin || !$new_admin || !$this->getRefId() || !$new_obj->getRefId()) {
            ilLoggerFactory::getLogger('grp')->warning('Error cloning auto generated rol: il_grp_admin');
        }
        $rbacadmin->copyRolePermissions($admin, $this->getRefId(), $new_obj->getRefId(), $new_admin, true);
        ilLoggerFactory::getLogger('grp')->info('Finished copying of role il_grp_admin.');
 
        $member = $this->getDefaultMemberRole();
        $new_member = $new_obj->getDefaultMemberRole();
        if (!$member || !$new_member) {
            ilLoggerFactory::getLogger('grp')->warning('Error cloning auto generated rol: il_grp_member');
        }
        $rbacadmin->copyRolePermissions($member, $this->getRefId(), $new_obj->getRefId(), $new_member, true);
        ilLoggerFactory::getLogger('grp')->info('Finished copying of role il_grp_member.');
    }

References $DIC, ilObject\$rbacadmin, ilObject\$rbacreview, getDefaultAdminRole(), getDefaultMemberRole(), ilLoggerFactory\getLogger(), and ilObject\getRefId().

Referenced by cloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneDependencies()

ilObjGroup::cloneDependencies	(	$a_target_id,
		$a_copy_id
	)

Clone object dependencies (crs items, preconditions)

@access public

Parameters

int	target ref id of new course
int	copy id

Reimplemented from ilContainer.

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

    {
        global $DIC;
 
        $tree = $DIC['tree'];
 
        parent::cloneDependencies($a_target_id, $a_copy_id);
 
        include_once('Services/Object/classes/class.ilObjectActivation.php');
        ilObjectActivation::cloneDependencies($this->getRefId(), $a_target_id, $a_copy_id);
 
        // clone membership limitation
        foreach (\ilObjCourseGrouping::_getGroupings($this->getId()) as $grouping_id) {
            \ilLoggerFactory::getLogger('grp')->info('Handling grouping id: ' . $grouping_id);
            $grouping = new \ilObjCourseGrouping($grouping_id);
            $grouping->cloneGrouping($a_target_id, $a_copy_id);
        }
 
        return true;
    }

References $DIC, ilContainer\$tree, ilObjCourseGrouping\_getGroupings(), ilObjectActivation\cloneDependencies(), ilObject\getId(), ilLoggerFactory\getLogger(), and ilObject\getRefId().

Here is the call graph for this function:

◆ cloneObject()

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

Clone group (no member data)

@access public

Parameters

int	target ref_id
int	copy id

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $ilUser = $DIC['ilUser'];
        $ilSetting = $DIC['ilSetting'];
 
        $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
 
        // current template
        $current_template = ilDidacticTemplateObjSettings::lookupTemplateId($this->getRefId());
        $new_obj->applyDidacticTemplate($current_template);
        $this->cloneAutoGeneratedRoles($new_obj);
        $this->cloneMetaData($new_obj);
 
        $new_obj->setRegistrationType($this->getRegistrationType());
        $new_obj->setInformation($this->getInformation());
        $new_obj->setRegistrationStart($this->getRegistrationStart());
        $new_obj->setRegistrationEnd($this->getRegistrationEnd());
        $new_obj->enableUnlimitedRegistration($this->isRegistrationUnlimited());
        $new_obj->setPassword($this->getPassword());
        $new_obj->enableMembershipLimitation($this->isMembershipLimited());
        $new_obj->setMaxMembers($this->getMaxMembers());
        $new_obj->enableWaitingList($this->isWaitingListEnabled());
        $new_obj->setShowMembers($this->getShowMembers());
 
        // map
        $new_obj->setLatitude($this->getLatitude());
        $new_obj->setLongitude($this->getLongitude());
        $new_obj->setLocationZoom($this->getLocationZoom());
        $new_obj->setEnableGroupMap($this->getEnableGroupMap());
        $new_obj->enableRegistrationAccessCode($this->isRegistrationAccessCodeEnabled());
        include_once './Services/Membership/classes/class.ilMembershipRegistrationCodeUtils.php';
        $new_obj->setRegistrationAccessCode(ilMembershipRegistrationCodeUtils::generateCode());
 
        $new_obj->setViewMode($this->view_mode);
        $new_obj->setMailToMembersType($this->getMailToMembersType());
        
        $new_obj->setCancellationEnd($this->getCancellationEnd());
        $new_obj->setMinMembers($this->getMinMembers());
        $new_obj->setWaitingListAutoFill($this->hasWaitingListAutoFill());
        $new_obj->setPeriod($this->getStart(), $this->getEnd());
        $new_obj->setAutoNotification($this->getAutoNotification());
        $new_obj->update();
        
        // #13008 - Group Defined Fields
        include_once('Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php');
        ilCourseDefinedFieldDefinition::_clone($this->getId(), $new_obj->getId());
        
        // Assign user as admin
        include_once('./Modules/Group/classes/class.ilGroupParticipants.php');
        $part = ilGroupParticipants::_getInstanceByObjId($new_obj->getId());
        $part->add($ilUser->getId(), IL_GRP_ADMIN);
        $part->updateNotification($ilUser->getId(), $ilSetting->get('mail_grp_admin_notification', true));
        $part->updateContact($ilUser->getId(), true);
 
        // Copy learning progress settings
        include_once('Services/Tracking/classes/class.ilLPObjSettings.php');
        $obj_settings = new ilLPObjSettings($this->getId());
        $obj_settings->cloneSettings($new_obj->getId());
        unset($obj_settings);
        
        return $new_obj;
    }

References $DIC, $ilDB, $ilSetting, $ilUser, ilCourseDefinedFieldDefinition\_clone(), ilGroupParticipants\_getInstanceByObjId(), cloneAutoGeneratedRoles(), ilObject\cloneMetaData(), ilMembershipRegistrationCodeUtils\generateCode(), getAutoNotification(), getCancellationEnd(), getEnableGroupMap(), getEnd(), ilObject\getId(), getInformation(), getLatitude(), getLocationZoom(), getLongitude(), getMailToMembersType(), getMaxMembers(), getMinMembers(), getPassword(), ilObject\getRefId(), getRegistrationEnd(), getRegistrationStart(), getRegistrationType(), getShowMembers(), getStart(), hasWaitingListAutoFill(), IL_GRP_ADMIN, isMembershipLimited(), isRegistrationAccessCodeEnabled(), isRegistrationUnlimited(), isWaitingListEnabled(), and ilDidacticTemplateObjSettings\lookupTemplateId().

Here is the call graph for this function:

◆ create()

ilObjGroup::create ( )

Create group.

Reimplemented from ilContainer.

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $ilAppEventHandler = $DIC['ilAppEventHandler'];
 
        if (!parent::create()) {
            return false;
        }
 
        if (!$a_upload) {
            $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) " .
            "VALUES(" .
            $ilDB->quote($this->getId(), 'integer') . ", " .
            $ilDB->quote($this->getInformation(), 'text') . ", " .
            $ilDB->quote((int) $this->getGroupType(), 'integer') . ", " .
            $ilDB->quote($this->getRegistrationType(), 'integer') . ", " .
            $ilDB->quote(($this->isRegistrationEnabled() ? 1 : 0), 'integer') . ", " .
            $ilDB->quote(($this->isRegistrationUnlimited() ? 1 : 0), 'integer') . ", " .
            $ilDB->quote(($this->getRegistrationStart() && !$this->getRegistrationStart()->isNull()) ? $this->getRegistrationStart()->get(IL_CAL_DATETIME, '') : null, 'timestamp') . ", " .
            $ilDB->quote(($this->getRegistrationEnd() && !$this->getRegistrationEnd()->isNull()) ? $this->getRegistrationEnd()->get(IL_CAL_DATETIME, '') : null, 'timestamp') . ", " .
            $ilDB->quote($this->getPassword(), 'text') . ", " .
            $ilDB->quote((int) $this->isMembershipLimited(), 'integer') . ", " .
            $ilDB->quote($this->getMaxMembers(), 'integer') . ", " .
            $ilDB->quote($this->isWaitingListEnabled() ? 1 : 0, 'integer') . ", " .
            $ilDB->quote($this->getLatitude(), 'text') . ", " .
            $ilDB->quote($this->getLongitude(), 'text') . ", " .
            $ilDB->quote($this->getLocationZoom(), 'integer') . ", " .
            $ilDB->quote((int) $this->getEnableGroupMap(), 'integer') . ", " .
            $ilDB->quote($this->isRegistrationAccessCodeEnabled(), 'integer') . ', ' .
            $ilDB->quote($this->getRegistrationAccessCode(), 'text') . ', ' .
            $ilDB->quote($this->view_mode, 'integer') . ', ' .
            $ilDB->quote($this->getMailToMembersType(), 'integer') . ', ' .
            $ilDB->quote(($this->getCancellationEnd() && !$this->getCancellationEnd()->isNull()) ? $this->getCancellationEnd()->get(IL_CAL_UNIX) : null, 'integer') . ', ' .
            $ilDB->quote($this->getMinMembers(), 'integer') . ', ' .
            $ilDB->quote($this->hasWaitingListAutoFill(), 'integer') . ', ' .
            $ilDB->quote($this->getStart() instanceof ilDate ? $this->getStart()->get(IL_CAL_UNIX) : null, 'integer') . ', ' .
            $ilDB->quote($this->getEnd() instanceof ilDate ? $this->getEnd()->get(IL_CAL_UNIX) : null, 'integer') . ', ' .
            $ilDB->quote($this->getAutoNotification(), \ilDBConstants::T_INTEGER) . ' ' .
            ")";
        $res = $ilDB->manipulate($query);
 
        $ilAppEventHandler->raise(
            'Modules/Group',
            'create',
            array('object' => $this,
                'obj_id' => $this->getId(),
                'appointments' => $this->prepareAppointments('create'))
        );
        
        return $this->getId();
    }

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

Here is the call graph for this function:

◆ delete()

ilObjGroup::delete ( )

delete group and all related data

@access public

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

Reimplemented from ilContainer.

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $ilAppEventHandler = $DIC['ilAppEventHandler'];
 
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }
 
        $query = "DELETE FROM grp_settings " .
            "WHERE obj_id = " . $ilDB->quote($this->getId(), 'integer');
        $res = $ilDB->manipulate($query);
        
        include_once('./Modules/Group/classes/class.ilGroupParticipants.php');
        ilGroupParticipants::_deleteAllEntries($this->getId());
        
        $ilAppEventHandler->raise(
            'Modules/Group',
            'delete',
            array('object' => $this,
                'obj_id' => $this->getId(),
                'appointments' => $this->prepareAppointments('delete'))
        );
        
        
        return true;
    }

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

Here is the call graph for this function:

◆ enableMembershipLimitation()

ilObjGroup::enableMembershipLimitation ( $a_status )

enable max member limitation

@access public

Parameters

bool status

Returns

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

    {
        $this->reg_membership_limitation = $a_status;
    }

Referenced by read().

Here is the caller graph for this function:

◆ enableRegistrationAccessCode()

ilObjGroup::enableRegistrationAccessCode ( $a_status )

En/disable registration access code.

Parameters

object $a_status

Returns

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

    {
        $this->reg_access_code_enabled = $a_status;
    }

Referenced by read().

Here is the caller graph for this function:

◆ enableUnlimitedRegistration()

ilObjGroup::enableUnlimitedRegistration ( $a_status )

enable unlimited registration

@access public

Parameters

bool

Returns

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

    {
        $this->reg_unlimited = $a_status;
    }

Referenced by read().

Here is the caller graph for this function:

◆ enableWaitingList()

ilObjGroup::enableWaitingList ( $a_status )

enable waiting list

@access public

Parameters

bool

Returns

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

    {
        $this->waiting_list = $a_status;
    }

Referenced by read().

Here is the caller graph for this function:

◆ findGroupsWithNotEnoughMembers()

static ilObjGroup::findGroupsWithNotEnoughMembers ( )

static

Minimum members check @global $ilDB $ilDB.

Returns: array

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

    {
        $ilDB = $GLOBALS['DIC']->database();
        $tree = $GLOBALS['DIC']->repositoryTree();
        
        $res = array();
        
        $now = date("Y-m-d H:i:s");
 
        $before = new ilDateTime(time(), IL_CAL_UNIX);
        $before->increment(IL_CAL_DAY, -1);
        $now_date = $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, "text") . "))" .
            " AND (period_start IS NULL OR period_start > " . $ilDB->quote($now, "integer") . ")");
        while ($row = $ilDB->fetchAssoc($set)) {
            $refs = ilObject::_getAllReferences($row['obj_id']);
            $ref = end($refs);
            
            if ($tree->isDeleted($ref)) {
                continue;
            }
            
            $part = new ilGroupParticipants($row["obj_id"]);
            $reci = $part->getNotificationRecipients();
            if (sizeof($reci)) {
                $missing = (int) $row["registration_min_members"] - $part->getCountMembers();
                if ($missing > 0) {
                    $res[$row["obj_id"]] = array($missing, $reci);
                }
            }
        }
        
        return $res;
    }

References $GLOBALS, $ilDB, $res, ilContainer\$tree, ilObject\_getAllReferences(), IL_CAL_DATETIME, IL_CAL_DAY, and IL_CAL_UNIX.

Referenced by ilMembershipCronMinMembers\getGroups().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAutoNotification()

ilObjGroup::getAutoNotification ( )

Returns: bool|null

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

                                          : ?bool
    {
        return $this->auto_notification;
    }

References $auto_notification.

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

Here is the caller graph for this function:

◆ getCancellationEnd()

ilObjGroup::getCancellationEnd ( )

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

    {
        return $this->leave_end;
    }

References $leave_end.

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

Here is the caller graph for this function:

◆ getCountMembers()

ilObjGroup::getCountMembers ( )

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

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

References getGroupMemberIds().

Here is the call graph for this function:

◆ getDefaultAdminRole()

ilObjGroup::getDefaultAdminRole ( )

returns object id of created default adminstrator role @access public

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

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

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

Referenced by cloneAutoGeneratedRoles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultGroupRoles()

ilObjGroup::getDefaultGroupRoles ( $a_grp_id = "" )

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

Parameters

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

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

    {
        global $DIC;
 
        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];
 
        if (strlen($a_grp_id) > 0) {
            $grp_id = $a_grp_id;
        } else {
            $grp_id = $this->getRefId();
        }
 
        $role_arr = $rbacreview->getRolesOfRoleFolder($grp_id);
 
        foreach ($role_arr as $role_id) {
            $role_Obj = &$this->ilias->obj_factory->getInstanceByObjId($role_id);
 
            $grp_Member = "il_grp_member_" . $grp_id;
            $grp_Admin = "il_grp_admin_" . $grp_id;
 
            if (strcmp($role_Obj->getTitle(), $grp_Member) == 0) {
                $arr_grpDefaultRoles["grp_member_role"] = $role_Obj->getId();
            }
 
            if (strcmp($role_Obj->getTitle(), $grp_Admin) == 0) {
                $arr_grpDefaultRoles["grp_admin_role"] = $role_Obj->getId();
            }
        }
 
        return $arr_grpDefaultRoles;
    }

References $DIC, ilObject\$rbacadmin, ilObject\$rbacreview, and ilObject\getRefId().

Referenced by getGroupAdminIds(), and isAdmin().

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 @access public

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

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

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

Referenced by cloneAutoGeneratedRoles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEnableGroupMap()

ilObjGroup::getEnableGroupMap ( )

Get Enable Group Map.

Returns: boolean Enable Group Map

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

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

References $enablemap.

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

Here is the caller graph for this function:

◆ getEnableMap()

ilObjGroup::getEnableMap ( )

Type independent wrapper.

Returns: type

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

    {
        return $this->getEnableGroupMap();
    }

References getEnableGroupMap().

Here is the call graph for this function:

◆ getEnd()

ilObjGroup::getEnd ( )

Returns: \ilDateTime|null

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

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

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

Here is the caller graph for this function:

◆ getGroupAdminIds()

ilObjGroup::getGroupAdminIds ( $a_grpId = "" )

get Group Admin Id @access public

Parameters

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

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

    {
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
 
        if (!empty($a_grpId)) {
            $grp_id = $a_grpId;
        } else {
            $grp_id = $this->getRefId();
        }
 
        $usr_arr = array();
        $roles = $this->getDefaultGroupRoles($this->getRefId());
 
        foreach ($rbacreview->assignedUsers($this->getDefaultAdminRole()) as $member_id) {
            array_push($usr_arr, $member_id);
        }
 
        return $usr_arr;
    }

References $DIC, ilObject\$rbacreview, getDefaultGroupRoles(), and ilObject\getRefId().

Referenced by leaveGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGroupMemberData()

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

get all group Members regardless of group role.

fetch all users data in one shot to improve performance @access public

Parameters

array of user ids

Returns: return array of userdata

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

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

References $DIC, $ilBench, $ilDB, ilObject\$rbacadmin, ilObject\$rbacreview, ilDBConstants\FETCHMODE_OBJECT, and ilUtil\quoteArray().

Here is the call graph for this function:

◆ getGroupMemberIds()

ilObjGroup::getGroupMemberIds ( )

get all group Member ids regardless of role @access public

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

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

    {
        global $DIC;
 
        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];
 
        $usr_arr = array();
 
        $rol = $this->getLocalGroupRoles();
 
        foreach ($rol as $value) {
            foreach ($rbacreview->assignedUsers($value) as $member_id) {
                array_push($usr_arr, $member_id);
            }
        }
 
        $mem_arr = array_unique($usr_arr);
 
        return $mem_arr ? $mem_arr : array();
    }

References $DIC, ilObject\$rbacadmin, ilObject\$rbacreview, and getLocalGroupRoles().

Referenced by getCountMembers(), and leaveGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGroupStatus()

ilObjGroup::getGroupStatus ( )

get group status

@access public

Parameters

int	group status

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

    {
        return $this->group_status;
    }

◆ getGroupType()

ilObjGroup::getGroupType ( )

get group type

@access public

Returns: int group type

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

    {
        return $this->group_type;
    }

References $group_type.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getGrpStatusClosedTemplateId()

ilObjGroup::getGrpStatusClosedTemplateId ( )

get group status closed template @access public

Parameters

return obj_id of roletemplate containing permissionsettings for a closed group

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

    {
        $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 $row["obj_id"];
    }

References $res, and ilDBConstants\FETCHMODE_ASSOC.

◆ getGrpStatusOpenTemplateId()

ilObjGroup::getGrpStatusOpenTemplateId ( )

get group status open template @access public

Parameters

return obj_id of roletemplate containing permissionsettings for an open group

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

    {
        $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 $row["obj_id"];
    }

References $res, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by setParentRolePermissions().

Here is the caller graph for this function:

◆ getInformation()

ilObjGroup::getInformation ( )

get Information

@access public

Parameters

return string information

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

    {
        return $this->information;
    }

References $information.

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

Here is the caller graph for this function:

◆ getLatitude()

ilObjGroup::getLatitude ( )

Get Latitude.

Returns: string Latitude

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

    {
        return $this->latitude;
    }

References $latitude.

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

Here is the caller graph for this function:

◆ getLocalGroupRoles()

ilObjGroup::getLocalGroupRoles ( $a_translate = false )

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

info is stored in object variable @access public

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

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

    {
        global $DIC;
 
        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];
 
        if (empty($this->local_roles)) {
            $this->local_roles = array();
            $role_arr = $rbacreview->getRolesOfRoleFolder($this->getRefId());
 
            foreach ($role_arr as $role_id) {
                if ($rbacreview->isAssignable($role_id, $this->getRefId()) == true) {
                    $role_Obj = &$this->ilias->obj_factory->getInstanceByObjId($role_id);
 
                    if ($a_translate) {
                        $role_name = ilObjRole::_getTranslation($role_Obj->getTitle());
                    } else {
                        $role_name = $role_Obj->getTitle();
                    }
 
                    $this->local_roles[$role_name] = $role_Obj->getId();
                }
            }
        }
 
        return $this->local_roles;
    }

References $DIC, ilObject\$rbacadmin, ilObject\$rbacreview, ilObjRole\_getTranslation(), and ilObject\getRefId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLocationZoom()

ilObjGroup::getLocationZoom ( )

Get LocationZoom.

Returns: int LocationZoom

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

    {
        return $this->locationzoom;
    }

References $locationzoom.

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

Here is the caller graph for this function:

◆ getLongitude()

ilObjGroup::getLongitude ( )

Get Longitude.

Returns: string Longitude

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

    {
        return $this->longitude;
    }

References $longitude.

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

Here is the caller graph for this function:

◆ getMailToMembersType()

ilObjGroup::getMailToMembersType ( )

Get mail to members type.

Returns: int

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

    {
        return $this->mail_members;
    }

References $mail_members.

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

Here is the caller graph for this function:

◆ getMaxMembers()

ilObjGroup::getMaxMembers ( )

get max members

@access public

Returns

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

    {
        return $this->reg_max_members;
    }

References $reg_max_members.

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

Here is the caller graph for this function:

◆ getMemberRoles()

ilObjGroup::getMemberRoles ( $a_user_id )

get group member status @access public

Parameters

integer user_id

Returns: returns array of obj_ids of assigned local roles

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

    {
        global $DIC;
 
        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];
        $ilBench = $DIC['ilBench'];
 
        $ilBench->start("Group", "getMemberRoles");
 
        $arr_assignedRoles = array();
 
        $arr_assignedRoles = array_intersect($rbacreview->assignedRoles($a_user_id), $this->getLocalGroupRoles());
 
        $ilBench->stop("Group", "getMemberRoles");
 
        return $arr_assignedRoles;
    }

References $DIC, $ilBench, ilObject\$rbacadmin, and ilObject\$rbacreview.

Referenced by leave().

Here is the caller graph for this function:

◆ getMembersObject()

ilObjGroup::getMembersObject ( )

Get members objects.

Returns: ilGroupParticipants

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

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

References $members_obj, and initParticipants().

Referenced by handleAutoFill().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMessage()

ilObjGroup::getMessage ( )

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

    {
        return $this->message;
    }

References $message.

Referenced by appendMessage().

Here is the caller graph for this function:

◆ getMinMembers()

ilObjGroup::getMinMembers ( )

get min members

@access public

Returns

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

    {
        return $this->reg_min_members;
    }

References $reg_min_members.

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

Here is the caller graph for this function:

◆ getPassword()

ilObjGroup::getPassword ( )

get password

@access public

Returns: string password

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

    {
        return $this->reg_password;
    }

References $reg_password.

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

Here is the caller graph for this function:

◆ getRegistrationAccessCode()

ilObjGroup::getRegistrationAccessCode ( )

get access code

Returns

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

    {
        return $this->reg_access_code;
    }

References $reg_access_code.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getRegistrationEnd()

ilObjGroup::getRegistrationEnd ( )

get registration end

@access public

Returns: int registration end

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

    {
        return $this->reg_end;
    }

References $reg_end.

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

Here is the caller graph for this function:

◆ getRegistrationStart()

ilObjGroup::getRegistrationStart ( )

get registration start

@access public

Returns: int registration start

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

    {
        return $this->reg_start;
    }

References $reg_start.

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

Here is the caller graph for this function:

◆ getRegistrationType()

ilObjGroup::getRegistrationType ( )

get registration type

@access public

Returns: int registration type

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

    {
        return $this->reg_type;
    }

References $reg_type.

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

Here is the caller graph for this function:

◆ getShowMembers()

ilObjGroup::getShowMembers ( )

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

    {
        return $this->show_members;
    }

References $show_members.

Referenced by cloneObject(), and update().

Here is the caller graph for this function:

◆ getStart()

ilObjGroup::getStart ( )

Returns: \ilDateTime | null

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

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

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

Here is the caller graph for this function:

◆ getStartTimeIndication()

ilObjGroup::getStartTimeIndication ( )

Returns: bool

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

                                             : ?bool
    {
        return $this->start_time_indication;
    }

Referenced by prepareAppointments(), and update().

Here is the caller graph for this function:

◆ getViewMode()

ilObjGroup::getViewMode ( )

Get effective container view mode.

Returns: int

Reimplemented from ilContainer.

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

    {
        $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;
    }

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

Here is the call graph for this function:

◆ handleAutoFill()

ilObjGroup::handleAutoFill ( )

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

    {
        if ($this->isWaitingListEnabled() &&
            $this->hasWaitingListAutoFill()) {
            $max = $this->getMaxMembers();
            $now = ilGroupParticipants::lookupNumberOfMembers($this->getRefId());
            if ($max > $now) {
                // see assignFromWaitingListObject()
                include_once('./Modules/Group/classes/class.ilGroupWaitingList.php');
                $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, IL_GRP_MEMBER); // #18213
                    include_once './Modules/Group/classes/class.ilGroupMembershipMailNotification.php';
                    $this->getMembersObject()->sendNotification(ilGroupMembershipMailNotification::TYPE_ACCEPTED_SUBSCRIPTION_MEMBER, $user_id, true);
                    $waiting_list->removeFromList($user_id);
 
                    $now++;
                    if ($now >= $max) {
                        break;
                    }
                }
            }
        }
    }

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

Here is the call graph for this function:

◆ hasWaitingListAutoFill()

ilObjGroup::hasWaitingListAutoFill ( )

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

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

References $auto_fill_from_waiting.

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

Here is the caller graph for this function:

◆ initDefaultRoles()

ilObjGroup::initDefaultRoles ( )

init default roles settings @access public

Returns: array object IDs of created local roles.

Reimplemented from ilObject.

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

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

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

Here is the call graph for this function:

◆ initParticipants()

ilObjGroup::initParticipants ( )

protected

init participants object

@access protected

Returns

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

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

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

Referenced by getMembersObject(), and read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAdmin()

ilObjGroup::isAdmin ( $a_userId )

is Admin @access public

Parameters

integer	user_id
boolean,true	if user is group administrator

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

    {
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
 
        $grp_Roles = $this->getDefaultGroupRoles();
 
        if (in_array($a_userId, $rbacreview->assignedUsers($grp_Roles["grp_admin_role"]))) {
            return true;
        } else {
            return false;
        }
    }

References $DIC, ilObject\$rbacreview, and getDefaultGroupRoles().

Referenced by leaveGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isMembershipLimited()

ilObjGroup::isMembershipLimited ( )

is max member limited

@access public

Returns

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

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

References $reg_membership_limitation.

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

Here is the caller graph for this function:

◆ isRegistrationAccessCodeEnabled()

ilObjGroup::isRegistrationAccessCodeEnabled ( )

Check if access code is enabled.

Returns

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

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

References $reg_access_code_enabled.

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

Here is the caller graph for this function:

◆ isRegistrationEnabled()

ilObjGroup::isRegistrationEnabled ( )

is registration enabled

@access public

Returns: bool

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

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

References getRegistrationType(), and GRP_REGISTRATION_DEACTIVATED.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRegistrationUnlimited()

ilObjGroup::isRegistrationUnlimited ( )

is registration unlimited

@access public

Returns: bool

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

    {
        return $this->reg_unlimited;
    }

References $reg_unlimited.

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

Here is the caller graph for this function:

◆ isWaitingListEnabled()

ilObjGroup::isWaitingListEnabled ( )

is waiting list enabled

@access public

Parameters

return bool

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

    {
        return $this->waiting_list;
    }

References $waiting_list.

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

Here is the caller graph for this function:

◆ join()

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

join Group, assigns user to role @access private

Parameters

integer member status = obj_id of local_group_role

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

    {
        global $DIC;
 
        $rbacadmin = $DIC['rbacadmin'];
 
        if (is_array($a_mem_role)) {
            foreach ($a_mem_role as $role) {
                $rbacadmin->assignUser($role, $a_user_id, false);
            }
        } else {
            $rbacadmin->assignUser($a_mem_role, $a_user_id, false);
        }
 
        return true;
    }

References $DIC, and ilObject\$rbacadmin.

Referenced by addMember().

Here is the caller graph for this function:

◆ leave()

ilObjGroup::leave ( $a_user_id )

deassign member from group role @access private

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

    {
        global $DIC;
 
        $rbacadmin = $DIC['rbacadmin'];
 
        $arr_groupRoles = $this->getMemberRoles($a_user_id);
 
        if (is_array($arr_groupRoles)) {
            foreach ($arr_groupRoles as $groupRole) {
                $rbacadmin->deassignUser($groupRole, $a_user_id);
            }
        } else {
            $rbacadmin->deassignUser($arr_groupRoles, $a_user_id);
        }
 
        return true;
    }

References $DIC, ilObject\$rbacadmin, and getMemberRoles().

Referenced by leaveGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ leaveGroup()

ilObjGroup::leaveGroup ( )

is called when a member decides to leave group @access public

Parameters

integer	user-Id
integer	group-Id

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

    {
        global $DIC;
 
        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];
 
        $member_ids = $this->getGroupMemberIds();
 
        if (count($member_ids) <= 1 || !in_array($this->ilias->account->getId(), $member_ids)) {
            return 2;
        } else {
            if (!$this->isAdmin($this->ilias->account->getId())) {
                $this->leave($this->ilias->account->getId());
                $this->recommended_content_manager->removeObjectRecommendation($this->user->getId(), $this->getRefId());
 
                return 0;
            } elseif (count($this->getGroupAdminIds()) == 1) {
                return 1;
            }
        }
    }

References $DIC, ilObject\$rbacadmin, ilObject\$rbacreview, getGroupAdminIds(), getGroupMemberIds(), isAdmin(), leave(), and user().

Here is the call graph for this function:

◆ lookupGroupStatusTemplateId()

static ilObjGroup::lookupGroupStatusTemplateId ( $a_obj_id )

static

@global $ilDB $ilDB

Parameters

int $a_obj_id

Returns: int

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

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

References $DIC, $ilDB, $query, $res, ilObject\$type, ilDBConstants\FETCHMODE_ASSOC, GRP_TYPE_CLOSED, and lookupGroupTye().

Referenced by ilRbacAdmin\adjustMovedObjectPermissions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupGroupTye()

static ilObjGroup::lookupGroupTye ( $a_id )

static

Lookup group type.

Parameters

object $a_id

Returns

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $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 $row->grp_type;
        }
        return GRP_TYPE_UNKNOWN;
    }

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

Referenced by ilObjRole\createPermissionIntersection(), and lookupGroupStatusTemplateId().

Here is the caller graph for this function:

◆ lookupObjectsByCode()

static ilObjGroup::lookupObjectsByCode ( $a_code )

static

See also: interface.ilMembershipRegistrationCodes

Returns: array obj ids

Implements ilMembershipRegistrationCodes.

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

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

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

Referenced by ilMembershipRegistrationCodeUtils\lookupObjectsByCode().

Here is the caller graph for this function:

◆ lookupShowMembersEnabled()

static ilObjGroup::lookupShowMembersEnabled ( int $a_obj_id )

static

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

                                                                   : bool
    {
        global $DIC;
        $ilDB = $DIC["ilDB"];
        $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'];
    }

References $DIC, $ilDB, $query, and $res.

Referenced by ilParticipants\hasParticipantListAccess().

Here is the caller graph for this function:

◆ lookupViewMode()

static ilObjGroup::lookupViewMode ( $a_obj_id )

static

lookup view mode @global $ilDB

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = 'SELECT view_mode FROM grp_settings ' .
            'WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer');
        $res = $ilDB->query($query);
 
        $view_mode = null;
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $view_mode = $row->view_mode;
        }
        return $view_mode;
    }

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

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

Here is the caller graph for this function:

◆ mayLeave()

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

static

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

    {
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
        $ilDB = $DIC['ilDB'];
        
        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 && $row["leave_end"]) {
            // timestamp to date
            $limit = date("Ymd", $row["leave_end"]);
            if ($limit < date("Ymd")) {
                $a_date = new ilDate(date("Y-m-d", $row["leave_end"]), IL_CAL_DATE);
                return false;
            }
        }
        return true;
    }

References $DIC, $ilDB, $ilUser, and IL_CAL_DATE.

Referenced by ilObjGroupAccess\_checkAccess().

Here is the caller graph for this function:

◆ prepareAppointments()

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

protected

Prepare calendar appointments.

@access protected

Parameters

string mode UPDATE|CREATE|DELETE

Returns

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

    {
        include_once('./Services/Calendar/classes/class.ilCalendarAppointmentTemplate.php');
        
        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(IL_CAL_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(IL_CAL_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(IL_CAL_TRANSLATION_SYSTEM);
                $app->setDescription($this->getLongDescription());
                $app->setStart($this->getRegistrationStart());
                $apps[] = $app;
 
                $app = new ilCalendarAppointmentTemplate(self::CAL_REG_END);
                $app->setTitle($this->getTitle());
                $app->setSubtitle('grp_cal_reg_end');
                $app->setTranslationType(IL_CAL_TRANSLATION_SYSTEM);
                $app->setDescription($this->getLongDescription());
                $app->setStart($this->getRegistrationEnd());
                $apps[] = $app;
                
                
                return $apps;
                
            case 'delete':
                // Nothing to do: The category and all assigned appointments will be deleted.
                return array();
        }
    }

References $app, getEnd(), ilObject\getLongDescription(), getRegistrationEnd(), getRegistrationStart(), getStart(), getStartTimeIndication(), ilObject\getTitle(), IL_CAL_TRANSLATION_SYSTEM, and isRegistrationUnlimited().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilObjGroup::read ( )

Read group.

Reimplemented from ilContainer.

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        parent::read();
 
        $query = "SELECT * FROM grp_settings " .
            "WHERE obj_id = " . $ilDB->quote($this->getId(), 'integer');
        
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setInformation($row->information);
            $this->setGroupType($row->grp_type);
            $this->setRegistrationType($row->registration_type);
            $this->enableUnlimitedRegistration($row->registration_unlimited);
            $this->setRegistrationStart(new ilDateTime($row->registration_start, IL_CAL_DATETIME));
            $this->setRegistrationEnd(new ilDateTime($row->registration_end, IL_CAL_DATETIME));
            $this->setPassword($row->registration_password);
            $this->enableMembershipLimitation((bool) $row->registration_mem_limit);
            $this->setMaxMembers($row->registration_max_members);
            $this->enableWaitingList($row->waiting_list);
            $this->setLatitude($row->latitude);
            $this->setLongitude($row->longitude);
            $this->setLocationZoom($row->location_zoom);
            $this->setEnableGroupMap($row->enablemap);
            $this->enableRegistrationAccessCode($row->reg_ac_enabled);
            $this->setRegistrationAccessCode($row->reg_ac);
            $this->setViewMode($row->view_mode);
            $this->setMailToMembersType($row->mail_members_type);
            $this->setCancellationEnd($row->leave_end ? new ilDate($row->leave_end, IL_CAL_UNIX) : null);
            $this->setMinMembers($row->registration_min_members);
            $this->setWaitingListAutoFill($row->auto_wait);
            $this->setShowMembers($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->initParticipants();
        
        // Inherit order type from parent course (if exists)
        include_once('./Services/Container/classes/class.ilContainerSortingSettings.php');
        $this->setOrderType(ilContainerSortingSettings::_lookupSortMode($this->getId()));
    }

References $DIC, $ilDB, $query, $res, ilContainerSortingSettings\_lookupSortMode(), enableMembershipLimitation(), enableRegistrationAccessCode(), enableUnlimitedRegistration(), enableWaitingList(), ilDBConstants\FETCHMODE_OBJECT, ilObject\getId(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_UNIX, initParticipants(), setAutoNotification(), setCancellationEnd(), setEnableGroupMap(), setGroupType(), setInformation(), setLatitude(), setLocationZoom(), setLongitude(), setMailToMembersType(), setMaxMembers(), setMinMembers(), ilContainer\setOrderType(), setPassword(), setPeriod(), setRegistrationAccessCode(), setRegistrationEnd(), setRegistrationStart(), setRegistrationType(), setShowMembers(), setViewMode(), setWaitingListAutoFill(), toggleStartTimeIndication(), and ilTimeZone\UTC.

Here is the call graph for this function:

◆ readGroupStatus()

ilObjGroup::readGroupStatus ( )

Read group type.

Returns: int

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

                                      : int
    {
        global $DIC;
 
 
        $tpl_id = ilDidacticTemplateObjSettings::lookupTemplateId($this->getRefId());
        $logger = $DIC->logger()->grp();
        $logger->dump($tpl_id);
        if (!$tpl_id) {
            return GRP_TYPE_OPEN;
        }
        return GRP_TYPE_CLOSED;
    }

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

Here is the call graph for this function:

◆ register()

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

See also: ilMembershipRegistrationCodes::register()

Parameters

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

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

    {
        include_once './Services/Membership/exceptions/class.ilMembershipRegistrationException.php';
        include_once "./Modules/Group/classes/class.ilGroupParticipants.php";
        $part = ilGroupParticipants::_getInstanceByObjId($this->getId());
 
        if ($part->isAssigned($a_user_id)) {
            return true;
        }
        
        if (!$a_force_registration) {
            // Availability
            if (!$this->isRegistrationEnabled()) {
                include_once './Modules/Group/classes/class.ilObjGroupAccess.php';
 
                if (!ilObjGroupAccess::_usingRegistrationCode()) {
                    throw new ilMembershipRegistrationException('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());
                include_once('./Modules/Group/classes/class.ilGroupWaitingList.php');
                $waiting_list = new ilGroupWaitingList($this->getId());
                if ($this->isWaitingListEnabled() and (!$free or $waiting_list->getCountUsers())) {
                    $this->lng->loadLanguageModule("grp");
                    $waiting_list->addToList($a_user_id);
 
                    $info = sprintf(
                        $this->lng->txt('grp_added_to_list'),
                        $this->getTitle(),
                        $waiting_list->getPosition($a_user_id)
                    );
 
                    include_once('./Modules/Group/classes/class.ilGroupParticipants.php');
                    include_once('./Modules/Group/classes/class.ilGroupMembershipMailNotification.php');
                    $participants = ilGroupParticipants::_getInstanceByObjId($this->getId());
                    $participants->sendNotification(ilGroupMembershipMailNotification::TYPE_WAITING_LIST_MEMBER, $a_user_id);
 
                    throw new ilMembershipRegistrationException($info, 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);
        return true;
    }

References $end, $start, $waiting_list, ilDateTime\_after(), ilDateTime\_before(), ilGroupParticipants\_getInstanceByObjId(), ilObjGroupAccess\_usingRegistrationCode(), ilMembershipRegistrationException\ADDED_TO_WAITINGLIST, ilObject\getId(), getMaxMembers(), getRegistrationEnd(), getRegistrationStart(), IL_CAL_UNIX, isMembershipLimited(), isRegistrationEnabled(), isRegistrationUnlimited(), isWaitingListEnabled(), 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.

Here is the call graph for this function:

◆ setAutoNotification()

ilObjGroup::setAutoNotification ( bool $a_status )

Parameters

bool $a_status

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

    {
        $this->auto_notification = $a_status;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setCancellationEnd()

ilObjGroup::setCancellationEnd ( ilDate $a_value = null )

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

    {
        $this->leave_end = $a_value;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setEnableGroupMap()

ilObjGroup::setEnableGroupMap ( $a_enablemap )

Set Enable Group Map.

Parameters

boolean $a_enablemap Enable Group Map

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

    {
        $this->enablemap = $a_enablemap;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setEnd()

ilObjGroup::setEnd ( ilDateTime $a_value = null )

protected

Parameters

\ilDateTime | null $a_value

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

    {
        $this->grp_end = $a_value;
    }

Referenced by setPeriod().

Here is the caller graph for this function:

◆ setGroupStatus()

ilObjGroup::setGroupStatus ( $a_status )

Set group status.

@access public

Parameters

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

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

    {
        $this->group_status = $a_status;
    }

◆ setGroupType()

ilObjGroup::setGroupType ( $a_type )

set group type

@access public

Parameters

int type

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

    {
        $this->group_type = $a_type;
    }

References $a_type.

Referenced by read().

Here is the caller graph for this function:

◆ setInformation()

ilObjGroup::setInformation ( $a_information )

set information

@access public

Parameters

string information

Returns

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

    {
        $this->information = $a_information;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setLatitude()

ilObjGroup::setLatitude ( $a_latitude )

Set Latitude.

Parameters

string $a_latitude Latitude

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

    {
        $this->latitude = $a_latitude;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setLocationZoom()

ilObjGroup::setLocationZoom ( $a_locationzoom )

Set LocationZoom.

Parameters

int $a_locationzoom LocationZoom

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

    {
        $this->locationzoom = $a_locationzoom;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setLongitude()

ilObjGroup::setLongitude ( $a_longitude )

Set Longitude.

Parameters

string $a_longitude Longitude

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

    {
        $this->longitude = $a_longitude;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setMailToMembersType()

ilObjGroup::setMailToMembersType ( $a_type )

Set mail to members type.

See also: ilCourseConstants

Parameters

type $a_type

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

    {
        $this->mail_members = $a_type;
    }

References $a_type.

Referenced by read().

Here is the caller graph for this function:

◆ setMaxMembers()

ilObjGroup::setMaxMembers ( $a_max )

set max members

@access public

Parameters

int	max members

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

    {
        $this->reg_max_members = $a_max;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setMessage()

ilObjGroup::setMessage ( $a_message )

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

    {
        $this->message = $a_message;
    }

◆ setMinMembers()

ilObjGroup::setMinMembers ( $a_max )

set min members

@access public

Parameters

int	min members

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

    {
        $this->reg_min_members = $a_max;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setParentRolePermissions()

ilObjGroup::setParentRolePermissions ( $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.

Parameters

int	parent ref id

Reimplemented from ilObject.

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

    {
        $rbacadmin = $GLOBALS['DIC']->rbac()->admin();
        $rbacreview = $GLOBALS['DIC']->rbac()->review();
        
        $parent_roles = $rbacreview->getParentRoleIds($a_parent_ref);
        foreach ((array) $parent_roles as $parent_role) {
            if ($parent_role['parent'] == $this->getRefId()) {
                continue;
            }
            if ($rbacreview->isProtected($parent_role['parent'], $parent_role['rol_id'])) {
                $operations = $rbacreview->getOperationsOfRole(
                    $parent_role['obj_id'],
                    $this->getType(),
                    $parent_role['parent']
                );
                $rbacadmin->grantPermission(
                    $parent_role['obj_id'],
                    $operations,
                    $this->getRefId()
                );
                continue;
            }
 
            $rbacadmin->initIntersectionPermissions(
                $this->getRefId(),
                $parent_role['obj_id'],
                $parent_role['parent'],
                $this->getGrpStatusOpenTemplateId(),
                ROLE_FOLDER_ID
            );
        }
    }

References $GLOBALS, ilObject\$rbacadmin, ilObject\$rbacreview, getGrpStatusOpenTemplateId(), ilObject\getRefId(), and ilObject\getType().

Referenced by applyDidacticTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPassword()

ilObjGroup::setPassword ( $a_pass )

set password

@access public

Parameters

string password

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

    {
        $this->reg_password = $a_pass;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setPeriod()

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

Parameters

\ilDateTime \| null	$start
\ilDateTime \| null	$end

Exceptions

InvalidArgumentException

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

    {
        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);
    }

References $end, $start, setEnd(), setStart(), and toggleStartTimeIndication().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRegistrationAccessCode()

ilObjGroup::setRegistrationAccessCode ( $a_code )

Set refistration access code.

Parameters

string $a_code

Returns

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

    {
        $this->reg_access_code = $a_code;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setRegistrationEnd()

ilObjGroup::setRegistrationEnd ( $a_end )

set registration end

@access public

Parameters

int unix time

Returns

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

    {
        $this->reg_end = $a_end;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setRegistrationStart()

ilObjGroup::setRegistrationStart ( $a_start )

set registration start

@access public

Parameters

object ilDateTime

Returns

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

    {
        $this->reg_start = $a_start;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setRegistrationType()

ilObjGroup::setRegistrationType ( $a_type )

set registration type

@access public

Parameters

int	registration type

Returns

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

    {
        $this->reg_type = $a_type;
    }

References $a_type.

Referenced by read().

Here is the caller graph for this function:

◆ setShowMembers()

ilObjGroup::setShowMembers ( $a_status )

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

    {
        $this->show_members = $a_status;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setStart()

ilObjGroup::setStart ( ilDateTime $a_value = null )

protected

Parameters

\ilDateTime | null $a_value

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

    {
        $this->grp_start = $a_value;
    }

Referenced by setPeriod().

Here is the caller graph for this function:

◆ setViewMode()

ilObjGroup::setViewMode ( $a_view_mode )

Set group view mode.

Parameters

int $a_view_mode

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

    {
        $this->view_mode = $a_view_mode;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setWaitingListAutoFill()

ilObjGroup::setWaitingListAutoFill ( $a_value )

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

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

Referenced by read().

Here is the caller graph for this function:

◆ toggleStartTimeIndication()

ilObjGroup::toggleStartTimeIndication ( bool $time_indication )

protected

Parameters

bool $time_indication

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

    {
        $this->start_time_indication = $time_indication;
    }

Referenced by read(), and setPeriod().

Here is the caller graph for this function:

◆ translateViewMode()

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

static

translate view mode

Parameters

int	$a_obj_id
int	$a_view_mode
int	$a_ref_id

Returns: int

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

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

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

Here is the call graph for this function:

◆ update()

ilObjGroup::update ( )

Update group.

Reimplemented from ilContainer.

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $ilAppEventHandler = $DIC['ilAppEventHandler'];
 
        if (!parent::update()) {
            return false;
        }
 
        $query = "UPDATE grp_settings " .
            "SET information = " . $ilDB->quote($this->getInformation(), 'text') . ", " .
            "grp_type = " . $ilDB->quote((int) $this->getGroupType(), 'integer') . ", " .
            "registration_type = " . $ilDB->quote($this->getRegistrationType(), 'integer') . ", " .
            "registration_enabled = " . $ilDB->quote($this->isRegistrationEnabled() ? 1 : 0, 'integer') . ", " .
            "registration_unlimited = " . $ilDB->quote($this->isRegistrationUnlimited() ? 1 : 0, 'integer') . ", " .
            "registration_start = " . $ilDB->quote(($this->getRegistrationStart() && !$this->getRegistrationStart()->isNull()) ? $this->getRegistrationStart()->get(IL_CAL_DATETIME, '') : null, 'timestamp') . ", " .
            "registration_end = " . $ilDB->quote(($this->getRegistrationEnd() && !$this->getRegistrationEnd()->isNull()) ? $this->getRegistrationEnd()->get(IL_CAL_DATETIME, '') : null, 'timestamp') . ", " .
            "registration_password = " . $ilDB->quote($this->getPassword(), 'text') . ", " .
//                      "registration_membership_limited = ".$ilDB->quote((int) $this->isMembershipLimited() ,'integer').", ".
            "registration_mem_limit = " . $ilDB->quote((int) $this->isMembershipLimited(), 'integer') . ", " .
            "registration_max_members = " . $ilDB->quote($this->getMaxMembers(), 'integer') . ", " .
            "waiting_list = " . $ilDB->quote($this->isWaitingListEnabled() ? 1 : 0, 'integer') . ", " .
            "latitude = " . $ilDB->quote($this->getLatitude(), 'text') . ", " .
            "longitude = " . $ilDB->quote($this->getLongitude(), 'text') . ", " .
            "location_zoom = " . $ilDB->quote($this->getLocationZoom(), 'integer') . ", " .
            "enablemap = " . $ilDB->quote((int) $this->getEnableGroupMap(), 'integer') . ", " .
            'reg_ac_enabled = ' . $ilDB->quote($this->isRegistrationAccessCodeEnabled(), 'integer') . ', ' .
            'reg_ac = ' . $ilDB->quote($this->getRegistrationAccessCode(), 'text') . ', ' .
            'view_mode = ' . $ilDB->quote($this->view_mode, 'integer') . ', ' .
            'mail_members_type = ' . $ilDB->quote($this->getMailToMembersType(), 'integer') . ', ' .
            'leave_end = ' . $ilDB->quote(($this->getCancellationEnd() && !$this->getCancellationEnd()->isNull()) ? $this->getCancellationEnd()->get(IL_CAL_UNIX) : null, 'integer') . ', ' .
            "registration_min_members = " . $ilDB->quote($this->getMinMembers(), 'integer') . ", " .
            "auto_wait = " . $ilDB->quote($this->hasWaitingListAutoFill(), 'integer') . ", " .
            "show_members = " . $ilDB->quote((int) $this->getShowMembers(), 'integer') . ", " .
            'period_start = ' . $ilDB->quote(\ilCalendarUtil::convertDateToUtcDBTimestamp($this->getStart()), \ilDBConstants::T_TIMESTAMP) . ', ' .
            'period_end = ' . $ilDB->quote(\ilCalendarUtil::convertDateToUtcDBTimestamp($this->getEnd()), \ilDBConstants::T_TIMESTAMP) . ', ' .
            'period_time_indication = ' . $ilDB->quote($this->getStartTimeIndication() ? 1 : 0, \ilDBConstants::T_INTEGER) . ', ' .
            'auto_notification = ' . $ilDB->quote($this->getAutoNotification(), \ilDBConstants::T_INTEGER) . ' ' .
            "WHERE obj_id = " . $ilDB->quote($this->getId(), 'integer');
        $res = $ilDB->manipulate($query);
        
        $ilAppEventHandler->raise(
            'Modules/Group',
            'update',
            array('object' => $this,
                'obj_id' => $this->getId(),
                'appointments' => $this->prepareAppointments('update'))
        );
                
        
        return true;
    }

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

Here is the call graph for this function:

◆ updateGroupType()

ilObjGroup::updateGroupType ( $a_group_type = 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.

@access public

Returns

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

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

References $DIC, applyDidacticTemplate(), ilDidacticTemplateSettings\getInstanceByObjectType(), ilObject\getType(), and GRP_TYPE_OPEN.

Here is the call graph for this function:

◆ validate()

ilObjGroup::validate ( )

validate group settings

@access public

Returns: bool

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

    {
        global $DIC;
 
        $ilErr = $DIC['ilErr'];
        
        if (!$this->getTitle()) {
            $this->title = '';
            $ilErr->appendMessage($this->lng->txt(self::ERR_MISSING_TITLE));
        }
        if ($this->getRegistrationType() == GRP_REGISTRATION_PASSWORD and !strlen($this->getPassword())) {
            $ilErr->appendMessage($this->lng->txt(self::ERR_MISSING_PASSWORD));
        }
        /*
        if(ilDateTime::_before($this->getRegistrationEnd(),$this->getRegistrationStart()))
        {
            $ilErr->appendMessage($this->lng->txt(self::ERR_WRONG_REG_TIME_LIMIT));
        }
        */
        if ($this->isMembershipLimited()) {
            if ($this->getMinMembers() <= 0 && $this->getMaxMembers() <= 0) {
                $ilErr->appendMessage($this->lng->txt(self::ERR_MISSING_MIN_MAX_MEMBERS));
            }
            if ($this->getMaxMembers() <= 0 && $this->isWaitingListEnabled()) {
                $ilErr->appendMessage($this->lng->txt(self::ERR_WRONG_MAX_MEMBERS));
            }
            if ($this->getMaxMembers() > 0 && $this->getMinMembers() > $this->getMaxMembers()) {
                $ilErr->appendMessage($this->lng->txt(self::ERR_WRONG_MIN_MAX_MEMBERS));
            }
        }
        if (
            ($this->getRegistrationStart() && !$this->getRegistrationEnd()) ||
            (!$this->getRegistrationStart() && $this->getRegistrationEnd()) ||
            $this->getRegistrationEnd() <= $this->getRegistrationStart()
        ) {
            $ilErr->appendMessage($this->lng->txt((self::ERR_WRONG_REGISTRATION_LIMITED)));
        }
        
        return strlen($ilErr->getMessage()) == 0;
    }

References $DIC, $ilErr, getMaxMembers(), getMinMembers(), getPassword(), getRegistrationEnd(), getRegistrationStart(), getRegistrationType(), ilObject\getTitle(), GRP_REGISTRATION_PASSWORD, isMembershipLimited(), and isWaitingListEnabled().

Here is the call graph for this function:

Field Documentation

◆ $auto_fill_from_waiting

ilObjGroup::$auto_fill_from_waiting

protected

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

Referenced by hasWaitingListAutoFill().

◆ $auto_notification

ilObjGroup::$auto_notification = true

protected

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

Referenced by getAutoNotification().

◆ $enablemap

ilObjGroup::$enablemap = 0

private

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

Referenced by getEnableGroupMap().

◆ $end

ilObjGroup::$end = null

protected

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

Referenced by register(), and setPeriod().

◆ $file_obj

ilObjGroup::$file_obj = null

Group file object for handling of export files.

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

◆ $group_type

ilObjGroup::$group_type = null

protected

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

Referenced by getGroupType().

◆ $grp_start_time_indication

ilObjGroup::$grp_start_time_indication = false

protected

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

◆ $information

ilObjGroup::$information

protected

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

Referenced by getInformation().

◆ $latitude

ilObjGroup::$latitude = ''

private

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

Referenced by getLatitude().

◆ $leave_end

ilObjGroup::$leave_end

protected

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

Referenced by getCancellationEnd().

◆ $locationzoom

ilObjGroup::$locationzoom = 0

private

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

Referenced by getLocationZoom().

◆ $longitude

ilObjGroup::$longitude = ''

private

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

Referenced by getLongitude().

◆ $m_grpStatus

ilObjGroup::$m_grpStatus

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

◆ $m_roleAdminId

ilObjGroup::$m_roleAdminId

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

◆ $m_roleMemberId

ilObjGroup::$m_roleMemberId

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

◆ $mail_members

ilObjGroup::$mail_members = self::MAIL_ALLOWED_ALL

private

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

Referenced by getMailToMembersType().

◆ $members_obj

ilObjGroup::$members_obj

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

Referenced by getMembersObject().

◆ $reg_access_code

ilObjGroup::$reg_access_code = ''

private

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

Referenced by getRegistrationAccessCode().

◆ $reg_access_code_enabled

ilObjGroup::$reg_access_code_enabled = false

private

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

Referenced by isRegistrationAccessCodeEnabled().

◆ $reg_enabled

ilObjGroup::$reg_enabled = true

protected

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

◆ $reg_end

ilObjGroup::$reg_end = null

protected

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

Referenced by getRegistrationEnd().

◆ $reg_max_members

ilObjGroup::$reg_max_members = 0

protected

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

Referenced by getMaxMembers().

◆ $reg_membership_limitation

ilObjGroup::$reg_membership_limitation = false

protected

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

Referenced by isMembershipLimited().

◆ $reg_min_members

ilObjGroup::$reg_min_members = 0

protected

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

Referenced by getMinMembers().

◆ $reg_password

ilObjGroup::$reg_password = ''

protected

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

Referenced by getPassword().

◆ $reg_start

ilObjGroup::$reg_start = null

protected

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

Referenced by getRegistrationStart().

◆ $reg_type

ilObjGroup::$reg_type = GRP_REGISTRATION_DIRECT

protected

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

Referenced by getRegistrationType().

◆ $reg_unlimited

ilObjGroup::$reg_unlimited = true

protected

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

Referenced by isRegistrationUnlimited().

◆ $show_members

ilObjGroup::$show_members = 1

protected

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

Referenced by getShowMembers().

◆ $SHOW_MEMBERS_DISABLED

ilObjGroup::$SHOW_MEMBERS_DISABLED = 0

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

◆ $SHOW_MEMBERS_ENABLED

ilObjGroup::$SHOW_MEMBERS_ENABLED = 1

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

◆ $start

ilObjGroup::$start = null

protected

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

Referenced by register(), and setPeriod().

◆ $view_mode

ilObjGroup::$view_mode = ilContainer::VIEW_DEFAULT

private

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

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

◆ $waiting_list

ilObjGroup::$waiting_list = false

protected

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

Referenced by handleAutoFill(), isWaitingListEnabled(), and register().

◆ CAL_END

const ilObjGroup::CAL_END = 4

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

◆ CAL_REG_END

const ilObjGroup::CAL_REG_END = 2

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

◆ CAL_REG_START

const ilObjGroup::CAL_REG_START = 1

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

◆ CAL_START

const ilObjGroup::CAL_START = 3

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

◆ ERR_MISSING_GROUP_TYPE

const ilObjGroup::ERR_MISSING_GROUP_TYPE = 'grp_missing_grp_type'

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

◆ ERR_MISSING_PASSWORD

const ilObjGroup::ERR_MISSING_PASSWORD = 'grp_missing_password'

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

◆ ERR_MISSING_TITLE

const ilObjGroup::ERR_MISSING_TITLE = 'msg_no_title'

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

◆ ERR_WRONG_MAX_MEMBERS

const ilObjGroup::ERR_WRONG_MAX_MEMBERS = 'grp_wrong_max_members'

Definition at line 46 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 49 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 47 of file class.ilObjGroup.php.

◆ ERR_WRONG_REGISTRATION_LIMITED

const ilObjGroup::ERR_WRONG_REGISTRATION_LIMITED = 'grp_err_registration_limited'

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

◆ GRP_ADMIN

const ilObjGroup::GRP_ADMIN = 2

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

◆ GRP_MEMBER

const ilObjGroup::GRP_MEMBER = 1

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

◆ MAIL_ALLOWED_ALL

const ilObjGroup::MAIL_ALLOWED_ALL = 1

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

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

◆ MAIL_ALLOWED_TUTORS

const ilObjGroup::MAIL_ALLOWED_TUTORS = 2

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

Referenced by ilObjGroupGUI\initForm().

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

Modules/Group/classes/class.ilObjGroup.php

Static Public Member Functions
static	lookupGroupTye ($a_id)
	Lookup group type. More...

static	lookupGroupStatusTemplateId ($a_obj_id)
	@global $ilDB $ilDB More...

static	_lookupIdByTitle ($a_title)

static	lookupViewMode ($a_obj_id)
	lookup view mode @global $ilDB More...

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

static	lookupObjectsByCode ($a_code)

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

static	findGroupsWithNotEnoughMembers ()
	Minimum members check @global $ilDB $ilDB. More...

static	lookupShowMembersEnabled (int $a_obj_id)

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

static	_lookupImportId ($a_obj_id)

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

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

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

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

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

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

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

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

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

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

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id, $a_deleted_by)

static	setDeletedDates ($a_ref_ids, $a_user_id)
	Set deleted date. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

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

Static Public Member Functions inherited from ilContainer
static	_getContainerDirectory ($a_id)
	Get the container directory. More...

static	_lookupContainerSetting ($a_id, $a_keyword, $a_default_value=null)
	Lookup a container setting. More...

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

static	_getContainerSettings ($a_id)

static	_deleteContainerSettings ($a_id, $a_keyword=null, $a_keyword_like=false)

static	_exportContainerSettings (ilXmlWriter $a_xml, $a_obj_id)

static	getCompleteDescriptions (array $objects)
	overwrites description fields to long or short description in an assoc array keys needed (obj_id and description) More...

static	lookupObjectsByCode ($a_code)
	Lookup all objects with reg_access_code enabled and. More...

Protected Member Functions
	toggleStartTimeIndication (bool $time_indication)

	setStart (ilDateTime $a_value=null)

	setEnd (ilDateTime $a_value=null)

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

	initParticipants ()
	init participants object More...

Protected Member Functions inherited from ilContainer
	getInitialSubitems ()
	Get initial subitems. More...

	applyContainerUserFilter ($objects, ilContainerUserFilter $container_user_filter=null)
	Apply container user filter on objects. More...

	legacyOnlineFilter ($obj_ids, $objects, $val)
	Legacy online filter. More...

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

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

	$members_obj

	$file_obj = null
	Group file object for handling of export files. More...

	$m_grpStatus

	$m_roleMemberId

	$m_roleAdminId

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

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

Protected Attributes
	$information

	$group_type = null

	$reg_type = GRP_REGISTRATION_DIRECT

	$reg_enabled = true

	$reg_unlimited = true

	$reg_start = null

	$reg_end = null

	$reg_password = ''

	$reg_membership_limitation = false

	$reg_min_members = 0

	$reg_max_members = 0

	$waiting_list = false

	$auto_fill_from_waiting

	$leave_end

	$show_members = 1

	$auto_notification = true

	$grp_start_time_indication = false

	$start = null

	$end = null

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Protected Attributes inherited from ilContainer
	$db

	$log

	$access

	$error

	$rbacsystem

	$tree

	$user

	$obj_definition

	$order_type = 0

	$hiddenfilesfound = false

	$news_timeline = false

	$news_timeline_auto_entries = false

	$setting

	$obj_trans = null

	$recommended_content_manager

Private Attributes
	$latitude = ''

	$longitude = ''

	$locationzoom = 0

	$enablemap = 0

	$reg_access_code = ''

	$reg_access_code_enabled = false

	$view_mode = ilContainer::VIEW_DEFAULT

	$mail_members = self::MAIL_ALLOWED_ALL

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getMembers()

◆ _isMember()

◆ _lookupIdByTitle()

◆ addAdditionalSubItemInformation()

◆ addMember()

◆ appendMessage()

◆ applyDidacticTemplate()

◆ cloneAutoGeneratedRoles()

◆ cloneDependencies()

◆ cloneObject()

◆ create()

◆ delete()

◆ enableMembershipLimitation()

◆ enableRegistrationAccessCode()

◆ 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()

◆ getPassword()

◆ getRegistrationAccessCode()

◆ getRegistrationEnd()

◆ getRegistrationStart()

◆ getRegistrationType()

◆ getShowMembers()

◆ getStart()

◆ getStartTimeIndication()

◆ getViewMode()

◆ handleAutoFill()

◆ hasWaitingListAutoFill()

◆ initDefaultRoles()

◆ initParticipants()

◆ isAdmin()

◆ isMembershipLimited()

◆ isRegistrationAccessCodeEnabled()

◆ isRegistrationEnabled()

◆ isRegistrationUnlimited()

◆ isWaitingListEnabled()

◆ join()

◆ leave()

◆ leaveGroup()

◆ lookupGroupStatusTemplateId()

◆ lookupGroupTye()

◆ lookupObjectsByCode()