class.ilContainerXmlWriter.php

Go to the documentation of this file.

<?php

class ilContainerXmlWriter extends ilXmlWriter
{
    protected ilTree $tree;
    protected ?ilExportOptions $exp_options = null;
    private int $source = 0;
    protected ilObjectDefinition $objDefinition;

    public function __construct(int $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(): void
    {
        $this->xmlStartTag('Items');
        $this->writeSubitems($this->source);
        $this->xmlEndTag('Items');
    }

    protected function writeSubitems(int $a_ref_id): void
    {
        $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 || $mode == ilExportOptions::EXPORT_OMIT) {
                return;
            }
        }

        $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');
    }


    protected function writeCourseItemInformation(int $a_ref_id): void
    {
        $item = ilObjectActivation::getItem($a_ref_id);

        $this->xmlStartTag(
            'Timing',
            [
                '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', [], $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', [], $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', [], $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', [], $tmp_date->get(IL_CAL_DATETIME, '', ilTimeZone::UTC));
        }
        if ($item['earliest_start'] ?? false) {
            $tmp_date = new ilDateTime($item['earliest_start'], IL_CAL_UNIX);
            $this->xmlElement('EarliestStart', [], $tmp_date->get(IL_CAL_DATETIME, '', ilTimeZone::UTC));
        }

        $this->xmlEndTag('Timing');
    }

    protected function buildHeader(): void
    {
        $this->xmlSetGenCmt("Container object");
        $this->xmlHeader();
    }
}