Inheritance diagram for ilContainerReferenceXmlParser:

Collaboration diagram for ilContainerReferenceXmlParser:

Public Member Functions
	__construct ($a_xml, $a_parent_id=0)
	Constructor. More...

	setImportMapping (ilImportMapping $mapping)

	getParentId ()
	Get parent id. More...

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

	startParsing ()
	start the parser More...

	handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
	handler for begin of element More...

	handlerEndTag ($a_xml_parser, $a_name)
	Handler end tag. More...

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

	setMode ($mode)
	Set import mode. More...

	setReference (ilContainerReference $ref)
	Set container reference. More...

	getReference ()
	Get container reference. More...

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

const	MODE_UPDATE = 2

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
	parseTargetId (string $attribute_target)

	save ()
	Save category object. 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
	$error

	$logger

	$import_mapping

Private Attributes
	$ref = null

	$parent_id = 0

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

Group Import Parser.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

string $a_xml_file xml file

@access public

Reimplemented from ilSaxParser.

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

    {
        global $DIC;
 
        $this->error = $DIC["ilErr"];
        parent::__construct(null);
 
        $this->mode = ilContainerReferenceXmlParser::MODE_CREATE;
        $this->setXMLContent($a_xml);
 
        $this->logger = $DIC->logger()->exp();
    }

References $DIC, error(), MODE_CREATE, and ilSaxParser\setXMLContent().

Here is the call graph for this function:

Member Function Documentation

◆ getParentId()

ilContainerReferenceXmlParser::getParentId ( )

Get parent id.

Returns: type

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

    {
        return $this->parent_id;
    }

References $parent_id.

Referenced by save().

Here is the caller graph for this function:

◆ getReference()

ilContainerReferenceXmlParser::getReference ( )

Get container reference.

Returns: ilContainerReference

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

    {
        return $this->ref;
    }

References $ref.

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

Here is the caller graph for this function:

◆ handlerBeginTag()

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

handler for begin of element

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

    {
        $ilErr = $this->error;
 
        switch ($a_name) {
            case "ContainerReference":
                break;
            
            case 'Title':
                switch ($a_attribs['type']) {
                    case ilContainerReference::TITLE_TYPE_REUSE:
                        $this->getReference()->setTitleType(ilContainerReference::TITLE_TYPE_REUSE);
                        break;
 
                    default:
                        $this->getReference()->setTitleType(ilContainerReference::TITLE_TYPE_REUSE);
                        break;
                }
                break;
            
            case 'Target':
                $target_id = $this->parseTargetId(isset($a_attribs['id']) ? (string) $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 $error, $ilErr, $target_id, getReference(), parseTargetId(), and ilContainerReference\TITLE_TYPE_REUSE.

Here is the call graph for this function:

◆ handlerCharacterData()

ilContainerReferenceXmlParser::handlerCharacterData	(	$a_xml_parser,
		$a_data
	)

handler for character data

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

    {
        #$a_data = str_replace("<","&lt;",$a_data);
        #$a_data = str_replace(">","&gt;",$a_data);
 
        if (!empty($a_data)) {
            $this->cdata .= $a_data;
        }
    }

◆ handlerEndTag()

ilContainerReferenceXmlParser::handlerEndTag	(	$a_xml_parser,
		$a_name
	)

Handler end tag.

Parameters

type	$a_xml_parser
type	$a_name

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

    {
        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 getReference(), save(), and ilContainerReference\TITLE_TYPE_CUSTOM.

Here is the call graph for this function:

◆ parseTargetId()

ilContainerReferenceXmlParser::parseTargetId ( string $attribute_target )

protected

Parameters

string $attribute_target

Returns: int

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

                                                               : int
    {
        if (!strlen($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('Services/Container', 'objs', $attribute_target);
        if (!$obj_mapping_id) {
            $this->logger->debug('Cannot find object mapping for target_id: ' . $attribute_target);
            return 0;
        }
        return $obj_mapping_id;
    }

Referenced by handlerBeginTag().

Here is the caller graph for this function:

◆ save()

ilContainerReferenceXmlParser::save ( )

protected

Save category object.

Returns: type

mode can be create or update

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

    {
        include_once './Modules/Category/classes/class.ilCategoryXmlParser.php';
        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();
        return true;
    }

References getParentId(), getReference(), and ilCategoryXmlParser\MODE_CREATE.

Referenced by handlerEndTag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlers()

ilContainerReferenceXmlParser::setHandlers ( $a_xml_parser )

set event handler should be overwritten by inherited class @access private

Reimplemented from ilSaxParser.

Definition at line 104 of file class.ilContainerReferenceXmlParser.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');
    }

◆ setImportMapping()

ilContainerReferenceXmlParser::setImportMapping ( ilImportMapping $mapping )

Parameters

ilImportMapping $mapping

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

    {
        $this->import_mapping = $mapping;
    }

◆ setMode()

ilContainerReferenceXmlParser::setMode ( $mode )

Set import mode.

Parameters

type $mode

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

    {
        $this->mode = $mode;
    }

◆ setReference()

ilContainerReferenceXmlParser::setReference ( ilContainerReference $ref )

Set container reference.

Parameters

ilContainerReference $ref

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

    {
        $this->ref = $ref;
    }

References $ref.

◆ startParsing()

ilContainerReferenceXmlParser::startParsing ( )

start the parser

Reimplemented from ilSaxParser.

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

    {
        parent::startParsing();
        
        if ($this->ref instanceof ilContainerReference) {
            return $this->ref;
        }
        return 0;
    }