Inheritance diagram for ilCategoryImportParser:

Collaboration diagram for ilCategoryImportParser:

Public Member Functions
	__construct ($a_xml_file, $a_parent, $withrol)
	Constructor. More...

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

	startParsing ()
	start the parser More...

	buildTag ($type, $name, $attr="")
	generate a tag with given name and attributes More...

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

	handlerEndTag ($a_xml_parser, $a_name)
	handler for end of element More...

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

Public Member Functions inherited from ilSaxParser
	__construct ($a_xml_file='', $throwException=false)
	Constructor setup ILIAS global object 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 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
	$parent

	$withrol

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 Attributes
	$rbacadmin

	$rbacreview

	$rbacsystem

	$cat_log

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

Protected Member Functions inherited from ilSaxParser
	handleError ($message, $code)
	use given error handler to handle error message or internal ilias error message handle More...

Detailed Description

Category Import Parser.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilCategoryImportParser::__construct	(	$a_xml_file,
		$a_parent,
		$withrol
	)

Constructor.

Parameters

string $a_xml_file xml file

public

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

References $DIC, and $withrol.

     {
         global $DIC;
 
         $this->rbacadmin = $DIC->rbac()->admin();
         $this->rbacreview = $DIC->rbac()->review();
         $this->rbacsystem = $DIC->rbac()->system();
         $this->parent_cnt = 0;
         $this->parent[$this->parent_cnt] = $a_parent;
         $this->parent_cnt++;
         $this->withrol = $withrol;
         
         parent::__construct($a_xml_file);
     }

Member Function Documentation

◆ buildTag()

ilCategoryImportParser::buildTag	(	$type,
		$name,
		$attr = `""`
	)

generate a tag with given name and attributes

Parameters

string	"start" \| "end" for starting or ending tag
string	element/tag name
array	array of attributes

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

References $name, $tag, and $type.

     {
         $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,
		$a_name,
		$a_attribs
	)

handler for begin of element

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

References $rbacadmin, $rbacreview, $rbacsystem, and ilObject\setImportId().

     {
         $rbacadmin = $this->rbacadmin;
         $rbacreview = $this->rbacreview;
         $rbacsystem = $this->rbacsystem;
       
         switch ($a_name) {
             case "Category":
                 $cur_parent = $this->parent[$this->parent_cnt - 1];
                 require_once("Modules/Category/classes/class.ilObjCategory.php");
                 $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:

◆ handlerCharacterData()

ilCategoryImportParser::handlerCharacterData	(	$a_xml_parser,
		$a_data
	)

handler for character data

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

     {
         // 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;", $a_data);
         $a_data = str_replace(">", "&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;
         }
     }

◆ handlerEndTag()

ilCategoryImportParser::handlerEndTag	(	$a_xml_parser,
		$a_name
	)

handler for end of element

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

     {
         switch ($a_name) {
             case "Category":
                 unset($this->category);
                 unset($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 = "";
     }

◆ setHandlers()

ilCategoryImportParser::setHandlers ( $a_xml_parser )

set event handler should be overwritten by inherited class private

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

◆ startParsing()

ilCategoryImportParser::startParsing ( )

start the parser

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

     {
         parent::startParsing();
     }

Field Documentation

◆ $cat_log

ilCategoryImportParser::$cat_log

protected

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

◆ $parent

ilCategoryImportParser::$parent

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

◆ $rbacadmin

ilCategoryImportParser::$rbacadmin

protected

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

Referenced by handlerBeginTag().

◆ $rbacreview

ilCategoryImportParser::$rbacreview

protected

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

Referenced by handlerBeginTag().

◆ $rbacsystem

ilCategoryImportParser::$rbacsystem

protected

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

Referenced by handlerBeginTag().

◆ $withrol

ilCategoryImportParser::$withrol

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

Referenced by __construct().

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

Modules/Category/classes/class.ilCategoryImportParser.php

Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildTag()

◆ handlerBeginTag()

◆ handlerCharacterData()

◆ handlerEndTag()

◆ setHandlers()

◆ startParsing()

Field Documentation

◆ $cat_log

◆ $parent

◆ $rbacadmin

◆ $rbacreview

◆ $rbacsystem

◆ $withrol