ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilXMLResultSetParser Class Reference
+ Inheritance diagram for ilXMLResultSetParser:
+ Collaboration diagram for ilXMLResultSetParser:

Public Member Functions

 ilXMLResultSetParser ($a_xml_data='')
 Constructor. More...
 
 getXMLResultSet ()
 parsed result More...
 
 setHandlers ($a_xml_parser)
 set event handlers 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
 ilSaxParser ($a_xml_file='', $throwException=false)
 Constructor setup ILIAS global object @access 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 @access 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
 PEAR ($error_class=null)
 Constructor. More...
 
 _PEAR ()
 Destructor (the emulated type of...). More...
 
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...
 
 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...
 
 setErrorHandling ($mode=null, $options=null)
 Sets how errors generated by this object should be handled. 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

 $xmlResultSet
 
- 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()
 

Additional Inherited Members

- 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

Definition at line 40 of file class.ilXMLResultSetParser.php.

Member Function Documentation

◆ getXMLResultSet()

ilXMLResultSetParser::getXMLResultSet ( )

parsed result

Returns
ilXMLResultSet xmlResultSet

Definition at line 60 of file class.ilXMLResultSetParser.php.

References $xmlResultSet.

◆ handlerBeginTag()

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

handler for begin of element

Parameters
resource$a_xml_parserxml parser
string$a_nameelement name
array$a_attribselement attributes array

Definition at line 86 of file class.ilXMLResultSetParser.php.

87 {
88 switch($a_name)
89 {
90 case 'result':
91 $this->xmlResultSet = new ilXMLResultSet();
92 break;
93
94 case 'colspecs':
95 break;
96
97 case 'colspec':
98 $this->xmlResultSet->addColumn ($a_attribs["name"]);
99 break;
100 case 'row':
101 $this->currentRow = new ilXMLResultSetRow();
102 $this->xmlResultSet->addRow ($this->currentRow);
103 $this->currentColumnIndex = 0;
104 break;
105 case 'column':
106 break;
107 }
108 }

◆ handlerCharacterData()

ilXMLResultSetParser::handlerCharacterData (   $a_xml_parser,
  $a_data 
)

handler for character data

Parameters
resource$a_xml_parserxml parser
string$a_datacharacter data

Definition at line 134 of file class.ilXMLResultSetParser.php.

135 {
136 if($a_data != "\n")
137 {
138 // Replace multiple tabs with one space
139 $a_data = preg_replace("/\t+/"," ",$a_data);
140
141 $this->cdata .= trim($a_data);
142 }
143
144
145 }

◆ handlerEndTag()

ilXMLResultSetParser::handlerEndTag (   $a_xml_parser,
  $a_name 
)

handler for end of element

Parameters
resource$a_xml_parserxml parser
string$a_nameelement name

Definition at line 116 of file class.ilXMLResultSetParser.php.

117 {
118 switch($a_name)
119 {
120 case 'column':
121 $this->currentRow->setValue ($this->currentColumnIndex, $this->cdata);
122 $this->currentColumnIndex ++;
123 break;
124 }
125 $this->cdata = '';
126 }

◆ ilXMLResultSetParser()

ilXMLResultSetParser::ilXMLResultSetParser (   $a_xml_data = '')

Constructor.

Parameters
string$a_xml_dataxml data @access public

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

50 {
51 parent::ilSaxParser();
52 $this->setXMLContent($a_xml_data);
53 }
setXMLContent($a_xml_content)

References ilSaxParser\setXMLContent().

+ Here is the call graph for this function:

◆ setHandlers()

ilXMLResultSetParser::setHandlers (   $a_xml_parser)

set event handlers

Parameters
resourcereference to the xml parser @access private

Reimplemented from ilSaxParser.

Definition at line 71 of file class.ilXMLResultSetParser.php.

72 {
73 xml_set_object($a_xml_parser,$this);
74 xml_set_element_handler($a_xml_parser,'handlerBeginTag','handlerEndTag');
75 xml_set_character_data_handler($a_xml_parser,'handlerCharacterData');
76 }

Field Documentation

◆ $xmlResultSet

ilXMLResultSetParser::$xmlResultSet

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

Referenced by getXMLResultSet().


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