ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilXMLResultSetParser Class Reference
+ Inheritance diagram for ilXMLResultSetParser:
+ Collaboration diagram for ilXMLResultSetParser:

Public Member Functions

 ilXMLResultSetParser ($a_xml_data= '')
 Constructor.
 getXMLResultSet ()
 parsed result
 setHandlers ($a_xml_parser)
 set event handlers
 handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
 handler for begin of element
 handlerEndTag ($a_xml_parser, $a_name)
 handler for end of element
 handlerCharacterData ($a_xml_parser, $a_data)
 handler for character data
- 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.

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

Detailed Description

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

Member Function Documentation

ilXMLResultSetParser::getXMLResultSet ( )

parsed result

Returns
ilXMLResultSet xmlResultSet

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

References $xmlResultSet.

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

{
switch($a_name)
{
case 'result':
$this->xmlResultSet = new ilXMLResultSet();
break;
case 'colspecs':
break;
case 'colspec':
$this->xmlResultSet->addColumn ($a_attribs["name"]);
break;
case 'row':
$this->currentRow = new ilXMLResultSetRow();
$this->xmlResultSet->addRow ($this->currentRow);
$this->currentColumnIndex = 0;
break;
case 'column':
break;
}
}
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.

{
if($a_data != "\n")
{
// Replace multiple tabs with one space
$a_data = preg_replace("/\t+/"," ",$a_data);
$this->cdata .= trim($a_data);
}
}
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.

{
switch($a_name)
{
case 'column':
$this->currentRow->setValue ($this->currentColumnIndex, $this->cdata);
$this->currentColumnIndex ++;
break;
}
$this->cdata = '';
}
ilXMLResultSetParser::ilXMLResultSetParser (   $a_xml_data = '')

Constructor.

Parameters
string$a_xml_dataxml data public

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

References ilSaxParser\ilSaxParser(), and ilSaxParser\setXMLContent().

{
$this->setXMLContent($a_xml_data);
}

+ Here is the call graph for this function:

ilXMLResultSetParser::setHandlers (   $a_xml_parser)

set event handlers

Parameters
resourcereference to the xml parser private

Reimplemented from ilSaxParser.

Definition at line 71 of file class.ilXMLResultSetParser.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

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: