ilObjDefReader Class Reference

Component definition reader (reads common tags in module.xml and service.xml files) Name is misleading and should be ilComponentDefReader instead. More...

Inheritance diagram for ilObjDefReader:

Collaboration diagram for ilObjDefReader:

Public Member Functions
	ilObjDefReader ($a_path, $a_name, $a_type)
	setHandlers ($a_xml_parser)
	set event handler should be overwritten by inherited class private
	handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
	start tag handler
	handlerEndTag ($a_xml_parser, $a_name)
	end tag handler
	handlerCharacterData ($a_xml_parser, $a_data)
	end tag handler
Public Member Functions inherited from ilSaxParser
	ilSaxParser ($a_xml_file= '', $throwException=false)
	Constructor setup ILIAS global object public.
	setXMLContent ($a_xml_content)
	getXMLContent ()
	getInputType ()
	startParsing ()
	stores xml data in array
	createParser ()
	create parser
	setOptions ($a_xml_parser)
	set parser options
	openXMLFile ()
	open xml file
	parse ($a_xml_parser, $a_fp=null)
	parse xml file
	freeParser ($a_xml_parser)
	free xml parser handle
	setThrowException ($throwException)
	set error handling
Public Member Functions inherited from PEAR
	PEAR ($error_class=null)
	Constructor.
	_PEAR ()
	Destructor (the emulated type of...).
&	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.
	registerShutdownFunc ($func, $args=array())
	Use this function to register a shutdown method for static classes.
	isError ($data, $code=null)
	Tell whether a value is a PEAR error.
	setErrorHandling ($mode=null, $options=null)
	Sets how errors generated by this object should be handled.
	expectError ($code= '*')
	This method is used to tell which errors you expect to get.
	popExpect ()
	This method pops one element off the expected error codes stack.
	_checkDelExpect ($error_code)
	This method checks unsets an error code if available.
	delExpect ($error_code)
	This method deletes all occurences of the specified element from the expected error codes stack.
&	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.
&	throwError ($message=null, $code=null, $userinfo=null)
	Simpler form of raiseError with fewer options.
	staticPushErrorHandling ($mode, $options=null)
	staticPopErrorHandling ()
	pushErrorHandling ($mode, $options=null)
	Push a new error handler on top of the error handler options stack.
	popErrorHandling ()
	Pop the last error handler used.
	loadExtension ($ext)
	OS independant PHP extension load.

Static Public Member Functions
static	clearTables ()
	clear the tables
static	deleteObjectDefinition ($a_id)
	Delete an object definition (this is currently needed for test cases)

Additional Inherited Members
Data Fields inherited from ilSaxParser
	$input_type = null
	$xml_content = ''
	$ilias
	$lng
	$xml_file
	$throwException = false
Protected Member Functions inherited from ilSaxParser
	handleError ($message, $code)
	use given error handler to handle error message or internal ilias error message handle

Detailed Description

Component definition reader (reads common tags in module.xml and service.xml files) Name is misleading and should be ilComponentDefReader instead.

Reads reads module information of modules.xml files into db

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

Member Function Documentation

static ilObjDefReader::clearTables ( )

static

clear the tables

Reimplemented in ilServiceReader, and ilModuleReader.

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

References $ilDB.

        {
                global $ilDB;

                $ilDB->manipulate("DELETE FROM il_object_def");
                
                $ilDB->manipulate("DELETE FROM il_object_subobj");
                
                $ilDB->manipulate("DELETE FROM il_object_group");

                $ilDB->manipulate("DELETE FROM il_pluginslot");
                
                $ilDB->manipulate("DELETE FROM il_component");
        }

static ilObjDefReader::deleteObjectDefinition (   $a_id )

static

Delete an object definition (this is currently needed for test cases)

Definition at line 72 of file class.ilObjDefReader.php.

References $ilDB.

        {
                global $ilDB;

                $ilDB->manipulateF("DELETE FROM il_object_def WHERE id = %s",
                        array("text"), array($a_id));
                
                $ilDB->manipulateF("DELETE FROM il_object_subobj WHERE parent = %s OR subobj = %s",
                        array("text", "text"), array($a_id, $a_id));
        }

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

start tag handler

Parameters

ressouce	internal xml_parser_handler
string	element tag name
array	element attributes private

Reimplemented in ilModuleReader, and ilServiceReader.

Definition at line 91 of file class.ilObjDefReader.php.

References $ilDB, and $q.

        {
                global $ilDB;

                $this->current_tag = $a_name;
                
                switch ($a_name)
                {
                        case 'object':
                                $this->current_object = $a_attribs["id"];
                                $ilDB->manipulateF("INSERT INTO il_object_def (id, class_name, component,location,".
                                        "checkbox,inherit,translate,devmode,allow_link,allow_copy,rbac,default_pos,default_pres_pos,sideblock,grp,system) VALUES ".
                                        "(%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s)",
                                        array("text", "text", "text", "text", "integer", "integer", "text", "integer","integer","integer",
                                                "integer","integer","integer","integer", "text", "integer"),
                                        array(
                                                $a_attribs["id"],
                                                $a_attribs["class_name"],
                                                $this->current_component,
                                                $this->current_component."/".$a_attribs["dir"],
                                                (int) $a_attribs["checkbox"],
                                                (int) $a_attribs["inherit"],
                                                $a_attribs["translate"],
                                                (int) $a_attribs["devmode"],
                                                (int) $a_attribs["allow_link"],
                                                (int) $a_attribs["allow_copy"],
                                                (int) $a_attribs["rbac"],
                                                (int) $a_attribs["default_pos"],
                                                (int) $a_attribs["default_pres_pos"],
                                                (int) $a_attribs["sideblock"],
                                                $a_attribs["group"],
                                                (int) $a_attribs["system"]));
                                break;
                        
                        case "subobj":
                                $ilDB->manipulateF("INSERT INTO il_object_subobj (parent, subobj, mmax) VALUES (%s,%s,%s)",
                                        array("text", "text", "integer"),
                                        array($this->current_object, $a_attribs["id"], (int) $a_attribs["max"]));
                                break;

                        case "parent":
                                $ilDB->manipulateF("INSERT INTO il_object_subobj (parent, subobj, mmax) VALUES (%s,%s,%s)",
                                        array("text", "text", "integer"),
                                        array($a_attribs["id"], $this->current_object, (int) $a_attribs["max"]));
                                break;

                        case "objectgroup":
                                $ilDB->manipulateF("INSERT INTO il_object_group (id, name, default_pres_pos) VALUES (%s,%s,%s)",
                                        array("text", "text", "integer"),
                                        array($a_attribs["id"], $a_attribs["name"], $a_attribs["default_pres_pos"]));
                                break;
                                
                        case "pluginslot":
                                $this->current_object = $a_attribs["id"];
                                $q = "INSERT INTO il_pluginslot (component, id, name) VALUES (".
                                        $ilDB->quote($this->current_component, "text").",".
                                        $ilDB->quote($a_attribs["id"], "text").",".
                                        $ilDB->quote($a_attribs["name"], "text").")";
                                $ilDB->manipulate($q);
                                break;
                }
        }

ilObjDefReader::handlerCharacterData	(		$a_xml_parser,
			$a_data
	)

end tag handler

Parameters

ressouce	internal xml_parser_handler
string	data private

Reimplemented in ilModuleReader, and ilServiceReader.

Definition at line 173 of file class.ilObjDefReader.php.

        {
                // 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))
                {
                        switch ($this->current_tag)
                        {
                                case '':
                        }
                }
        }

ilObjDefReader::handlerEndTag	(		$a_xml_parser,
			$a_name
	)

end tag handler

Parameters

ressouce	internal xml_parser_handler
string	element tag name private

Reimplemented in ilModuleReader, and ilServiceReader.

Definition at line 161 of file class.ilObjDefReader.php.

        {
        }

ilObjDefReader::ilObjDefReader	(		$a_path,
			$a_name,
			$a_type
	)

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

References ilSaxParser\ilSaxParser().

Referenced by ilModuleReader\ilModuleReader(), and ilServiceReader\ilServiceReader().

        {
                $this->name = $a_name;
                $this->type = $a_type;
//echo "<br>-".$a_path."-".$this->name."-".$this->type."-";
                parent::ilSaxParser($a_path);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjDefReader::setHandlers

(

$a_xml_parser

)

set event handler should be overwritten by inherited class private

Reimplemented from ilSaxParser.

Reimplemented in ilServiceReader, and ilModuleReader.

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

---

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

• setup/classes/class.ilObjDefReader.php