Inheritance diagram for ilGroupXMLWriter:

Collaboration diagram for ilGroupXMLWriter:

Public Member Functions
	__construct (ilObjGroup $group_obj)

	setMode (int $a_mode)

	getMode ()

	start ()

	getXML ()

	__buildHeader ()

	__buildGroup ()

	__buildTitleDescription ()

	__buildRegistration ()

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

	__buildAdmin ()

	__buildMember ()

	__buildFooter ()

	setAttachUsers (bool $value)

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

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

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

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

	xmlHeader ()
	Writes xml header. More...

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

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

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

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

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

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

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

	xmlClear ()
	clears xmlStr More...

Data Fields
const int	MODE_SOAP = 1

const int	MODE_EXPORT = 2

const int	EXPORT_VERSION = 3

Protected Member Functions
	__buildPeriod ()
	Add group period settings to xml. More...

Private Member Functions
	__buildAdvancedMetaData ()

Private Attributes
int	$mode = self::MODE_SOAP

ilLogger	$logger

ilSetting	$settings

ilAccessHandler	$access

ilObjGroup	$group_obj

ilGroupParticipants	$participants

bool	$attach_users = true

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ilGroupXMLWriter::__construct ( ilObjGroup $group_obj )

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

References $DIC, $group_obj, ILIAS\GlobalScreen\Provider\__construct(), ilGroupParticipants\_getInstanceByObjId(), ILIAS\Repository\access(), ILIAS\Repository\logger(), and ILIAS\Repository\settings().

     {
         global $DIC;
 
         $this->logger = $DIC->logger()->grp();
         $this->settings = $DIC->settings();
         $this->access = $DIC->access();
         parent::__construct();
         $this->group_obj = $group_obj;
         $this->participants = ilGroupParticipants::_getInstanceByObjId($this->group_obj->getId());
     }

Here is the call graph for this function:

Member Function Documentation

◆ __buildAdmin()

ilGroupXMLWriter::__buildAdmin ( )

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

References $id, ILIAS\Repository\access(), ilOrgUnitOperation\OP_MANAGE_MEMBERS, ILIAS\Repository\settings(), and ilXmlWriter\xmlElement().

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildAdvancedMetaData()

ilGroupXMLWriter::__buildAdvancedMetaData ( )

private

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

References ilAdvancedMDValues\_appendXMLByObjId().

Referenced by start().

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

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 235 of file class.ilGroupXMLWriter.php.

References ilObjGroup\lookupViewMode(), null, and ilXmlWriter\xmlElement().

Referenced by start().

                                           : void
     {
         $this->xmlElement('showMembers', null, $this->group_obj->getShowMembers());
         $this->xmlElement('admissionNotification', null, $this->group_obj->getAutoNotification() ? 1 : 0);
 
         $this->xmlElement('ViewMode', null, ilObjGroup::lookupViewMode($this->group_obj->getId()));
         $this->xmlElement(
             'SessionLimit',
             [
                 'active' => $this->group_obj->isSessionLimitEnabled() ? 1 : 0,
                 'previous' => $this->group_obj->getNumberOfPreviousSessions(),
                 'next' => $this->group_obj->getNumberOfNextSessions()
             ]
         );
 
         $this->xmlElement('GroupMap', [
             'enabled' => (int) $this->group_obj->getEnableGroupMap(),
             'latitude' => $this->group_obj->getLatitude(),
             'longitude' => $this->group_obj->getLongitude(),
             'location_zoom' => $this->group_obj->getLocationZoom()
         ]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildFooter()

ilGroupXMLWriter::__buildFooter ( )

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

References ilXmlWriter\xmlEndTag().

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildGroup()

ilGroupXMLWriter::__buildGroup ( )

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

References ilGroupConstants\GRP_TYPE_CLOSED, ilGroupConstants\GRP_TYPE_OPEN, ILIAS\Repository\settings(), and ilXmlWriter\xmlStartTag().

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildHeader()

ilGroupXMLWriter::__buildHeader ( )

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

References ILIAS\Repository\settings(), ilXmlWriter\xmlHeader(), ilXmlWriter\xmlSetDtdDef(), and ilXmlWriter\xmlSetGenCmt().

Referenced by start().

                                    : bool
     {
         $this->xmlSetDtdDef("<!DOCTYPE group PUBLIC \"-//ILIAS//DTD Group//EN\" \"" . ILIAS_HTTP_PATH . "/components/ILIAS/Export/xml/ilias_grp_9_0.xsd\">");
         $this->xmlSetGenCmt("Export of ILIAS group " . $this->group_obj->getId() . " of installation " . $this->settings->get('inst_id') . ".");
         $this->xmlHeader();
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildMember()

ilGroupXMLWriter::__buildMember ( )

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

References $id, ILIAS\Repository\access(), ilOrgUnitOperation\OP_MANAGE_MEMBERS, ILIAS\Repository\settings(), and ilXmlWriter\xmlElement().

Referenced by start().

                                    : void
     {
         $members = $this->group_obj->getGroupMemberIds();
         $members = $this->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->settings->get('inst_id') . '_usr_' . $id;
 
                 $this->xmlElement('member', $attr);
             }
         }
     }

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 147 of file class.ilGroupXMLWriter.php.

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

Referenced by start().

                                       : void
     {
         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()?->get(IL_CAL_UNIX)
         );
         $this->xmlElement(
             'end',
             null,
             $this->group_obj->getEnd()->get(IL_CAL_UNIX) ?
                 $this->group_obj->getEnd()->get(IL_CAL_UNIX) :
                 null
         );
 
         $this->xmlEndTag('period');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildRegistration()

ilGroupXMLWriter::__buildRegistration ( )

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

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

Referenced by start().

                                          : void
     {
         // registration type
         switch ($this->group_obj->getRegistrationType()) {
             case ilGroupConstants::GRP_REGISTRATION_DIRECT:
                 $attrs['type'] = 'direct';
                 break;
             case ilGroupConstants::GRP_REGISTRATION_REQUEST:
                 $attrs['type'] = 'confirmation';
                 break;
             case ilGroupConstants::GRP_REGISTRATION_PASSWORD:
                 $attrs['type'] = 'password';
                 break;
 
             default:
             case ilGroupConstants::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, $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->xmlElement(
             'RegistrationAccessCode',
             [
                 'enabled' => (int) $this->group_obj->isRegistrationAccessCodeEnabled(),
                 'code' => $this->group_obj->getRegistrationAccessCode()
             ]
         );
 
         $this->xmlEndTag('registration');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildTitleDescription()

ilGroupXMLWriter::__buildTitleDescription ( )

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

References null, ILIAS\Repository\settings(), and ilXmlWriter\xmlElement().

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMode()

ilGroupXMLWriter::getMode ( )

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

References $mode.

Referenced by start().

                              : int
     {
         return $this->mode;
     }

Here is the caller graph for this function:

◆ getXML()

ilGroupXMLWriter::getXML ( )

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

References ilXmlWriter\xmlDumpMem().

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

Here is the call graph for this function:

◆ setAttachUsers()

ilGroupXMLWriter::setAttachUsers ( bool $value )

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

     {
         $this->attach_users = $value;
     }

◆ setMode()

ilGroupXMLWriter::setMode ( int $a_mode )

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

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

◆ start()

ilGroupXMLWriter::start ( )

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

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

                            : void
     {
         if ($this->getMode() == self::MODE_SOAP) {
             $this->logger->debug('Using soap mode');
             $this->__buildHeader();
             $this->__buildGroup();
             $this->__buildAdvancedMetaData();
             $this->__buildTitleDescription();
             $this->__buildRegistration();
             $this->__buildExtraSettings();
             if ($this->attach_users) {
                 $this->__buildAdmin();
                 $this->__buildMember();
             }
             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->__buildTitleDescription();
             $this->__buildRegistration();
             $this->__buildExtraSettings();
             $this->__buildPeriod();
             ilContainerSortingSettings::_exportContainerSortingSettings($this, $this->group_obj->getId());
             ilContainer::_exportContainerSettings($this, $this->group_obj->getId());
             $this->__buildFooter();
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $access

ilAccessHandler ilGroupXMLWriter::$access

private

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

◆ $attach_users

bool ilGroupXMLWriter::$attach_users = true

private

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

◆ $group_obj

ilObjGroup ilGroupXMLWriter::$group_obj

private

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

Referenced by __construct().

◆ $logger

ilLogger ilGroupXMLWriter::$logger

private

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

◆ $mode

int ilGroupXMLWriter::$mode = self::MODE_SOAP

private

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

Referenced by getMode().

◆ $participants

ilGroupParticipants ilGroupXMLWriter::$participants

private

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

◆ $settings

ilSetting ilGroupXMLWriter::$settings

private

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

◆ EXPORT_VERSION

const int ilGroupXMLWriter::EXPORT_VERSION = 3

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

◆ MODE_EXPORT

const int ilGroupXMLWriter::MODE_EXPORT = 2

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

Referenced by ilGroupExporter\getXmlRepresentation().

◆ MODE_SOAP

const int ilGroupXMLWriter::MODE_SOAP = 1

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

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

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

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __buildAdmin()

◆ __buildAdvancedMetaData()

◆ __buildExtraSettings()

◆ __buildFooter()

◆ __buildGroup()

◆ __buildHeader()

◆ __buildMember()

◆ __buildPeriod()

◆ __buildRegistration()

◆ __buildTitleDescription()

◆ getMode()

◆ getXML()

◆ setAttachUsers()

◆ setMode()

◆ start()

Field Documentation

◆ $access

◆ $attach_users

◆ $group_obj

◆ $logger

◆ $mode

◆ $participants

◆ $settings

◆ EXPORT_VERSION

◆ MODE_EXPORT

◆ MODE_SOAP