XML writer class. More...

Inheritance diagram for ilSoapRoleObjectXMLWriter:

Collaboration diagram for ilSoapRoleObjectXMLWriter:

Public Member Functions
	__construct ()
	constructor More...

	setObjects (&$roles)

	setType ($type)

	start ()

	getXML ()

	__buildHeader ()

	__buildFooter ()

Public Member Functions inherited from ilXmlWriter
	__construct ($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...

	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
	$ilias

	$xml

	$roles

	$role_type

	$user_id = 0

Data Fields inherited from ilXmlWriter
	$xmlStr

	$version

	$outEnc

	$inEnc

	$dtdDef = ""

	$stSheet = ""

	$genCmt = "Generated by ILIAS XmlWriter"

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

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: class.ilObjectXMLWriter.php,v 1.3 2005/11/04 12:50:24 smeyer Exp

Definition at line 19 of file class.ilSoapRoleObjectXMLWriter.php.

Constructor & Destructor Documentation

◆ __construct()

ilSoapRoleObjectXMLWriter::__construct ( )

constructor

Parameters

string	xml version
string	output encoding
string	input encoding public

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

References $DIC, $ilias, and $ilUser.

     {
         global $DIC;
 
         $ilias = $DIC['ilias'];
         $ilUser = $DIC['ilUser'];
 
         parent::__construct();
 
         $this->ilias =&$ilias;
         $this->user_id = $ilUser->getId();
     }

Member Function Documentation

◆ __buildFooter()

ilSoapRoleObjectXMLWriter::__buildFooter ( )

Definition at line 132 of file class.ilSoapRoleObjectXMLWriter.php.

References ilXmlWriter\xmlEndTag().

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildHeader()

ilSoapRoleObjectXMLWriter::__buildHeader ( )

Definition at line 121 of file class.ilSoapRoleObjectXMLWriter.php.

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

Referenced by start().

     {
         $this->xmlSetDtdDef("<!DOCTYPE Roles PUBLIC \"-//ILIAS//DTD ILIAS Roles//EN\" \"" . ILIAS_HTTP_PATH . "/xml/ilias_role_object_3_10.dtd\">");
         $this->xmlSetGenCmt("Roles information of ilias system");
         $this->xmlHeader();
 
         $this->xmlStartTag('Roles');
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getXML()

ilSoapRoleObjectXMLWriter::getXML ( )

Definition at line 115 of file class.ilSoapRoleObjectXMLWriter.php.

References ilXmlWriter\xmlDumpMem().

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

Here is the call graph for this function:

◆ setObjects()

ilSoapRoleObjectXMLWriter::setObjects ( & $roles )

Definition at line 48 of file class.ilSoapRoleObjectXMLWriter.php.

References $roles.

     {
         $this->roles = &$roles;
     }

◆ setType()

ilSoapRoleObjectXMLWriter::setType ( $type )

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

References $type.

     {
         $this->role_type = $type;
     }

◆ start()

ilSoapRoleObjectXMLWriter::start ( )

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

References $DIC, __buildFooter(), __buildHeader(), ilUtil\__extractRefId(), ilObjRole\_getTranslation(), ilObjectXMLWriter\appendPathToObject(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

     {
         global $DIC;
 
         $rbacreview = $DIC['rbacreview'];
         if (!is_array($this->roles)) {
             return false;
         }
 
         $this->__buildHeader();
 
         include_once './Services/AccessControl/classes/class.ilObjRole.php';
         include_once './webservice/soap/classes/class.ilObjectXMLWriter.php';
 
         foreach ($this->roles as $role) {
             // if role type is not empty and does not match, then continue;
             if (!empty($this->role_type) && strcasecmp($this->role_type, $role["role_type"]) != 0) {
                 continue;
             }
             if ($rbacreview->isRoleDeleted($role["obj_id"])) {
                 continue;
             }
             
             $attrs = array(     'role_type' => ucwords($role["role_type"]),
                 'id' => "il_" . IL_INST_ID . "_role_" . $role["obj_id"]);
 
             // open tag
             $this->xmlStartTag("Role", $attrs);
 
 
             $this->xmlElement('Title', null, $role["title"]);
             $this->xmlElement('Description', null, $role["description"]);
             $this->xmlElement('Translation', null, ilObjRole::_getTranslation($role["title"]));
 
             if ($ref_id = ilUtil::__extractRefId($role["title"])) {
                 $ownerObj = IlObjectFactory::getInstanceByRefId($ref_id, false);
 
                 if (is_object($ownerObj)) {
                     $attrs = array("obj_id" =>
                         "il_" . IL_INST_ID . "_" . $ownerObj->getType() . "_" . $ownerObj->getId(), "ref_id" => $ownerObj->getRefId(), "type" => $ownerObj->getType());
                     $this->xmlStartTag('AssignedObject', $attrs);
                     $this->xmlElement('Title', null, $ownerObj->getTitle());
                     $this->xmlElement('Description', null, $ownerObj->getDescription());
                     ilObjectXMLWriter::appendPathToObject($this, $ref_id);
                     $this->xmlEndTag('AssignedObject', $attrs);
                 }
             }
 
             $this->xmlEndTag("Role");
         }
 
         $this->__buildFooter();
 
         return true;
     }