Category Import Parser. More...

Inheritance diagram for ilCategoryImportParser:

Collaboration diagram for ilCategoryImportParser:

Public Member Functions
	setHandlers ($a_xml_parser)

	buildTag (string $type, string $name, ?array $attr=null)

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

	handlerEndTag ($a_xml_parser, string $a_name)

	handlerCharacterData ($a_xml_parser, string $a_data)

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
array	$parent

int	$parent_cnt

int	$withrol

Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

Protected Attributes
ilRbacAdmin	$rbacadmin

ilRbacReview	$rbacreview

ilRbacSystem	$rbacsystem

ilLogger	$cat_log

ilObjCategory	$category = null

string	$default_language = ""

string	$cur_spec_lang = ""

string	$cur_title = ""

string	$cur_description = ""

string	$cdata = ""

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Additional Inherited Members
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)

Detailed Description

Category Import Parser.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

◆ buildTag()

ilCategoryImportParser::buildTag	(	string	$type,
		string	$name,
		?array	$attr = `null`
	)

Definition at line 75 of file class.ilCategoryImportParser.php.

      : string {
         $tag = "<";
 
         if ($type === "end") {
             $tag .= "/";
         }
 
         $tag .= $name;
 
         if (is_array($attr)) {
             foreach ($attr as $k => $v) {
                 $tag .= " " . $k . "=\"$v\"";
             }
         }
 
         $tag .= ">";
 
         return $tag;
     }

◆ handlerBeginTag()

ilCategoryImportParser::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 105 of file class.ilCategoryImportParser.php.

References ilContainerBaseXmlParser\trimAndStripAttribs().

Referenced by setHandlers().

                                                                                     : void
     {
         $a_attribs = $this->trimAndStripAttribs($a_attribs);
         switch ($a_name) {
             case "Category":
                 $cur_parent = $this->parent[$this->parent_cnt - 1];
                 $this->category = new ilObjCategory();
                 $this->category->setImportId($a_attribs["Id"] . " (#" . $cur_parent . ")");
                 $this->default_language = $a_attribs["DefaultLanguage"];
                 $this->category->setTitle($a_attribs["Id"]);
                 $this->category->create();
                 $this->category->createReference();
                 $this->category->putInTree($cur_parent);
                 $this->parent[$this->parent_cnt++] = $this->category->getRefId();
                 break;
 
             case "CategorySpec":
                 $this->cur_spec_lang = $a_attribs["Language"];
                 break;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handlerCharacterData()

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

Parameters

XMLParser \| resource	$a_xml_parser
string	$a_data

Returns: void

Definition at line 174 of file class.ilCategoryImportParser.php.

Referenced by setHandlers().

                                                                        : void
     {
         // i don't know why this is necessary, but
         // the parser seems to convert "&gt;" to ">" and "&lt;" to "<"
         // in character data, but we don't want that, because it's the
         // way we mask user html in our content, so we convert back...
         $a_data = str_replace(["<", ">"], ["&lt;", "&gt;"], $a_data);
 
         // DELETE WHITESPACES AND NEWLINES OF CHARACTER DATA
         $a_data = preg_replace("/\n/", "", $a_data);
         $a_data = preg_replace("/\t+/", "", $a_data);
         if (!empty($a_data)) {
             $this->cdata .= $a_data;
         }
     }

Here is the caller graph for this function:

◆ handlerEndTag()

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

Parameters

XMLParser \| resource	$a_xml_parser
string	$a_name

Returns: void

Definition at line 132 of file class.ilCategoryImportParser.php.

References $cdata, and ilContainerBaseXmlParser\trimAndStrip().

Referenced by setHandlers().

                                                                 : void
     {
         $this->cdata = $this->trimAndStrip($this->cdata);
         switch ($a_name) {
             case "Category":
                 unset($this->category, $this->parent[$this->parent_cnt - 1]);
                 $this->parent_cnt--;
                 break;
 
             case "CategorySpec":
                 $is_def = '0';
                 if ($this->cur_spec_lang === $this->default_language) {
                     $this->category->setTitle($this->cur_title);
                     $this->category->setDescription($this->cur_description);
                     $this->category->update();
                     $is_def = '1';
                 }
                 $this->category->addTranslation(
                     $this->cur_title,
                     $this->cur_description,
                     $this->cur_spec_lang,
                     $is_def
                 );
                 break;
 
             case "Title":
                 $this->cur_title = $this->cdata;
                 break;
 
             case "Description":
                 $this->cur_description = $this->cdata;
                 break;
         }
 
         $this->cdata = "";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlers()

ilCategoryImportParser::setHandlers ( $a_xml_parser )

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

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

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