Public Member Functions | Data Fields

ilBMFClient Class Reference

Inheritance diagram for ilBMFClient:
Collaboration diagram for ilBMFClient:

Public Member Functions

 ilBMFClient ($endpoint, $wsdl=false, $portName=false, $proxy_params=array())
 ilBMFClient constructor
 setEncoding ($encoding)
 setEncoding
 addHeader (&$soap_value)
 addHeader
 call ($method, $params=array(), $namespace=false, $soapAction=false, $paramtype=array())
 ilBMFClient::call
 __call ($method, $args, &$return_value)
 ilBMFClient::__call
& __getlastrequest ()
& __getlastresponse ()
 __use ($use)
 __style ($style)
 __trace ($level)
& __generate ($method, $params=array(), $namespace=false, $soapAction=false, $paramtype=array())
& __parse ($response, $encoding, $attachments)
& __decodeResponse ($response, $shift=true)
 __get_wire ()

Data Fields

 $_endpoint = ''
 $_portName = ''
 $__endpointType = ''
 $xml
 $wire
 $__last_request = NULL
 $__last_response = NULL
 $__options = array('trace'=>0)
 $_encoding = SOAP_DEFAULT_ENCODING
 $headersOut = NULL
 $headersIn = NULL
 $__proxy_params = array()

Detailed Description

Definition at line 46 of file class.ilBMFClient.php.

Member Function Documentation

ilBMFClient::__call ( $  method,
$  args,
&$  return_value 
)

ilBMFClient::__call

Overload extension support if the overload extension is loaded, you can call the client class with a soap method name $soap = new ilBMFClient(....); $value = $soap->getStockQuote('MSFT');

Parameters:
string method
array args
string retur_value
Returns:
boolean public

Definition at line 268 of file class.ilBMFClient.php.

References call().

    {
        if ($this->_wsdl) $this->_wsdl->matchMethod($method);
        $return_value = $this->call($method, $args);
        return TRUE;
    }

Here is the call graph for this function:

& ilBMFClient::__decodeResponse ( $  response,
$  shift = true 
)

Definition at line 489 of file class.ilBMFClient.php.

References ilBMFBase::_decode(), and ilBMFBase::_raiseSoapFault().

Referenced by __parse().

    {
        if (!$response) return NULL;
        // check for valid response
        if (PEAR::isError($response)) {
            return $this->_raiseSoapFault($response);
        } else if (!is_a($response,'ilbmfvalue')) {
            return $this->_raiseSoapFault("didn't get ilBMFValue object back from client");
        }

        // decode to native php datatype
        $returnArray = $this->_decode($response);
        // fault?
        if (PEAR::isError($returnArray)) {
            return $this->_raiseSoapFault($returnArray);
        }
        if (is_object($returnArray) && get_class($returnArray) == 'stdClass') {
            $returnArray = get_object_vars($returnArray);
        }

        if (is_array($returnArray)) {
            if (isset($returnArray['faultcode']) || isset($returnArray['SOAP-ENV:faultcode'])) {
                $faultcode = $faultstring = $faultdetail = $faultactor = '';
                foreach ($returnArray as $k => $v) {
                    if (stristr($k,'faultcode')) $faultcode = $v;
                    if (stristr($k,'faultstring')) $faultstring = $v;
                    if (stristr($k,'detail')) $faultdetail = $v;
                    if (stristr($k,'faultactor')) $faultactor = $v;
                }
                return $this->_raiseSoapFault($faultstring, $faultdetail, $faultactor, $faultcode);
            }
            // return array of return values
            if ($shift && count($returnArray) == 1) {
                return array_shift($returnArray);
            }
            return $returnArray;
        }
        return $returnArray;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

& ilBMFClient::__generate ( $  method,
$  params = array(),
$  namespace = false,
$  soapAction = false,
$  paramtype = array() 
)

Definition at line 300 of file class.ilBMFClient.php.

References $namespace, $type, ilBMFBase::_makeDIMEMessage(), ilBMFBase::_makeEnvelope(), ilBMFBase::_makeMimeMessage(), ilBMFBase::_raiseSoapFault(), and ilBMFBase::_setSchemaVersion().

Referenced by call().

    {
        $this->fault = null;
        $this->__options['input']='parse';
        $this->__options['result']='parse';
        $this->__options['parameters'] = false;
        if ($params && gettype($params) != 'array') {
            $params = array($params);
        }
        if (gettype($namespace) == 'array')
        {
            foreach ($namespace as $optname=>$opt)
            {
                $this->__options[strtolower($optname)]=$opt;
            }
            if (isset($this->__options['namespace']))
               $namespace = $this->__options['namespace'];
            else
                $namespace = false;
        }
        else
        {
            // we'll place soapaction into our array for usage in the transport
            $this->__options['soapaction'] = $soapAction;
            $this->__options['namespace'] = $namespace;
        }
        
        if ($this->__endpointType == 'wsdl') {
            $this->_setSchemaVersion($this->_wsdl->xsd);
            // get portName
            if (!$this->_portName) {
                $this->_portName = $this->_wsdl->getPortName($method);
            }
            if (PEAR::isError($this->_portName)) {
                return $this->_raiseSoapFault($this->_portName);
            }

            // get endpoint
            $this->_endpoint = $this->_wsdl->getEndpoint($this->_portName);
            if (PEAR::isError($this->_endpoint)) {
                return $this->_raiseSoapFault($this->_endpoint);
            }

            // get operation data
            $opData = $this->_wsdl->getOperationData($this->_portName, $method);
            
            if (PEAR::isError($opData)) {
                return $this->_raiseSoapFault($opData);
            }
            $namespace = $opData['namespace'];
            $this->__options['style'] = $opData['style'];
            $this->__options['use'] = $opData['input']['use'];
            $this->__options['soapaction'] = $opData['soapAction'];

            // set input params
            if ($this->__options['input'] == 'parse') {
            $this->__options['parameters'] = $opData['parameters'];
            $nparams = array();
            if (isset($opData['input']['parts']) && count($opData['input']['parts']) > 0) {
                $i = 0;
                reset($params);
                foreach ($opData['input']['parts'] as $name => $part) {
                    $xmlns = '';
                    $attrs = array();
                    // is the name actually a complex type?
                    if (isset($part['element'])) {
                        $xmlns = $this->_wsdl->namespaces[$part['namespace']];
                        $part = $this->_wsdl->elements[$part['namespace']][$part['type']];
                        $name = $part['name'];
                    }
                    if (isset($params[$name])) {
                        $nparams[$name] = $params[$name];
                    } else {
                        # we now force an associative array for parameters if using wsdl
                        return $this->_raiseSoapFault("The named parameter $name is not in the call parameters.");
                    }
                    if (gettype($nparams[$name]) != 'object' ||
                        !is_a($nparams[$name],'ilbmfvalue')) {
                        // type is a qname likely, split it apart, and get the type namespace from wsdl
                        $qname = new QName($part['type']);
                        if ($qname->ns) 
                            $type_namespace = $this->_wsdl->namespaces[$qname->ns];
                        else if (isset($part['namespace']))
                            $type_namespace = $this->_wsdl->namespaces[$part['namespace']];
                        else
                            $type_namespace = NULL;
                        $qname->namespace = $type_namespace;
                        $type = $qname->name;
                        $pqname = $name;
                        if ($xmlns) $pqname = '{'.$xmlns.'}'.$name;
                        $nparams[$name] = new ilBMFValue($pqname, $qname->fqn(), $nparams[$name],$attrs);
                    } else {
                        // wsdl fixups to the soap value
                    }
                }
            }
            $params = $nparams;
            }
        } else {
            $this->_setSchemaVersion(SOAP_XML_SCHEMA_VERSION);
        }
        
        // serialize the message
        $this->_section5 = TRUE; // assume we encode with section 5
        if (isset($this->__options['use']) && $this->__options['use']=='literal') $this->_section5 = FALSE;
        
        if (!isset($this->__options['style']) || $this->__options['style'] == 'rpc') {
            $this->__options['style'] = 'rpc';
            $this->docparams = true;
            $mqname = new QName($method, $namespace);
            $methodValue = new ilBMFValue($mqname->fqn(), 'Struct', $params);
            $soap_msg = $this->_makeEnvelope($methodValue, $this->headersOut, $this->_encoding,$this->__options);
        } else {
            if (!$params) {
                $mqname = new QName($method, $namespace);
                $params = new ilBMFValue($mqname->fqn(), 'Struct', NULL);
            } elseif ($this->__options['input'] == 'parse') {
                if (is_array($params)) {
                    $nparams = array();
                    foreach ($params as $n => $v) {
                        if (gettype($v) != 'object') {
                            $nparams[] = new ilBMFValue($n, false, $v);
                        } else {
                            $nparams[] = $v;
                        }
                    }
                    $params = $nparams;
                }
                if ($this->__options['parameters']) {
                    $mqname = new QName($method, $namespace);
                    $params = new ilBMFValue($mqname->fqn(), 'Struct', $params);
                }
            }
            $soap_msg = $this->_makeEnvelope($params, $this->headersOut, $this->_encoding,$this->__options);
        }

        if (PEAR::isError($soap_msg)) {
            return $this->_raiseSoapFault($soap_msg);
        }
        
        // handle Mime or DIME encoding
        // XXX DIME Encoding should move to the transport, do it here for now
        // and for ease of getting it done
        if (count($this->__attachments)) {
            if ((isset($this->__options['attachments']) && $this->__options['attachments'] == 'Mime') || isset($this->__options['Mime'])) {
                $soap_msg = $this->_makeMimeMessage($soap_msg, $this->_encoding);
            } else {
                // default is dime
                $soap_msg = $this->_makeDIMEMessage($soap_msg, $this->_encoding);
                $this->__options['headers']['Content-Type'] = 'application/dime';
            }
            if (PEAR::isError($soap_msg)) {
                return $this->_raiseSoapFault($soap_msg);
            }
        }
        
        // instantiate client
        if (is_array($soap_msg)) {
            $soap_data = $soap_msg['body'];
            if (count($soap_msg['headers'])) {
                if (isset($this->__options['headers'])) {
                    $this->__options['headers'] = array_merge($this->__options['headers'],$soap_msg['headers']);
                } else {
                    $this->__options['headers'] = $soap_msg['headers'];
                }
            }
        } else {
            $soap_data = $soap_msg;
        }
        return $soap_data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBMFClient::__get_wire (  ) 

Definition at line 529 of file class.ilBMFClient.php.

Referenced by call().

    {
        if ($this->__options['trace'] > 0) {
            return "OUTGOING:\n\n".
            $this->__last_request.
            "\n\nINCOMING\n\n".
            preg_replace("/></",">\r\n<",$this->__last_response);
        }
        return NULL;
    }

Here is the caller graph for this function:

& ilBMFClient::__getlastrequest (  ) 

Definition at line 275 of file class.ilBMFClient.php.

    {
        return $this->__last_request;
    }

& ilBMFClient::__getlastresponse (  ) 

Definition at line 280 of file class.ilBMFClient.php.

    {
        return $this->__last_response;
    }

& ilBMFClient::__parse ( $  response,
$  encoding,
$  attachments 
)

Definition at line 472 of file class.ilBMFClient.php.

References __decodeResponse(), and ilBMFBase::_raiseSoapFault().

Referenced by call().

    {
        // parse the response
        $this->response = new ilBMFParser($response, $encoding, $attachments);
        if ($this->response->fault) {
            return $this->_raiseSoapFault($this->response->fault);
        }
        // return array of parameters
        $return = $this->response->getResponse();
        $headers = $this->response->getHeaders();
        if ($headers) {
            $this->headersIn = $this->__decodeResponse($headers,false);
        }
        
        return $this->__decodeResponse($return); 
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBMFClient::__style ( $  style  ) 

Definition at line 290 of file class.ilBMFClient.php.

    {
        $this->__options['style'] = $style;
    }

ilBMFClient::__trace ( $  level  ) 

Definition at line 295 of file class.ilBMFClient.php.

    {
        $this->__options['trace'] = $level;
    }

ilBMFClient::__use ( $  use  ) 

Definition at line 285 of file class.ilBMFClient.php.

    {
        $this->__options['use'] = $use;
    }

ilBMFClient::addHeader ( &$  soap_value  ) 

addHeader

To add headers to the envelop, you use this function, sending it a ilBMFHeader class instance.

Parameters:
ilBMFHeader a soap value to send as a header

public

Definition at line 173 of file class.ilBMFClient.php.

References ilBMFBase::_raiseSoapFault().

    {
        # add a new header to the message
        if (is_a($soap_value,'ibmfheader')) {
            $this->headersOut[] = $soap_value;
        } else if (gettype($soap_value) == 'array') {
            // name, value, namespace, mustunderstand, actor
            $h = new ilBMFHeader($soap_value[0], NULL, $soap_value[1], $soap_value[2], $soap_value[3]);
            $this->headersOut[] = $h;
        } else {
            $this->_raiseSoapFault("Don't understand the header info you provided.  Must be array or ilBMFHeader.");
        }
    }

Here is the call graph for this function:

ilBMFClient::call ( $  method,
$  params = array(),
$  namespace = false,
$  soapAction = false,
$  paramtype = array() 
)

ilBMFClient::call

the namespace parameter is overloaded to accept an array of options that can contain data necessary for various transports if it is used as an array, it MAY contain a namespace value and a soapaction value. If it is overloaded, the soapaction parameter is ignored and MUST be placed in the options array. This is done to provide backwards compatibility with current clients, but may be removed in the future.

Parameters:
string method
array params
array options (hash with namespace, soapaction, timeout, from, subject, etc.)

The options parameter can have a variety of values added. The currently supported values are: namespace soapaction timeout (http socket timeout) from (smtp) transfer-encoding (smtp, sets the Content-Transfer-Encoding header) subject (smtp, subject header) headers (smtp, array-hash of extra smtp headers)

Returns:
array of results public

Definition at line 215 of file class.ilBMFClient.php.

References $namespace, __generate(), __get_wire(), __parse(), and ilBMFBase::_raiseSoapFault().

Referenced by __call().

    {
        $soap_data = $this->__generate($method, $params, $namespace, $soapAction, $paramtype);
        if (PEAR::isError($soap_data)) {
            return $this->_raiseSoapFault($soap_data);
        }
        $soap_transport = new ilBMFTransport($this->_endpoint, $this->_encoding);
        if ($soap_transport->fault) {
            return $this->_raiseSoapFault($soap_transport->fault);
        }
        // send the message

        $transport_options = array_merge($this->__proxy_params, $this->__options);
            //echo "$soap_data";
        $this->xml = $soap_transport->send($soap_data, $transport_options);

        // save the wire information for debugging
#$this->__options["trace"] = 1;
        if ($this->__options['trace'] > 0) {
            $this->__last_request =& $soap_transport->transport->outgoing_payload;
            $this->__last_response =& $soap_transport->transport->incoming_payload;
            $this->wire = $this->__get_wire();
#                       var_dump("<pre>",$this->wire,"</pre>");
        }
        if ($soap_transport->fault) {
            return $this->_raiseSoapFault($this->xml);
        }

        $this->__attachments =& $soap_transport->transport->attachments;
        $this->__result_encoding = $soap_transport->result_encoding;
        unset($soap_transport);
        
        if (isset($this->__options['result']) && $this->__options['result'] != 'parse') return $this->xml;
        
        return $this->__parse($this->xml, $this->__result_encoding,$this->__attachments);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBMFClient::ilBMFClient ( $  endpoint,
$  wsdl = false,
$  portName = false,
$  proxy_params = array() 
)

ilBMFClient constructor

Parameters:
string endpoint (URL)
boolean wsdl (true if endpoint is a wsdl file)
string portName
array contains options for HTTP_Request class (see HTTP/Request.php) public

Definition at line 126 of file class.ilBMFClient.php.

References ilBMFBase::_raiseSoapFault(), and ilBMFBase::ilBMFBase().

    {
        parent::ilBMFBase('Client');
        $this->_endpoint = $endpoint;
        $this->_portName = $portName;
        $this->__proxy_params = $proxy_params;
        
        // make values
        if ($wsdl) {
            $this->__endpointType = 'wsdl';
            // instantiate wsdl class
            $this->_wsdl = new ilBMFWSDL($this->_endpoint, $this->__proxy_params);
            if ($this->_wsdl->fault) {
                $this->_raiseSoapFault($this->_wsdl->fault);
            }
        }
    }

Here is the call graph for this function:

ilBMFClient::setEncoding ( $  encoding  ) 

setEncoding

set the character encoding, limited to 'UTF-8', 'US_ASCII' and 'ISO-8859-1'

Parameters:
string encoding
Returns:
mixed returns NULL or ilBMFFault public

Definition at line 154 of file class.ilBMFClient.php.

References ilBMFBase::_raiseSoapFault().

    {
        if (in_array($encoding, $this->_encodings)) {
            $this->_encoding = $encoding;
            return NULL;
        }
        return $this->_raiseSoapFault('Invalid Encoding');
    }

Here is the call graph for this function:

Field Documentation

ilBMFClient::$__endpointType = ''

Definition at line 78 of file class.ilBMFClient.php.

ilBMFClient::$__last_request = NULL

Definition at line 87 of file class.ilBMFClient.php.

ilBMFClient::$__last_response = NULL

Definition at line 88 of file class.ilBMFClient.php.

ilBMFClient::$__options = array('trace'=>0)

Definition at line 89 of file class.ilBMFClient.php.

ilBMFClient::$__proxy_params = array()

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

ilBMFClient::$_encoding = SOAP_DEFAULT_ENCODING

Definition at line 95 of file class.ilBMFClient.php.

ilBMFClient::$_endpoint = ''

Definition at line 63 of file class.ilBMFClient.php.

ilBMFClient::$_portName = ''

Definition at line 70 of file class.ilBMFClient.php.

ilBMFClient::$headersIn = NULL

Definition at line 109 of file class.ilBMFClient.php.

ilBMFClient::$headersOut = NULL

Definition at line 103 of file class.ilBMFClient.php.

ilBMFClient::$wire

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

ilBMFClient::$xml

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

The documentation for this class was generated from the following file:
Generated on Fri Dec 13 2013 13:52:22 for ILIAS Release_3_7_x_branch .rev 46817 by  doxygen 1.7.1