ilCourseXMLWriter Class Reference

XML writer class Class to simplify manual writing of xml documents. More...

Inheritance diagram for ilCourseXMLWriter:

Collaboration diagram for ilCourseXMLWriter:

Public Member Functions
	__construct (ilObjCourse $course_obj)
	setMode (int $a_mode)
	getMode ()
	start ()
	getXML ()
	modifyExportIdentifier ($a_tag, $a_param, $a_value)
	__buildHeader ()
	__buildTitleDescription ()
	__buildCourseStart ()
	__buildAdmin ()
	__buildTutor ()
	__buildMember ()
	__buildSubscriber ()
	__buildWaitingList ()
	__buildSetting ()
	__buildFooter ()
	setAttachUsers ($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 string	EXPORT_VERSION = '8.0'

Protected Attributes
ilSetting	$setting
ilAccessHandler	$access

Private Member Functions
	__buildAdvancedMetaData ()

Private Attributes
int	$mode = self::MODE_SOAP
string	$xml = ''
ilObjCourse	$course_obj
bool	$attach_users = true

Detailed Description

XML writer class Class to simplify manual writing of xml documents.

It only supports writing xml sequentially, because the xml document is saved in a string with no additional structure information. The author is responsible for well-formedness and validity of the xml document.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilCourseXMLWriter::__construct

(

ilObjCourse

$course_obj

)

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

References $course_obj, $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\access().

    {
        global $DIC;

        $this->setting = $DIC->settings();
        $this->access = $DIC->access();

        parent::__construct();
        $this->course_obj = $course_obj;
    }

Here is the call graph for this function:

Member Function Documentation

__buildAdmin()

ilCourseXMLWriter::__buildAdmin

(

)

Definition at line 138 of file class.ilCourseXMLWriter.php.

References $GLOBALS, $id, ilOrgUnitOperation\OP_MANAGE_MEMBERS, ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

                                  : void
    {
        $admins = $this->course_obj->getMembersObject()->getAdmins();
        $admins = $GLOBALS['DIC']->access()->filterUserIdsByRbacOrPositionOfCurrentUser(
            'manage_members',
            ilOrgUnitOperation::OP_MANAGE_MEMBERS,
            $this->course_obj->getRefId(),
            $admins
        );

        foreach ($admins as $id) {
            $attr['id'] = 'il_' . $this->setting->get('inst_id') . '_usr_' . $id;
            $attr['notification'] = ($this->course_obj->getMembersObject()->isNotificationEnabled($id)) ? 'Yes' : 'No';
            $attr['passed'] = $this->course_obj->getMembersObject()->hasPassed($id) ? 'Yes' : 'No';
            $attr['contact'] = $this->course_obj->getMembersObject()->isContact($id) ? 'Yes' : 'No';

            $this->xmlStartTag('Admin', $attr);
            $this->xmlEndTag('Admin');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__buildAdvancedMetaData()

ilCourseXMLWriter::__buildAdvancedMetaData ( )

private

Definition at line 133 of file class.ilCourseXMLWriter.php.

References ilAdvancedMDValues\_appendXMLByObjId().

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

__buildCourseStart()

ilCourseXMLWriter::__buildCourseStart

(

)

Definition at line 125 of file class.ilCourseXMLWriter.php.

References ilXmlWriter\xmlStartTag().

Referenced by start().

                                        : void
    {
        $attrs["exportVersion"] = self::EXPORT_VERSION;
        $attrs["id"] = "il_" . $this->setting->get('inst_id') . '_crs_' . $this->course_obj->getId();
        $attrs['showMembers'] = ($this->course_obj->getShowMembers() ? 'Yes' : 'No');
        $this->xmlStartTag("Course", $attrs);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__buildFooter()

ilCourseXMLWriter::__buildFooter

(

)

Definition at line 369 of file class.ilCourseXMLWriter.php.

References ilXmlWriter\xmlEndTag().

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

__buildHeader()

ilCourseXMLWriter::__buildHeader

(

)

Definition at line 110 of file class.ilCourseXMLWriter.php.

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

Referenced by start().

                                   : void
    {
        $this->xmlSetGenCmt("Export of ILIAS course " . $this->course_obj->getId() . " of installation " . $this->setting->get('inst_id') . ".");
        $this->xmlHeader();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__buildMember()

ilCourseXMLWriter::__buildMember

(

)

Definition at line 179 of file class.ilCourseXMLWriter.php.

References $GLOBALS, $id, ilOrgUnitOperation\OP_MANAGE_MEMBERS, ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

                                   : void
    {
        $members = $this->course_obj->getMembersObject()->getMembers();
        $members = $GLOBALS['DIC']->access()->filterUserIdsByRbacOrPositionOfCurrentUser(
            'manage_members',
            ilOrgUnitOperation::OP_MANAGE_MEMBERS,
            $this->course_obj->getRefId(),
            $members
        );
        foreach ($members as $id) {
            $attr['id'] = 'il_' . $this->setting->get('inst_id') . '_usr_' . $id;
            $attr['blocked'] = ($this->course_obj->getMembersObject()->isBlocked($id)) ? 'Yes' : 'No';
            $attr['passed'] = $this->course_obj->getMembersObject()->hasPassed($id) ? 'Yes' : 'No';

            $this->xmlStartTag('Member', $attr);
            $this->xmlEndTag('Member');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__buildSetting()

ilCourseXMLWriter::__buildSetting

(

)

Definition at line 243 of file class.ilCourseXMLWriter.php.

References IL_CAL_UNIX, ilCourseConstants\IL_CRS_SUBSCRIPTION_CONFIRMATION, ilCourseConstants\IL_CRS_SUBSCRIPTION_DEACTIVATED, ilCourseConstants\IL_CRS_SUBSCRIPTION_DIRECT, ilCourseConstants\IL_CRS_SUBSCRIPTION_UNLIMITED, ilCourseConstants\IL_CRS_VIEW_TIMING, null, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

                                    : void
    {
        $this->xmlStartTag('Settings');

        // Availability
        $this->xmlStartTag('Availability');
        if ($this->course_obj->getOfflineStatus()) {
            $this->xmlElement('NotAvailable');
        } elseif ($this->course_obj->getActivationUnlimitedStatus()) {
            $this->xmlElement('Unlimited');
        } else {
            $this->xmlStartTag('TemporarilyAvailable');
            $this->xmlElement('Start', null, $this->course_obj->getActivationStart());
            $this->xmlElement('End', null, $this->course_obj->getActivationEnd());
            $this->xmlEndTag('TemporarilyAvailable');
        }
        $this->xmlEndTag('Availability');

        // Syllabus
        $this->xmlElement('Syllabus', null, $this->course_obj->getSyllabus());
        $this->xmlElement('ImportantInformation', null, $this->course_obj->getImportantInformation());
        $this->xmlElement('TargetGroup', null, $this->course_obj->getTargetGroup());

        // Contact
        $this->xmlStartTag('Contact');
        $this->xmlElement('Name', null, $this->course_obj->getContactName());
        $this->xmlElement('Responsibility', null, $this->course_obj->getContactResponsibility());
        $this->xmlElement('Phone', null, $this->course_obj->getContactPhone());
        $this->xmlElement('Email', null, $this->course_obj->getContactEmail());
        $this->xmlElement('Consultation', null, $this->course_obj->getContactConsultation());
        $this->xmlEndTag('Contact');

        // Registration
        $attr = array();

        if ($this->course_obj->getSubscriptionType() == ilCourseConstants::IL_CRS_SUBSCRIPTION_CONFIRMATION) {
            $attr['registrationType'] = 'Confirmation';
        } elseif ($this->course_obj->getSubscriptionType() == ilCourseConstants::IL_CRS_SUBSCRIPTION_DIRECT) {
            $attr['registrationType'] = 'Direct';
        } else {
            $attr['registrationType'] = 'Password';
        }

        $attr['maxMembers'] = $this->course_obj->isSubscriptionMembershipLimited() ?
            $this->course_obj->getSubscriptionMaxMembers() : 0;
        $attr['notification'] = $this->course_obj->getSubscriptionNotify() ? 'Yes' : 'No';
        $attr['waitingList'] = $this->course_obj->enabledWaitingList() ? 'Yes' : 'No';

        $this->xmlStartTag('Registration', $attr);

        if ($this->course_obj->getSubscriptionLimitationType() == ilCourseConstants::IL_CRS_SUBSCRIPTION_DEACTIVATED) {
            $this->xmlElement('Disabled');
        } elseif ($this->course_obj->getSubscriptionLimitationType() == ilCourseConstants::IL_CRS_SUBSCRIPTION_UNLIMITED) {
            $this->xmlElement('Unlimited');
        } else {
            $this->xmlStartTag('TemporarilyAvailable');
            $this->xmlElement('Start', null, $this->course_obj->getSubscriptionStart());
            $this->xmlElement('End', null, $this->course_obj->getSubscriptionEnd());
            $this->xmlEndTag('TemporarilyAvailable');
        }
        if (strlen($pwd = $this->course_obj->getSubscriptionPassword())) {
            $this->xmlElement('Password', null, $pwd);
        }
        $this->xmlEndTag('Registration');

        $this->xmlStartTag('Period', ['withTime' => $this->course_obj->getCourseStartTimeIndication() ? 1 : 0]);
        $this->xmlElement(
            'Start',
            null,
            $this->course_obj->getCourseStart()
                ? $this->course_obj->getCourseStart()->get(IL_CAL_UNIX)
                : null
        );
        $this->xmlElement(
            'End',
            null,
            $this->course_obj->getCourseEnd()
                ? $this->course_obj->getCourseEnd()->get(IL_CAL_UNIX)
                : null
        );
        $this->xmlEndTag('Period');
        $this->xmlElement('WaitingListAutoFill', null, (int) $this->course_obj->hasWaitingListAutoFill());
        $this->xmlElement(
            'CancellationEnd',
            null,
            ($this->course_obj->getCancellationEnd() && !$this->course_obj->getCancellationEnd()->isNull()) ? $this->course_obj->getCancellationEnd()->get(IL_CAL_UNIX) : null
        );
        $this->xmlElement('MinMembers', null, $this->course_obj->getSubscriptionMinMembers());

        $this->xmlElement('ViewMode', null, $this->course_obj->getViewMode());
        if ($this->course_obj->getViewMode() == ilCourseConstants::IL_CRS_VIEW_TIMING) {
            $this->xmlElement('TimingMode', null, $this->course_obj->getTimingMode());
        }

        $this->xmlElement('TutorialSupportBlock', [
            'active' => $this->course_obj->getTutorialSupportBlockSettingValue()
        ]);

        $this->xmlElement(
            'SessionLimit',
            [
                'active' => $this->course_obj->isSessionLimitEnabled() ? 1 : 0,
                'previous' => $this->course_obj->getNumberOfPreviousSessions(),
                'next' => $this->course_obj->getNumberOfNextSessions()
            ]
        );

        $this->xmlElement(
            'WelcomeMail',
            [
                'status' => $this->course_obj->getAutoNotification() ? 1 : 0
            ]
        );

        $this->xmlElement('StatusDetermination', null, (int) $this->course_obj->getStatusDetermination());
        $this->xmlElement('MailToMembersType', null, (int) $this->course_obj->getMailToMembersType());
        $this->xmlElement('CourseMap', [
            'enabled' => (int) $this->course_obj->getEnableCourseMap(),
            'latitude' => $this->course_obj->getLatitude(),
            'longitude' => $this->course_obj->getLongitude(),
            'location_zoom' => $this->course_obj->getLocationZoom()
        ]);

        $this->xmlEndTag('Settings');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__buildSubscriber()

ilCourseXMLWriter::__buildSubscriber

(

)

Definition at line 198 of file class.ilCourseXMLWriter.php.

References $data, $id, ILIAS\Repository\access(), ilOrgUnitOperation\OP_MANAGE_MEMBERS, ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

                                       : void
    {
        $subs = $this->course_obj->getMembersObject()->getSubscribers();
        $subs = $this->access->filterUserIdsByRbacOrPositionOfCurrentUser(
            'manage_members',
            ilOrgUnitOperation::OP_MANAGE_MEMBERS,
            $this->course_obj->getRefId(),
            $subs
        );

        foreach ($subs as $id) {
            $data = $this->course_obj->getMembersObject()->getSubscriberData($id);

            $attr['id'] = 'il_' . $this->setting->get('inst_id') . '_usr_' . $id;
            $attr['subscriptionTime'] = $data['time'];

            $this->xmlStartTag('Subscriber', $attr);
            $this->xmlEndTag('Subscriber');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__buildTitleDescription()

ilCourseXMLWriter::__buildTitleDescription

(

)

Definition at line 116 of file class.ilCourseXMLWriter.php.

References null, and ilXmlWriter\xmlElement().

Referenced by start().

                                             : void
    {
        $this->xmlElement('Title', null, $this->course_obj->getTitle());

        if ($desc = $this->course_obj->getDescription()) {
            $this->xmlElement('Description', null, $desc);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__buildTutor()

ilCourseXMLWriter::__buildTutor

(

)

Definition at line 159 of file class.ilCourseXMLWriter.php.

References $id, ILIAS\Repository\access(), ilOrgUnitOperation\OP_MANAGE_MEMBERS, ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

                                  : void
    {
        $tutors = $this->course_obj->getMembersObject()->getTutors();
        $tutors = $this->access->filterUserIdsByRbacOrPositionOfCurrentUser(
            'manage_members',
            ilOrgUnitOperation::OP_MANAGE_MEMBERS,
            $this->course_obj->getRefId(),
            $tutors
        );
        foreach ($tutors as $id) {
            $attr['id'] = 'il_' . $this->setting->get('inst_id') . '_usr_' . $id;
            $attr['notification'] = ($this->course_obj->getMembersObject()->isNotificationEnabled($id)) ? 'Yes' : 'No';
            $attr['passed'] = $this->course_obj->getMembersObject()->hasPassed($id) ? 'Yes' : 'No';
            $attr['contact'] = $this->course_obj->getMembersObject()->isContact($id) ? 'Yes' : 'No';

            $this->xmlStartTag('Tutor', $attr);
            $this->xmlEndTag('Tutor');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__buildWaitingList()

ilCourseXMLWriter::__buildWaitingList

(

)

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

References $data, $GLOBALS, ilWaitingList\getAllUsers(), ilOrgUnitOperation\OP_MANAGE_MEMBERS, ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

                                        : void
    {
        $waiting_list = new ilCourseWaitingList($this->course_obj->getId());
        $wait = $waiting_list->getAllUsers();
        foreach ($wait as $data) {
            $is_accessible = $GLOBALS['DIC']->access()->filterUserIdsByRbacOrPositionOfCurrentUser(
                'manage_members',
                ilOrgUnitOperation::OP_MANAGE_MEMBERS,
                $this->course_obj->getRefId(),
                [$data['usr_id']]
            );
            if (count($is_accessible) === 0) {
                continue;
            }

            $attr['id'] = 'il_' . $this->setting->get('inst_id') . '_usr_' . $data['usr_id'];
            $attr['position'] = $data['position'];
            $attr['subscriptionTime'] = $data['time'];

            $this->xmlStartTag('WaitingList', $attr);
            $this->xmlEndTag('WaitingList');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMode()

ilCourseXMLWriter::getMode

(

)

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

References $mode.

Referenced by start().

                             : int
    {
        return $this->mode;
    }

Here is the caller graph for this function:

getXML()

ilCourseXMLWriter::getXML

(

)

Definition at line 95 of file class.ilCourseXMLWriter.php.

References ilXmlWriter\xmlDumpMem().

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

Here is the call graph for this function:

modifyExportIdentifier()

ilCourseXMLWriter::modifyExportIdentifier	(		$a_tag,
			$a_param,
			$a_value
	)

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

    {
        if ($a_tag == "Identifier" && $a_param == "Entry") {
            $a_value = "il_" . $this->setting->get('inst_id') . "_crs_" . $this->course_obj->getId();
        }

        return $a_value;
    }

setAttachUsers()

ilCourseXMLWriter::setAttachUsers

(

$value

)

Definition at line 374 of file class.ilCourseXMLWriter.php.

                                          : void
    {
        $this->attach_users = (bool) $value;
    }

setMode()

ilCourseXMLWriter::setMode

(

int

$a_mode

)

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

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

start()

ilCourseXMLWriter::start

(

)

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

References __buildAdmin(), __buildAdvancedMetaData(), __buildCourseStart(), __buildFooter(), __buildHeader(), __buildMember(), __buildSetting(), __buildSubscriber(), __buildTitleDescription(), __buildTutor(), __buildWaitingList(), ilContainer\_exportContainerSettings(), ilContainerSortingSettings\_exportContainerSortingSettings(), and getMode().

                           : void
    {
        if ($this->getMode() == self::MODE_SOAP) {
            $this->__buildHeader();
            $this->__buildCourseStart();
            $this->__buildAdvancedMetaData();
            $this->__buildTitleDescription();
            if ($this->attach_users) {
                $this->__buildAdmin();
                $this->__buildTutor();
                $this->__buildMember();
            }
            $this->__buildSubscriber();
            $this->__buildWaitingList();

            $this->__buildSetting();
            ilContainerSortingSettings::_exportContainerSortingSettings($this, $this->course_obj->getId());
            ilContainer::_exportContainerSettings($this, $this->course_obj->getId());
            $this->__buildFooter();
        } elseif ($this->getMode() == self::MODE_EXPORT) {
            $this->__buildCourseStart();
            $this->__buildSetting();
            ilContainerSortingSettings::_exportContainerSortingSettings($this, $this->course_obj->getId());
            ilContainer::_exportContainerSettings($this, $this->course_obj->getId());
            $this->__buildFooter();
        }
    }

Here is the call graph for this function:

Field Documentation

$access

ilAccessHandler ilCourseXMLWriter::$access

protected

Definition at line 44 of file class.ilCourseXMLWriter.php.

$attach_users

bool ilCourseXMLWriter::$attach_users = true

private

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

$course_obj

ilObjCourse ilCourseXMLWriter::$course_obj

private

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

Referenced by __construct().

$mode

int ilCourseXMLWriter::$mode = self::MODE_SOAP

private

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

Referenced by getMode().

$setting

ilSetting ilCourseXMLWriter::$setting

protected

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

$xml

string ilCourseXMLWriter::$xml = ''

private

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

EXPORT_VERSION

const string ilCourseXMLWriter::EXPORT_VERSION = '8.0'

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

MODE_EXPORT

const int ilCourseXMLWriter::MODE_EXPORT = 2

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

Referenced by ilCourseExporter\getXmlRepresentation().

MODE_SOAP

const int ilCourseXMLWriter::MODE_SOAP = 1

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

---

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

• components/ILIAS/Course/classes/class.ilCourseXMLWriter.php