Group Import Parser. More...

Inheritance diagram for ilCategoryXmlParser:

Collaboration diagram for ilCategoryXmlParser:

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

	getParentId ()

	setHandlers ($a_xml_parser)

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

	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)

	setCategory (ilObjCategory $cat)

	getCategory ()

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
	getCurrentTranslation ()

	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	$cat_log

int	$mode

string	$cdata = ""

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Private Attributes
ilObjCategory	$cat = null

int	$parent_id = 0

array	$current_translation = []

string	$current_container_setting

Detailed Description

Group Import Parser.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilCategoryXmlParser::__construct	(	string	$a_xml,
		int	$a_parent_id
	)

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

    {
        parent::__construct(null);
 
        $this->mode = self::MODE_CREATE;
        $this->parent_id = $a_parent_id;
        $this->setXMLContent($a_xml);
 
        $this->cat_log = ilLoggerFactory::getLogger("cat");
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ getCategory()

ilCategoryXmlParser::getCategory ( )

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

                                 : ?ilObjCategory
    {
        return $this->cat;
    }

References $cat.

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

Here is the caller graph for this function:

◆ getCurrentTranslation()

ilCategoryXmlParser::getCurrentTranslation ( )

protected

Returns: array

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

                                              : array
    {
        return $this->current_translation;
    }

References $current_translation.

◆ getParentId()

ilCategoryXmlParser::getParentId ( )

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

                                 : int
    {
        return $this->parent_id;
    }

References $parent_id.

Referenced by save().

Here is the caller graph for this function:

◆ handlerBeginTag()

ilCategoryXmlParser::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 82 of file class.ilCategoryXmlParser.php.

                                                                                    : void
    {
        $a_attribs = $this->trimAndStripAttribs($a_attribs);
        switch ($a_name) {
            case "Category":
                break;
 
            case 'Translations':
                $this->getCategory()->removeTranslations();
                break;
 
            case 'Translation':
                $this->current_translation = [];
                $this->current_translation['default'] = $a_attribs['default'] ? 1 : 0;
                $this->current_translation['lang'] = $a_attribs['language'];
                break;
 
            case 'Sorting':
            case 'Sort':
                ilContainerSortingSettings::_importContainerSortingSettings($a_attribs, $this->getCategory()->getId());
                break;
 
            case 'ContainerSetting':
                $this->current_container_setting = $a_attribs['id'];
                break;
        }
    }

References ilContainerSortingSettings\_importContainerSortingSettings(), getCategory(), ILIAS\Survey\Mode\getId(), and ilContainerBaseXmlParser\trimAndStripAttribs().

Here is the call graph for this function:

◆ handlerCharacterData()

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

Parameters

XMLParser \| resource	$a_xml_parser
string	$a_data

Returns: void

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

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

◆ handlerEndTag()

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

Parameters

XMLParser \| resource	$a_xml_parser
string	$a_name

Returns: void

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

                                                                : void
    {
        $this->cdata = $this->trimAndStrip($this->cdata);
        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'],
                    (string) ((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(), ILIAS\Survey\Mode\getId(), save(), and ilContainerBaseXmlParser\trimAndStrip().

Here is the call graph for this function:

◆ save()

ilCategoryXmlParser::save ( )

protected

mode can be create or update

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

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

References getCategory(), and getParentId().

Referenced by handlerEndTag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCategory()

ilCategoryXmlParser::setCategory ( ilObjCategory $cat )

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

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

References $cat.

◆ setHandlers()

ilCategoryXmlParser::setHandlers ( $a_xml_parser )

Parameters

XMLParser | resource $a_xml_parser

Returns: void

Reimplemented from ilSaxParser.

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

                                              : void
    {
        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 ( int $mode )

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

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

References $mode.

◆ startParsing()

ilCategoryXmlParser::startParsing ( )

stores xml data in array

Exceptions

ilSaxParserException

Reimplemented from ilSaxParser.

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

                                  : void
    {
        parent::startParsing();
 
        if ($this->mode !== self::MODE_CREATE) {
            $this->cat->update();
        }
    }