XML writer class. More...

Inheritance diagram for ilSoapRoleObjectXMLWriter:

Collaboration diagram for ilSoapRoleObjectXMLWriter:

Public Member Functions
	ilSoapRoleObjectXMLWriter ()
	constructor
	setObjects (&$roles)
	setType ($type)
	start ()
	getXML ()
	__buildHeader ()
	__buildFooter ()
Public Member Functions inherited from ilXmlWriter
	ilXmlWriter ($version="1.0", $outEnc="utf-8", $inEnc="utf-8")
	constructor
	_ilXmlWriter ()
	destructor public
	xmlSetDtdDef ($dtdDef)
	Sets dtd definition.
	xmlSetStSheet ($stSheet)
	Sets stylesheet.
	xmlSetGenCmt ($genCmt)
	Sets generated comment.
	_xmlEscapeData ($data)
	Escapes reserved characters.
	xmlEncodeData ($data)
	Encodes text from input encoding into output encoding.
	xmlFormatData ($data)
	Indents text for better reading.
	xmlFormatElement ($array)
	Callback function for xmlFormatData; do not invoke directly.
	xmlHeader ()
	Writes xml header public.
	xmlStartTag ($tag, $attrs=NULL, $empty=FALSE, $encode=TRUE, $escape=TRUE)
	Writes a starttag.
	xmlEndTag ($tag)
	Writes an endtag.
	xmlComment ($comment)
	Writes a comment.
	xmlData ($data, $encode=TRUE, $escape=TRUE)
	Writes data.
	xmlElement ($tag, $attrs=NULL, $data=Null, $encode=TRUE, $escape=TRUE)
	Writes a basic element (no children, just textual content)
	xmlDumpFile ($file, $format=TRUE)
	Dumps xml document from memory into a file.
	xmlDumpMem ($format=TRUE)
	Returns xml document from memory.
	appendXML ($a_str)
	append xml string to document
	xmlClear ()
	clears xmlStr public

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"

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.

Member Function Documentation

ilSoapRoleObjectXMLWriter::__buildFooter ( )

Definition at line 133 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:

ilSoapRoleObjectXMLWriter::__buildHeader ( )

Definition at line 122 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:

ilSoapRoleObjectXMLWriter::getXML ( )

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

References ilXmlWriter\xmlDumpMem().

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

Here is the call graph for this function:

ilSoapRoleObjectXMLWriter::ilSoapRoleObjectXMLWriter ( )

constructor

Parameters

string	xml version
string	output encoding
string	input encoding public

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

References $ilias, and ilXmlWriter\ilXmlWriter().

        {
                global $ilias,$ilUser;
                parent::ilXmlWriter();
                $this->ilias =& $ilias;
                $this->user_id = $ilUser->getId();
        }

Here is the call graph for this function:

ilSoapRoleObjectXMLWriter::setObjects ( & $roles )

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

References $roles.

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

ilSoapRoleObjectXMLWriter::setType ( $type )

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

References $type.

        {
                $this->role_type = $type;
        }

ilSoapRoleObjectXMLWriter::start ( )

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

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

        {
                global $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;
        }