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


Classes:
SOAP_Client
SOAP_Value
SOAP_WSDL
Files:
Client.php
WSDL.php

Class: SOAP_Client

Source Location: /SOAP-0.9.0/Client.php

Class Overview

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

SOAP Client Class


Author(s):

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 79]
SOAP Client Class

This class is the main interface for making soap requests.

basic usage:

  1.    $soapclient = new SOAP_Client( string path [ , boolean wsdl] );
    2. 

  2.    echo $soapclient->call( string methodname [ , array parameters] );
    3.

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



[ Top ]

Class Variables

$headersIn =  null

[line 154]

The headers we recieved back in the response.
  • Var: array

Type:   $headersIn


[ Top ]

$headersOut =  null

[line 147]

The array of SOAP_Headers that we are sending.
  • Var: array

Type:   $headersOut


[ Top ]

$wire =

[line 124]

The outgoing and incoming data stream for debugging.
  • Var: string

Type:   $wire


[ Top ]

$xml =

[line 117]

The received xml.
  • Var: string

Type:   $xml


[ Top ]


Method Detail

SOAP_Client (Constructor)   [line 176]

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

Constructor.
  • Access: public

Parameters:

string   $endpoint   —  An URL.
boolean   $wsdl   —  Whether the endpoint is a WSDL file.
string   $portName   — 
array   $proxy_params   —  Options for the HTTP_Request class (see HTTP/Request.php)

[ Top ]

addHeader   [line 243]

void addHeader( &$soap_value, SOAP_Header $soap_value)

Adds a header to the envelope.
  • Access: public

Parameters:

SOAP_Header   $soap_value   —  A SOAP_Header or an array with the elements 'name', 'namespace', 'mustunderstand', and 'actor' to send as a header.
   &$soap_value   — 

[ Top ]

call   [line 288]

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

Calls a method on the SOAP endpoint.

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. The currently supported values are:

   namespace
   soapaction
   timeout (HTTP socket timeout)
   transfer-encoding (SMTP, Content-Transfer-Encoding: header)
   from (SMTP, From: header)
   subject (SMTP, Subject: header)
   headers (SMTP, hash of extra SMTP headers)

  • Return: The method result or a SOAP_Fault on error.
  • Access: public

Parameters:

string   $method   —  The method to call.
array   $params   —  The method parameters.
string|array   $namespace   —  Namespace or hash with options.
string   $soapAction   — 
   &$params   — 

[ Top ]

setEncoding   [line 224]

mixed setEncoding( string $encoding)

Sets the character encoding.

Limited to 'UTF-8', 'US_ASCII' and 'ISO-8859-1'.

  • Return: SOAP_Fault on error.
  • Access: public

Parameters:

string   $encoding   —  encoding

[ Top ]

setOpt   [line 361]

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

Sets an option to use with the transport layers.

For example: 

  1.  $soapclient->setOpt('curl', CURLOPT_VERBOSE, 1)
    2.
to pass a specific option to curl if using an SSL connection.

  • Access: public

Parameters:

string   $category   —  Category to which the option applies or option name.
string   $option   —  An option name if $category is a category name, an option value if $category is an option name.
string   $value   —  An option value if $category is a category name.

[ Top ]

_call   [line 392]

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

Call method supporting the overload extension.

If the overload extension is loaded, you can call the client class with a soap method name: 

  1.  $soap = new SOAP_Client(....);
    2. 

  2.  $value = $soap->getStockQuote('MSFT');
    3.

  • Return: Always true.
  • Access: public

Parameters:

string   $method   —  The method to call.
array   $params   —  The method parameters.
string   $return_value   —  Will get the method's return value assigned.
   &$return_value   — 

[ Top ]

__decodeResponse   [line 652]

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


Parameters:

   &$response   — 
   $shift   — 

[ Top ]

__generate   [line 431]

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


Parameters:

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

[ Top ]

__getlastrequest   [line 406]

void &__getlastrequest( )


[ Top ]

__getlastresponse   [line 411]

void &__getlastresponse( )


[ Top ]

__get_wire   [line 698]

void __get_wire( )


[ Top ]

__parse   [line 634]

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


Parameters:

   &$response   — 
   $encoding   — 
   &$attachments   — 

[ Top ]

__style   [line 421]

void __style( $style)


Parameters:

   $style   — 

[ Top ]

__trace   [line 426]

void __trace( $level)


Parameters:

   $level   — 

[ Top ]

__use   [line 416]

void __use( $use)


Parameters:

   $use   — 

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