Public Member Functions

ilnetucateResponse Class Reference

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

Detailed Description

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


Member Function Documentation

ilnetucateResponse::getErrorMsg (  ) 

Definition at line 78 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 91 of file class.ilnetucateResponse.php.

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

ilnetucateResponse::getResultMsg (  ) 

Definition at line 86 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 142 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 251 of file class.ilnetucateResponse.php.

        {
                if(!empty($a_data))
                {
                        $this->cdata .= $a_data;
                }
        }

ilnetucateResponse::handlerEndTag ( a_xml_parser,
a_name 
)

Definition at line 214 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 42 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 68 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 128 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 103 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 113 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 51 of file class.ilnetucateResponse.php.

References 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: