Import Parser. More...

Inheritance diagram for ilContainerReferenceXmlParser:

Collaboration diagram for ilContainerReferenceXmlParser:

Public Member Functions
	__construct (string $a_xml, int $a_parent_id=0)

	setImportMapping (ilImportMapping $mapping)

	getParentId ()

	setHandlers ($a_xml_parser)

	handlerBeginTag ( $a_xml_parser, string $a_name, array $a_attribs)

	handlerEndTag ( $a_xml_parser, string $a_name)

	handlerCharacterData ( $a_xml_parser, string $a_data)

	setMode (int $mode)

	setReference (ilContainerReference $ref)

	getReference ()

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_CREATE = 1

const	MODE_UPDATE = 2

Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

Protected Member Functions
	parseTargetId (string $attribute_target)

	create ()

	save ()

Protected Member Functions inherited from ilContainerBaseXmlParser
	trimAndStripAttribs (array $attribs)

	trimAndStrip (string $input)

Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Protected Attributes
ilLogger	$logger

ilImportMapping	$import_mapping

string	$cdata = ""

int	$mode = 0

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Private Attributes
ilContainerReference	$ref = null

int	$parent_id = 0

Detailed Description

Import Parser.

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

Definition at line 26 of file class.ilContainerReferenceXmlParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilContainerReferenceXmlParser::__construct	(	string	$a_xml,
		int	$a_parent_id = `0`
	)

Definition at line 38 of file class.ilContainerReferenceXmlParser.php.

      {
        global $DIC;
 
        parent::__construct(null);
 
        $this->mode = self::MODE_CREATE;
        $this->setXMLContent($a_xml);
 
        $this->logger = $DIC->logger()->exp();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\logger(), MODE_CREATE, and ilSaxParser\setXMLContent().

Here is the call graph for this function:

Member Function Documentation

◆ create()

ilContainerReferenceXmlParser::create ( )

protected

Definition at line 162 of file class.ilContainerReferenceXmlParser.php.

                               : void
    {
    }

◆ getParentId()

ilContainerReferenceXmlParser::getParentId ( )

Definition at line 57 of file class.ilContainerReferenceXmlParser.php.

                                 : int
    {
        return $this->parent_id;
    }

References $parent_id.

◆ getReference()

ilContainerReferenceXmlParser::getReference ( )

Definition at line 189 of file class.ilContainerReferenceXmlParser.php.

                                  : ?ilContainerReference
    {
        return $this->ref;
    }

Referenced by handlerBeginTag().

Here is the caller graph for this function:

◆ handlerBeginTag()

ilContainerReferenceXmlParser::handlerBeginTag	(		$a_xml_parser,
		string	$a_name,
		array	$a_attribs
	)

Parameters

XMLParser \| resource	$a_xml_parser
string	$a_name
array	$a_attribs

Returns: void

Definition at line 74 of file class.ilContainerReferenceXmlParser.php.

     : void {
        $a_attribs = $this->trimAndStripAttribs($a_attribs);
        switch ($a_name) {
            case "ContainerReference":
                break;
 
            case 'Title':
                switch ($a_attribs['type']) {
                    case ilContainerReference::TITLE_TYPE_REUSE:
                    default:
                        $this->getReference()->setTitleType(ilContainerReference::TITLE_TYPE_REUSE);
                        break;
                }
                break;
 
            case 'Target':
                $target_id = $this->parseTargetId($a_attribs['id'] ?? '');
                if ($target_id) {
                    $this->logger->debug('Using mapped target_id: ' . $target_id);
                    $this->getReference()->setTargetId($target_id);
                } else {
                    $this->logger->info('No mapping found for: ' . $a_attribs['id']);
                    $this->getReference()->setTargetId(0);
                }
                break;
        }
    }

References getReference(), ILIAS\Repository\logger(), parseTargetId(), and ilContainerReference\TITLE_TYPE_REUSE.

Referenced by setHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handlerCharacterData()

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

Parameters

XMLParser \| resource	$a_xml_parser
string	$a_data

Returns: void

Definition at line 153 of file class.ilContainerReferenceXmlParser.php.

     : void {
        if (!empty($a_data)) {
            $this->cdata .= $a_data;
        }
    }

Referenced by setHandlers().

Here is the caller graph for this function:

◆ handlerEndTag()

ilContainerReferenceXmlParser::handlerEndTag	(		$a_xml_parser,
		string	$a_name
	)

Parameters

XMLParser \| resource	$a_xml_parser
string	$a_name

Returns: void

Definition at line 129 of file class.ilContainerReferenceXmlParser.php.

     : void {
        $this->cdata = $this->trimAndStrip($this->cdata);
        switch ($a_name) {
            case "ContainerReference":
                $this->save();
                break;
 
            case 'Title':
                if ($this->getReference()->getTitleType() === ilContainerReference::TITLE_TYPE_CUSTOM) {
                    $this->getReference()->setTitle(trim($this->cdata));
                }
                break;
        }
        $this->cdata = '';
    }

References ilContainerReference\TITLE_TYPE_CUSTOM.

Referenced by setHandlers().

Here is the caller graph for this function:

◆ parseTargetId()

ilContainerReferenceXmlParser::parseTargetId ( string $attribute_target )

protected

Definition at line 106 of file class.ilContainerReferenceXmlParser.php.

                                                              : int
    {
        if ($attribute_target === '') {
            $this->logger->debug('No target id provided');
            return 0;
        }
        if (!$this->import_mapping instanceof ilImportMapping) {
            return 0;
        }
        $obj_mapping_id = $this->import_mapping->getMapping('components/ILIAS/Container', 'objs', $attribute_target);
        if (!$obj_mapping_id) {
            $this->logger->debug('Cannot find object mapping for target_id: ' . $attribute_target);
            return 0;
        }
 
        return (int) $obj_mapping_id;
    }

References ILIAS\Repository\logger().

Referenced by handlerBeginTag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilContainerReferenceXmlParser::save ( )

protected

Definition at line 166 of file class.ilContainerReferenceXmlParser.php.

                             : void
    {
        if ($this->mode === ilCategoryXmlParser::MODE_CREATE) {
            $this->create();
            $this->getReference()->create();
            $this->getReference()->createReference();
            $this->getReference()->putInTree($this->getParentId());
            $this->getReference()->setPermissions($this->getParentId());
        }
        $this->getReference()->update();
    }

References ilCategoryXmlParser\MODE_CREATE.

◆ setHandlers()

ilContainerReferenceXmlParser::setHandlers ( $a_xml_parser )

Parameters

XMLParser | resource $a_xml_parser

Returns: void

Reimplemented from ilSaxParser.

Definition at line 62 of file class.ilContainerReferenceXmlParser.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:

◆ setImportMapping()

ilContainerReferenceXmlParser::setImportMapping ( ilImportMapping $mapping )

Definition at line 52 of file class.ilContainerReferenceXmlParser.php.

                                                              : void
    {
        $this->import_mapping = $mapping;
    }

◆ setMode()

ilContainerReferenceXmlParser::setMode ( int $mode )

Definition at line 178 of file class.ilContainerReferenceXmlParser.php.

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

◆ setReference()

ilContainerReferenceXmlParser::setReference ( ilContainerReference $ref )

Definition at line 184 of file class.ilContainerReferenceXmlParser.php.

                                                           : void
    {
        $this->ref = $ref;
    }

Field Documentation

◆ $cdata

string ilContainerReferenceXmlParser::$cdata = ""

protected

Definition at line 35 of file class.ilContainerReferenceXmlParser.php.

◆ $import_mapping

ilImportMapping ilContainerReferenceXmlParser::$import_mapping

protected

Definition at line 34 of file class.ilContainerReferenceXmlParser.php.

◆ $logger

ilLogger ilContainerReferenceXmlParser::$logger

protected

Definition at line 33 of file class.ilContainerReferenceXmlParser.php.

◆ $mode

int ilContainerReferenceXmlParser::$mode = 0

protected

Definition at line 36 of file class.ilContainerReferenceXmlParser.php.

◆ $parent_id

int ilContainerReferenceXmlParser::$parent_id = 0

private

Definition at line 32 of file class.ilContainerReferenceXmlParser.php.

Referenced by getParentId().

◆ $ref

ilContainerReference ilContainerReferenceXmlParser::$ref = null

private

Definition at line 31 of file class.ilContainerReferenceXmlParser.php.

◆ MODE_CREATE

const ilContainerReferenceXmlParser::MODE_CREATE = 1

Definition at line 28 of file class.ilContainerReferenceXmlParser.php.

Referenced by __construct().

◆ MODE_UPDATE

const ilContainerReferenceXmlParser::MODE_UPDATE = 2

Definition at line 29 of file class.ilContainerReferenceXmlParser.php.

The documentation for this class was generated from the following file:

components/ILIAS/ContainerReference/classes/class.ilContainerReferenceXmlParser.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ create()

◆ getParentId()

◆ getReference()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ parseTargetId()

◆ save()

◆ setHandlers()

◆ setImportMapping()

◆ setMode()

◆ setReference()

Field Documentation

◆ $cdata

◆ $import_mapping

◆ $logger

◆ $mode

◆ $parent_id

◆ $ref

◆ MODE_CREATE

◆ MODE_UPDATE