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

Inheritance diagram for ilObjectXMLWriter:

Collaboration diagram for ilObjectXMLWriter:

Public Member Functions
	__construct ()

	setMode (int $a_mode)

	getMode ()

	setHighlighter (ilLuceneHighlighterResultParser $a_highlighter)

	getHighlighter ()

	enablePermissionCheck (bool $a_status)

	isPermissionCheckEnabled ()

	setUserId (int $a_id)

	getUserId ()

	enableOperations (bool $a_status)

	enabledOperations ()

	enableReferences (bool $a_stat)

	enabledReferences ()

	setObjects (array $objects)

	getObjects ()

	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...

Static Public Member Functions
static	appendPathToObject (ilXmlWriter $writer, int $refid)

Data Fields
const	MODE_SEARCH_RESULT = 1

const	TIMING_DEACTIVATED = 0

const	TIMING_TEMPORARILY_AVAILABLE = 1

const	TIMING_PRESETTING = 2

const	TIMING_VISIBILITY_OFF = 0

const	TIMING_VISIBILITY_ON = 1

Protected Attributes
string	$xml

bool	$enable_operations = false

bool	$enable_references = true

array	$objects = array()

int	$user_id = 0

bool	$check_permission = false

Private Member Functions
	appendTimeTargets (int $a_ref_id)
	Append time target settings for items inside of courses. More...

	appendObjectProperties (ilObject $obj)

	appendOperations (int $a_ref_id, string $a_type)

	appendPath (int $refid)

	buildHeader ()

	buildFooter ()

	getAccessInfo (ilObject $object, int $ref_id)

Private Attributes
int	$mode = 0

ilLuceneHighlighterResultParser	$highlighter = null

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 14 of file class.ilObjectXMLWriter.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectXMLWriter::__construct ( )

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ appendObjectProperties()

ilObjectXMLWriter::appendObjectProperties ( ilObject $obj )

private

Definition at line 256 of file class.ilObjectXMLWriter.php.

References ilObject\getType(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by getXML().

                                                           : void
     {
         switch ($obj->getType()) {
             case 'file':
                 if (!$obj instanceof ilObjFile) {
                     break;
                 }
                 $size = $obj->getFileSize();
                 $extension = $obj->getFileExtension();
                 $this->xmlStartTag('Properties');
                 $this->xmlElement("Property", array('name' => 'fileSize'), (string) $size);
                 $this->xmlElement("Property", array('name' => 'fileExtension'), (string) $extension);
                 $this->xmlElement(
                     'Property',
                     array('name' => 'fileVersion'),
                     (string) $obj->getVersion()
                 );
                 $this->xmlEndTag('Properties');
                 break;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendOperations()

ilObjectXMLWriter::appendOperations	(	int	$a_ref_id,
		string	$a_type
	)

private

Definition at line 278 of file class.ilObjectXMLWriter.php.

References $DIC, enabledOperations(), ilRbacReview\lookupCreateOperationIds(), and ilXmlWriter\xmlElement().

Referenced by getXML().

                                                                     : void
     {
         global $DIC;
 
         $ilAccess = $DIC['ilAccess'];
         $rbacreview = $DIC['rbacreview'];
         $objDefinition = $DIC['objDefinition'];
 
         if ($this->enabledOperations()) {
             $ops = $rbacreview->getOperationsOnTypeString($a_type);
             if (is_array($ops)) {
                 foreach ($ops as $ops_id) {
                     $operation = $rbacreview->getOperation($ops_id);
 
                     if (count($operation) && $ilAccess->checkAccessOfUser(
                         $this->getUserId(),
                         $operation['operation'],
                         'view',
                         $a_ref_id
                     )) {
                         $this->xmlElement('Operation', null, $operation['operation']);
                     }
                 }
             }
 
             $objects = $objDefinition->getCreatableSubObjects($a_type);
             $ops_ids = ilRbacReview::lookupCreateOperationIds(array_keys($objects));
             $creation_operations = array();
             foreach ($objects as $type => $info) {
                 $ops_id = $ops_ids[$type] ?? null;
 
                 if (!$ops_id) {
                     continue;
                 }
 
                 $operation = $rbacreview->getOperation($ops_id);
 
                 if (count($operation) && $ilAccess->checkAccessOfUser(
                     $this->getUserId(),
                     $operation['operation'],
                     'view',
                     $a_ref_id
                 )) {
                     $this->xmlElement('Operation', null, $operation['operation']);
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendPath()

ilObjectXMLWriter::appendPath ( int $refid )

private

Definition at line 327 of file class.ilObjectXMLWriter.php.

Referenced by getXML().

                                            : void
     {
         self::appendPathToObject($this, $refid);
     }

Here is the caller graph for this function:

◆ appendPathToObject()

static ilObjectXMLWriter::appendPathToObject	(	ilXmlWriter	$writer,
		int	$refid
	)

static

Definition at line 360 of file class.ilObjectXMLWriter.php.

References $DIC, $lng, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by ilSoapRoleObjectXMLWriter\start().

                                                                               : void
     {
         global $DIC;
 
         $tree = $DIC['tree'];
         $lng = $DIC['lng'];
         $items = $tree->getPathFull($refid);
         $writer->xmlStartTag("Path");
         foreach ($items as $item) {
             if ((int) $item["ref_id"] === $refid) {
                 continue;
             }
             if ($item["type"] === "root") {
                 $item["title"] = $lng->txt("repository");
             }
             $writer->xmlElement("Element", array("ref_id" => $item["ref_id"], "type" => $item["type"]), $item["title"]);
         }
         $writer->xmlEndTag("Path");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendTimeTargets()

ilObjectXMLWriter::appendTimeTargets ( int $a_ref_id )

private

Append time target settings for items inside of courses.

Parameters

int $ref_id Reference id of object

Returns: void

Definition at line 210 of file class.ilObjectXMLWriter.php.

References $DIC, ilObjectActivation\getItem(), ILIAS\Repository\int(), ilObjectActivation\TIMINGS_ACTIVATION, ilObjectActivation\TIMINGS_DEACTIVATED, ilObjectActivation\TIMINGS_PRESETTING, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by getXML().

                                                      : void
     {
         global $DIC;
 
         $tree = $DIC['tree'];
 
         if (!$tree->checkForParentType($a_ref_id, 'crs')) {
             return;
         }
         $time_targets = ilObjectActivation::getItem($a_ref_id);
 
         switch ($time_targets['timing_type']) {
             case ilObjectActivation::TIMINGS_ACTIVATION:
                 $type = self::TIMING_TEMPORARILY_AVAILABLE;
                 break;
             case ilObjectActivation::TIMINGS_PRESETTING:
                 $type = self::TIMING_PRESETTING;
                 break;
             case ilObjectActivation::TIMINGS_DEACTIVATED:
             default:
                 $type = self::TIMING_DEACTIVATED;
                 break;
         }
 
         $this->xmlStartTag('TimeTarget', array('type' => $type));
 
         $vis = (int) $time_targets['visible'] === 0 ? self::TIMING_VISIBILITY_OFF : self::TIMING_VISIBILITY_ON;
         $this->xmlElement(
             'Timing',
             array('starting_time' => $time_targets['timing_start'],
                   'ending_time' => $time_targets['timing_end'],
                   'visibility' => $vis
             )
         );
 
         $this->xmlElement(
             'Suggestion',
             array(
                 'starting_time' => $time_targets['suggestion_start'],
                 'ending_time' => $time_targets['suggestion_end'],
                 'changeable' => $time_targets['changeable']
             )
         );
         $this->xmlEndTag('TimeTarget');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildFooter()

ilObjectXMLWriter::buildFooter ( )

private

Definition at line 340 of file class.ilObjectXMLWriter.php.

References ilXmlWriter\xmlEndTag().

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildHeader()

ilObjectXMLWriter::buildHeader ( )

private

Definition at line 332 of file class.ilObjectXMLWriter.php.

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

Referenced by start().

                                   : void
     {
         $this->xmlSetDtdDef("<!DOCTYPE Objects PUBLIC \"-//ILIAS//DTD ILIAS Repositoryobjects//EN\" \"" . ILIAS_HTTP_PATH . "/components/ILIAS/Export/xml/ilias_object_4_0.dtd\">");
         $this->xmlSetGenCmt("Export of ILIAS objects");
         $this->xmlHeader();
         $this->xmlStartTag("Objects");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enabledOperations()

ilObjectXMLWriter::enabledOperations ( )

Definition at line 90 of file class.ilObjectXMLWriter.php.

References $enable_operations.

Referenced by appendOperations().

                                        : bool
     {
         return $this->enable_operations;
     }

Here is the caller graph for this function:

◆ enabledReferences()

ilObjectXMLWriter::enabledReferences ( )

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

References $enable_references.

Referenced by getXML().

                                        : bool
     {
         return $this->enable_references;
     }

Here is the caller graph for this function:

◆ enableOperations()

ilObjectXMLWriter::enableOperations ( bool $a_status )

Definition at line 85 of file class.ilObjectXMLWriter.php.

                                                     : void
     {
         $this->enable_operations = $a_status;
     }

◆ enablePermissionCheck()

ilObjectXMLWriter::enablePermissionCheck ( bool $a_status )

Definition at line 65 of file class.ilObjectXMLWriter.php.

                                                          : void
     {
         $this->check_permission = $a_status;
     }

◆ enableReferences()

ilObjectXMLWriter::enableReferences ( bool $a_stat )

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

                                                   : void
     {
         $this->enable_references = $a_stat;
     }

◆ getAccessInfo()

ilObjectXMLWriter::getAccessInfo	(	ilObject	$object,
		int	$ref_id
	)

private

Definition at line 345 of file class.ilObjectXMLWriter.php.

References $DIC, ilObject\getId(), ilObject\getType(), and getUserId().

Referenced by getXML().

                                                                  : string
     {
         global $DIC;
 
         $ilAccess = $DIC['ilAccess'];
 
         $ilAccess->checkAccessOfUser($this->getUserId(), 'read', 'view', $ref_id, $object->getType(), $object->getId());
 
         if (!$info = $ilAccess->getInfo()) {
             return 'granted';
         }
 
         return $info[0]['type'];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHighlighter()

ilObjectXMLWriter::getHighlighter ( )

Definition at line 60 of file class.ilObjectXMLWriter.php.

References $highlighter.

                                     : ?ilLuceneHighlighterResultParser
     {
         return $this->highlighter;
     }

◆ getMode()

ilObjectXMLWriter::getMode ( )

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

References $mode.

                              : int
     {
         return $this->mode;
     }

◆ getObjects()

ilObjectXMLWriter::getObjects ( )

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

References $objects.

Referenced by start().

                                 : array
     {
         return $this->objects;
     }

Here is the caller graph for this function:

◆ getUserId()

ilObjectXMLWriter::getUserId ( )

Definition at line 80 of file class.ilObjectXMLWriter.php.

References $user_id.

Referenced by getAccessInfo().

                                : int
     {
         return $this->user_id;
     }

Here is the caller graph for this function:

◆ getXML()

ilObjectXMLWriter::getXML ( )

Definition at line 141 of file class.ilObjectXMLWriter.php.

References $DIC, $id, $ref_id, ilObject\_getAllReferences(), appendObjectProperties(), appendOperations(), appendPath(), appendTimeTargets(), enabledReferences(), getAccessInfo(), ilObject\getCreateDate(), ilObject\getDescription(), ilObject\getId(), ilObject\getImportId(), ilObject\getLastUpdateDate(), ilObject\getOfflineStatus(), ilObject\getOwner(), ilObject\getRefId(), ilObject\getTitle(), ilObject\getType(), ILIAS\Repository\int(), ilXmlWriter\xmlDumpMem(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

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

Here is the call graph for this function:

◆ isPermissionCheckEnabled()

ilObjectXMLWriter::isPermissionCheckEnabled ( )

Definition at line 70 of file class.ilObjectXMLWriter.php.

References $check_permission.

Referenced by start().

                                               : bool
     {
         return $this->check_permission;
     }

Here is the caller graph for this function:

◆ setHighlighter()

ilObjectXMLWriter::setHighlighter ( ilLuceneHighlighterResultParser $a_highlighter )

Definition at line 55 of file class.ilObjectXMLWriter.php.

                                                                                   : void
     {
         $this->highlighter = $a_highlighter;
     }

◆ setMode()

ilObjectXMLWriter::setMode ( int $a_mode )

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

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

◆ setObjects()

ilObjectXMLWriter::setObjects ( array $objects )

Definition at line 105 of file class.ilObjectXMLWriter.php.

References $objects.

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

◆ setUserId()

ilObjectXMLWriter::setUserId ( int $a_id )

Definition at line 75 of file class.ilObjectXMLWriter.php.

                                         : void
     {
         $this->user_id = $a_id;
     }

◆ start()

ilObjectXMLWriter::start ( )

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

References $DIC, buildFooter(), buildHeader(), getObjects(), and isPermissionCheckEnabled().

                            : bool
     {
         global $DIC;
 
         $ilAccess = $DIC['ilAccess'];
         $objDefinition = $DIC['objDefinition'];
 
         $this->buildHeader();
         foreach ($this->getObjects() as $object) {
             if (method_exists($object, 'getType') &&
                 $this->isPermissionCheckEnabled() &&
                 $objDefinition->isRBACObject($object->getType()) &&
                 !$ilAccess->checkAccessOfUser(
                     $this->getUserId(),
                     'read',
                     '',
                     $object->getRefId()
                 )) {
                 continue;
             }
             $this->appendObject($object);
         }
         $this->buildFooter();
         return true;
     }