SOAP--Client
[ class tree: SOAP--Client ] [ index: SOAP--Client ] [ all elements ]
Packages:
SOAP
SOAP--Attachment
SOAP--Client
SOAP--Header
SOAP--Parser
SOAP--Server
SOAP--Transport
SOAP--Transport--HTTP
SOAP--Transport--SMTP
SOAP--Transport--TCP


Classes:
QName
SOAP_Base
SOAP_Server
SOAP_Value
SOAP_WSDL
SOAP
   SOAP_Client
   SOAP_Client_Overload
   SOAP_WSDL_Cache
   SOAP_WSDL_ObjectParser
   SOAP_WSDL_Parser
Files:
Base.php
Server.php
WSDL.php

subpackage SOAP
Client.php

Class: SOAP_Client

Source Location: /SOAP-0.8.1/Client.php

Class Overview

PEAR
   |
   --SOAP_Base_Object
      |
      --SOAP_Base
         |
         --SOAP_Client_Overload
            |
            --SOAP_Client

SOAP Client Class this class is the main interface for making soap requests


Author(s):

Version:

  • $Id: Client.php,v 1.62.2.4 2004/10/21 17:52:02 arnaud Exp $

Variables

Methods

Inherited Variables

Class: SOAP_Base_Object

SOAP_Base_Object::$fault
SOAP_Base_Object::$_debug_data

Inherited Methods

Class: SOAP_Client_Overload

SOAP_Client_Overload::__call()

Class: SOAP_Base

SOAP_Base::SOAP_Base()
Constructor
SOAP_Base::__set_type_translation()

Class: SOAP_Base_Object

SOAP_Base_Object::SOAP_Base_Object()
Constructor
SOAP_Base_Object::__getfault()
SOAP_Base_Object::__isfault()

Class Details

[line 78]
SOAP Client Class this class is the main interface for making soap requests

basic usage: $soapclient = new SOAP_Client( string path [ , boolean wsdl] ); echo $soapclient->call( string methodname [ , array parameters] );

originaly based on SOAPx4 by Dietrich Ayala http://dietrich.ganx4.com/soapx4

  • Author: Shane Caraveo <shane@php.net> Conversion to PEAR and updates
  • Author: Stig Bakken <ssb@fast.no> Conversion to PEAR
  • Author: Dietrich Ayala <dietrich@ganx4.com> Original Author
  • Version: $Id: Client.php,v 1.62.2.4 2004/10/21 17:52:02 arnaud Exp $
  • Access: public


[ Top ]

Class Variables

$headersIn =  null

[line 148]

headersOut
  • Var: contains an array headers we recieved back in the response

Type:   array


[ Top ]

$headersOut =  null

[line 142]

headersOut
  • Var: contains an array of SOAP_Headers that we are sending

Type:   array


[ Top ]

$wire =

[line 118]


Type:   mixed


[ Top ]

$xml =

[line 117]

wire
  • Var: contains outoing and incoming data stream for debugging.

Type:   string


[ Top ]


Method Detail

SOAP_Client (Constructor)   [line 167]

SOAP_Client SOAP_Client( string $endpoint, [boolean $wsdl = false], [string $portName = false], [array $proxy_params = array()])

SOAP_Client constructor
  • Access: public

Parameters:

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

[ Top ]

addHeader   [line 224]

void addHeader( SOAP_Header &$soap_value)

addHeader

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

  • Access: public

Parameters:

SOAP_Header   &$soap_value   —  a soap value to send as a header

[ Top ]

call   [line 265]

array &call( string $method, array &$params, [array $namespace = false], [ $soapAction = false])

SOAP_Client::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.

  • Return: of results
  • Access: public

Parameters:

string   $method   —  method
array   &$params   —  params
array   $namespace   — 

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)
   $soapAction   — 

[ Top ]

setEncoding   [line 206]

mixed setEncoding( string $encoding)

setEncoding

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

  • Return: returns NULL or SOAP_Fault
  • Access: public

Parameters:

string   $encoding   —  encoding

[ Top ]

setOpt   [line 328]

void setOpt( string $category, string $option, [string $value = null])

Sets option to use with the transports layers.

An example of such use is $soapclient->setOpt('curl', CURLOPT_VERBOSE, 1) to pass a specific option to when using an SSL connection.

  • Access: public

Parameters:

string   $category   —  category to which the option applies
string   $option   —  option name
string   $value   —  option value

[ Top ]

_call   [line 354]

boolean _call( string $method, array $args, string &$return_value)

Overload extension support

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

  • Access: public

Parameters:

string   $method   —  method
array   $args   —  args
string   &$return_value   —  retur_value

[ Top ]

__decodeResponse   [line 580]

void &__decodeResponse( &$response, [ $shift = true])


Parameters:

   &$response   — 
   $shift   — 

[ Top ]

__generate   [line 393]

void &__generate( $method, &$params, [ $namespace = false], [ $soapAction = false])


Parameters:

   $method   — 
   &$params   — 
   $namespace   — 
   $soapAction   — 

[ Top ]

__getlastrequest   [line 368]

void &__getlastrequest( )


[ Top ]

__getlastresponse   [line 373]

void &__getlastresponse( )


[ Top ]

__get_wire   [line 619]

void __get_wire( )


[ Top ]

__parse   [line 564]

void &__parse( &$response, $encoding, &$attachments)


Parameters:

   &$response   — 
   $encoding   — 
   &$attachments   — 

[ Top ]

__style   [line 383]

void __style( $style)


Parameters:

   $style   — 

[ Top ]

__trace   [line 388]

void __trace( $level)


Parameters:

   $level   — 

[ Top ]

__use   [line 378]

void __use( $use)


Parameters:

   $use   — 

[ Top ]
Documentation generated on Mon, 11 Mar 2019 13:59:45 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.