Class: AbstractWsdl

Source Location: /mikebevz/xsd2php/wsdl/AbstractWsdl.php

Class Overview

Author(s):

Variables

Methods

Child classes:

Wsdl_1_1

Wsdl_2_0

Class Details

[line 8]

Tags:

abstract:

[ Top ]

Class Variables

$bindingNameSuffix = "_Binding"

[line 98]

Suffix for generated binding tag name

Tags:

access:

protected

Type:

unknown_type

[ Top ]

$common =

[line 58]

Commons class

Tags:

access:

protected

Type:

com\mikebevz\xsd2php\Common

[ Top ]

$debug = false

[line 52]

Tags:

access:

public

Type:

boolean

[ Top ]

$docNamespaces = array()

[line 118]

Tags:

access:

protected

Type:

mixed

[ Top ]

$dom =

[line 40]

DOM Instance

Tags:

access:

protected

Type:

\DomDocument

[ Top ]

$importedNamespaces = array()

[line 116]

Namespaces already imported to XML Schema

Tags:

access:

protected

Type:

array

[ Top ]

$lastNsKey = 0

[line 135]

Tags:

access:

public

Type:

mixed

[ Top ]

$location =

[line 137]

Tags:

access:

private

Type:

mixed

[ Top ]

$methodsMeta =

[line 152]

Tags:

access:

protected

Type:

mixed

[ Top ]

$portNameSuffix = "_Port"

[line 93]

Suffix for generated port tag name

Tags:

access:

protected

Type:

string

[ Top ]

$publicPath = null

[line 131]

Path to publicly accessable folder to store imported/included schemas

Tags:

access:

private

Type:

string

[ Top ]

$publicUrl = null

[line 133]

Tags:

access:

private

Type:

mixed

[ Top ]

$refl =

[line 34]

Service Reflection

Tags:

access:

protected

Type:

\ReflectionClass

[ Top ]

$requestSuffix = "Request"

[line 110]

Request

Tags:

access:

protected

Type:

unknown_type

[ Top ]

$responseSuffix = "Response"

[line 104]

Response items suffix

Tags:

access:

protected

Type:

string

[ Top ]

$schemasPath = null

[line 124]

Path to schema to be imported/included in XSD

Tags:

access:

private

Type:

string

[ Top ]

$service = null

[line 28]

Service

Tags:

access:

protected

Type:

object

[ Top ]

$serviceNameSuffix = "_Service"

[line 87]

Suffix for generated service tag name

Tags:

access:

protected

Type:

string

[ Top ]

$soapBindingStyle = SOAP_DOCUMENT

[line 64]

Soap binding style: rpc|document

Tags:

access:

protected

Type:

string

[ Top ]

$soapBindingTransport = "http://schemas.xmlsoap.org/soap/http"

[line 70]

Soap binding transport: which transport of SOAP this binding corresponds to

Tags:

access:

protected

Type:

string

[ Top ]

$targetNsPrefix = "tns"

[line 76]

Prefix of target namespace

Tags:

access:

protected

Type:

string

[ Top ]

$wsBinding =

[line 149]

Tags:

access:

protected

Type:

mixed

[ Top ]

$wsDefinitions =

[line 144]

Definitions node

Tags:

access:

protected

Type:

DOMNode

[ Top ]

$wsdlName =

[line 16]

WSDL Name

Tags:

access:

protected

Type:

string

[ Top ]

$wsdlTargetNamespace =

[line 22]

WSDL Target namespace

Tags:

access:

protected

Type:

string

[ Top ]

$wsdlXmlSource =

[line 46]

Copy of Current WSDL as XML string

Tags:

access:

protected

Type:

string

[ Top ]

$wsDocumentation =

[line 145]

Tags:

access:

protected

Type:

mixed

[ Top ]

$wsMessage =

[line 147]

Tags:

access:

protected

Type:

mixed

[ Top ]

$wsPortType =

[line 148]

Tags:

access:

protected

Type:

mixed

[ Top ]

$wsService =

[line 150]

Tags:

access:

protected

Type:

mixed

[ Top ]

$wsTypes =

[line 146]

Tags:

access:

protected

Type:

mixed

[ Top ]

$wsXmlSchema =

[line 151]

Tags:

access:

protected

Type:

mixed

[ Top ]

$xmlSchemaImports = array()

[line 154]

Tags:

access:

protected

Type:

mixed

[ Top ]

$xmlSchemaPreffix = "xsd"

[line 82]

Prefix for XML Schema namespace

Tags:

access:

protected

Type:

string

[ Top ]

Class Methods

constructor __construct [line 163]

void __construct(
object|class
$service)

Tags:

access:

public

Parameters:

object|class

$service

Class name or object of the service to build WSDL for

[ Top ]

method addImportToSchema [line 330]

void addImportToSchema(
string
$namespace, string
$code)

Add xsd:import tag to XML schema before any childs added

Tags:

access:

private

Parameters:

string	$namespace	Namespace URI
string	$code	Shortcut for namespace, fx, ns0. Returned by getNsCode()

[ Top ]

method composeUrl [line 560]

string composeUrl(
array
$parts)

Compose URL of kind schema://host:port

Tags:

return:	URL
access:	public

Parameters:

array

$parts

[ Top ]

method copyToPublic [line 540]

string copyToPublic(
string
$path, [boolean
$overwrite = false])

Copy given file to publicSchemaPath

Tags:

return:	Path to new file
throws:	RuntimeException If file cannot be copied
access:	public

Parameters:

string	$path	Path to file
boolean	$overwrite	Overwrite file if it exists? default false

[ Top ]

method getClassMethods [line 242]

array getClassMethods(
)

Get service class public methods

Tags:

access:

private

[ Top ]

method getClassNamespace [line 480]

string getClassNamespace(
string
$class)

Return class XML namespace taken from @xmlNamespace doc

Tags:

return:	XML namespace
throws:	RuntimeException If namespace cannot be found in class DocBlock
access:	protected

Parameters:

string

$class

Class name

[ Top ]

method getDebug [line 665]

the getDebug(
)

Tags:

access:

public

[ Top ]

method getLocation [line 633]

string getLocation(
)

Get SOAP service location (service->port->address->location)

Tags:

access:

public

[ Top ]

method getMethodIO [line 231]

array getMethodIO(
string
$method)

Return method input/output

Tags:

access:

private

Parameters:

string

$method

Method name

[ Top ]

method getNsCode [line 303]

void getNsCode(

$longNs, [
$rt = false])

Tags:

access:

public

Parameters:

	$longNs
	$rt

[ Top ]

method getPublicPath [line 599]

the getPublicPath(
)

Tags:

access:

public

[ Top ]

method getPublicUrl [line 649]

the getPublicUrl(
)

Tags:

access:

public

[ Top ]

method getSchemaLocation [line 390]

string getSchemaLocation(
string
$ns)

Get path to schema in schemasPath with targetNamespace = $ns

Tags:

return:	absolut path to schema file
throws:	RuntimeException If SchemaPath is not specified
throws:	RuntimeException If Public folder is not specified
throws:	RuntimeException If SchemaPath is not readable
throws:	RuntimeException If namespace cannot be found in SchemaPath
throws:	RuntimeException If PublicPath is not writable
access:	public

Parameters:

string

$ns

Namespace to match

[ Top ]

method getSchemasPath [line 615]

the getSchemasPath(
)

Tags:

access:

public

[ Top ]

method getShortName [line 497]

string getShortName(
string
$longName)

Get class name without namespace

Tags:

return:	Class base name
access:	protected

Parameters:

string

$longName

Class full name

[ Top ]

method getSoapBindingStyle [line 583]

the getSoapBindingStyle(
)

Tags:

access:

public

[ Top ]

method getTypeName [line 283]

string getTypeName(
string
$type)

Get QName style for given type

Tags:

throws:	RuntimeException If class of type cannot be found
access:	protected

Parameters:

string

$type

Type name

[ Top ]

method importsToAbsUrl [line 441]

string importsToAbsUrl(
string
$schemaPath, [
$relPath = ''])

Convert relative paths in XMLSchema's imports and includes to URLs using $location

Tags:

return:	URL of the schema
access:	public

Parameters:

string	$schemaPath	Absolute path to XML Schema file
	$relPath

[ Top ]

method isTargetNamespaceEqualsTo [line 512]

boolean isTargetNamespaceEqualsTo(
string
$schema, string
$ns)

Check if $schema XML Schema file belongs to $ns

Tags:

access:

public

Parameters:

string	$schema	Path to XML Schema file
string	$ns	Target namespace to match

[ Top ]

method namespaceToUrn [line 271]

string namespaceToUrn(
string
$namespace)

Convert PHP namespace to URN

Tags:

access:

protected

Parameters:

string

$namespace

[ Top ]

method prepareDom [line 196]

void prepareDom(
)

Prepare DOM

Tags:

access:

private

[ Top ]

method prepareReflection [line 217]

void prepareReflection(
)

Prepare service class reflection

Tags:

access:

private

[ Top ]

method setDebug [line 673]

void setDebug(
$debug
$debug)

Tags:

access:

public

Parameters:

$debug

$debug

the $debug to set

[ Top ]

method setLocation [line 641]

void setLocation(
$location
$location)

Tags:

access:

public

Parameters:

$location

$location

the $location to set

[ Top ]

method setPublicPath [line 607]

void setPublicPath(
$publicPath
$publicPath)

Tags:

access:

public

Parameters:

$publicPath

$publicPath

the $publicPath to set

[ Top ]

method setPublicUrl [line 657]

void setPublicUrl(
$publicUrl
$publicUrl)

Tags:

access:

public

Parameters:

$publicUrl

$publicUrl

the $publicUrl to set

[ Top ]

method setSchemasPath [line 623]

void setSchemasPath(
$schemasPath
$schemasPath)

Tags:

access:

public

Parameters:

$schemasPath

$schemasPath

the $schemasPath to set

[ Top ]

method setSoapBindingStyle [line 591]

void setSoapBindingStyle(
$soapBindingStyle
$soapBindingStyle)

Tags:

access:

public

Parameters:

$soapBindingStyle

$soapBindingStyle

the $soapBindingStyle to set

[ Top ]

method toXml [line 252]

string toXml(
)

Return WSDL as XML string

Tags:

access:

public

[ Top ]

Documentation generated on Tue, 01 Feb 2011 22:29:28 +0100 by phpDocumentor 1.4.3