SOAP
[ class tree: SOAP ] [ index: SOAP ] [ all elements ]

Class: SOAP_WSDL

Source Location: /SOAP-0.13.0/SOAP/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):

Variables

Methods


Inherited Variables

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::SOAPENCPrefix()
Sets the SOAP-ENC prefix and returns the current value.
SOAP_Base::SOAPENVPrefix()
Sets the SOAP-ENV prefix and returns the current value.

Class: SOAP_Base_Object

SOAP_Base_Object::SOAP_Base_Object()
Constructor.

Class Details

[line 47]
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: - refactor namespace handling ($namespace/$ns)
    • implement IDL type syntax declaration so we can generate WSDL
  • Access: public


[ Top ]


Class Variables

$bindings = array()

[line 58]


Type:   mixed


[ Top ]

$cacheDir =

[line 103]

WSDL cache directory.

Type:   string


[ Top ]

$cacheMaxAge =

[line 110]

Cache maximum lifetime (in seconds).

Type:   integer


[ Top ]

$cacheUse =

[line 96]

Use WSDL cache?

Type:   boolean


[ Top ]

$complexTypes = array()

[line 54]


Type:   mixed


[ Top ]

$definition = array()

[line 50]


Type:   mixed


[ Top ]

$docs =

[line 75]

Parse documentation in the WSDL?

Type:   boolean


[ Top ]

$elements = array()

[line 55]


Type:   mixed


[ Top ]

$imports = array()

[line 59]


Type:   mixed


[ Top ]

$messages = array()

[line 56]


Type:   mixed


[ Top ]

$namespaces = array()

[line 51]


Type:   mixed


[ Top ]

$ns = array()

[line 52]


Type:   mixed


[ Top ]

$portTypes = array()

[line 57]


Type:   mixed


[ Top ]

$proxy =

[line 82]

Proxy parameters.

Type:   array


[ Top ]

$service =  ''

[line 61]


Type:   mixed


[ Top ]

$services = array()

[line 60]


Type:   mixed


[ Top ]

$tns =  null

[line 49]


Type:   mixed


[ Top ]

$trace =  false

[line 89]

Enable tracing in the generated proxy class?

Type:   boolean


[ Top ]

$uri =

[line 68]

URL to WSDL file.

Type:   string


[ Top ]

$wsdlParserClass =  'SOAP_WSDL_Parser'

[line 118]

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

Type:   string


[ Top ]

$xsd =  SOAP_XML_SCHEMA_VERSION

[line 53]


Type:   mixed


[ Top ]



Method Detail

SOAP_WSDL (Constructor)   [line 163]

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 492]

void addNamespace( $namespace)


Parameters:

   $namespace     

[ Top ]

generateAllProxies   [line 760]

void generateAllProxies( )


[ Top ]

generateProxyCode   [line 591]

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 848]

void getComplexTypeChildType( $ns, $name, $child_ns, $child_name)


Parameters:

   $ns     
   $name     
   $child_ns     
   $child_name     

[ Top ]

getComplexTypeNameForElement   [line 839]

void getComplexTypeNameForElement( $name, $namespace)


Parameters:

   $name     
   $namespace     

[ Top ]

getDataHandler   [line 409]

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 244]

void getEndpoint( $portName)


Parameters:

   $portName     

[ Top ]

getNamespace   [line 464]

void getNamespace( $portName, $operation)


Parameters:

   $portName     
   $operation     

[ Top ]

getNamespaceAttributeName   [line 477]

void getNamespaceAttributeName( $namespace)


Parameters:

   $namespace     

[ Top ]

getOperationData   [line 300]

void getOperationData( $portName, $operation)


Parameters:

   $portName     
   $operation     

[ Top ]

getPortName   [line 274]

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 770]

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


Parameters:

   $port     
   $name     

[ Top ]

getSchemaType   [line 872]

array getSchemaType( QName $type, QName $name)

  • Return: A list of [type, array element type, array element namespace, array length].

Parameters:

QName   $name     A parameter name.
QName   $type     A parameter type.

[ Top ]

getSoapAction   [line 451]

void getSoapAction( $portName, $operation)


Parameters:

   $portName     
   $operation     

[ Top ]

matchMethod   [line 382]

void matchMethod( &$operation)


Parameters:

   &$operation     

[ Top ]

parseObject   [line 232]

void parseObject( mixed $wsdl_obj, string $targetNamespace, string $service_name, [string $service_desc = ''])

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.

[ Top ]

parseURL   [line 212]

void parseURL( string $wsdl_uri)

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

Parameters:

string   $wsdl_uri     URL to WSDL file.

[ Top ]

setService   [line 200]

void setService( string $service)

Sets the service currently to be used.

Parameters:

string   $service     An (existing) service name.

[ Top ]

set_service   [line 190]

void set_service( $service)

  • Deprecated: Use setService().

Parameters:

   $service     

[ Top ]


Documentation generated on Thu, 26 Jan 2012 14:00:17 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.