Class: SOAP_WSDL

Source Location: /SOAP-0.10.0/WSDL.php

Class Overview

PEAR
   |
   --SOAP_Base_Object
      |
      --SOAP_Base
         |
         --SOAP_WSDL

This class parses WSDL files, and can be used by SOAP::Client to properly register soap values for services.

Author(s):

Shane Caraveo <shane at php.net> Conversion to PEAR and updates
Dietrich Ayala <dietrich at ganx4.com> Original Author

Variables

Methods

Inherited Variables

Class: SOAP_Base_Object

SOAP_Base_Object::$fault
SOAP_Base_Object::$_debug_data

Inherited Methods

Class: SOAP_Base

SOAP_Base::SOAP_Base(): Constructor.
SOAP_Base::makeEnvelope(): Creates the SOAP envelope with the SOAP envelop data.
SOAP_Base::setDefaultNamespace(): Sets the default namespace.
SOAP_Base::setTypeTranslation(): Explicitly sets the translation for a specific class.
SOAP_Base::__set_type_translation()

Class: SOAP_Base_Object

SOAP_Base_Object::SOAP_Base_Object(): Constructor.

Class Details

[line 48]
This class parses WSDL files, and can be used by SOAP::Client to properly register soap values for services.

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

Author: Shane Caraveo <shane@php.net> Conversion to PEAR and updates
Author: Dietrich Ayala <dietrich@ganx4.com> Original Author
Todo: - add wsdl caching
- refactor namespace handling ($namespace/$ns)
- implement IDL type syntax declaration so we can generate WSDL
Access: public

[ Top ]

Class Variables

$bindings = array()

[line 59]

Type:

mixed

[ Top ]

$cacheDir =

[line 104]

WSDL cache directory.

Type:

string

[ Top ]

$cacheMaxAge =

[line 111]

Cache maximum lifetime (in seconds).

Type:

integer

[ Top ]

$cacheUse =

[line 97]

Use WSDL cache?

Type:

boolean

[ Top ]

$complexTypes = array()

[line 55]

Type:

mixed

[ Top ]

$definition = array()

[line 51]

Type:

mixed

[ Top ]

$docs =

[line 76]

Parse documentation in the WSDL?

Type:

boolean

[ Top ]

$elements = array()

[line 56]

Type:

mixed

[ Top ]

$imports = array()

[line 60]

Type:

mixed

[ Top ]

$messages = array()

[line 57]

Type:

mixed

[ Top ]

$namespaces = array()

[line 52]

Type:

mixed

[ Top ]

$ns = array()

[line 53]

Type:

mixed

[ Top ]

$portTypes = array()

[line 58]

Type:

mixed

[ Top ]

$proxy =

[line 83]

Proxy parameters.

Type:

array

[ Top ]

$service = ''

[line 62]

Type:

mixed

[ Top ]

$services = array()

[line 61]

Type:

mixed

[ Top ]

$tns = null

[line 50]

Type:

mixed

[ Top ]

$trace = false

[line 90]

Enable tracing in the generated proxy class?

Type:

boolean

[ Top ]

$uri =

[line 69]

URL to WSDL file.

Type:

string

[ Top ]

$wsdlParserClass = 'SOAP_WSDL_Parser'

[line 119]

Class to use for WSDL parsing. Can be overridden for special cases, subclasses, etc.

Type:

string

[ Top ]

$xsd = SOAP_XML_SCHEMA_VERSION

[line 54]

Type:

mixed

[ Top ]

Method Detail

SOAP_WSDL (Constructor) [line 164]

SOAP_WSDL SOAP_WSDL(
[string
$wsdl_uri = false], [array
$proxy = array()], [boolean|string
$cacheUse = false], [integer
$cacheMaxAge = WSDL_CACHE_MAX_AGE], [boolean
$docs = false])

SOAP_WSDL constructor.

See: HTTP_Request.
Access: public

Parameters:

string	`$wsdl_uri`	—	URL to WSDL file.
array	`$proxy`	—	Options for HTTP_Request class
boolean\|string	`$cacheUse`	—	Use WSDL caching? The cache directory if a string.
integer	`$cacheMaxAge`	—	Cache maximum lifetime (in seconds).
boolean	`$docs`	—	Parse documentation in the WSDL?

[ Top ]

addNamespace [line 483]

void addNamespace(

$namespace)

Parameters:

$namespace —

[ Top ]

generateAllProxies [line 752]

void generateAllProxies(
)

[ Top ]

generateProxyCode [line 582]

void generateProxyCode(
[
$port = ''], [
$classname = ''])

Generates stub code from the WSDL that can be saved to a file or eval'd into existence.

Parameters:

	`$port`	—
	`$classname`	—

[ Top ]

getComplexTypeChildType [line 840]

void getComplexTypeChildType(

$ns, 
$name, 
$child_ns, 
$child_name)

Parameters:

	`$ns`	—
	`$name`	—
	`$child_ns`	—
	`$child_name`	—

[ Top ]

getComplexTypeNameForElement [line 831]

void getComplexTypeNameForElement(

$name, 
$namespace)

Parameters:

	`$name`	—
	`$namespace`	—

[ Top ]

getDataHandler [line 403]

string getDataHandler(
string
$datatype, string
$namespace)

Given a datatype, what function handles the processing?

This is used for doc/literal requests where we receive a datatype, and we need to pass it to a method in out server class.

Access: public

Parameters:

string	`$datatype`	—
string	`$namespace`	—

[ Top ]

getEndpoint [line 247]

void getEndpoint(

$portName)

Parameters:

$portName —

[ Top ]

getNamespace [line 455]

void getNamespace(

$portName, 
$operation)

Parameters:

	`$portName`	—
	`$operation`	—

[ Top ]

getNamespaceAttributeName [line 468]

void getNamespaceAttributeName(

$namespace)

Parameters:

$namespace —

[ Top ]

getOperationData [line 303]

void getOperationData(

$portName, 
$operation)

Parameters:

	`$portName`	—
	`$operation`	—

[ Top ]

getPortName [line 277]

void getPortName(

$operation, [
$service = null])

Finds the name of the first port that contains an operation of name $operation. Always returns a SOAP portName.

Parameters:

	`$operation`	—
	`$service`	—

[ Top ]

getProxy [line 762]

void &getProxy(
[
$port = ''], [
$name = ''])

Parameters:

	`$port`	—
	`$name`	—

[ Top ]

getSchemaType [line 857]

void getSchemaType(

$type, 
$name, 
$type_namespace)

Parameters:

	`$type`	—
	`$name`	—
	`$type_namespace`	—

[ Top ]

getSoapAction [line 442]

void getSoapAction(

$portName, 
$operation)

Parameters:

	`$portName`	—
	`$operation`	—

[ Top ]

matchMethod [line 376]

void matchMethod(

&$operation)

Parameters:

&$operation —

[ Top ]

parseObject [line 235]

void parseObject(

&$wsdl_obj, string
$targetNamespace, string
$service_name, [string
$service_desc = ''], mixed
$wsdl_obj)

Fills the WSDL array tree with data from one or more PHP class objects.

Parameters:

mixed	`$wsdl_obj`	—	An object or array of objects to add to the internal WSDL tree.
string	`$targetNamespace`	—	The target namespace of schema types etc.
string	`$service_name`	—	Name of the WSDL service.
string	`$service_desc`	—	Optional description of the WSDL service.
	`&$wsdl_obj`	—

[ Top ]

parseURL [line 215]

void parseURL(
string
$wsdl_uri, [array
$proxy = array()])

Fills the WSDL array tree with data from a WSDL file.

See: HTTP_Request.

Parameters:

string	`$wsdl_uri`	—	URL to WSDL file.
array	`$proxy`	—	Contains options for HTTP_Request class

[ Top ]

setService [line 201]

void setService(
string
$service)

Sets the service currently to be used.

Parameters:

string $service — An (existing) service name.

[ Top ]

set_service [line 191]

void set_service(

$service)

Deprecated: Use setService().

Parameters:

$service —

[ Top ]