ILIAS  Release_4_1_x_branch Revision 61804
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions
ilnetucateResponse Class Reference

process reponse from Centra Server (c) Sascha Hofmann, 2004 More...

+ Inheritance diagram for ilnetucateResponse:
+ Collaboration diagram for ilnetucateResponse:

Public Member Functions

 ilnetucateResponse ($a_str)
 Constructor public.
 validateInput ($a_str)
 isError ()
 getErrorMsg ()
 getResultMsg ()
 getFirstID ()
 setHandlers ($a_xml_parser)
 set event handler should be overwritten by inherited class private
 startParsing ()
 start the parser
 parse ($a_xml_parser, $a_xml_str)
 parse xml file
 handlerBeginTag ($a_xml_parser, $a_name, $a_attribs)
 handler for begin of element
 handlerEndTag ($a_xml_parser, $a_name)
 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 ()
 createParser ()
 create parser
 setOptions ($a_xml_parser)
 set parser options
 openXMLFile ()
 open 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.

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

process reponse from Centra Server (c) Sascha Hofmann, 2004

Author
Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de
Version
Id:
class.ilnetucateResponse.php 15689 2008-01-08 15:55:14Z akill

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

Member Function Documentation

ilnetucateResponse::getErrorMsg ( )

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

{
if ($this->data['response']['status'] == "error" or $this->data['response']['status'] == "")
{
return trim($this->data['result']['cdata']);
}
}
ilnetucateResponse::getFirstID ( )

Definition at line 90 of file class.ilnetucateResponse.php.

{
reset($this->data['id']);
return current($this->data['id']);
}
ilnetucateResponse::getResultMsg ( )

Definition at line 85 of file class.ilnetucateResponse.php.

{
return trim($this->data['result']['cdata']);
}
ilnetucateResponse::handlerBeginTag (   $a_xml_parser,
  $a_name,
  $a_attribs 
)

handler for begin of element

Definition at line 141 of file class.ilnetucateResponse.php.

References $ilErr.

{
global $ilErr;
switch($a_name)
{
case "netucate.API.Response":
$this->data['response']['failureCount'] = $a_attribs['failureCount'];
$this->data['response']['operationTotal'] = $a_attribs['operationTotal'];
$this->data['response']['status'] = $a_attribs['status'];
$this->data['response']['successCount'] = $a_attribs['successCount'];
break;
case "netucate.Result":
$this->data['result']['code'] = $a_attribs['code'];
$this->data['result']['id'] = $a_attribs['id'];
$this->data['result']['name'] = $a_attribs['name'];
$this->data['result']['request'] = $a_attribs['request'];
break;
case "netucate.ElementID":
$this->data['element']['type'] = $a_attribs['type'];
break;
case "netucate.URL":
break;
case "netucate.ID":
break;
case "netucate.Class.List":
case "netucate.User.List":
break;
case "netucate.Class":
$this->data['classes'][$a_attribs['classid']] = array (
'name' => $a_attribs['name'],
'instructoruserid' => $a_attribs['instructoruserid'],
'bandwidth' => $a_attribs['bandwidth'],
'appsharebandwidth' => $a_attribs['appsharebandwidth'],
'description' => $a_attribs['description'],
'password' => $a_attribs['password'],
'message' => $a_attribs['message'],
'floorpolicy' => $a_attribs['floorpolicy'],
'conferencetypeid' => $a_attribs['conferencetypeid'],
'videobandwidth' => $a_attribs['videobandwidth'],
'videoframerate' => $a_attribs['videoframerate'],
'enablepush' => $a_attribs['enablepush'],
'issecure' => $a_attribs['issecure'],
'alwaysopen' => $a_attribs['alwaysopen'],
'akclassvalue1' => $a_attribs['akclassvalue1'],
'akclassvalue2' => $a_attribs['akclassvalue2']
);
break;
case "netucate.User":
$this->data['users'][$a_attribs['userid']] = array (
'fullname' => $a_attribs['fullname'],
'authority' => $a_attribs['authority'],
'email' => $a_attribs['email'],
'homepage' => $a_attribs['homepage'],
'contactinfo' => $a_attribs['contactinfo'],
'comment' => $a_attribs['comments'],
'phonenumber' => $a_attribs['phonenumber'],
'akuservalue1' => $a_attribs['akuservalue1'],
'akuservalue2' => $a_attribs['akuservalue2'],
);
break;
}
}
ilnetucateResponse::handlerCharacterData (   $a_xml_parser,
  $a_data 
)

handler for character data

Definition at line 250 of file class.ilnetucateResponse.php.

{
if(!empty($a_data))
{
$this->cdata .= $a_data;
}
}
ilnetucateResponse::handlerEndTag (   $a_xml_parser,
  $a_name 
)

Definition at line 213 of file class.ilnetucateResponse.php.

{
switch($a_name)
{
case "netucate.API.Response":
$this->data['response']['cdata'] = $this->cdata;
break;
case "netucate.Result":
$this->data['result']['cdata'] = $this->cdata;
break;
case "netucate.ElementID":
//$this->data['element']['cdata'] = $this->cdata;
break;
case "netucate.URL":
$this->data['url']['cdata'] = trim($this->cdata);
break;
case "netucate.ID":
$this->data['id'][trim($this->cdata)] = trim($this->cdata);
break;
case "netucate.Class.List":
case "netucate.Class":
case "netucate.User.List":
case "netucate.User":
break;
}
$this->cdata = '';
}
ilnetucateResponse::ilnetucateResponse (   $a_str)

Constructor public.

Definition at line 41 of file class.ilnetucateResponse.php.

References ilSaxParser\ilSaxParser(), startParsing(), and validateInput().

{
$xml_str = $this->validateInput($a_str);
parent::ilSaxParser($xml_str);
$this->startParsing();
}

+ Here is the call graph for this function:

ilnetucateResponse::isError ( )

Definition at line 67 of file class.ilnetucateResponse.php.

{
if ($this->data['response']['status'] == "error" or $this->data['response']['status'] == "")
{
return true;
}
return false;
}
ilnetucateResponse::parse (   $a_xml_parser,
  $a_xml_str 
)

parse xml file

private

Reimplemented from ilSaxParser.

Definition at line 127 of file class.ilnetucateResponse.php.

Referenced by startParsing().

{
$parseOk = xml_parse($a_xml_parser,$a_xml_str,true);
if (!$parseOk && (xml_get_error_code($a_xml_parser) != XML_ERROR_NONE))
{
$this->ilias->raiseError("XML Parse Error: ".xml_error_string(xml_get_error_code($a_xml_parser)),$this->ilias->error_obj->FATAL);
}
}

+ Here is the caller graph for this function:

ilnetucateResponse::setHandlers (   $a_xml_parser)

set event handler should be overwritten by inherited class private

Reimplemented from ilSaxParser.

Definition at line 102 of file class.ilnetucateResponse.php.

Referenced by startParsing().

{
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');
}

+ Here is the caller graph for this function:

ilnetucateResponse::startParsing ( )

start the parser

Reimplemented from ilSaxParser.

Definition at line 112 of file class.ilnetucateResponse.php.

References ilSaxParser\createParser(), ilSaxParser\freeParser(), parse(), setHandlers(), and ilSaxParser\setOptions().

Referenced by ilnetucateResponse().

{
$xml_parser = $this->createParser();
$this->setOptions($xml_parser);
$this->setHandlers($xml_parser);
$this->parse($xml_parser,$this->xml_file);
$this->freeParser($xml_parser);
return true;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilnetucateResponse::validateInput (   $a_str)

Definition at line 50 of file class.ilnetucateResponse.php.

References $response_data, and exit.

Referenced by ilnetucateResponse().

{
$response = split("\r\n\r\n",$a_str);
$header = $response[0];
$response_data = $response[1];
if (strpos($response_data,"<?xml") === false)
{
echo "netucateResponse::validateInput() : No valid response data!<br/>";
var_dump($header,$response_data);
exit;
}
return chop($response_data);
}

+ Here is the caller graph for this function:

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