class.ilObjGroup.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

//TODO: function getRoleId($groupRole) returns the object-id of grouprole

require_once "./Services/Container/classes/class.ilContainer.php";
include_once('./Services/Calendar/classes/class.ilDateTime.php');
include_once './Services/Membership/interfaces/interface.ilMembershipRegistrationCodes.php';

define('GRP_REGISTRATION_DEACTIVATED', -1);
define('GRP_REGISTRATION_DIRECT', 0);
define('GRP_REGISTRATION_REQUEST', 1);
define('GRP_REGISTRATION_PASSWORD', 2);

define('GRP_REGISTRATION_LIMITED', 1);
define('GRP_REGISTRATION_UNLIMITED', 2);

define('GRP_TYPE_UNKNOWN', 0);
define('GRP_TYPE_CLOSED', 1);
define('GRP_TYPE_OPEN', 2);
define('GRP_TYPE_PUBLIC', 3);

class ilObjGroup extends ilContainer implements ilMembershipRegistrationCodes
{
    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;

    public $SHOW_MEMBERS_ENABLED = 1;
    public $SHOW_MEMBERS_DISABLED = 0;
    
    protected $information;
    protected $group_type = null;
    protected $reg_type = GRP_REGISTRATION_DIRECT;
    protected $reg_enabled = true;
    protected $reg_unlimited = true;
    protected $reg_start = null;
    protected $reg_end = null;
    protected $reg_password = '';
    protected $reg_membership_limitation = false;
    protected $reg_min_members = 0;
    protected $reg_max_members = 0;
    protected $waiting_list = false;
    protected $auto_fill_from_waiting; // [bool]
    protected $leave_end; // [ilDate]
    protected $show_members = 1;

    private $session_limit = 0;
    private $session_prev = -1;
    private $session_next = -1;


    protected $auto_notification = true;


    protected $grp_start_time_indication = false;


    protected $start = null;

    protected $end = null;
    
    
    // Map
    private $latitude = '';
    private $longitude = '';
    private $locationzoom = 0;
    private $enablemap = 0;
    
    private $reg_access_code = '';
    private $reg_access_code_enabled = false;

    private $view_mode = ilContainer::VIEW_DEFAULT;
    
    private $mail_members = self::MAIL_ALLOWED_ALL;
    
    
    public $members_obj;


    public $file_obj = null;

    public $m_grpStatus;

    public $m_roleMemberId;

    public $m_roleAdminId;


    public function __construct($a_id = 0, $a_call_by_reference = true)
    {
        global $DIC;

        $tree = $DIC['tree'];

        $this->tree = &$tree;

        $this->type = "grp";
        parent::__construct($a_id, $a_call_by_reference);
        $this->setRegisterMode(true); // ???
    }
    
    public static function lookupGroupTye($a_id)
    {
        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;
    }
    
    // Setter/Getter
    public function setInformation($a_information)
    {
        $this->information = $a_information;
    }
    
    public function getInformation()
    {
        return $this->information;
    }
    
    public function setGroupType($a_type)
    {
        $this->group_type = $a_type;
    }
    
    public function getGroupType()
    {
        return $this->group_type;
    }
    
    public function setRegistrationType($a_type)
    {
        $this->reg_type = $a_type;
    }
    
    public function getRegistrationType()
    {
        return $this->reg_type;
    }
    
    public function isRegistrationEnabled()
    {
        return $this->getRegistrationType() != GRP_REGISTRATION_DEACTIVATED;
    }
    
    public function enableUnlimitedRegistration($a_status)
    {
        $this->reg_unlimited = $a_status;
    }
    
    public function isRegistrationUnlimited()
    {
        return $this->reg_unlimited;
    }
    
    public function setRegistrationStart($a_start)
    {
        $this->reg_start = $a_start;
    }
    
    public function getRegistrationStart()
    {
        return $this->reg_start;
    }
    

    public function setRegistrationEnd($a_end)
    {
        $this->reg_end = $a_end;
    }
    
    public function getRegistrationEnd()
    {
        return $this->reg_end;
    }

    public function setPassword($a_pass)
    {
        $this->reg_password = $a_pass;
    }
    
    public function getPassword()
    {
        return $this->reg_password;
    }
    
    public function enableMembershipLimitation($a_status)
    {
        $this->reg_membership_limitation = $a_status;
    }
    
    public function isMembershipLimited()
    {
        return (bool) $this->reg_membership_limitation;
    }

    public function setMinMembers($a_max)
    {
        $this->reg_min_members = $a_max;
    }
    
    public function getMinMembers()
    {
        return $this->reg_min_members;
    }

    public function setMaxMembers($a_max)
    {
        $this->reg_max_members = $a_max;
    }
    
    public function getMaxMembers()
    {
        return $this->reg_max_members;
    }
    
    public function enableWaitingList($a_status)
    {
        $this->waiting_list = $a_status;
    }
    
    public function isWaitingListEnabled()
    {
        return $this->waiting_list;
    }
    
    public function setWaitingListAutoFill($a_value)
    {
        $this->auto_fill_from_waiting = (bool) $a_value;
    }
    
    public function hasWaitingListAutoFill()
    {
        return (bool) $this->auto_fill_from_waiting;
    }
    
    public function setLatitude($a_latitude)
    {
        $this->latitude = $a_latitude;
    }

    public function getLatitude()
    {
        return $this->latitude;
    }

    public function setLongitude($a_longitude)
    {
        $this->longitude = $a_longitude;
    }

    public function getLongitude()
    {
        return $this->longitude;
    }

    public function setLocationZoom($a_locationzoom)
    {
        $this->locationzoom = $a_locationzoom;
    }

    public function getLocationZoom()
    {
        return $this->locationzoom;
    }

    public function setEnableGroupMap($a_enablemap)
    {
        $this->enablemap = $a_enablemap;
    }

    public function getEnableMap()
    {
        return $this->getEnableGroupMap();
    }
    
    public function getEnableGroupMap()
    {
        return (bool) $this->enablemap;
    }
    
    public function getRegistrationAccessCode()
    {
        return $this->reg_access_code;
    }
    
    public function setRegistrationAccessCode($a_code)
    {
        $this->reg_access_code = $a_code;
    }
    
    public function isRegistrationAccessCodeEnabled()
    {
        return (bool) $this->reg_access_code_enabled;
    }
    
    public function enableRegistrationAccessCode($a_status)
    {
        $this->reg_access_code_enabled = $a_status;
    }
    
    public function setMailToMembersType($a_type)
    {
        $this->mail_members = $a_type;
    }
    
    public function getMailToMembersType()
    {
        return $this->mail_members;
    }
    
    public function setCancellationEnd(ilDate $a_value = null)
    {
        $this->leave_end = $a_value;
    }
    
    public function getCancellationEnd()
    {
        return $this->leave_end;
    }

    public function setShowMembers($a_status)
    {
        $this->show_members = $a_status;
    }
    public function getShowMembers()
    {
        return $this->show_members;
    }

    public function setAutoNotification(bool $a_status)
    {
        $this->auto_notification = $a_status;
    }

    public function getAutoNotification() : ?bool
    {
        return $this->auto_notification;
    }


    public function setPeriod(\ilDateTime $start = null, \ilDateTime $end = null)
    {
        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);
    }

    protected function toggleStartTimeIndication(bool $time_indication)
    {
        $this->start_time_indication = $time_indication;
    }

    public function getStartTimeIndication() : ?bool
    {
        return $this->start_time_indication;
    }


    protected function setStart(ilDateTime $a_value = null)
    {
        $this->grp_start = $a_value;
    }

    public function getStart() : ?\ilDateTime
    {
        return $this->grp_start;
    }

    protected function setEnd(ilDateTime $a_value = null)
    {
        $this->grp_end = $a_value;
    }

    public function getEnd() : ?\ilDateTime
    {
        return $this->grp_end;
    }

    public function enableSessionLimit(bool $a_status)
    {
        $this->session_limit = $a_status;
    }

    public function isSessionLimitEnabled() : bool
    {
        return (bool) $this->session_limit;
    }

    public function setNumberOfPreviousSessions(int $a_num)
    {
        $this->session_prev = $a_num;
    }

    public function getNumberOfPreviousSessions() : int
    {
        return $this->session_prev;
    }

    public function setNumberOfNextSessions(int $a_num)
    {
        $this->session_next = $a_num;
    }

    public function getNumberOfNextSessions() : int
    {
        return $this->session_next;
    }


    public function validate()
    {
        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;
    }
    
    
    

    public function create()
    {
        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, session_limit, session_prev, session_next) " .
            "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) . ', ' .
            $ilDB->quote($this->isSessionLimitEnabled(), ilDBConstants::T_INTEGER) . ', ' .
            $ilDB->quote($this->getNumberOfPreviousSessions(), ilDBConstants::T_INTEGER) . ', ' .
            $ilDB->quote($this->getNumberOfNextSessions(), 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();
    }

    public function update()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $ilAppEventHandler = $DIC['ilAppEventHandler'];

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

        $this->updateMetaData();

        $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) . ', ' .
            'session_limit = ' . $ilDB->quote($this->isSessionLimitEnabled(), ilDBConstants::T_INTEGER) . ', ' .
            'session_prev = ' . $ilDB->quote($this->getNumberOfPreviousSessions(), ilDBConstants::T_INTEGER) . ', ' .
            'session_next = ' . $ilDB->quote($this->getNumberOfNextSessions(), 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;
    }
    
    public function delete()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $ilAppEventHandler = $DIC['ilAppEventHandler'];

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

        $this->deleteMetaData();

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

    public function read()
    {
        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->enableSessionLimit((bool) $row->session_limit);
            $this->setNumberOfPreviousSessions((int) $row->session_prev);
            $this->setNumberOfNextSessions((int) $row->session_next);
        }
        $this->initParticipants();
        
        // Inherit order type from parent course (if exists)
        include_once('./Services/Container/classes/class.ilContainerSortingSettings.php');
        $this->setOrderType(ilContainerSortingSettings::_lookupSortMode($this->getId()));
    }

    public function cloneObject($a_target_id, $a_copy_id = 0, $a_omit_tree = false)
    {
        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->enableSessionLimit($this->isSessionLimitEnabled());
        $new_obj->setNumberOfPreviousSessions($this->getNumberOfPreviousSessions());
        $new_obj->setNumberOfNextSessions($this->getNumberOfNextSessions());
        $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;
    }

    public function cloneDependencies($a_target_id, $a_copy_id)
    {
        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;
    }

    public function cloneAutoGeneratedRoles($new_obj)
    {
        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.');
    }


    public function join($a_user_id, $a_mem_role = "")
    {
        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;
    }

    public function getDefaultMemberRole()
    {
        $local_group_Roles = $this->getLocalGroupRoles();

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

    public function getDefaultAdminRole()
    {
        $local_group_Roles = $this->getLocalGroupRoles();

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

    public function addMember($a_user_id, $a_mem_role)
    {
        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;
        }
    }


    public function leaveGroup()
    {
        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;
            }
        }
    }

    public function leave($a_user_id)
    {
        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;
    }

    public function getGroupMemberIds()
    {
        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();
    }

    public function getGroupMemberData($a_mem_ids, $active = 1)
    {
        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();
    }

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

    public function getGroupAdminIds($a_grpId = "")
    {
        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;
    }

    public function getDefaultGroupRoles($a_grp_id = "")
    {
        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;
    }

    public function getLocalGroupRoles($a_translate = false)
    {
        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;
    }

    public function getGrpStatusClosedTemplateId()
    {
        $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"];
    }

    public function getGrpStatusOpenTemplateId()
    {
        $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"];
    }
    
    public static function lookupGroupStatusTemplateId($a_obj_id)
    {
        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;
    }


    
    public function updateGroupType($a_group_type = GRP_TYPE_OPEN)
    {
        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.');
    }


    public function setGroupStatus($a_status)
    {
        $this->group_status = $a_status;
    }

    public function getGroupStatus()
    {
        return $this->group_status;
    }

    public function readGroupStatus() : 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;
    }

    public function getMemberRoles($a_user_id)
    {
        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;
    }

    public function isAdmin($a_userId)
    {
        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;
        }
    }
    public function initDefaultRoles()
    {
        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();
    }
    
    public function setParentRolePermissions($a_parent_ref)
    {
        $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
            );
        }
    }
    
    
    public function applyDidacticTemplate($a_tpl_id)
    {
        parent::applyDidacticTemplate($a_tpl_id);
        
        if (!$a_tpl_id) {
            // init default type
            $this->setParentRolePermissions($this->getRefId());
        }
    }
    

    public static function _lookupIdByTitle($a_title)
    {
        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;
    }


    public function _isMember($a_user_id, $a_ref_id, $a_field = '')
    {
        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;
    }

    public function _getMembers($a_obj_id)
    {
        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);
    }
    
    public function getViewMode()
    {
        $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;
    }


    public function setViewMode($a_view_mode)
    {
        $this->view_mode = $a_view_mode;
    }

    public static function lookupViewMode($a_obj_id)
    {
        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;
    }
    
    public static function translateViewMode($a_obj_id, $a_view_mode, $a_ref_id = null)
    {
        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;
    }

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

    public function getMessage()
    {
        return $this->message;
    }
    public function setMessage($a_message)
    {
        $this->message = $a_message;
    }
    public function appendMessage($a_message)
    {
        if ($this->getMessage()) {
            $this->message .= "<br /> ";
        }
        $this->message .= $a_message;
    }
    
    protected function prepareAppointments($a_mode = 'create')
    {
        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();
        }
    }
    
    protected function initParticipants()
    {
        include_once('./Modules/Group/classes/class.ilGroupParticipants.php');
        $this->members_obj = ilGroupParticipants::_getInstanceByObjId($this->getId());
    }
    
    public function getMembersObject()
    {
        // #17886
        if (!$this->members_obj instanceof ilGroupParticipants) {
            $this->initParticipants();
        }
        return $this->members_obj;
    }
    
    public static function lookupObjectsByCode($a_code)
    {
        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;
    }
    
    public function register($a_user_id, $a_role = IL_GRP_MEMBER, $a_force_registration = false)
    {
        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;
    }
        
    public function handleAutoFill()
    {
        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;
                    }
                }
            }
        }
    }
    
    public static function mayLeave($a_group_id, $a_user_id = null, &$a_date = null)
    {
        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;
    }
    
    public static function findGroupsWithNotEnoughMembers()
    {
        $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;
    }

    public static function lookupShowMembersEnabled(int $a_obj_id) : 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'];
    }


    public function getSubItems(
        $a_admin_panel_enabled = false,
        $a_include_side_block = false,
        $a_get_single = 0,
        \ilContainerUserFilter $container_user_filter = null
    ) {
        // Caching
        if (is_array($this->items[(int) $a_admin_panel_enabled][(int) $a_include_side_block])) {
            return $this->items[(int) $a_admin_panel_enabled][(int) $a_include_side_block];
        }

        // Results are stored in $this->items
        parent::getSubItems($a_admin_panel_enabled, $a_include_side_block, $a_get_single);
        $this->items = ilContainerSessionsContentGUI::prepareSessionPresentationLimitation(
            $this->items,
            $this,
            (bool) $a_admin_panel_enabled,
            (bool) $a_include_side_block
        );
        return $this->items[(int) $a_admin_panel_enabled][(int) $a_include_side_block];
    }
} //END class.ilObjGroup