ILIAS  release_10 Revision v10.1-43-ga1241a92c2f
ilXMLResultSetParser Class Reference
+ Inheritance diagram for ilXMLResultSetParser:
+ Collaboration diagram for ilXMLResultSetParser:

Public Member Functions

 __construct (string $a_xml_data='')
 
 getXMLResultSet ()
 
 setHandlers ($a_xml_parser)
 
 handlerBeginTag ($a_xml_parser, string $a_name, array $a_attribs)
 
 handlerEndTag ($a_xml_parser, string $a_name)
 Handler for end of element. More...
 
 handlerCharacterData ($a_xml_parser, string $a_data)
 Handler for character data. More...
 
- Public Member Functions inherited from ilSaxParser
 __construct (?string $path_to_file='', ?bool $throw_exception=false)
 
 setXMLContent (string $a_xml_content)
 
 getXMLContent ()
 
 getInputType ()
 
 startParsing ()
 stores xml data in array More...
 
 createParser ()
 
 setHandlers ($a_xml_parser)
 
 parse ($a_xml_parser, $a_fp=null)
 

Private Attributes

ilXMLResultSet $xmlResultSet = null
 
ilXMLResultSetRow $currentRow = null
 
int $currentColumnIndex = 0
 
string $cdata = ''
 

Additional Inherited Members

- Data Fields inherited from ilSaxParser
string $xml_file
 
bool $throw_exception = false
 
- Protected Member Functions inherited from ilSaxParser
 openXMLFile ()
 
 handleError (string $message)
 
 setThrowException (bool $throw_exception)
 
- Protected Attributes inherited from ilSaxParser
ilLanguage $lng = null
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilXMLResultSetParser::__construct ( string  $a_xml_data = '')

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

References ILIAS\GlobalScreen\Provider\__construct(), and ilSaxParser\setXMLContent().

22  {
24  $this->setXMLContent($a_xml_data);
25  }
__construct(Container $dic, ilPlugin $plugin)
setXMLContent(string $a_xml_content)
+ Here is the call graph for this function:

Member Function Documentation

◆ getXMLResultSet()

ilXMLResultSetParser::getXMLResultSet ( )

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

References $xmlResultSet.

◆ handlerBeginTag()

ilXMLResultSetParser::handlerBeginTag (   $a_xml_parser,
string  $a_name,
array  $a_attribs 
)
Parameters
XMLParser | resource$a_xml_parserxml parser
string$a_nameelement name
array$a_attribselement attributes array
Returns
void

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

48  : void
49  {
50  switch ($a_name) {
51  case 'result':
52  $this->xmlResultSet = new ilXMLResultSet();
53  break;
54 
55  case 'colspecs':
56  break;
57 
58  case 'colspec':
59  $this->xmlResultSet->addColumn($a_attribs["name"]);
60  break;
61  case 'row':
62  $this->currentRow = new ilXMLResultSetRow();
63  $this->xmlResultSet->addRow($this->currentRow);
64  $this->currentColumnIndex = 0;
65  break;
66  }
67  }
Row Class for XMLResultSet.

◆ handlerCharacterData()

ilXMLResultSetParser::handlerCharacterData (   $a_xml_parser,
string  $a_data 
)

Handler for character data.

Parameters
XMLParser | resource$a_xml_parserxml parser
string$a_datacharacter data
Returns
void

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

92  : void
93  {
94  if ($a_data !== "\n") {
95  // Replace multiple tabs with one space
96  $a_data = preg_replace("/\t+/", " ", $a_data);
97  $this->cdata .= trim($a_data);
98  }
99  }

◆ handlerEndTag()

ilXMLResultSetParser::handlerEndTag (   $a_xml_parser,
string  $a_name 
)

Handler for end of element.

Parameters
XMLParser | resource$a_xml_parserxml parser
string$a_nameelement name
Returns
void

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

75  : void
76  {
77  switch ($a_name) {
78  case 'column':
79  $this->currentRow->setValue($this->currentColumnIndex, $this->cdata);
80  $this->currentColumnIndex++;
81  break;
82  }
83  $this->cdata = '';
84  }

◆ setHandlers()

ilXMLResultSetParser::setHandlers (   $a_xml_parser)
Parameters
XMLParser|resourceA reference to the xml parser

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

35  : void
36  {
37  xml_set_object($a_xml_parser, $this);
38  xml_set_element_handler($a_xml_parser, 'handlerBeginTag', 'handlerEndTag');
39  xml_set_character_data_handler($a_xml_parser, 'handlerCharacterData');
40  }

Field Documentation

◆ $cdata

string ilXMLResultSetParser::$cdata = ''
private

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

◆ $currentColumnIndex

int ilXMLResultSetParser::$currentColumnIndex = 0
private

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

◆ $currentRow

ilXMLResultSetRow ilXMLResultSetParser::$currentRow = null
private

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

◆ $xmlResultSet

ilXMLResultSet ilXMLResultSetParser::$xmlResultSet = null
private

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

Referenced by getXMLResultSet().


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