class.ilContainerXmlWriter.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once "./Services/Xml/classes/class.ilXmlWriter.php";
include_once './Services/Export/classes/class.ilExportOptions.php';

class ilContainerXmlWriter extends ilXmlWriter
{
    protected $tree;

    protected $exp_options = null;
    private $source = 0;

    protected $objDefinition;

    public function __construct($a_ref_id)
    {
        global $DIC;

        $this->tree = $DIC->repositoryTree();
        parent::__construct();
        $this->source = $a_ref_id;
        $this->exp_options = ilExportOptions::getInstance();
        $this->objDefinition = $DIC['objDefinition'];
    }
    
    public function write()
    {
        $this->xmlStartTag('Items');
        $this->writeSubitems($this->source);
        $this->xmlEndTag('Items');
    }
    
    protected function writeSubitems($a_ref_id)
    {
        $tree = $this->tree;
    
        // because of the co-page-stuff (incl. styles) we also need to process the container itself
        if ($a_ref_id != $this->source) {
            $mode = $this->exp_options->getOptionByRefId($a_ref_id, ilExportOptions::KEY_ITEM_MODE);
            if ($mode == null or $mode == ilExportOptions::EXPORT_OMIT) {
                return false;
            }
        }

        $obj_id = ilObject::_lookupObjId($a_ref_id);

        $atts = [];
        $atts['RefId'] = $a_ref_id;
        $atts['Id'] = $obj_id;
        $atts['Title'] = ilObject::_lookupTitle($obj_id);
        $atts['Type'] = ilObject::_lookupType($obj_id);
        $atts['Page'] = ilContainerPage::_exists('cont', $obj_id);
        $atts['StartPage'] = ilContainerStartObjectsPage::_exists('cstr', $obj_id);
        $atts['Style'] = ilObjStyleSheet::lookupObjectStyle($obj_id);
        if ($this->objDefinition->supportsOfflineHandling($atts['Type'])) {
            $atts['Offline'] = ilObject::lookupOfflineStatus($obj_id) ? '1' : '0';
        }
        $this->xmlStartTag(
            'Item',
            $atts
        );
        $this->writeCourseItemInformation($a_ref_id);
        
        foreach ($tree->getChilds($a_ref_id) as $node) {
            $this->writeSubitems($node['child']);
        }
        
        $this->xmlEndTag('Item');
        return true;
    }
    
    
    protected function writeCourseItemInformation($a_ref_id)
    {
        include_once './Services/Object/classes/class.ilObjectActivation.php';
        $item = ilObjectActivation::getItem($a_ref_id);
        
        $this->xmlStartTag(
            'Timing',
            array(
                'Type' => $item['timing_type'],
                'Visible' => $item['visible'],
                'Changeable' => $item['changeable'],
                )
        );
        if ($item['timing_start']) {
            $tmp_date = new ilDateTime($item['timing_start'], IL_CAL_UNIX);
            $this->xmlElement('Start', array(), $tmp_date->get(IL_CAL_DATETIME, '', ilTimeZone::UTC));
        }
        if ($item['timing_end']) {
            $tmp_date = new ilDateTime($item['timing_end'], IL_CAL_UNIX);
            $this->xmlElement('End', array(), $tmp_date->get(IL_CAL_DATETIME, '', ilTimeZone::UTC));
        }
        if ($item['suggestion_start']) {
            $tmp_date = new ilDateTime($item['suggestion_start'], IL_CAL_UNIX);
            $this->xmlElement('SuggestionStart', array(), $tmp_date->get(IL_CAL_DATETIME, '', ilTimeZone::UTC));
        }
        if ($item['suggestion_end']) {
            $tmp_date = new ilDateTime($item['suggestion_end'], IL_CAL_UNIX);
            $this->xmlElement('SuggestionEnd', array(), $tmp_date->get(IL_CAL_DATETIME, '', ilTimeZone::UTC));
        }
        if ($item['earliest_start']) {
            $tmp_date = new ilDateTime($item['earliest_start'], IL_CAL_UNIX);
            $this->xmlElement('EarliestStart', array(), $tmp_date->get(IL_CAL_DATETIME, '', ilTimeZone::UTC));
        }

        $this->xmlEndTag('Timing');
    }
    
    protected function buildHeader()
    {
        $this->xmlSetDtdDef("<!DOCTYPE Container PUBLIC \"-//ILIAS//DTD Container//EN\" \"" . ILIAS_HTTP_PATH . "/xml/ilias_container_4_1.dtd\">");
        $this->xmlSetGenCmt("Container object");
        $this->xmlHeader();

        return true;
    }
}