ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilModuleReader Class Reference

Class ilModuleReader. More...

+ Inheritance diagram for ilModuleReader:
+ Collaboration diagram for ilModuleReader:

Public Member Functions

 __construct ($a_path, $a_name, $a_type)
 
 getModules ()
 
 setHandlers ($a_xml_parser)
 
 clearTables ()
 clear the tables More...
 
 handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
 start tag handler More...
 
 handlerEndTag ($a_xml_parser, $a_name)
 end tag handler More...
 
 handlerCharacterData ($a_xml_parser, $a_data)
 end tag handler More...
 
- Public Member Functions inherited from ilObjDefReader
 __construct ($a_path, $a_name, $a_type)
 
 setHandlers ($a_xml_parser)
 
 clearTables ()
 clear the tables More...
 
 handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
 Start tag handler. More...
 
 handlerEndTag ($a_xml_parser, $a_name)
 End tag handler. More...
 
 handlerCharacterData ($a_xml_parser, $a_data)
 end tag handler More...
 
 setComponentId ($a_component_id)
 Set from module or service reader. More...
 
 getComponentId ()
 Get component id. 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from ilObjDefReader
static deleteObjectDefinition ($a_id)
 Delete an object definition (this is currently needed for test cases) More...
 
- 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...
 
- 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 Member Functions inherited from ilSaxParser
 handleError ($message, $code)
 use given error handler to handle error message or internal ilias error message handle More...
 
- Protected Attributes inherited from ilObjDefReader
 $component_id
 
 $readers
 
 $current_reader = null
 
 $in_mail_templates = false
 
 $mail_templates_by_component = array()
 

Detailed Description

Class ilModuleReader.

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 35 of file class.ilModuleReader.php.

Constructor & Destructor Documentation

◆ __construct()

ilModuleReader::__construct (   $a_path,
  $a_name,
  $a_type 
)

Definition at line 37 of file class.ilModuleReader.php.

References $a_type.

38  {
39  parent::__construct($a_path, $a_name, $a_type);
40  }
$a_type
Definition: workflow.php:92

Member Function Documentation

◆ clearTables()

ilModuleReader::clearTables ( )

clear the tables

Definition at line 58 of file class.ilModuleReader.php.

References $ilDB.

59  {
60  global $ilDB;
61 
62  // only this one clears parents tables (not service reader)
63  parent::clearTables();
64 
65  $ilDB->manipulate("DELETE FROM module_class");
66  }
global $ilDB

◆ getModules()

ilModuleReader::getModules ( )

Definition at line 42 of file class.ilModuleReader.php.

References ilSaxParser\startParsing().

43  {
44  $this->startParsing();
45  }
startParsing()
stores xml data in array
+ Here is the call graph for this function:

◆ handlerBeginTag()

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

start tag handler

Parameters
ressouceinternal xml_parser_handler
stringelement tag name
arrayelement attributes private

Definition at line 77 of file class.ilModuleReader.php.

References $ilDB, $name, and ilObjDefReader\setComponentId().

78  {
79  global $ilDB;
80 
81 
82  switch ($a_name) {
83  case 'module':
84  $this->current_module = $this->name;
85  $this->current_component = $this->type . "/" . $this->name;
86  $ilDB->manipulateF(
87  "INSERT INTO il_component (type, name, id) " .
88  "VALUES (%s,%s,%s)",
89  array("text", "text", "text"),
90  array($this->type, $this->name, $a_attribs["id"])
91  );
92 
93  $this->setComponentId($a_attribs['id']);
94  break;
95 
96  case 'baseclass':
97  $ilDB->manipulateF(
98  "INSERT INTO module_class (module, class, dir) " .
99  "VALUES (%s,%s,%s)",
100  array("text", "text", "text"),
101  array($this->name, $a_attribs["name"], $a_attribs["dir"])
102  );
103  break;
104 
105  }
106 
107  // smeyer: first read outer xml
108  parent::handlerBeginTag($a_xml_parser, $a_name, $a_attribs);
109  }
setComponentId($a_component_id)
Set from module or service reader.
global $ilDB
+ Here is the call graph for this function:

◆ handlerCharacterData()

ilModuleReader::handlerCharacterData (   $a_xml_parser,
  $a_data 
)

end tag handler

Parameters
ressouceinternal xml_parser_handler
stringdata private

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

132  {
133  parent::handlerCharacterData($a_xml_parser, $a_data);
134 
135  // DELETE WHITESPACES AND NEWLINES OF CHARACTER DATA
136  $a_data = preg_replace("/\n/", "", $a_data);
137  $a_data = preg_replace("/\t+/", "", $a_data);
138 
139  if (!empty($a_data)) {
140  switch ($this->current_tag) {
141  case '':
142  }
143  }
144  }

◆ handlerEndTag()

ilModuleReader::handlerEndTag (   $a_xml_parser,
  $a_name 
)

end tag handler

Parameters
ressouceinternal xml_parser_handler
stringelement tag name private

Definition at line 118 of file class.ilModuleReader.php.

119  {
120  parent::handlerEndTag($a_xml_parser, $a_name);
121  }

◆ setHandlers()

ilModuleReader::setHandlers (   $a_xml_parser)

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

48  {
49  xml_set_object($a_xml_parser, $this);
50  xml_set_element_handler($a_xml_parser, 'handlerBeginTag', 'handlerEndTag');
51  xml_set_character_data_handler($a_xml_parser, 'handlerCharacterData');
52  }

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