XML writer class. More...

Inheritance diagram for ilGroupXMLWriter:

Collaboration diagram for ilGroupXMLWriter:

Public Member Functions
	__construct ($group_obj)
	constructor More...

	setMode ($a_mode)

	getMode ()

	start ()

	getXML ()

	__buildHeader ()

	__buildGroup ()
	Group start. More...

	__buildTitleDescription ()

	__buildRegistration ()

	__buildExtraSettings ()
	Build extra settings, like "show member list". More...

	__buildAdmin ()

	__buildMember ()

	__buildFooter ()

	setAttachUsers ($value)

Public Member Functions inherited from ilXmlWriter
	__construct ($version="1.0", $outEnc="utf-8", $inEnc="utf-8")
	constructor More...

	_ilXmlWriter ()
	destructor @access public More...

	xmlSetDtdDef ($dtdDef)
	Sets dtd definition. More...

	xmlSetStSheet ($stSheet)
	Sets stylesheet. More...

	xmlSetGenCmt ($genCmt)
	Sets generated comment. More...

	xmlEncodeData ($data)
	Encodes text from input encoding into output encoding. More...

	xmlFormatData ($data)
	Indents text for better reading. More...

	xmlFormatElement ($array)
	Callback function for xmlFormatData; do not invoke directly. More...

	xmlHeader ()
	Writes xml header @access public. More...

	xmlStartTag ($tag, $attrs=null, $empty=false, $encode=true, $escape=true)
	Writes a starttag. More...

	xmlEndTag ($tag)
	Writes an endtag. More...

	xmlComment ($comment)
	Writes a comment. More...

	xmlData ($data, $encode=true, $escape=true)
	Writes data. More...

	xmlElement ($tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...

	xmlDumpFile ($file, $format=true)
	Dumps xml document from memory into a file. More...

	xmlDumpMem ($format=true)
	Returns xml document from memory. More...

	appendXML ($a_str)
	append xml string to document More...

	xmlClear ()
	clears xmlStr @access public More...

Data Fields
const	MODE_SOAP = 1

const	MODE_EXPORT = 2

Data Fields inherited from ilXmlWriter
	$xmlStr

	$version

	$outEnc

	$inEnc

	$dtdDef = ""

	$stSheet = ""

	$genCmt = "Generated by ILIAS XmlWriter"

Protected Member Functions
	__buildMetaData ()
	write lom meta data More...

	__buildPeriod ()
	Add group period settings to xml. More...

Private Member Functions
	__buildAdvancedMetaData ()
	Build advanced meta data. More...

Private Attributes
	$mode = self::MODE_SOAP

	$logger = null

	$ilias

	$xml

	$group_obj

	$attach_users = true

Additional Inherited Members
Static Public Member Functions inherited from ilXmlWriter
static	_xmlEscapeData ($data)
	Escapes reserved characters. More...

Detailed Description

XML writer class.

Class for writing xml export versions of courses

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

Version

Id: class.ilGroupXMLWriter.php 16108 2008-02-28 17:36:41Z rkuester

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

Constructor & Destructor Documentation

◆ __construct()

ilGroupXMLWriter::__construct ( $group_obj )

constructor

Parameters

string	xml version
string	output encoding
string	input encoding @access public

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

    {
        global $DIC;
 
        $ilias = $DIC['ilias'];
 
        parent::__construct();
 
        $this->logger = $DIC->logger()->grp();
 
        $this->EXPORT_VERSION = "3";
 
        $this->ilias = $ilias;
        $this->group_obj = $group_obj;
        $this->participants = ilGroupParticipants::_getInstanceByObjId($this->group_obj->getId());
    }

References $DIC, $group_obj, $ilias, ILIAS\GlobalScreen\Provider\__construct(), and ilGroupParticipants\_getInstanceByObjId().

Here is the call graph for this function:

Member Function Documentation

◆ __buildAdmin()

ilGroupXMLWriter::__buildAdmin ( )

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

    {
        $admins = $this->group_obj->getGroupAdminIds();
        $admins = $GLOBALS['DIC']->access()->filterUserIdsByRbacOrPositionOfCurrentUser(
            'manage_members',
            ilOrgUnitOperation::OP_MANAGE_MEMBERS,
            $this->group_obj->getRefId(),
            $admins
        );
        
        foreach ($admins as $id) {
            $attr['id'] = 'il_' . $this->ilias->getSetting('inst_id') . '_usr_' . $id;
            $attr['notification'] = $this->participants->isNotificationEnabled($id) ? 'Yes' : 'No';
 
            $this->xmlElement('admin', $attr);
        }
        return true;
    }

References $GLOBALS, ilOrgUnitOperation\OP_MANAGE_MEMBERS, and ilXmlWriter\xmlElement().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildAdvancedMetaData()

ilGroupXMLWriter::__buildAdvancedMetaData ( )

private

Build advanced meta data.

@access private

Definition at line 187 of file class.ilGroupXMLWriter.php.

    {
        ilAdvancedMDValues::_appendXMLByObjId($this, $this->group_obj->getId());
    }

References ilAdvancedMDValues\_appendXMLByObjId().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildExtraSettings()

ilGroupXMLWriter::__buildExtraSettings ( )

Build extra settings, like "show member list".

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

    {
        $this->xmlElement('showMembers', null, $this->group_obj->getShowMembers());
        $this->xmlElement('admissionNotification', null, $this->group_obj->getAutoNotification() ? 1 : 0);
    }

References ilXmlWriter\xmlElement().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildFooter()

ilGroupXMLWriter::__buildFooter ( )

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

    {
        $this->xmlEndTag('group');
    }

References ilXmlWriter\xmlEndTag().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildGroup()

ilGroupXMLWriter::__buildGroup ( )

Group start.

Returns

Definition at line 149 of file class.ilGroupXMLWriter.php.

    {
        $attrs["exportVersion"] = $this->EXPORT_VERSION;
        $attrs["id"] = "il_" . $this->ilias->getSetting('inst_id') . '_grp_' . $this->group_obj->getId();
 
        switch ($this->group_obj->readGroupStatus()) {
            case GRP_TYPE_OPEN:
                $attrs['type'] = 'open';
                break;
                
            case GRP_TYPE_CLOSED:
            default:
                $attrs['type'] = 'closed';
                break;
        }
        
        $this->xmlStartTag("group", $attrs);
    }

References GRP_TYPE_CLOSED, GRP_TYPE_OPEN, and ilXmlWriter\xmlStartTag().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildHeader()

ilGroupXMLWriter::__buildHeader ( )

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

    {
        $this->xmlSetDtdDef("<!DOCTYPE group PUBLIC \"-//ILIAS//DTD Group//EN\" \"" . ILIAS_HTTP_PATH . "/xml/ilias_group_3_10.dtd\">");
        $this->xmlSetGenCmt("Export of ILIAS group " . $this->group_obj->getId() . " of installation " . $this->ilias->getSetting('inst_id') . ".");
        $this->xmlHeader();
 
 
        return true;
    }

References ILIAS_HTTP_PATH, ilXmlWriter\xmlHeader(), ilXmlWriter\xmlSetDtdDef(), and ilXmlWriter\xmlSetGenCmt().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildMember()

ilGroupXMLWriter::__buildMember ( )

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

    {
        $members = $this->group_obj->getGroupMemberIds();
        $members = $GLOBALS['DIC']->access()->filterUserIdsByRbacOrPositionOfCurrentUser(
            'manage_members',
            ilOrgUnitOperation::OP_MANAGE_MEMBERS,
            $this->group_obj->getRefId(),
            $members
        );
        foreach ($members as $id) {
            if (!$this->group_obj->isAdmin($id)) {
                $attr['id'] = 'il_' . $this->ilias->getSetting('inst_id') . '_usr_' . $id;
                
                $this->xmlElement('member', $attr);
            }
        }
        return true;
    }

References $GLOBALS, ilOrgUnitOperation\OP_MANAGE_MEMBERS, and ilXmlWriter\xmlElement().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildMetaData()

ilGroupXMLWriter::__buildMetaData ( )

protected

write lom meta data

Returns: bool

Definition at line 172 of file class.ilGroupXMLWriter.php.

    {
        $md2xml = new ilMD2XML($this->group_obj->getId(), $this->group_obj->getId(), 'grp');
        $md2xml->startExport();
        $this->appendXML($md2xml->getXML());
 
        return true;
    }

References ilXmlWriter\appendXML().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildPeriod()

ilGroupXMLWriter::__buildPeriod ( )

protected

Add group period settings to xml.

Definition at line 210 of file class.ilGroupXMLWriter.php.

    {
        if (!$this->group_obj->getStart() || !$this->group_obj->getEnd()) {
            return;
        }
 
        $this->xmlStartTag(
            'period',
            [
                'withTime' => $this->group_obj->getStartTimeIndication()
            ]
        );
        $this->xmlElement(
            'start',
            null,
            $this->group_obj->getStart() ?
                $this->group_obj->getStart()->get(IL_CAL_UNIX) :
                null
        );
        $this->xmlElement(
            'end',
            null,
            $this->group_obj->getEnd()->get(IL_CAL_UNIX) ?
                $this->group_obj->getEnd()->get(IL_CAL_UNIX) :
                null
        );
 
        $this->xmlEndTag('period');
        return;
    }

References IL_CAL_UNIX, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildRegistration()

ilGroupXMLWriter::__buildRegistration ( )

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

    {
        
        // registration type
        switch ($this->group_obj->getRegistrationType()) {
            case GRP_REGISTRATION_DIRECT:
                $attrs['type'] = 'direct';
                break;
            case GRP_REGISTRATION_REQUEST:
                $attrs['type'] = 'confirmation';
                break;
            case GRP_REGISTRATION_PASSWORD:
                $attrs['type'] = 'password';
                break;
                
            default:
            case GRP_REGISTRATION_DEACTIVATED:
                $attrs['type'] = 'disabled';
                break;
        }
        $attrs['waitingList'] = $this->group_obj->isWaitingListEnabled() ? 'Yes' : 'No';
        
        $this->xmlStartTag('registration', $attrs);
        
        if (strlen($pwd = $this->group_obj->getPassword())) {
            $this->xmlElement('password', null, $pwd);
        }
 
        
        // limited registration period
        if (!$this->group_obj->isRegistrationUnlimited()) {
            $this->xmlStartTag('temporarilyAvailable');
            $this->xmlElement('start', null, $this->group_obj->getRegistrationStart()->get(IL_CAL_UNIX));
            $this->xmlElement('end', null, $this->group_obj->getRegistrationEnd()->get(IL_CAL_UNIX));
            $this->xmlEndTag('temporarilyAvailable');
        }
 
        // max members
        $attrs = array();
        $attrs['enabled'] = $this->group_obj->isMembershipLimited() ? 'Yes' : 'No';
        $this->xmlElement('maxMembers', $attrs, $this->group_obj->getMaxMembers());
        $this->xmlElement('minMembers', null, (int) $this->group_obj->getMinMembers());
        $this->xmlElement('WaitingListAutoFill', null, (int) $this->group_obj->hasWaitingListAutoFill());
        $this->xmlElement('CancellationEnd', null, ($this->group_obj->getCancellationEnd() && !$this->group_obj->getCancellationEnd()->isNull()) ? $this->group_obj->getCancellationEnd()->get(IL_CAL_UNIX) : null);
        
        $this->xmlElement('mailMembersType', null, (string) $this->group_obj->getMailToMembersType());
 
        $this->xmlEndTag('registration');
    }

References GRP_REGISTRATION_DEACTIVATED, GRP_REGISTRATION_DIRECT, GRP_REGISTRATION_PASSWORD, GRP_REGISTRATION_REQUEST, IL_CAL_UNIX, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildTitleDescription()

ilGroupXMLWriter::__buildTitleDescription ( )

Definition at line 193 of file class.ilGroupXMLWriter.php.

    {
        $this->xmlElement('title', null, $this->group_obj->getTitle());
        
        if ($desc = $this->group_obj->getDescription()) {
            $this->xmlElement('description', null, $desc);
        }
 
        $attr['id'] = 'il_' . $this->ilias->getSetting('inst_id') . '_usr_' . $this->group_obj->getOwner();
        $this->xmlElement('owner', $attr);
        
        $this->xmlElement('information', null, $this->group_obj->getInformation());
    }

References ilXmlWriter\xmlElement().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMode()

ilGroupXMLWriter::getMode ( )

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

    {
        return $this->mode;
    }

References $mode.

Referenced by start().

Here is the caller graph for this function:

◆ getXML()

ilGroupXMLWriter::getXML ( )

Definition at line 129 of file class.ilGroupXMLWriter.php.

    {
        return $this->xmlDumpMem(false);
    }

References ilXmlWriter\xmlDumpMem().

Here is the call graph for this function:

◆ setAttachUsers()

ilGroupXMLWriter::setAttachUsers ( $value )

Definition at line 343 of file class.ilGroupXMLWriter.php.

    {
        $this->attach_users = $value ? true : false;
    }

◆ setMode()

ilGroupXMLWriter::setMode ( $a_mode )

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

    {
        $this->mode = $a_mode;
    }

◆ start()

ilGroupXMLWriter::start ( )

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

    {
        if ($this->getMode() == self::MODE_SOAP) {
            $this->logger->debug('Using soap mode');
            $this->__buildHeader();
            $this->__buildGroup();
            $this->__buildMetaData();
            $this->__buildAdvancedMetaData();
            $this->__buildTitleDescription();
            $this->__buildRegistration();
            $this->__buildExtraSettings();
            if ($this->attach_users) {
                $this->__buildAdmin();
                $this->__buildMember();
            }
            include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
            ilContainerSortingSettings::_exportContainerSortingSettings($this, $this->group_obj->getId());
            ilContainer::_exportContainerSettings($this, $this->group_obj->getId());
            $this->__buildFooter();
        } elseif ($this->getMode() == self::MODE_EXPORT) {
            $this->logger->debug('Using export mode');
            $this->__buildGroup();
            $this->__buildMetaData();
            $this->__buildAdvancedMetaData();
            $this->__buildTitleDescription();
            $this->__buildRegistration();
            $this->__buildExtraSettings();
            $this->__buildPeriod();
            include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
            ilContainerSortingSettings::_exportContainerSortingSettings($this, $this->group_obj->getId());
            ilContainer::_exportContainerSettings($this, $this->group_obj->getId());
            $this->__buildFooter();
        }
    }

References __buildAdmin(), __buildAdvancedMetaData(), __buildExtraSettings(), __buildFooter(), __buildGroup(), __buildHeader(), __buildMember(), __buildMetaData(), __buildPeriod(), __buildRegistration(), __buildTitleDescription(), ilContainer\_exportContainerSettings(), ilContainerSortingSettings\_exportContainerSortingSettings(), and getMode().

Here is the call graph for this function:

Field Documentation

◆ $attach_users

ilGroupXMLWriter::$attach_users = true

private

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

◆ $group_obj

ilGroupXMLWriter::$group_obj

private

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

Referenced by __construct().

◆ $ilias

ilGroupXMLWriter::$ilias

private

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

Referenced by __construct().

◆ $logger

ilGroupXMLWriter::$logger = null

private

Definition at line 46 of file class.ilGroupXMLWriter.php.

◆ $mode

ilGroupXMLWriter::$mode = self::MODE_SOAP

private

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

Referenced by getMode().

◆ $xml

ilGroupXMLWriter::$xml

private

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

◆ MODE_EXPORT

const ilGroupXMLWriter::MODE_EXPORT = 2

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

Referenced by ilGroupExporter\getXmlRepresentation().

◆ MODE_SOAP

const ilGroupXMLWriter::MODE_SOAP = 1

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

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

Modules/Group/classes/class.ilGroupXMLWriter.php

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __buildAdmin()

◆ __buildAdvancedMetaData()

◆ __buildExtraSettings()

◆ __buildFooter()

◆ __buildGroup()

◆ __buildHeader()

◆ __buildMember()

◆ __buildMetaData()

◆ __buildPeriod()

◆ __buildRegistration()

◆ __buildTitleDescription()

◆ getMode()

◆ getXML()

◆ setAttachUsers()

◆ setMode()

◆ start()

Field Documentation

◆ $attach_users

◆ $group_obj

◆ $ilias

◆ $logger

◆ $mode

◆ $xml

◆ MODE_EXPORT

◆ MODE_SOAP