XML writer class. More...

Inheritance diagram for ilObjectXMLWriter:

Collaboration diagram for ilObjectXMLWriter:

Public Member Functions
	__construct ()
	constructor More...

	setMode ($a_mode)

	setHighlighter ($a_highlighter)

	enablePermissionCheck ($a_status)

	isPermissionCheckEnabled ()

	setUserId ($a_id)

	getUserId ()

	enableOperations ($a_status)

	enabledOperations ()

	enableReferences ($a_stat)

	enabledReferences ()

	setObjects ($objects)

	__getObjects ()

	start ()

	getXML ()

	__appendObject (&$object)

	__appendTimeTargets ($a_ref_id)
	Append time target settings for items inside of courses. More...

	__appendObjectProperties (ilObject $obj)
	Append object properties. More...

	__appendOperations ($a_ref_id, $a_type)

	__appendPath ($refid)

	__buildHeader ()

	__buildFooter ()

	__getAccessInfo (&$object, $ref_id)

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

	_ilXmlWriter ()
	destructor @access 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 @access 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 @access public More...

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

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

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

	$ilias

	$xml

	$enable_operations = false

	$objects = array()

	$user_id = 0

Data Fields inherited from ilXmlWriter
	$xmlStr

	$version

	$outEnc

	$inEnc

	$dtdDef = ""

	$stSheet = ""

	$genCmt = "Generated by ILIAS XmlWriter"

Protected Attributes
	$check_permission = false

Private Attributes
	$mode = 0

	$highlighter = null

	$enable_references = 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 19 of file class.ilObjectXMLWriter.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectXMLWriter::__construct ( )

constructor

Parameters

string	xml version
string	output encoding
string	input encoding @access public

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

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

References $ilias, and $ilUser.

Member Function Documentation

◆ __appendObject()

ilObjectXMLWriter::__appendObject ( & $object )

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

    {
        global $tree, $rbacreview;
 
        $id = $object->getId();
        if ($object->getType() == "role" && $rbacreview->isRoleDeleted($id)) {
            return;
        }
      
        $attrs = array('type' => $object->getType(),
                   'obj_id' => $id);
 
        $this->xmlStartTag('Object', $attrs);
        //$this->xmlElement('Title',null,$object->getTitle());
        //$this->xmlElement('Description',null,$object->getDescription());
 
        // begin-patch fm
        if ($this->mode == self::MODE_SEARCH_RESULT) {
            $title = $object->getTitle();
            if ($this->highlighter->getTitle($object->getId(), 0)) {
                $title = $this->highlighter->getTitle($object->getId(), 0);
            }
            $description = $object->getDescription();
            if ($this->highlighter->getDescription($object->getId(), 0)) {
                $description = $this->highlighter->getDescription($object->getId(), 0);
            }
 
            // Currently disabled
            #$this->xmlElement('Title', null, $title);
            #$this->xmlElement('Description',null,$description);
            #$this->xmlElement('SearchResultContent', null, $this->highlighter->getContent($object->getId(),0));
 
            $this->xmlElement('Title', null, $object->getTitle());
            $this->xmlElement('Description', null, $object->getDescription());
        } else {
            $this->xmlElement('Title', null, $object->getTitle());
            $this->xmlElement('Description', null, $object->getDescription());
        }
        // end-patch fm
 
        $this->xmlElement('Owner', null, $object->getOwner());
        $this->xmlElement('CreateDate', null, $object->getCreateDate());
        $this->xmlElement('LastUpdate', null, $object->getLastUpdateDate());
        $this->xmlElement('ImportId', null, $object->getImportId());
 
        $this->__appendObjectProperties($object);
 
        // begin-patch filemanager
        if ($this->enabledReferences()) {
            $refs = ilObject::_getAllReferences($object->getId());
        } else {
            $refs = array($object->getRefId());
        }
 
        foreach ($refs as $ref_id) {
            // end-patch filemanager
            if (!$tree->isInTree($ref_id)) {
                continue;
            }
            
            $attr = array('ref_id' => $ref_id, 'parent_id'=> $tree->getParentId(intval($ref_id)));
            $attr['accessInfo'] = $this->__getAccessInfo($object, $ref_id);
            $this->xmlStartTag('References', $attr);
            $this->__appendTimeTargets($ref_id);
            $this->__appendOperations($ref_id, $object->getType());
            $this->__appendPath($ref_id);
            $this->xmlEndTag('References');
        }
        $this->xmlEndTag('Object');
    }

References $description, $id, $title, __appendObjectProperties(), __appendOperations(), __appendPath(), __appendTimeTargets(), __getAccessInfo(), ilObject\_getAllReferences(), enabledReferences(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __appendObjectProperties()

ilObjectXMLWriter::__appendObjectProperties ( ilObject $obj )

Append object properties.

Parameters

ilObject $obj

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

    {
        switch ($obj->getType()) {
 
            case 'file':
                include_once './Modules/File/classes/class.ilObjFileAccess.php';
                $size = ilObjFileAccess::_lookupFileSize($obj->getId());
                $extension = ilObjFileAccess::_lookupSuffix($obj->getId());
                $this->xmlStartTag('Properties');
                $this->xmlElement("Property", array('name' => 'fileSize'), (int) $size);
                $this->xmlElement("Property", array('name' => 'fileExtension'), (string) $extension);
                // begin-patch fm
                $this->xmlElement('Property', array('name' => 'fileVersion'), (string) ilObjFileAccess::_lookupVersion($obj->getId()));
                // end-patch fm
                $this->xmlEndTag('Properties');
                break;
        }
    }

References $size, ilObjFileAccess\_lookupFileSize(), ilObjFileAccess\_lookupSuffix(), ilObjFileAccess\_lookupVersion(), ilObject\getId(), ilObject\getType(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by __appendObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __appendOperations()

ilObjectXMLWriter::__appendOperations	(	$a_ref_id,
		$a_type
	)

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

    {
        global $ilAccess,$rbacreview,$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']);
                    }
                }
            }
 
            // Create operations
            // Get creatable objects
            $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];
 
                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']);
                }
            }
        }
        return true;
    }

References $a_type, $info, $objects, $type, enabledOperations(), ilRbacReview\lookupCreateOperationIds(), and ilXmlWriter\xmlElement().

Referenced by __appendObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __appendPath()

ilObjectXMLWriter::__appendPath ( $refid )

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

    {
        ilObjectXMLWriter::appendPathToObject($this, $refid);
    }

References appendPathToObject().

Referenced by __appendObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __appendTimeTargets()

ilObjectXMLWriter::__appendTimeTargets ( $a_ref_id )

Append time target settings for items inside of courses.

Parameters

int $ref_id Reference id of object

Returns: void

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

    {
        global $tree;
        
        if (!$tree->checkForParentType($a_ref_id, 'crs')) {
            return;
        }
        include_once('./Services/Object/classes/class.ilObjectActivation.php');
        $time_targets = ilObjectActivation::getItem($a_ref_id);
        
        switch ($time_targets['timing_type']) {
            case ilObjectActivation::TIMINGS_DEACTIVATED:
                $type = self::TIMING_DEACTIVATED;
                break;
            case ilObjectActivation::TIMINGS_ACTIVATION:
                $type = self::TIMING_TEMPORARILY_AVAILABLE;
                break;
            case ilObjectActivation::TIMINGS_PRESETTING:
                $type = self::TIMING_PRESETTING;
                break;
            default:
                $type = self::TIMING_DEACTIVATED;
                break;
        }
        
        $this->xmlStartTag('TimeTarget', array('type' => $type));
        
        #               if($type == self::TIMING_TEMPORARILY_AVAILABLE)
        {
            $vis = $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)
            );
                
        }
        #               if($type == self::TIMING_PRESETTING)
        {
            if ($time_targets['changeable'] or 1) {
                $this->xmlElement(
                    'Suggestion',
                    array('starting_time' => $time_targets['suggestion_start'],
                        'ending_time' => $time_targets['suggestion_end'],
                        'changeable' => $time_targets['changeable'],
                        'earliest_start' => $time_targets['earliest_start'],
                        'latest_end' => $time_targets['latest_end'])
                );
            } else {
                $this->xmlElement(
                    'Suggestion',
                    array('starting_time' => $time_targets['suggestion_start'],
                        'ending_time' => $time_targets['suggestion_end'],
                        'changeable' => $time_targets['changeable'])
                );
            }
        }
        $this->xmlEndTag('TimeTarget');
        return;
    }

References $type, ilObjectActivation\getItem(), TIMING_DEACTIVATED, TIMING_PRESETTING, TIMING_TEMPORARILY_AVAILABLE, TIMING_VISIBILITY_OFF, TIMING_VISIBILITY_ON, ilObjectActivation\TIMINGS_ACTIVATION, ilObjectActivation\TIMINGS_DEACTIVATED, ilObjectActivation\TIMINGS_PRESETTING, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by __appendObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildFooter()

ilObjectXMLWriter::__buildFooter ( )

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

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

References ilXmlWriter\xmlEndTag().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildHeader()

ilObjectXMLWriter::__buildHeader ( )

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

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

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

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __getAccessInfo()

ilObjectXMLWriter::__getAccessInfo	(	&	$object,
			$ref_id
	)

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

    {
        global $ilAccess;
 
        include_once 'Services/AccessControl/classes/class.ilAccess.php';
 
        $ilAccess->checkAccessOfUser($this->getUserId(), 'read', 'view', $ref_id, $object->getType(), $object->getId());
 
        if (!$info = $ilAccess->getInfo()) {
            return 'granted';
        } else {
            return $info[0]['type'];
        }
    }

References $info, and getUserId().

Referenced by __appendObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __getObjects()

ilObjectXMLWriter::__getObjects ( )

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

    {
        return $this->objects ? $this->objects : array();
    }

Referenced by start().

Here is the caller graph for this function:

◆ appendPathToObject()

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

static

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

    {
        global $tree, $lng;
        $items = $tree->getPathFull($refid);
        $writer->xmlStartTag("Path");
        foreach ($items as $item) {
            if ($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");
    }

References $lng.

Referenced by __appendPath(), and ilSoapRoleObjectXMLWriter\start().

Here is the caller graph for this function:

◆ enabledOperations()

ilObjectXMLWriter::enabledOperations ( )

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

    {
        return $this->enable_operations;
    }

References $enable_operations.

Referenced by __appendOperations().

Here is the caller graph for this function:

◆ enabledReferences()

ilObjectXMLWriter::enabledReferences ( )

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

    {
        return $this->enable_references;
    }

References $enable_references.

Referenced by __appendObject().

Here is the caller graph for this function:

◆ enableOperations()

ilObjectXMLWriter::enableOperations ( $a_status )

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

    {
        $this->enable_operations = $a_status;
 
        return true;
    }

◆ enablePermissionCheck()

ilObjectXMLWriter::enablePermissionCheck ( $a_status )

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

    {
        $this->check_permission = $a_status;
    }

◆ enableReferences()

ilObjectXMLWriter::enableReferences ( $a_stat )

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

    {
        $this->enable_references = $a_stat;
    }

◆ getUserId()

ilObjectXMLWriter::getUserId ( )

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

    {
        return $this->user_id;
    }

References $user_id.

Referenced by __getAccessInfo().

Here is the caller graph for this function:

◆ getXML()

ilObjectXMLWriter::getXML ( )

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

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

References ilXmlWriter\xmlDumpMem().

Here is the call graph for this function:

◆ isPermissionCheckEnabled()

ilObjectXMLWriter::isPermissionCheckEnabled ( )

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

    {
        return $this->check_permission;
    }

References $check_permission.

Referenced by start().

Here is the caller graph for this function:

◆ setHighlighter()

ilObjectXMLWriter::setHighlighter ( $a_highlighter )

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

    {
        $this->highlighter = $a_highlighter;
    }

◆ setMode()

ilObjectXMLWriter::setMode ( $a_mode )

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

    {
        $this->mode = $a_mode;
    }

◆ setObjects()

ilObjectXMLWriter::setObjects ( $objects )

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

    {
        $this->objects = $objects;
    }

References $objects.

◆ setUserId()

ilObjectXMLWriter::setUserId ( $a_id )

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

    {
        $this->user_id = $a_id;
    }

◆ start()

ilObjectXMLWriter::start ( )

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

    {
        global $ilAccess,$objDefinition;
        
        $this->__buildHeader();
 
        foreach ($this->__getObjects() as $object) {
            if (method_exists($object, 'getType') and $objDefinition->isRBACObject($object->getType())) {
                if ($this->isPermissionCheckEnabled() and !$ilAccess->checkAccessOfUser($this->getUserId(), 'read', '', $object->getRefId())) {
                    continue;
                }
            }
            $this->__appendObject($object);
        }
        $this->__buildFooter();
 
        return true;
    }