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
	clearTables ()
	clear the tables
	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	deleteObjectDefinition ($a_id)
	Delete an object definition (this is currently needed for test cases)

Protected Attributes
	$readers
	$current_reader = null

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 15 of file class.ilObjDefReader.php.

Member Function Documentation

ilObjDefReader::clearTables

(

)

clear the tables

Reimplemented in ilServiceReader, and ilModuleReader.

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

References $ilDB, and $reader.

        {
                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");
                
                $ilDB->manipulate("DELETE FROM il_event_handling");
                
                $ilDB->manipulate("DELETE FROM il_object_sub_type");
                
                foreach ($this->readers as $k => $reader)
                {
                        $this->readers[$k]["reader"]->clearTables();
                }
        }

static ilObjDefReader::deleteObjectDefinition (   $a_id )

static

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

Definition at line 76 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

Reimplemented in ilModuleReader, and ilServiceReader.

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

References $current_reader, $ilDB, and ilCronManager\updateFromXML().

        {
                global $ilDB;
                
                $this->current_tag = $a_name;
                
                // check if a special reader needs to be activated
                if (isset($this->readers[$a_name]))
                {
                        $this->current_reader = $a_name;
                }
                
                // call special reader
                if ($this->current_reader != "")
                {
                        $this->readers[$this->current_reader]["reader"]->handlerBeginTag($a_xml_parser,$a_name,$a_attribs,
                                $this->current_component);
                }
                else
                {
                        // default handling
                        switch ($a_name)
                        {
                                case 'object':
        
                                        // if attributes are not given, set default (repository only)
                                        if($a_attribs["repository"] === NULL)
                                        {
                                                $a_attribs["repository"] = true;
                                        }
                                        if($a_attribs["workspace"] === NULL)
                                        {
                                                $a_attribs["workspace"] = false;
                                        }
        
                                        $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,export,repository,workspace,administration,amet) VALUES ".
                                                "(%s,%s,%s,%s,%s,%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", "integer", "integer", "integer",'integer','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"],
                                                        (int) $a_attribs["export"],
                                                        (int) $a_attribs["repository"],
                                                        (int) $a_attribs["workspace"],
                                                        (int) $a_attribs['administration'],
                                                        (int) $a_attribs['amet']
                                                ));
                                        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;
                                
                                case "event":
                                        $component = $a_attribs["component"];
                                        if(!$component)
                                        {
                                                $component = $this->current_component;
                                        }                               
                                        $q = "INSERT INTO il_event_handling (component, type, id) VALUES (".
                                                $ilDB->quote($component, "text").",".
                                                $ilDB->quote($a_attribs["type"], "text").",".
                                                $ilDB->quote($a_attribs["id"], "text").")";
                                        $ilDB->manipulate($q);
                                        break;
                                        
                                case "cron":                            
                                        $component = $a_attribs["component"];
                                        if(!$component)
                                        {
                                                $component = $this->current_component;
                                        }                               
                                        include_once "Services/Cron/classes/class.ilCronManager.php";
                                        ilCronManager::updateFromXML($component, $a_attribs["id"], $a_attribs["class"], $a_attribs["path"]);            
                                        $this->has_cron[$component][] = $a_attribs["id"];
                                        break;
        
                                case "sub_type":
                                        $ilDB->manipulate("INSERT INTO il_object_sub_type ".
                                                "(obj_type, sub_type, amet) VALUES (".
                                                $ilDB->quote($this->current_object, "text").",".
                                                $ilDB->quote($a_attribs["id"], "text").",".
                                                $ilDB->quote($a_attribs["amet"], "integer").
                                                ")");
                                        break;
                        }
                }
        }

Here is the call graph for this function:

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

object	internal xml_parser_handler
string	element tag name

Reimplemented in ilModuleReader, and ilServiceReader.

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

References $current_reader, and ilCronManager\clearFromXML().

        {
                // call special reader
                if ($this->current_reader != "")
                {
                        $this->readers[$this->current_reader]["reader"]->handlerEndTag($a_xml_parser,$a_name);
                }
                else
                {
                        // cron
                        if($a_name == "module" || $a_name == "service")
                        {
                                include_once "Services/Cron/classes/class.ilCronManager.php";
                                ilCronManager::clearFromXML($this->current_component, 
                                        (array)$this->has_cron[$this->current_component]);                              
                        }
                }
                
                // check if a special reader needs to be activated
                if (isset($this->readers[$a_name]))
                {
                        $this->current_reader = null;
                }               
        }

Here is the call graph for this function:

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

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

References $reader, and ilSaxParser\ilSaxParser().

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

        {
                // init specialized readers
                foreach ($this->readers as $k => $reader)
                {
                        $class = $reader["class"];
                        $class_path = "./setup/classes/class.".$class.".php";
                        include_once($class_path);
                        $this->readers[$k]["reader"] = new $class();
                }
                
                $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 39 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');
        }

Field Documentation

ilObjDefReader::$current_reader = null

protected

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

Referenced by handlerBeginTag(), and handlerEndTag().

ilObjDefReader::$readers

protected

Initial value:

 array(
                "copage" => array("class" => "ilCOPageDefReader")
                )

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

---

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

• setup/classes/class.ilObjDefReader.php