ilSoapRoleObjectXMLWriter Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilSoapRoleObjectXMLWriter:

Collaboration diagram for ilSoapRoleObjectXMLWriter:

Public Member Functions
	__construct ()
	setObjects (array $roles)
	setType (string $type)
	start ()
	getXML ()
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
string	$xml = ''

Private Member Functions
	buildHeader ()
	buildFooter ()

Private Attributes
array	$roles = []
string	$role_type = ''

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 29 of file class.ilSoapRoleObjectXMLWriter.php.

Constructor & Destructor Documentation

__construct()

ilSoapRoleObjectXMLWriter::__construct

(

)

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

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

    {
        global $DIC;

        $ilUser = $DIC->user();

        parent::__construct();
    }

Here is the call graph for this function:

Member Function Documentation

buildFooter()

ilSoapRoleObjectXMLWriter::buildFooter ( )

private

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

References ilXmlWriter\xmlEndTag().

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

buildHeader()

ilSoapRoleObjectXMLWriter::buildHeader ( )

private

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

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

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getXML()

ilSoapRoleObjectXMLWriter::getXML

(

)

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

References ilXmlWriter\xmlDumpMem().

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

Here is the call graph for this function:

setObjects()

ilSoapRoleObjectXMLWriter::setObjects

(

array

$roles

)

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

References $roles.

                                            : void
    {
        $this->roles = $roles;
    }

setType()

ilSoapRoleObjectXMLWriter::setType

(

string

$type

)

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

                                         : void
    {
        $this->role_type = $type;
    }

start()

ilSoapRoleObjectXMLWriter::start

(

)

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

References $DIC, $ref_id, ilUtil\__extractRefId(), ilObjRole\_getTranslation(), ilObjectXMLWriter\appendPathToObject(), buildFooter(), buildHeader(), ilObjectFactory\getInstanceByRefId(), IL_INST_ID, null, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                           : bool
    {
        global $DIC;

        $rbacreview = $DIC['rbacreview'];
        if ($this->roles === []) {
            return false;
        }

        $this->buildHeader();

        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 = [
                'role_type' => ucwords($role["role_type"]),
                'id' => "il_" . IL_INST_ID . "_role_" . $role["obj_id"]
            ];

            $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 = [
                        "obj_id" => implode(
                            '_',
                            [
                                "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');
                }
            }
            $this->xmlEndTag("Role");
        }
        $this->buildFooter();
        return true;
    }

Here is the call graph for this function:

Field Documentation

$role_type

string ilSoapRoleObjectXMLWriter::$role_type = ''

private

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

$roles

array ilSoapRoleObjectXMLWriter::$roles = []

private

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

Referenced by setObjects().

$xml

string ilSoapRoleObjectXMLWriter::$xml = ''

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

---

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

• components/ILIAS/soap/classes/class.ilSoapRoleObjectXMLWriter.php