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

Inheritance diagram for ilAdvancedMDRecordParser:

Collaboration diagram for ilAdvancedMDRecordParser:

Public Member Functions
	__construct (string $a_file)

	setMode (int $a_mode)

	getMode ()

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

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

	setContext (int $a_obj_id, string $a_obj_type, ?string $a_sub_type=null)

	getRecordMap ()

Public Member Functions inherited from ilSaxParser
	__construct (?string $path_to_file='', ?bool $throw_exception=false)

	setXMLContent (string $a_xml_content)

	getXMLContent ()

	getInputType ()

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

	createParser ()

	setHandlers ($a_xml_parser)

	parse ($a_xml_parser, $a_fp=null)

Data Fields
const	MODE_UNDEFINED = 0

const	MODE_UPDATE = 1

const	MODE_INSERT = 2

const	MODE_UPDATE_VALIDATION = 3

const	MODE_INSERT_VALIDATION = 4

Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

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

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

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

Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Protected Attributes
array	$context

array	$scopes = []

array	$translations = []

string	$translation_language = ''

array	$field_translations = []

string	$field_translation_language = ''

ilAdvancedMDRecord	$current_record = null

ilAdvancedMDFieldDefinition	$current_field = null

string	$cdata = ''

ilLogger	$log

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Private Member Functions
	initRecordObject (string $a_id)

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

	getCurrentRecord ()

	getCurrentField ()

	extractRecordId (string $a_id_string)

	appendErrorMessage (string $a_msg)

	storeRecords ()

Private Attributes
int	$mode = self::MODE_UNDEFINED

array	$fields = []

bool	$is_error = false

array	$error_msg = []

string	$field_value_id = ''

array	$rec_map

Detailed Description

SAX based XML parser for record import files.

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

Todo:: remove update mode completely

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

Constructor & Destructor Documentation

◆ __construct()

ilAdvancedMDRecordParser::__construct ( string $a_file )

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

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

References ILIAS\GlobalScreen\Provider\__construct(), and ilLoggerFactory\getLogger().

Here is the call graph for this function:

Member Function Documentation

◆ appendErrorMessage()

ilAdvancedMDRecordParser::appendErrorMessage ( string $a_msg )

private

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

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

Referenced by handlerBeginTag().

Here is the caller graph for this function:

◆ extractRecordId()

ilAdvancedMDRecordParser::extractRecordId ( string $a_id_string )

private

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

                                                         : int
    {
        // first lookup import id
        if ($record_id = ilAdvancedMDRecord::_lookupRecordIdByImportId($a_id_string)) {
            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

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

                                      : ?ilAdvancedMDFieldDefinition
    {
        return $this->current_field;
    }

References $current_field.

Referenced by handlerBeginTag(), and handlerEndTag().

Here is the caller graph for this function:

◆ getCurrentRecord()

ilAdvancedMDRecordParser::getCurrentRecord ( )

private

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

                                       : ?ilAdvancedMDRecord
    {
        return $this->current_record;
    }

References $current_record.

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

Here is the caller graph for this function:

◆ getMode()

ilAdvancedMDRecordParser::getMode ( )

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

                             : int
    {
        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 417 of file class.ilAdvancedMDRecordParser.php.

                                  : array
    {
        return $this->rec_map;
    }

References $rec_map.

◆ handlerBeginTag()

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

protected

Handler for start tags @access protected.

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

                                                                          : void
    {
        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((int) $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((string) $a_attribs['id'])) {
                    $this->appendErrorMessage('Invalid attribute Id given for element "Record".');
                }
                $this->getCurrentRecord()->setActive((bool) $a_attribs['active']);
                $this->getCurrentRecord()->setImportId($a_attribs['id']);
                $this->getCurrentRecord()->setAssignedObjectTypes(array());
 
                if (isset($a_attribs['defaultLanguage'])) {
                    $language = (string) $a_attribs['defaultLanguage'];
                    if (ilLanguage::lookupId($language)) {
                        $this->getCurrentRecord()->setDefaultLanguage($language);
                    }
                } else {
                    $this->getCurrentRecord()->setDefaultLanguage($this->lng->getDefaultLanguage());
                }
                break;
 
            case 'RecordTranslations':
                $this->translations = [];
                $this->field_translations = [];
                $this->getCurrentRecord()->setDefaultLanguage(
                    $a_attribs['defaultLanguage'] ?? $this->getCurrentRecord()->getDefaultLanguage()
                );
                break;
 
            case 'RecordTranslation':
                $this->translation_language = $a_attribs['language'] ?? $this->lng->getDefaultLanguage();
                break;
 
            case 'FieldTranslations':
                $this->field_translations[$this->getCurrentField()->getImportId()] = [];
                break;
 
            case 'FieldTranslation':
                $this->field_translation_language = $a_attribs['language'] ?? $this->lng->getDefaultLanguage();
                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((int) $a_attribs['id'], (string) $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');
                break;
 
            case 'FieldTitle':
            case 'FieldDescription':
            case 'FieldPosition':
            case 'FieldValue':
                $this->field_value_id = (string) ($a_attribs['id'] ?? "");
                break;
        }
    }

References $scope, ilObject\_exists(), appendErrorMessage(), getCurrentField(), getCurrentRecord(), IL_INST_ID, initFieldObject(), initRecordObject(), ILIAS\Repository\lng(), ilLanguage\lookupId(), and ilUtil\parseImportId().

Referenced by setHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handlerCharacterData()

ilAdvancedMDRecordParser::handlerCharacterData	(		$a_xml_parser,
		string	$a_data
	)

protected

handler for character data

Parameters

resource	$a_xml_parser	xml parser
string	$a_data	character data

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

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

Referenced by setHandlers().

Here is the caller graph for this function:

◆ handlerEndTag()

ilAdvancedMDRecordParser::handlerEndTag	(	$a_xml_parser,
		$a_name
	)

protected

Handler for end tags @access protected.

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

                                                            : void
    {
        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 'RecordTranslationTitle':
                $this->translations[$this->translation_language]['title'] = trim($this->cdata);
                break;
 
            case 'RecordTranslationDescription':
                $this->translations[$this->translation_language]['description'] = trim($this->cdata);
                break;
 
            case 'FieldTranslationTitle':
                $this->field_translations[$this->getCurrentField()->getImportId()][$this->field_translation_language]['title'] = trim($this->cdata);
                break;
 
            case 'FieldTranslationDescription':
                $this->field_translations[$this->getCurrentField()->getImportId()][$this->field_translation_language]['description'] = trim($this->cdata);
                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 $field_translation_language, $parts, $translation_language, getCurrentField(), getCurrentRecord(), and storeRecords().

Referenced by setHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFieldObject()

ilAdvancedMDRecordParser::initFieldObject	(	int	$a_id,
		string	$a_type
	)

private

Init field definition object.

Definition at line 293 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:
                throw new InvalidArgumentException(
                    'Current parsing mode is not supported. Mode: ' . $this->getMode()
                );
        }
    }

References $current_field, 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 ( string $a_id )

private

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

                                                   : bool
    {
        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;
        }
    }

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	(	int	$a_obj_id,
		string	$a_obj_type,
		?string	$a_sub_type = `null`
	)

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

                                                                                             : void
    {
        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 89 of file class.ilAdvancedMDRecordParser.php.

                                              : void
    {
        xml_set_element_handler($a_xml_parser, $this->handlerBeginTag(...), $this->handlerEndTag(...));
        xml_set_character_data_handler($a_xml_parser, $this->handlerCharacterData(...));
    }

References handlerBeginTag(), handlerCharacterData(), and handlerEndTag().

Here is the call graph for this function:

◆ setMode()

ilAdvancedMDRecordParser::setMode ( int $a_mode )

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

                                        : void
    {
        $this->mode = $a_mode;
    }

◆ startParsing()

ilAdvancedMDRecordParser::startParsing ( )

stores xml data in array

Exceptions

ilSaxParserException

Reimplemented from ilSaxParser.

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

                                  : void
    {
        parent::startParsing();
        if ($this->is_error) {
            throw new ilSaxParserException(implode('<br/>', $this->error_msg));
        }
    }

◆ storeRecords()

ilAdvancedMDRecordParser::storeRecords ( )

private

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

                                   : void
    {
        switch ($this->getMode()) {
            case self::MODE_INSERT_VALIDATION:
            case self::MODE_UPDATE_VALIDATION:
                return;
 
            case self::MODE_INSERT:
                // set local context
                if (isset($this->context) && 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(false, true);
                    foreach ($this->field_translations as $field_id => $field_info) {
                        if (strcmp($field_id, $field->getImportId()) !== 0) {
                            continue;
                        }
                        foreach ((array) $field_info as $language => $field_translation) {
                            $translation = new ilAdvancedMDFieldTranslation(
                                (int) $field->getFieldId(),
                                (string) $field_translation['title'],
                                (string) $field_translation['description'],
                                (string) $language
                            );
                            $translation->insert();
                        }
                    }
 
                    // 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;
            }
        }
        $translations = ilAdvancedMDRecordTranslations::getInstanceByRecordId($this->getCurrentRecord()->getRecordId());
        $translations->addTranslationEntry($this->getCurrentRecord()->getDefaultLanguage(), true);
        $translations->updateTranslations(
            $this->getCurrentRecord()->getDefaultLanguage(),
            $this->getCurrentRecord()->getTitle(),
            $this->getCurrentRecord()->getDescription()
        );
 
        foreach ($this->translations as $lang_key => $translation_info) {
            if (!$translations->isConfigured($lang_key)) {
                $translations->addTranslationEntry($lang_key);
            }
            $translations->updateTranslations(
                $lang_key,
                (string) $translation_info['title'],
                (string) $translation_info['description']
            );
        }
    }