class.ilObjectXMLParser.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2001 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | This program is distributed in the hope that it will be useful,             |
    | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
    | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/


include_once './Services/Xml/classes/class.ilSaxParser.php';
include_once('./webservice/soap/classes/class.ilObjectXMLException.php');

class ilObjectXMLParser extends ilSaxParser
{
    public $object_data = array();
    
    private $ref_id;
    private $parent_id;

    public function __construct($a_xml_data = '', $throwException = false)
    {
        parent::__construct('', $throwException);
        $this->setXMLContent($a_xml_data);
    }

    public function getObjectData()
    {
        return $this->object_data ? $this->object_data : array();
    }
    
    public function parse($a_xml_parser, $a_fp = null)
    {
        parent::parse($a_xml_parser, $a_fp);
    }
    

    public function setHandlers($a_xml_parser)
    {
        xml_set_object($a_xml_parser, $this);
        xml_set_element_handler($a_xml_parser, 'handlerBeginTag', 'handlerEndTag');
        xml_set_character_data_handler($a_xml_parser, 'handlerCharacterData');
    }

    


    public function handlerBeginTag($a_xml_parser, $a_name, $a_attribs)
    {
        switch ($a_name) {
            case 'Objects':
                $this->curr_obj = -1;
                break;

            case 'Object':
                ++$this->curr_obj;
                
                $this->__addProperty('type', $a_attribs['type']);
                $this->__addProperty('obj_id', is_numeric($a_attribs['obj_id'])?(int) $a_attribs["obj_id"] :  ilUtil::__extractId($a_attribs["obj_id"], IL_INST_ID));
                break;

            case 'Title':
                break;

            case 'Description':
                break;

            case 'Owner':
                break;

            case 'CreateDate':
                break;

            case 'LastUpdate':
                break;
                
            case 'ImportId':
                break;

            case 'References':
                $this->time_target = array();
                $this->ref_id = $a_attribs["ref_id"];
                $this->parent_id = $a_attribs['parent_id'];
                break;
                
            case 'TimeTarget':
                $this->time_target['timing_type'] = $a_attribs['type'];
                break;
            
            case 'Timing':
                $this->time_target['timing_visibility'] = $a_attribs['visibility'];
                if (isset($a_attribs['starting_time'])) {
                    $this->time_target['starting_time'] = $a_attribs['starting_time'];
                }
                if (isset($a_attribs['ending_time'])) {
                    $this->time_target['ending_time'] = $a_attribs['ending_time'];
                }
                    
                if ($a_attribs['ending_time'] < $a_attribs['starting_time']) {
                    throw new ilObjectXMLException('Starting time must be earlier than ending time.');
                }
                break;
                
            case 'Suggestion':
                $this->time_target['changeable'] = $a_attribs['changeable'];
                
                
                if (isset($a_attribs['starting_time'])) {
                    $this->time_target['suggestion_start'] = $a_attribs['starting_time'];
                }
                if (isset($a_attribs['ending_time'])) {
                    $this->time_target['suggestion_end'] = $a_attribs['ending_time'];
                }
                if (isset($a_attribs['earliest_start'])) {
                    $this->time_target['earliest_start'] = $a_attribs['earliest_start'];
                }
                if (isset($a_attribs['latest_end'])) {
                    $this->time_target['latest_end'] = $a_attribs['latest_end'];
                }

                if ($a_attribs['latest_end'] < $a_attribs['earliest_start']) {
                    throw new ilObjectXMLException('Earliest start time must be earlier than latest ending time.');
                }
                if ($a_attribs['ending_time'] < $a_attribs['starting_time']) {
                    throw new ilObjectXMLException('Starting time must be earlier than ending time.');
                }
                break;
                
        }
    }

    public function handlerEndTag($a_xml_parser, $a_name)
    {
        switch ($a_name) {
            case 'Objects':
                break;

            case 'Object':
                break;

            case 'Title':
                $this->__addProperty('title', trim($this->cdata));
                break;

            case 'Description':
                $this->__addProperty('description', trim($this->cdata));
                break;

            case 'Owner':
                $this->__addProperty('owner', trim($this->cdata));
                break;

            case 'CreateDate':
                $this->__addProperty('create_date', trim($this->cdata));
                break;

            case 'LastUpdate':
                $this->__addProperty('last_update', trim($this->cdata));
                break;
                
            case 'ImportId':
                $this->__addProperty('import_id', trim($this->cdata));
                break;

            case 'References':
                $this->__addReference($this->ref_id, $this->parent_id, $this->time_target);
                break;
        }

        $this->cdata = '';

        return;
    }

    public function handlerCharacterData($a_xml_parser, $a_data)
    {
        if ($a_data != "\n") {
            // Replace multiple tabs with one space
            $a_data = preg_replace("/\t+/", " ", $a_data);

            $this->cdata .= $a_data;
        }
    }

    // PRIVATE
    public function __addProperty($a_name, $a_value)
    {
        $this->object_data[$this->curr_obj][$a_name] = $a_value;
    }

    public function __addReference($a_ref_id, $a_parent_id, $a_time_target)
    {
        $reference['ref_id'] = $a_ref_id;
        $reference['parent_id'] = $a_parent_id;
        $reference['time_target'] = $a_time_target;

        if (isset($reference['time_target']['changeable']) and $reference['time_target']['changeable']) {
            if (!isset($reference['time_target']['earliest_start']) or !isset($reference['time_target']['latest_end'])) {
                throw new ilObjectXMLException('Missing attributes: "earliest_start" and "latest_end" required for attribute "changeable"');
            }
            if (!isset($reference['time_target']['suggestion_start']) or !isset($reference['time_target']['suggestion_end'])) {
                throw new ilObjectXMLException('Missing attributes: "starting_time" and "ending_time" required for attribute "changeable"');
            }
            if (($reference['time_target']['earliest_start'] < $reference['time_target']['suggestion_start']) or
                ($reference['time_target']['earliest_start'] > $reference['time_target']['suggestion_end'])) {
                throw new ilObjectXMLException('Invalid attributes: "earliest_start" must be within "starting_time" and "ending_time"');
            }
            if (($reference['time_target']['latest_end'] < $reference['time_target']['suggestion_start']) or
                ($reference['time_target']['latest_end'] > $reference['time_target']['suggestion_end'])) {
                throw new ilObjectXMLException('Invalid attributes: "latest_end" must be within "starting_time" and "ending_time"');
            }
        }
        
        $this->object_data[$this->curr_obj]['references'][] = $reference;
    }
}