SAX based XML parser for record import files. More...

Inheritance diagram for ilAdvancedMDRecordParser:

Collaboration diagram for ilAdvancedMDRecordParser:

Public Member Functions
	__construct ($a_file)
	Constructor. More...

	setMode ($a_mode)
	set parsing mode More...

	getMode ()
	get mode More...

	startParsing ()
	stores xml data in array More...

	setHandlers ($a_xml_parser)
	set event handlers More...

	setContext ($a_obj_id, $a_obj_type, $a_sub_type=null)

	getRecordMap ()

Public Member Functions inherited from ilSaxParser
	__construct ($a_xml_file='', $throwException=false)
	Constructor setup ILIAS global object @access public. More...

	setXMLContent ($a_xml_content)

	getXMLContent ()

	getInputType ()

	startParsing ()
	stores xml data in array More...

	createParser ()
	create parser More...

	setOptions ($a_xml_parser)
	set parser options More...

	setHandlers ($a_xml_parser)
	set event handler should be overwritten by inherited class @access private More...

	openXMLFile ()
	open xml file More...

	parse ($a_xml_parser, $a_fp=null)
	parse xml file More...

	freeParser ($a_xml_parser)
	free xml parser handle More...

	setThrowException ($throwException)
	set error handling More...

Public Member Functions inherited from PEAR
	__construct ($error_class=null)
	Constructor. More...

	_PEAR ()
	Destructor (the emulated type of...). More...

	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes. More...

	isError ($data, $code=null)
	Tell whether a value is a PEAR error. More...

	expectError ($code=' *')
	This method is used to tell which errors you expect to get. More...

	popExpect ()
	This method pops one element off the expected error codes stack. More...

	_checkDelExpect ($error_code)
	This method checks unsets an error code if available. More...

	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack. More...

&	raiseError ($message=null, $code=null, $mode=null, $options=null, $userinfo=null, $error_class=null, $skipmsg=false)
	This method is a wrapper that returns an instance of the configured error class with this object's default error handling applied. More...

&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options. More...

	staticPushErrorHandling ($mode, $options=null)

	staticPopErrorHandling ()

	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack. More...

	popErrorHandling ()
	Pop the last error handler used. More...

	loadExtension ($ext)
	OS independant PHP extension load. More...

Data Fields
const	MODE_UPDATE = 1

const	MODE_INSERT = 2

const	MODE_UPDATE_VALIDATION = 3

const	MODE_INSERT_VALIDATION = 4

Data Fields inherited from ilSaxParser
	$input_type = null

	$xml_content = ''

	$ilias

	$lng

	$xml_file

	$throwException = false

Data Fields inherited from PEAR
	$_debug = false

	$_default_error_mode = null

	$_default_error_options = null

	$_default_error_handler = ''

	$_error_class = 'PEAR_Error'

	$_expected_errors = array()

Protected Member Functions
	handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
	Handler for start tags. More...

	handlerEndTag ($a_xml_parser, $a_name)
	Handler for end tags. More...

	handlerCharacterData ($a_xml_parser, $a_data)
	handler for character data More...

Protected Member Functions inherited from ilSaxParser
	handleError ($message, $code)
	use given error handler to handle error message or internal ilias error message handle More...

Protected Attributes
	$context

	$scopes = []

	$log

Private Member Functions
	initRecordObject ($a_id)
	Init record object. More...

	initFieldObject ($a_id, $a_type)
	Init field definition object. More...

	getCurrentRecord ()
	get current record More...

	getCurrentField ()
	get current field definition @access private More...

	extractRecordId ($a_id_string)
	Extract id. More...

	appendErrorMessage ($a_msg)
	@access private More...

	storeRecords ()
	Store Record. More...

Private Attributes
	$mode

	$fields = array()

	$is_error = false

	$error_msg = array()

Additional Inherited Members
Static Public Member Functions inherited from PEAR
static &	getStaticProperty ($class, $var)
	If you have a class that's mostly/entirely static, and you need static properties, you can use this method to simulate them. More...

static	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled. More...

Detailed Description

SAX based XML parser for record import files.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

Definition at line 37 of file class.ilAdvancedMDRecordParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilAdvancedMDRecordParser::__construct ( $a_file )

Constructor.

@access public

Parameters

string xml file

Reimplemented from PEAR.

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

    {
        parent::__construct($a_file, true);
        $this->log = ilLoggerFactory::getLogger('amet');
    }

References ilLoggerFactory\getLogger().

Here is the call graph for this function:

Member Function Documentation

◆ appendErrorMessage()

ilAdvancedMDRecordParser::appendErrorMessage ( $a_msg )

private

@access private

Parameters

Definition at line 362 of file class.ilAdvancedMDRecordParser.php.

    {
        $this->is_error = true;
        $this->error_msg[] = $a_msg;
    }

Referenced by handlerBeginTag().

Here is the caller graph for this function:

◆ extractRecordId()

ilAdvancedMDRecordParser::extractRecordId ( $a_id_string )

private

Extract id.

@access private

Parameters

Definition at line 343 of file class.ilAdvancedMDRecordParser.php.

    {
        // first lookup import id
        if ($record_id = ilAdvancedMDRecord::_lookupRecordIdByImportId($a_id_string)) {
            $this->record_exists = true;
            return $record_id;
        }
        return 0;
    }

References ilAdvancedMDRecord\_lookupRecordIdByImportId().

Referenced by initRecordObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentField()

ilAdvancedMDRecordParser::getCurrentField ( )

private

get current field definition @access private

Definition at line 331 of file class.ilAdvancedMDRecordParser.php.

    {
        return $this->current_field;
    }

Referenced by handlerBeginTag(), and handlerEndTag().

Here is the caller graph for this function:

◆ getCurrentRecord()

ilAdvancedMDRecordParser::getCurrentRecord ( )

private

get current record

@access private

Definition at line 321 of file class.ilAdvancedMDRecordParser.php.

    {
        return $this->current_record;
    }

Referenced by handlerBeginTag(), handlerEndTag(), and storeRecords().

Here is the caller graph for this function:

◆ getMode()

ilAdvancedMDRecordParser::getMode ( )

get mode

@access public

Definition at line 91 of file class.ilAdvancedMDRecordParser.php.

    {
        return $this->mode;
    }

References $mode.

Referenced by initFieldObject(), initRecordObject(), and storeRecords().

Here is the caller graph for this function:

◆ getRecordMap()

ilAdvancedMDRecordParser::getRecordMap ( )

Definition at line 425 of file class.ilAdvancedMDRecordParser.php.

    {
        return $this->rec_map;
    }

◆ handlerBeginTag()

ilAdvancedMDRecordParser::handlerBeginTag	(	$a_xml_parser,
		$a_name,
		$a_attribs
	)

protected

Handler for start tags.

@access protected

Definition at line 131 of file class.ilAdvancedMDRecordParser.php.

    {
        switch ($a_name) {
            case 'AdvancedMetaDataRecords':
                $this->is_error = false;
                $this->error_msg = array();
                // Nothing to do
                break;
            
            case 'Scope':
                $this->scopes = [];
                break;
            
            case 'ScopeEntry':
                $parsed_id = ilUtil::parseImportId($a_attribs['id']);
                if (
                    $parsed_id['inst_id'] == IL_INST_ID &&
                    ilObject::_exists($parsed_id['id'], true, $parsed_id['type'])
                ) {
                    $scope = new ilAdvancedMDRecordScope();
                    $scope->setRefId($parsed_id['id']);
                    $this->scopes[] = $scope;
                }
                break;
                
            
            case 'Record':
                $this->fields = array();
                $this->current_field = null;
                $this->current_record = null;
                if (!strlen($a_attribs['id']) or !isset($a_attribs['active'])) {
                    $this->appendErrorMessage('Missing XML attribute for element "Record".');
                }
                if (!$this->initRecordObject($a_attribs['id'])) {
                    $this->appendErrorMessage('Invalid attribute Id given for element "Record".');
                }
                $this->getCurrentRecord()->setActive($a_attribs['active']);
                $this->getCurrentRecord()->setImportId($a_attribs['id']);
                $this->getCurrentRecord()->setAssignedObjectTypes(array());
                break;
                
            case 'Title':
                break;
 
            case 'Field':
                if (!strlen($a_attribs['id']) or !isset($a_attribs['searchable']) or !isset($a_attribs['fieldType'])) {
                    $this->appendErrorMessage('Missing XML attribute for element "Field".');
                }
                if (!$this->initFieldObject($a_attribs['id'], $a_attribs['fieldType'])) {
                    $this->appendErrorMessage('Invalid attribute Id given for element "Record".');
                }
                $this->getCurrentField()->setImportId($a_attribs['id']);
                $this->getCurrentField()->setSearchable($a_attribs['searchable'] == 'Yes' ? true : false);
                break;
                
            case 'FieldTitle':
            case 'FieldDescription':
            case 'FieldPosition':
            case 'FieldValue':
                $this->field_value_id = $a_attribs['id'];
                break;
        }
    }

References ilObject\_exists(), appendErrorMessage(), fields, getCurrentField(), getCurrentRecord(), initFieldObject(), initRecordObject(), and ilUtil\parseImportId().

Here is the call graph for this function:

◆ handlerCharacterData()

ilAdvancedMDRecordParser::handlerCharacterData	(	$a_xml_parser,
		$a_data
	)

protected

handler for character data

Parameters

resource	$a_xml_parser	xml parser
string	$a_data	character data

Definition at line 257 of file class.ilAdvancedMDRecordParser.php.

    {
        if ($a_data != "\n") {
            // Replace multiple tabs with one space
            $a_data = preg_replace("/\t+/", " ", $a_data);
 
            $this->cdata .= $a_data;
        }
    }

◆ handlerEndTag()

ilAdvancedMDRecordParser::handlerEndTag	(	$a_xml_parser,
		$a_name
	)

protected

Handler for end tags.

@access protected

Definition at line 200 of file class.ilAdvancedMDRecordParser.php.

    {
        switch ($a_name) {
            case 'AdvancedMetaDataRecords':
                break;
                
            case 'Record':
                $this->storeRecords();
                break;
            
            case 'Scope':
                $this->getCurrentRecord()->setScopes($this->scopes);
                break;
                
            case 'Title':
                $this->getCurrentRecord()->setTitle(trim($this->cdata));
                break;
                
            case 'Description':
                $this->getCurrentRecord()->setDescription(trim($this->cdata));
                break;
                
            case 'ObjectType':
                // #12980
                $parts = explode(":", trim($this->cdata));
                $this->getCurrentRecord()->appendAssignedObjectType($parts[0], $parts[1]);
                break;
                
            case 'Field':
                break;
            
                
            case 'FieldTitle':
                $this->getCurrentField()->setTitle(trim($this->cdata));
                break;
            
            case 'FieldDescription':
                $this->getCurrentField()->setDescription(trim($this->cdata));
                break;
                
            case 'FieldPosition':
                $this->getCurrentField()->setPosition((int) trim($this->cdata));
                break;
                
            case 'FieldValue':
                $this->getCurrentField()->importXMLProperty($this->field_value_id, trim($this->cdata));
                break;
        }
        $this->cdata = '';
    }

References getCurrentField(), getCurrentRecord(), and storeRecords().

Here is the call graph for this function:

◆ initFieldObject()

ilAdvancedMDRecordParser::initFieldObject	(	$a_id,
		$a_type
	)

private

Init field definition object.

@access private

Parameters

string import id

Definition at line 296 of file class.ilAdvancedMDRecordParser.php.

    {
        switch ($this->getMode()) {
            case self::MODE_INSERT:
            case self::MODE_INSERT_VALIDATION:
                $this->current_field = ilAdvancedMDFieldDefinition::getInstanceByTypeString($a_type);
                $this->fields[] = $this->current_field;
                return true;
            
            default:
                // ??? nonsense
                $this->current_field = ilAdvancedMDRecord::_getInstanceByFieldId($this->extractFieldId($a_id));
                return true;
                break;
        }
    }

References $a_type, fields, ilAdvancedMDFieldDefinition\getInstanceByTypeString(), getMode(), MODE_INSERT, and MODE_INSERT_VALIDATION.

Referenced by handlerBeginTag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initRecordObject()

ilAdvancedMDRecordParser::initRecordObject ( $a_id )

private

Init record object.

Parameters

string import id @access private

Definition at line 274 of file class.ilAdvancedMDRecordParser.php.

    {
        switch ($this->getMode()) {
            case self::MODE_INSERT:
            case self::MODE_INSERT_VALIDATION:
                $this->current_record = new ilAdvancedMDRecord(0);
                return true;
            
            default:
                $this->current_record = ilAdvancedMDRecord::_getInstanceByRecordId($this->extractRecordId($a_id));
                return true;
                break;
        }
    }

References ilAdvancedMDRecord\_getInstanceByRecordId(), extractRecordId(), getMode(), MODE_INSERT, and MODE_INSERT_VALIDATION.

Referenced by handlerBeginTag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setContext()

ilAdvancedMDRecordParser::setContext	(	$a_obj_id,
		$a_obj_type,
		$a_sub_type = `null`
	)

Definition at line 412 of file class.ilAdvancedMDRecordParser.php.

    {
        if (!$a_sub_type) {
            $a_sub_type = "-";
        }
        
        $this->context = array(
            "obj_id" => $a_obj_id,
            "obj_type" => $a_obj_type,
            "sub_type" => $a_sub_type
        );
    }

◆ setHandlers()

ilAdvancedMDRecordParser::setHandlers ( $a_xml_parser )

set event handlers

Parameters

resource reference to the xml parser @access private

Reimplemented from ilSaxParser.

Definition at line 119 of file class.ilAdvancedMDRecordParser.php.

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

◆ setMode()

ilAdvancedMDRecordParser::setMode ( $a_mode )

set parsing mode

@access public

Parameters

int	MODE_VALIDATION, MODE_UPDATE or MODE_INSERT

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

    {
        $this->mode = $a_mode;
    }

◆ startParsing()

ilAdvancedMDRecordParser::startParsing ( )

stores xml data in array

Returns: bool success status @access private

Exceptions

ilSaxParserException

Reimplemented from ilSaxParser.

Definition at line 104 of file class.ilAdvancedMDRecordParser.php.

    {
        parent::startParsing();
        if ($this->is_error) {
            include_once('./Services/Xml/exceptions/class.ilSaxParserException.php');
            throw new ilSaxParserException(implode('<br/>', $this->error_msg));
        }
    }

◆ storeRecords()

ilAdvancedMDRecordParser::storeRecords ( )

private

Store Record.

@access private

Parameters

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

    {
        switch ($this->getMode()) {
            case self::MODE_INSERT_VALIDATION:
            case self::MODE_UPDATE_VALIDATION:
                return true;
            
            case self::MODE_INSERT:
                // set local context
                if (is_array($this->context)) {
                    $this->getCurrentRecord()->setParentObject($this->context["obj_id"]);
                    $this->getCurrentRecord()->setAssignedObjectTypes(array(
                        array(
                            "obj_type" => $this->context["obj_type"],
                            "sub_type" => $this->context["sub_type"],
                            "optional" => false
                    )));
                }
                
                $this->getCurrentRecord()->save();
                break;
        }
        foreach ($this->fields as $field) {
            $field->setRecordId($this->getCurrentRecord()->getRecordId());
            switch ($this->getMode()) {
                case self::MODE_INSERT:
                    $field->save();
                    
                    // see getRecordMap()
                    $this->log->debug("add to record map, rec id: " . $this->getCurrentRecord()->getRecordId() .
                        ", import id: " . $field->getImportId() . ", field id:" . $field->getFieldId());
                    $this->rec_map[$this->getCurrentRecord()->getRecordId()][$field->getImportId()] = $field->getFieldId();
                    break;
            }
        }
    }