Group Import Parser. More...

Inheritance diagram for ilGroupXMLParser:

Collaboration diagram for ilGroupXMLParser:

Public Member Functions
	__construct (ilObjGroup $group, string $a_xml, int $a_parent_id)

	pushParentId (int $a_id)

	popParentId ()

	getParentId ()

	setHandlers ($a_xml_parser)
	@inheritDoc More...

	startParsing ()
	@inheritDoc More...

	getObjectRefId ()

	handlerBeginTag ($a_xml_parser, string $a_name, array $a_attribs)
	@inheritDoc More...

	handlerEndTag ($a_xml_parser, string $a_name)

	handlerCharacterData ($a_xml_parser, string $a_data)
	@inheritDoc More...

	save ()

	assignMembers ()

	parseId (string $a_id)

	setMode (int $mode)

	initContainerSorting (array $a_attribs, int $a_group_id)

Public Member Functions inherited from ilMDSaxParser
	__construct (?string $a_xml_file='')

	enableMDParsing (bool $a_status)

	getMDParsingStatus ()

	setMDObject (ilMD $md)

	getMDObject ()

	inMetaData ()

	setHandlers ($a_xml_parser)
	Set event handlers. More...

	handlerBeginTag ($a_xml_parser, string $a_name, array $a_attribs)

	handlerEndTag ($a_xml_parser, string $a_name)

	handlerCharacterData ($a_xml_parser, string $a_data)

	__getCharacterData ()

	__pushParent (object $md_obj)

	__popParent ()

	__getParent ()

Public Member Functions inherited from ilSaxParser
	__construct (?string $path_to_file='', ?bool $throw_exception=false)

	setXMLContent (string $a_xml_content)

	getXMLContent ()

	getInputType ()

	startParsing ()
	stores xml data in array More...

	createParser ()

	setHandlers ($a_xml_parser)

	parse ($a_xml_parser, $a_fp=null)

	handlerBeginTag ($a_xml_parser, string $a_name, array $a_attribs)
	Start element handler. More...

	handlerEndTag ($a_xml_parser, string $a_name)
	End element handler. More...

	handlerCharacterData ($a_xml_parser, string $a_name)
	Character data handler. More...

Static Public Attributes
static int	$CREATE = 1

static int	$UPDATE = 2

Protected Attributes
ilObjUser	$user

ilRbacReview	$rbacreview

ilSetting	$settings

ilSaxController	$sax_controller

ilAdvancedMDValueParser	$advanced_md_value_parser = null

array	$parent = []

int	$counter = 0

int	$mode

Protected Attributes inherited from ilMDSaxParser
bool	$md_in_md = false

string	$md_chr_data = ''

ilMDIdentifier	$md_ide = null

ilMDLanguage	$md_lan = null

ilMDDescription	$md_des = null

ilMDLifecycle	$md_lif = null

ilMDContribute	$md_con = null

ilMDEntity	$md_ent = null

ilMDMetaMetadata	$md_met = null

ilMDTechnical	$md_tec = null

ilMDFormat	$md_for = null

ilMDLocation	$md_loc = null

ilMDRequirement	$md_req = null

ilMDOrComposite	$md_orc = null

ilMDEducational	$md_edu = null

ilMDTypicalAgeRange	$md_typ = null

ilMDRights	$md_rig = null

ilMDRelation	$md_rel = null

ilMDIdentifier_	$md_ide_ = null

ilMDAnnotation	$md_ann = null

ilMDClassification	$md_cla = null

ilMDTaxonPath	$md_taxp = null

ilMDTaxon	$md_tax = null

ilMDKeyword	$md_key = null

array	$md_parent = array()

ilMD	$md = null

ilMDGeneral	$md_gen = null

ilLogger	$meta_log

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Private Attributes
	$after_parsing_status = null

ilLogger	$log

ilObjGroup	$group_obj

bool	$lom_parsing_active = false

ilGroupParticipants	$participants = null

string	$current_container_setting = ''

array	$sort = null

array	$group_data = []

bool	$group_imported = false

bool	$in_period = false

string	$cdata = ''

Additional Inherited Members
Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

Protected Member Functions inherited from ilMDSaxParser
	trimAndStripAttribs (array $attribs)

	trimAndStrip (string $input)

Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Detailed Description

Group Import Parser.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

Id: class.ilGroupXMLParser.php 15678 2008-01-06 20:40:55Z akill

Definition at line 27 of file class.ilGroupXMLParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilGroupXMLParser::__construct	(	ilObjGroup	$group,
		string	$a_xml,
		int	$a_parent_id
	)

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

    {
        global $DIC;
 
        parent::__construct(null);
        $this->user = $DIC->user();
        $this->rbacreview = $DIC->rbac()->review();
        $this->settings = $DIC->settings();
        $this->sax_controller = new ilSaxController();
        $this->mode = ilGroupXMLParser::$CREATE;
        $this->group_obj = $group;
        $this->log = $DIC->logger()->grp();
        $this->setXMLContent($a_xml);
 
        // init md parsing
        $this->setMDObject(
            new ilMD(
                $this->group_obj->getId(),
                $this->group_obj->getId(),
                $this->group_obj->getType()
            )
        );
 
        // SET MEMBER VARIABLES
        $this->pushParentId($a_parent_id);
    }

References $CREATE, $DIC, ILIAS\GlobalScreen\Provider\__construct(), pushParentId(), ilMDSaxParser\setMDObject(), ILIAS\Repository\settings(), ilSaxParser\setXMLContent(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ assignMembers()

ilGroupXMLParser::assignMembers ( )

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

                                   : void
    {
        $this->participants = new ilGroupParticipants($this->group_obj->getId());
        $this->participants->add($this->user->getId(), ilParticipants::IL_GRP_ADMIN);
        $this->participants->updateNotification($this->user->getId(), (bool) $this->settings->get('mail_grp_admin_notification', "1"));
 
        // attach ADMINs
        if (isset($this->group_data["admin"]["attach"]) && count($this->group_data["admin"]["attach"])) {
            foreach ($this->group_data["admin"]["attach"] as $user) {
                if ($id_data = $this->parseId($user)) {
                    if ($id_data['local'] or $id_data['imported']) {
                        $this->participants->add($id_data['usr_id'], ilParticipants::IL_GRP_ADMIN);
                        if (isset($this->group_data['notifications']) && in_array($user, (array) $this->group_data['notifications'])) {
                            $this->participants->updateNotification($id_data['usr_id'], true);
                        }
                    }
                }
            }
        }
        // detach ADMINs
        if (isset($this->group_data["admin"]["detach"]) && count($this->group_data["admin"]["detach"])) {
            foreach ($this->group_data["admin"]["detach"] as $user) {
                if ($id_data = $this->parseId($user)) {
                    if ($id_data['local'] or $id_data['imported']) {
                        if ($this->participants->isAssigned($id_data['usr_id'])) {
                            $this->participants->delete($id_data['usr_id']);
                        }
                    }
                }
            }
        }
        // MEMBER
        if (isset($this->group_data["member"]["attach"]) && count($this->group_data["member"]["attach"])) {
            foreach ($this->group_data["member"]["attach"] as $user) {
                if ($id_data = $this->parseId($user)) {
                    if ($id_data['local'] or $id_data['imported']) {
                        $this->participants->add($id_data['usr_id'], ilParticipants::IL_GRP_MEMBER);
                    }
                }
            }
        }
 
        if (isset($this->group_data["member"]["detach"]) && count($this->group_data["member"]["detach"])) {
            foreach ($this->group_data["member"]["detach"] as $user) {
                if ($id_data = $this->parseId($user)) {
                    if ($id_data['local'] or $id_data['imported']) {
                        if ($this->participants->isAssigned($id_data['usr_id'])) {
                            $this->participants->delete($id_data['usr_id']);
                        }
                    }
                }
            }
        }
    }

References $user, ilParticipants\IL_GRP_ADMIN, ilParticipants\IL_GRP_MEMBER, parseId(), and ILIAS\Repository\user().

Referenced by save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjectRefId()

ilGroupXMLParser::getObjectRefId ( )

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

    {
        return $this->after_parsing_status;
    }

References $after_parsing_status.

◆ getParentId()

ilGroupXMLParser::getParentId ( )

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

                                 : int
    {
        return $this->parent[count($this->parent) - 1];
    }

Referenced by save().

Here is the caller graph for this function:

◆ handlerBeginTag()

ilGroupXMLParser::handlerBeginTag	(		$a_xml_parser,
		string	$a_name,
		array	$a_attribs
	)

@inheritDoc

Parameters

mixed | null $a_attribs

Reimplemented from ilMDSaxParser.

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

                                                                                    : void
    {
        global $DIC;
 
        $a_attribs = $this->trimAndStripAttribs($a_attribs);
 
        $ilErr = $DIC['ilErr'];
 
        if ($this->lom_parsing_active) {
            parent::handlerBeginTag($a_xml_parser, $a_name, $a_attribs);
            return;
        }
 
        switch ($a_name) {
            case "MetaData":
                $this->lom_parsing_active = true;
                parent::handlerBeginTag($a_xml_parser, $a_name, $a_attribs);
                break;
 
 
                // GROUP DATA
            case "group":
                $this->group_data["admin"] = array();
                $this->group_data["member"] = array();
 
                $this->group_data["type"] = $a_attribs["type"];
                $this->group_data["id"] = $a_attribs["id"];
 
                break;
 
            case 'title':
                break;
 
            case "owner":
                $this->group_data["owner"] = $a_attribs["id"];
                break;
 
            case 'registration':
                $this->group_data['registration_type'] = $a_attribs['type'];
                $this->group_data['waiting_list_enabled'] = $a_attribs['waitingList'] == 'Yes' ? true : false;
                break;
 
            case 'period':
                $this->in_period = true;
                $this->group_data['period_with_time'] = $a_attribs['withTime'];
                break;
 
            case 'maxMembers':
                $this->group_data['max_members_enabled'] = $a_attribs['enabled'] == 'Yes' ? true : false;
                break;
 
            case "admin":
                if (!isset($a_attribs['action']) || $a_attribs['action'] == "Attach") {
                    $this->group_data["admin"]["attach"][] = $a_attribs["id"];
                } elseif (isset($a_attribs['action']) || $a_attribs['action'] == "Detach") {
                    $this->group_data["admin"]["detach"][] = $a_attribs["id"];
                }
 
                if (isset($a_attribs['notification']) and $a_attribs['notification'] == 'Yes') {
                    $this->group_data['notifications'][] = $a_attribs['id'];
                }
 
                break;
 
            case "member":
                if (!isset($a_attribs['action']) || $a_attribs['action'] == "Attach") {
                    $GLOBALS['DIC']->logger()->grp()->debug('New member with id ' . $a_attribs['id']);
                    $this->group_data["member"]["attach"][] = $a_attribs["id"];
                } elseif (isset($a_attribs['action']) || $a_attribs['action'] == "Detach") {
                    $GLOBALS['DIC']->logger()->grp()->debug('Deprecated member with id ' . $a_attribs['id']);
                    $this->group_data["member"]["detach"][] = $a_attribs["id"];
                }
 
                break;
 
            case 'ContainerSetting':
                $this->current_container_setting = $a_attribs['id'];
                break;
 
            case 'Sort':
 
                if ($this->group_imported) {
                    $this->initContainerSorting($a_attribs, $this->group_obj->getId());
                } else {
                    $this->sort = $a_attribs;
                }
                break;
 
 
            case 'SessionLimit':
                if (isset($a_attribs['active'])) {
                    $this->group_data['session_limit'] = (bool) $a_attribs['active'];
                }
                if (isset($a_attribs['previous'])) {
                    $this->group_data['session_previous'] = (int) $a_attribs['previous'];
                }
                if (isset($a_attribs['next'])) {
                    $this->group_data['session_next'] = (int) $a_attribs['next'];
                }
                break;
 
            case 'GroupMap':
                $this->group_data['map_enabled'] = (bool) $a_attribs['enabled'] ?? false;
                $this->group_data['map_latitude'] = (string) $a_attribs['latitude'] ?? '';
                $this->group_data['map_longitude'] = (string) $a_attribs['longitude'] ?? '';
                $this->group_data['map_location_zoom'] = (int) $a_attribs['location_zoom'] ?? 0;
                break;
 
            case 'RegistrationAccessCode':
                $this->group_data['registration_code_enabled'] = (bool) $a_attribs['enabled'] ?? false;
                $this->group_data['registration_code'] = (string) $a_attribs['code'] ?? '';
                break;
 
            case 'WaitingListAutoFill':
            case 'CancellationEnd':
            case 'minMembers':
            case 'mailMembersType':
                break;
        }
    }

References $DIC, $GLOBALS, $ilErr, initContainerSorting(), ILIAS\Repository\int(), ilMDSaxParser\trimAndStripAttribs(), and true.

Here is the call graph for this function:

◆ handlerCharacterData()

ilGroupXMLParser::handlerCharacterData	(		$a_xml_parser,
		string	$a_data
	)

@inheritDoc

Reimplemented from ilMDSaxParser.

Definition at line 406 of file class.ilGroupXMLParser.php.

                                                                       : void
    {
        if ($this->lom_parsing_active) {
            parent::handlerCharacterData($a_xml_parser, $a_data);
        }
 
        $a_data = str_replace("<", "&lt;", $a_data);
        $a_data = str_replace(">", "&gt;", $a_data);
 
        if (!empty($a_data)) {
            $this->cdata .= $a_data;
        }
    }

◆ handlerEndTag()

ilGroupXMLParser::handlerEndTag	(		$a_xml_parser,
		string	$a_name
	)

Parameters

resource $a_xml_parser

Reimplemented from ilMDSaxParser.

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

                                                                : void
    {
        $this->cdata = $this->trimAndStrip((string) $this->cdata);
 
        if ($this->lom_parsing_active) {
            parent::handlerEndTag($a_xml_parser, $a_name);
        }
 
        switch ($a_name) {
            case 'MetaData':
                $this->lom_parsing_active = false;
                parent::handlerEndTag($a_xml_parser, $a_name);
                break;
 
 
            case "title":
                $this->group_data["title"] = trim($this->cdata);
                break;
 
            case "description":
                $this->group_data["description"] = trim($this->cdata);
                break;
 
            case 'information':
                $this->group_data['information'] = trim($this->cdata);
                break;
 
            case 'password':
                $this->group_data['password'] = trim($this->cdata);
                break;
 
            case 'maxMembers':
                $this->group_data['max_members'] = trim($this->cdata);
                break;
 
            case 'expiration':
                $this->group_data['expiration_end'] = trim($this->cdata);
                break;
 
            case 'start':
                if ($this->in_period) {
                    $this->group_data['period_start'] = trim($this->cdata);
                } else {
                    $this->group_data['expiration_start'] = trim($this->cdata);
                }
                break;
 
            case 'end':
                if ($this->in_period) {
                    $this->group_data['period_end'] = trim($this->cdata);
                } else {
                    $this->group_data['expiration_end'] = trim($this->cdata);
                }
                break;
 
            case 'period':
                $this->in_period = false;
                break;
 
            case "group":
                $this->save();
                break;
 
            case 'ContainerSetting':
                if ($this->current_container_setting) {
                    ilContainer::_writeContainerSetting(
                        $this->group_obj->getId(),
                        $this->current_container_setting,
                        trim($this->cdata)
                    );
                }
                break;
 
            case 'WaitingListAutoFill':
                $this->group_data['auto_wait'] = trim($this->cdata);
                break;
 
            case 'CancellationEnd':
                if ((int) $this->cdata) {
                    $this->group_data['cancel_end'] = new ilDate((int) $this->cdata, IL_CAL_UNIX);
                }
                break;
 
            case 'minMembers':
                if ((int) $this->cdata) {
                    $this->group_data['min_members'] = (int) $this->cdata;
                }
                break;
 
            case 'showMembers':
                if ((int) $this->cdata) {
                    $this->group_data['show_members'] = (int) $this->cdata;
                }
                break;
 
            case 'admissionNotification':
                if ((int) $this->cdata) {
                    $this->group_data['auto_notification'] = (bool) $this->cdata;
                }
                break;
 
            case 'mailMembersType':
                $this->group_data['mail_members_type'] = (int) $this->cdata;
                break;
 
            case 'ViewMode':
                $this->group_data['view_mode'] = (int) $this->cdata;
                break;
 
        }
        $this->cdata = '';
    }

References $cdata, ilContainer\_writeContainerSetting(), IL_CAL_UNIX, ILIAS\Repository\int(), save(), and ilMDSaxParser\trimAndStrip().

Here is the call graph for this function:

◆ initContainerSorting()

ilGroupXMLParser::initContainerSorting	(	array	$a_attribs,
		int	$a_group_id
	)

Definition at line 678 of file class.ilGroupXMLParser.php.

                                                                           : void
    {
        ilContainerSortingSettings::_importContainerSortingSettings($a_attribs, $a_group_id);
    }

References ilContainerSortingSettings\_importContainerSortingSettings().

Referenced by handlerBeginTag(), and save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseId()

ilGroupXMLParser::parseId ( string $a_id )

Definition at line 645 of file class.ilGroupXMLParser.php.

                                         : array
    {
        $fields = explode('_', $a_id);
 
        if (!is_array($fields) or
           $fields[0] != 'il' or
           !is_numeric($fields[1]) or
           $fields[2] != 'usr' or
           !is_numeric($fields[3])) {
            return [];
        }
        if ($id = ilObjUser::_getImportedUserId($a_id)) {
            return array('imported' => true,
                         'local' => false,
                         'usr_id' => $id);
        }
        if (($fields[1] == $this->settings->get('inst_id', "0")) and ($user = ilObjUser::_lookupName((int) $fields[3]))) {
            if (strlen($user['login'])) {
                return array('imported' => false,
                             'local' => true,
                             'usr_id' => (int) $fields[3]);
            }
        }
        $this->log->warning('Parsing id failed: ' . $a_id);
        return [];
    }

References $id, $user, ilObjUser\_getImportedUserId(), ilObjUser\_lookupName(), and ILIAS\Repository\settings().

Referenced by assignMembers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ popParentId()

ilGroupXMLParser::popParentId ( )

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

                                 : void
    {
        array_pop($this->parent);
    }

◆ pushParentId()

ilGroupXMLParser::pushParentId ( int $a_id )

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

                                           : void
    {
        $this->parent[] = $a_id;
    }

Referenced by __construct(), and save().

Here is the caller graph for this function:

◆ save()

ilGroupXMLParser::save ( )

mode can be create or update

Definition at line 420 of file class.ilGroupXMLParser.php.

                          : bool
    {
        if ($this->group_imported) {
            return true;
        }
 
        $this->group_obj->setImportId($this->group_data["id"] ?? '');
        $this->group_obj->setTitle($this->group_data["title"] ?? '');
        $this->group_obj->setDescription($this->group_data["description"] ?? '');
        $this->group_obj->setInformation((string) $this->group_data['information']);
 
        if (isset($this->group_data['period_start']) && isset($this->group_data['period_end'])) {
            try {
                if ($this->group_data['period_with_time'] ?? false) {
                    $this->group_obj->setPeriod(
                        new \ilDateTime($this->group_data['period_start'], IL_CAL_UNIX),
                        new \ilDateTime($this->group_data['period_end'], IL_CAL_UNIX)
                    );
                } else {
                    $this->group_obj->setPeriod(
                        new \ilDateTime($this->group_data['period_start'], IL_CAL_UNIX),
                        new \ilDateTime($this->group_data['period_end'], IL_CAL_UNIX)
                    );
                }
            } catch (Exception $e) {
                $this->log->warning('Ignoring invalid group period settings: ');
                $this->log->warning('Period start: ' . $this->group_data['period_start']);
                $this->log->warning('Period end: ' . $this->group_data['period_end']);
            }
        }
 
        $ownerChanged = false;
        if (isset($this->group_data["owner"])) {
            $owner = $this->group_data["owner"];
            if (!is_numeric($owner)) {
                $owner = ilUtil::__extractId($owner, (int) IL_INST_ID);
            }
            if (is_numeric($owner) && $owner > 0) {
                $this->group_obj->setOwner((int) $owner);
                $ownerChanged = true;
            }
        }
 
        if ($this->mode == ilGroupXMLParser::$CREATE) {
            $this->group_obj->createReference();
            $this->group_obj->putInTree($this->getParentId());
            $this->group_obj->setPermissions($this->getParentId());
            if (
                array_key_exists('type', $this->group_data) &&
                $this->group_data['type'] == 'closed'
            ) {
                $this->group_obj->updateGroupType(
                    ilGroupConstants::GRP_TYPE_CLOSED
                );
            }
        } else {
            if (
                array_key_exists('type', $this->group_data) &&
                $this->group_data['type'] == 'closed'
            ) {
                $this->group_obj->updateGroupType(
                    ilGroupConstants::GRP_TYPE_CLOSED
                );
            } elseif (
                array_key_exists('type', $this->group_data) &&
                $this->group_data['type'] == 'open'
            ) {
                $this->group_obj->updateGroupType(
                    ilGroupConstants::GRP_TYPE_OPEN
                );
            }
        }
        // SET GROUP SPECIFIC DATA
        switch ($this->group_data['registration_type'] ?? '') {
            case 'direct':
            case 'enabled':
                $flag = ilGroupConstants::GRP_REGISTRATION_DIRECT;
                break;
 
            case 'disabled':
                $flag = ilGroupConstants::GRP_REGISTRATION_DEACTIVATED;
                break;
 
            case 'confirmation':
                $flag = ilGroupConstants::GRP_REGISTRATION_REQUEST;
                break;
 
            case 'password':
                $flag = ilGroupConstants::GRP_REGISTRATION_PASSWORD;
                break;
 
            default:
                $flag = ilGroupConstants::GRP_REGISTRATION_DIRECT;
        }
        $this->group_obj->setRegistrationType($flag);
 
 
        $registration_end = null;
        if ($this->group_data['expiration_end'] ?? false) {
            $registration_end = new ilDateTime($this->group_data['expiration_end'], IL_CAL_UNIX);
        }
 
        $registration_start = null;
        if ($this->group_data['expiration_start'] ?? false) {
            $registration_start = new ilDateTime($this->group_data['expiration_start'], IL_CAL_UNIX);
        }
        if (
            $registration_start instanceof ilDateTime &&
            $registration_end instanceof ilDateTime
        ) {
            $this->group_obj->enableUnlimitedRegistration(false);
            $this->group_obj->setRegistrationStart($registration_start);
            $this->group_obj->setRegistrationEnd($registration_end);
        } else {
            $this->group_obj->enableUnlimitedRegistration(true);
        }
        $this->group_obj->setPassword($this->group_data['password'] ?? '');
        $this->group_obj->enableMembershipLimitation((bool) ($this->group_data['max_members_enabled'] ?? false));
        $this->group_obj->setMaxMembers((int) ($this->group_data['max_members'] ?? 0));
        $this->group_obj->enableWaitingList((bool) ($this->group_data['waiting_list_enabled'] ?? false));
        $this->group_obj->setWaitingListAutoFill((bool) ($this->group_data['auto_wait'] ?? false));
        $this->group_obj->setCancellationEnd($this->group_data['cancel_end'] ?? null);
        $this->group_obj->setMinMembers((int) ($this->group_data['min_members'] ?? 0));
        $this->group_obj->setShowMembers((bool) ($this->group_data['show_members'] ?? false));
        $this->group_obj->setAutoNotification((bool) (($this->group_data['auto_notification'] ?? false)));
        $this->group_obj->setMailToMembersType((int) ($this->group_data['mail_members_type'] ?? 0));
        $this->group_obj->enableRegistrationAccessCode((bool) ($this->group_data['registration_code_enabled'] ?? false));
        $this->group_obj->setRegistrationAccessCode((string) ($this->group_data['registration_code'] ?? ''));
        if (isset($this->group_data['view_mode'])) {
            $this->group_obj->setViewMode((int) $this->group_data['view_mode']);
        }
        if (isset($this->group_data['session_limit'])) {
            $this->group_obj->enableSessionLimit((bool) $this->group_data['session_limit']);
        }
        if (isset($this->group_data['session_previous'])) {
            $this->group_obj->setNumberOfPreviousSessions((int) $this->group_data['session_previous']);
        }
        if (isset($this->group_data['session_next'])) {
            $this->group_obj->setNumberOfNextSessions((int) $this->group_data['session_next']);
        }
 
        $this->group_obj->setEnableGroupMap((bool) ($this->group_data['map_enabled'] ?? false));
        $this->group_obj->setLatitude((string) ($this->group_data['map_latitude'] ?? ''));
        $this->group_obj->setLongitude((string) ($this->group_data['map_longitude'] ?? ''));
        $this->group_obj->setLocationZoom((int) ($this->group_data['map_location_zoom'] ?? 0));
 
        /*
         * readContainerSettings needs to be called before update, otherwise container
         * settings are overwritten by the default, see #24742.
         */
        $this->group_obj->readContainerSettings();
        $this->group_obj->update();
 
        // ASSIGN ADMINS/MEMBERS
        $this->assignMembers();
 
        $this->pushParentId($this->group_obj->getRefId());
 
        if ($this->sort) {
            $this->initContainerSorting($this->sort, $this->group_obj->getId());
        }
 
        $this->group_imported = true;
 
        return true;
    }

References $CREATE, Vendor\Package\$e, ilUtil\__extractId(), assignMembers(), getParentId(), ilGroupConstants\GRP_REGISTRATION_DEACTIVATED, ilGroupConstants\GRP_REGISTRATION_DIRECT, ilGroupConstants\GRP_REGISTRATION_PASSWORD, ilGroupConstants\GRP_REGISTRATION_REQUEST, ilGroupConstants\GRP_TYPE_CLOSED, ilGroupConstants\GRP_TYPE_OPEN, IL_CAL_UNIX, IL_INST_ID, initContainerSorting(), and pushParentId().

Referenced by handlerEndTag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlers()

ilGroupXMLParser::setHandlers ( $a_xml_parser )

@inheritDoc

Reimplemented from ilMDSaxParser.

Definition at line 114 of file class.ilGroupXMLParser.php.

                                              : void
    {
        $this->sax_controller->setHandlers($a_xml_parser);
        $this->sax_controller->setDefaultElementHandler($this);
 
        $this->advanced_md_value_parser = new ilAdvancedMDValueParser(
            $this->group_obj->getId()
        );
 
        $this->sax_controller->setElementHandler(
            $this->advanced_md_value_parser,
            'AdvancedMetaData'
        );
    }

◆ setMode()

ilGroupXMLParser::setMode ( int $mode )

Definition at line 673 of file class.ilGroupXMLParser.php.

                                      : void
    {
        $this->mode = $mode;
    }

References $mode.

◆ startParsing()

ilGroupXMLParser::startParsing ( )

@inheritDoc

Reimplemented from ilSaxParser.

Definition at line 134 of file class.ilGroupXMLParser.php.

                                  : void
    {
        parent::startParsing();
 
        if ($this->mode == ilGroupXMLParser::$CREATE) {
            $status = is_object($this->group_obj) ? $this->group_obj->getRefId() : false;
        } else {
            $status = is_object($this->group_obj) ? $this->group_obj->update() : false;
        }
        $this->after_parsing_status = $status;
 
        // rewrite autogenerated MD entry
        $general = $this->getMDObject()->getGeneral();
        $identifier_ids = $general->getIdentifierIds();
        if (!isset($identifier_ids[0])) {
            return;
        }
        $identifier = $general->getIdentifier($identifier_ids[0]);
        $identifier->setEntry(
            'il__' . $this->getMDObject()->getObjType() . '_' . $this->getMDObject()->getObjId()
        );
        $identifier->update();
    }

References $CREATE, and ilMDSaxParser\getMDObject().

Here is the call graph for this function:

Field Documentation

◆ $advanced_md_value_parser

ilAdvancedMDValueParser ilGroupXMLParser::$advanced_md_value_parser = null

protected

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

◆ $after_parsing_status

ilGroupXMLParser::$after_parsing_status = null

private

Definition at line 32 of file class.ilGroupXMLParser.php.

Referenced by getObjectRefId().

◆ $cdata

string ilGroupXMLParser::$cdata = ''

private

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

Referenced by handlerEndTag().

◆ $counter

int ilGroupXMLParser::$counter = 0

protected

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

◆ $CREATE

int ilGroupXMLParser::$CREATE = 1

static

Definition at line 29 of file class.ilGroupXMLParser.php.

Referenced by __construct(), save(), and startParsing().

◆ $current_container_setting

string ilGroupXMLParser::$current_container_setting = ''

private

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

◆ $group_data

array ilGroupXMLParser::$group_data = []

private

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

◆ $group_imported

bool ilGroupXMLParser::$group_imported = false

private

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

◆ $group_obj

ilObjGroup ilGroupXMLParser::$group_obj

private

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

◆ $in_period

bool ilGroupXMLParser::$in_period = false

private

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

◆ $log

ilLogger ilGroupXMLParser::$log

private

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

◆ $lom_parsing_active

bool ilGroupXMLParser::$lom_parsing_active = false

private

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

◆ $mode

int ilGroupXMLParser::$mode

protected

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

Referenced by setMode().

◆ $parent

array ilGroupXMLParser::$parent = []

protected

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

◆ $participants

ilGroupParticipants ilGroupXMLParser::$participants = null

private

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

◆ $rbacreview

ilRbacReview ilGroupXMLParser::$rbacreview

protected

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

◆ $sax_controller

ilSaxController ilGroupXMLParser::$sax_controller

protected

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

◆ $settings

ilSetting ilGroupXMLParser::$settings

protected

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

◆ $sort

array ilGroupXMLParser::$sort = null

private

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

◆ $UPDATE

int ilGroupXMLParser::$UPDATE = 2

static

Definition at line 30 of file class.ilGroupXMLParser.php.

◆ $user

ilObjUser ilGroupXMLParser::$user

protected

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

Referenced by assignMembers(), and parseId().

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

Modules/Group/classes/class.ilGroupXMLParser.php

Public Member Functions

Static Public Attributes

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assignMembers()

◆ getObjectRefId()

◆ getParentId()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ initContainerSorting()

◆ parseId()

◆ popParentId()

◆ pushParentId()

◆ save()

◆ setHandlers()

◆ setMode()

◆ startParsing()

Field Documentation

◆ $advanced_md_value_parser

◆ $after_parsing_status

◆ $cdata

◆ $counter

◆ $CREATE

◆ $current_container_setting

◆ $group_data

◆ $group_imported

◆ $group_obj

◆ $in_period

◆ $log

◆ $lom_parsing_active

◆ $mode

◆ $parent

◆ $participants

◆ $rbacreview

◆ $sax_controller

◆ $settings

◆ $sort

◆ $UPDATE

◆ $user