XML writer class. More...

Inheritance diagram for ilCourseXMLWriter:

Collaboration diagram for ilCourseXMLWriter:

Public Member Functions
	ilCourseXMLWriter (&$course_obj)
	constructor More...

	setMode ($a_mode)

	getMode ()

	start ()

	getXML ()

	modifyExportIdentifier ($a_tag, $a_param, $a_value)

	__buildHeader ()

	__buildCourseStart ()

	__buildMetaData ()

	__buildAdmin ()

	__buildTutor ()

	__buildMember ()

	__buildSubscriber ()

	__buildWaitingList ()

	__buildSetting ()

	__buildFooter ()

	setAttachUsers ($value)
	write access to attach user property, if set to false no users will be attached. More...

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

	_ilXmlWriter ()
	destructor public More...

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

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

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

	_xmlEscapeData ($data)
	Escapes reserved characters. 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 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 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"

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

Private Attributes
	$mode = self::MODE_SOAP

	$ilias

	$xml

	$course_obj

	$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

Version: $Id$

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

Member Function Documentation

◆ __buildAdmin()

ilCourseXMLWriter::__buildAdmin ( )

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

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

Referenced by start().

         {
                 foreach($this->course_obj->getMembersObject()->getAdmins() as $id)
                 {
                         $attr['id'] = 'il_'.$this->ilias->getSetting('inst_id').'_usr_'.$id;
                         $attr['notification'] = ($this->course_obj->getMembersObject()->isNotificationEnabled($id)) ? 'Yes' : 'No';
                         $attr['passed'] = $this->course_obj->getMembersObject()->hasPassed($id) ? 'Yes' : 'No';
 
                         $this->xmlStartTag('Admin',$attr);
                         $this->xmlEndTag('Admin');
                 }
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildAdvancedMetaData()

ilCourseXMLWriter::__buildAdvancedMetaData ( )

private

Build advanced meta data.

private

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

References ilAdvancedMDValues\_appendXMLByObjId().

Referenced by start().

         {
                 include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
                 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 148 of file class.ilCourseXMLWriter.php.

References ilXmlWriter\xmlStartTag().

Referenced by start().

         {
                 $attrs["exportVersion"] = $this->EXPORT_VERSION;
                 $attrs["id"] = "il_".$this->ilias->getSetting('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().

         {
                 $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 138 of file class.ilCourseXMLWriter.php.

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

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildMember()

ilCourseXMLWriter::__buildMember ( )

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

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

Referenced by start().

         {
                 foreach($this->course_obj->getMembersObject()->getMembers() as $id)
                 {
                         $attr['id'] = 'il_'.$this->ilias->getSetting('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');
                 }
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildMetaData()

ilCourseXMLWriter::__buildMetaData ( )

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

References ilXmlWriter\appendXML(), and ilMD2XML\startExport().

Referenced by start().

         {
                 include_once 'Services/MetaData/classes/class.ilMD2XML.php';
 
                 $md2xml = new ilMD2XML($this->course_obj->getId(),$this->course_obj->getId(),'crs');
                 $md2xml->startExport();
                 $this->appendXML($md2xml->getXML());
 
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildSetting()

ilCourseXMLWriter::__buildSetting ( )

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

References IL_CAL_UNIX, IL_CRS_ARCHIVE_DOWNLOAD, IL_CRS_SUBSCRIPTION_CONFIRMATION, IL_CRS_SUBSCRIPTION_DEACTIVATED, IL_CRS_SUBSCRIPTION_DIRECT, IL_CRS_SUBSCRIPTION_UNLIMITED, IL_CRS_VIEW_ARCHIVE, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

         {
                 $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());
                 
                 
                 // 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() == IL_CRS_SUBSCRIPTION_CONFIRMATION)
                 {
                         $attr['registrationType'] = 'Confirmation';
                 }
                 elseif($this->course_obj->getSubscriptionType() == 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() == IL_CRS_SUBSCRIPTION_DEACTIVATED)
                 {
                         $this->xmlElement('Disabled');
                 }
                 elseif($this->course_obj->getSubscriptionLimitationType() == 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');
 
                 // Archives
                 $attr = array();
                 if($this->course_obj->getViewMode() != IL_CRS_VIEW_ARCHIVE)
                 {
                         $attr['Access'] = 'Disabled';
                 }
                 elseif($this->course_obj->getViewMode() == IL_CRS_VIEW_ARCHIVE)
                 {
                         $attr['Access'] = 'Read';
                 }
                 if($this->course_obj->getArchiveType() == IL_CRS_ARCHIVE_DOWNLOAD)
                 {
                         $attr['Access'] = 'Download';
                 }
                 $this->xmlStartTag('Archive',$attr);
 
                 $this->xmlElement('Start',null,$this->course_obj->getArchiveStart());
                 $this->xmlElement('End',null,$this->course_obj->getArchiveEnd());
 
                 $this->xmlEndTag('Archive');
                 
                 $this->xmlStartTag('Period');
                 $this->xmlElement('Start',null,($this->course_obj->getCourseStart() && !$this->course_obj->getCourseStart()->isNull()) ? $this->course_obj->getCourseStart()->get(IL_CAL_UNIX) : null);
                 $this->xmlElement('End',null,($this->course_obj->getCourseEnd() && !$this->course_obj->getCourseEnd()->isNull()) ? $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,(int)$this->course_obj->getSubscriptionMinMembers());               
 
                 $this->xmlEndTag('Settings');
 
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildSubscriber()

ilCourseXMLWriter::__buildSubscriber ( )

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

References $data, ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

         {
                 foreach($this->course_obj->getMembersObject()->getSubscribers() as $id)
                 {
                         $data = $this->course_obj->getMembersObject()->getSubscriberData($id);
 
                         $attr['id'] = 'il_'.$this->ilias->getSetting('inst_id').'_usr_'.$id;
                         $attr['subscriptionTime'] = $data['time'];
 
                         $this->xmlStartTag('Subscriber',$attr);
                         $this->xmlEndTag('Subscriber');
                 }
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildTutor()

ilCourseXMLWriter::__buildTutor ( )

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

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

Referenced by start().

         {
                 foreach($this->course_obj->getMembersObject()->getTutors() as $id)
                 {
                         $attr['id'] = 'il_'.$this->ilias->getSetting('inst_id').'_usr_'.$id;
                         $attr['notification'] = ($this->course_obj->getMembersObject()->isNotificationEnabled($id)) ? 'Yes' : 'No';
                         $attr['passed'] = $this->course_obj->getMembersObject()->hasPassed($id) ? 'Yes' : 'No';
 
                         $this->xmlStartTag('Tutor',$attr);
                         $this->xmlEndTag('Tutor');
                 }
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildWaitingList()

ilCourseXMLWriter::__buildWaitingList ( )

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

References $data, ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

         {
                 include_once 'Modules/Course/classes/class.ilCourseWaitingList.php';
 
                 $waiting_list = new ilCourseWaitingList($this->course_obj->getId());
                 
                 foreach($waiting_list->getAllUsers() as $data)
                 {
                         $attr['id'] = 'il_'.$this->ilias->getSetting('inst_id').'_usr_'.$data['usr_id'];
                         $attr['position'] = $data['position'];
                         $attr['subscriptionTime'] = $data['time'];
                         
                         $this->xmlStartTag('WaitingList',$attr);
                         $this->xmlEndTag('WaitingList');
                 }
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMode()

ilCourseXMLWriter::getMode ( )

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

References $mode.

Referenced by start().

         {
                 return $this->mode;
         }

Here is the caller graph for this function:

◆ getXML()

ilCourseXMLWriter::getXML ( )

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

References ilXmlWriter\xmlDumpMem().

         {
                 #var_dump("<pre>", htmlentities($this->xmlDumpMem()),"<pre>");
                 return $this->xmlDumpMem(false);
         }

Here is the call graph for this function:

◆ ilCourseXMLWriter()

ilCourseXMLWriter::ilCourseXMLWriter ( & $course_obj )

constructor

Parameters

string	xml version
string	output encoding
string	input encoding public

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

References $course_obj, and $ilias.

         {
                 global $ilias;
 
                 parent::ilXmlWriter();
 
                 $this->EXPORT_VERSION = "2";
 
                 $this->ilias =& $ilias;
                 $this->course_obj =& $course_obj;
         }

◆ modifyExportIdentifier()

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

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

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

◆ setAttachUsers()

ilCourseXMLWriter::setAttachUsers ( $value )

write access to attach user property, if set to false no users will be attached.

Parameters

unknown_type $value

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

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

◆ setMode()

ilCourseXMLWriter::setMode ( $a_mode )

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

         {
                 $this->mode = $a_mode;
         }

◆ start()

ilCourseXMLWriter::start ( )

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

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

         {
                 if($this->getMode() == self::MODE_SOAP)
                 {
                         
                         $this->__buildHeader();
                         $this->__buildCourseStart();
                         $this->__buildMetaData();
                         $this->__buildAdvancedMetaData();
                         if ($this->attach_users) 
                         {
                                 $this->__buildAdmin();
                                 $this->__buildTutor();
                                 $this->__buildMember();
                         }
                         $this->__buildSubscriber();
                         $this->__buildWaitingList();
                         
                         $this->__buildSetting();
                         include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
                         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->__buildMetaData();
                         $this->__buildAdvancedMetaData();
                         $this->__buildSetting();
                         include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
                         ilContainerSortingSettings::_exportContainerSortingSettings($this,$this->course_obj->getId());
                         ilContainer::_exportContainerSettings($this, $this->course_obj->getId());
                         $this->__buildFooter();
                 }
         }