Inheritance diagram for ilCategoryXmlParser:

Collaboration diagram for ilCategoryXmlParser:

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

	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...

	setCategory ($cat)
	Set category object. More...

	getCategory ()

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
	getCurrentTranslation ()
	Get current translation. More...

	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

	$cat_log

Private Attributes
	$cat = null

	$parent_id = 0

	$current_translation = array()

	$current_container_setting

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.ilCategoryXmlParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilCategoryXmlParser::__construct	(	$a_xml,
		$a_parent_id
	)

Constructor.

Parameters

string $a_xml_file xml file

@access public

Reimplemented from ilSaxParser.

Definition at line 68 of file class.ilCategoryXmlParser.php.

    {
        global $DIC;
 
        $this->error = $DIC["ilErr"];
        parent::__construct(null);
 
        $this->mode = ilCategoryXmlParser::MODE_CREATE;
        $this->parent_id = $a_parent_id;
        $this->setXMLContent($a_xml);
 
        $this->cat_log = ilLoggerFactory::getLogger("cat");
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), error(), ilLoggerFactory\getLogger(), MODE_CREATE, and ilSaxParser\setXMLContent().

Here is the call graph for this function:

Member Function Documentation

◆ getCategory()

ilCategoryXmlParser::getCategory ( )

Definition at line 277 of file class.ilCategoryXmlParser.php.

    {
        return $this->cat;
    }

References $cat.

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

Here is the caller graph for this function:

◆ getCurrentTranslation()

ilCategoryXmlParser::getCurrentTranslation ( )

protected

Get current translation.

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

    {
        return $this->current_translation;
    }

References $current_translation.

◆ getParentId()

ilCategoryXmlParser::getParentId ( )

Get parent id.

Returns: type

Definition at line 86 of file class.ilCategoryXmlParser.php.

    {
        return $this->parent_id;
    }

References $parent_id.

Referenced by save().

Here is the caller graph for this function:

◆ handlerBeginTag()

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

handler for begin of element

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

    {
        $ilErr = $this->error;
 
        switch ($a_name) {
            case "Category":
                break;
            
            case 'Translations':
                $this->getCategory()->removeTranslations();
                break;
            
            case 'Translation':
                $this->current_translation = array();
                $this->current_translation['default'] = $a_attribs['default'] ? 1 : 0;
                $this->current_translation['lang'] = $a_attribs['language'];
                break;
 
            case 'Sorting':
            case 'Sort':
                include_once './Services/Container/classes/class.ilContainerSortingSettings.php';
                ilContainerSortingSettings::_importContainerSortingSettings($a_attribs, $this->getCategory()->getId());
                break;
            
            case 'ContainerSetting':
                $this->current_container_setting = $a_attribs['id'];
                break;
        }
    }

References $error, $ilErr, ilContainerSortingSettings\_importContainerSortingSettings(), and getCategory().

Here is the call graph for this function:

◆ handlerCharacterData()

ilCategoryXmlParser::handlerCharacterData	(	$a_xml_parser,
		$a_data
	)

handler for character data

Definition at line 225 of file class.ilCategoryXmlParser.php.

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

◆ handlerEndTag()

ilCategoryXmlParser::handlerEndTag	(	$a_xml_parser,
		$a_name
	)

Handler end tag.

Parameters

type	$a_xml_parser
type	$a_name

Definition at line 167 of file class.ilCategoryXmlParser.php.

    {
        switch ($a_name) {
            case "Category":
                $this->save();
                break;
            
            case 'Title':
                $this->current_translation['title'] = trim($this->cdata);
                
                if ($this->current_translation['default']) {
                    $this->getCategory()->setTitle(trim($this->cdata));
                }
                
                break;
            
            case 'Description':
                $this->current_translation['description'] = trim($this->cdata);
                
                if ($this->current_translation['default']) {
                    $this->getCategory()->setDescription(trim($this->cdata));
                }
                
                break;
            
            case 'Translation':
                // Add translation
                $this->getCategory()->addTranslation(
                    (string) $this->current_translation['title'],
                    (string) $this->current_translation['description'],
                    (string) $this->current_translation['lang'],
                    (int) $this->current_translation['default']
                );
                break;
            
            case 'ContainerSetting':
                if ($this->current_container_setting) {
                    $this->cat_log->debug("Write container Setting, ID: " . $this->getCategory()->getId() . ", setting: " .
                        $this->current_container_setting . ", data: " . $this->cdata);
                    ilContainer::_writeContainerSetting(
                        $this->getCategory()->getId(),
                        $this->current_container_setting,
                        $this->cdata
                    );
                }
                break;
 
            case 'ContainerSettings':
                $this->cat->readContainerSettings();    // read container settings to member vars (call getter/setter), see #0019870
                break;
        }
        $this->cdata = '';
    }

References ilContainer\_writeContainerSetting(), getCategory(), and save().

Here is the call graph for this function:

◆ save()

ilCategoryXmlParser::save ( )

protected

Save category object.

Returns: type

mode can be create or update

Definition at line 239 of file class.ilCategoryXmlParser.php.

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

References getCategory(), getParentId(), and MODE_CREATE.

Referenced by handlerEndTag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCategory()

ilCategoryXmlParser::setCategory ( $cat )

Set category object.

Parameters

type $cat

Definition at line 272 of file class.ilCategoryXmlParser.php.

    {
        $this->cat = $cat;
    }

References $cat.

◆ setHandlers()

ilCategoryXmlParser::setHandlers ( $a_xml_parser )

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

Reimplemented from ilSaxParser.

Definition at line 106 of file class.ilCategoryXmlParser.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()

ilCategoryXmlParser::setMode ( $mode )

Set import mode.

Parameters

type $mode

Definition at line 263 of file class.ilCategoryXmlParser.php.

    {
        $this->mode = $mode;
    }

◆ startParsing()

ilCategoryXmlParser::startParsing ( )

start the parser

Reimplemented from ilSaxParser.

Definition at line 116 of file class.ilCategoryXmlParser.php.

    {
        parent::startParsing();
 
        if ($this->mode == ilCategoryXmlParser::MODE_CREATE) {
            return is_object($this->cat) ? $this->cat->getRefId() : false;
        } else {
            return is_object($this->cat) ? $this->cat->update() : false;
        }
    }