default

# Class: Wsdl Source Location: /mikebevz/xsd2php/Wsdl.php
### Class Overview
    Common
       |
       --Wsdl
Common data #### Author(s): Mike Bevz <myb@mikebevz.com> #### Version: 0.0.1 | ### Variables $binding $bindingNameSuffix $class $importedNamespaces $location $portNameSuffix $portType $publicPath $publicUrl $refl $requestSuffix $responseSuffix $schemasPath $serviceNameSuffix $soapBindingStyle $soapBindingTransport $targetNsPrefix $wsdl $xmlSchemaPreffix | ### Methods __construct addBindingOperations addBindings addImportToSchema addMessages addPortOperations addPortType addServices addType addTypes composeUrl copyToPublic getBaseNsName getBindingName getBindingTypeName getClassMethods getClassNamespace getDebug getLocation getMethodIO getNamespaceName getPortName getPublicPath getPublicUrl getSchemaLocation getSchemasPath getServiceName getShortName getSoapBindingStyle getSoapBindingTransport getTypeName getWsdl importsToAbsUrl isLocalType isTargetNamespaceEqualsTo namespaceToUrn setDebug setLocation setPublicPath setPublicUrl setSchemasPath setSoapBindingStyle setSoapBindingTransport
### Inherited Variables #### Class: Common Common::$basicTypes Common::$debug Common::$dom Common::$lastNsKey Common::$namespaces Common::$phpTypes Common::$reservedWords | ### Inherited Methods #### Class: Common Common::getDocNamespaces() Common::getNsCode() Common::isQName() Common::normalizeType() Convert XMLSchema data type to PHP data type Common::parseDocComments() Parse Doc comments Common::parseParamDocs() Common::parseQName() Common::parseReturnDocs() Common::phpTypeToSoap() Common::resolveNamespace() Resolve short namespace to long, or return the same code if not found Common::urnToPhpName()
### Class Details [line 14] Common data #### Tags:
author: | Mike Bevz <myb@mikebevz.com>
version: | 0.0.1
[ Top ] ### Class Variables #### $binding = [line 58] Binding #### Tags:
access: | private
Type: | DomNode
[ Top ] #### $bindingNameSuffix = "_Binding" [line 93] Suffix for generated binding tag name #### Tags:
access: | private
Type: | unknown_type
[ Top ] #### $class = [line 21] Service class to be exposed #### Tags:
access: | private
Type: | object
[ Top ] #### $importedNamespaces = array() [line 126] Namespaces already imported to XML Schema #### Tags:
access: | private
Type: | array
[ Top ] #### $location = [line 65] Service location #### Tags:
access: | private
Type: | string
[ Top ] #### $portNameSuffix = "_Port" [line 88] Suffix for generated port tag name #### Tags:
access: | private
Type: | string
[ Top ] #### $portType = [line 52] Port type #### Tags:
access: | private
Type: | DomNode
[ Top ] #### $publicPath = null [line 118] Path to publicly accessable folder to store imported/included schemas #### Tags:
access: | private
Type: | string
[ Top ] #### $publicUrl = null [line 120] #### Tags:
access: | private
Type: | mixed
[ Top ] #### $refl = [line 34] Reflection of the $class #### Tags:
access: | private
Type: | \ReflectionClass
[ Top ] #### $requestSuffix = "Request" [line 105] Request #### Tags:
access: | private
Type: | unknown_type
[ Top ] #### $responseSuffix = "Response" [line 99] Response items suffix #### Tags:
access: | private
Type: | string
[ Top ] #### $schemasPath = null [line 111] Path to schema to be imported/included in XSD #### Tags:
access: | private
Type: | string
[ Top ] #### $serviceNameSuffix = "_Service" [line 82] Suffix for generated service tag name #### Tags:
access: | private
Type: | string
[ Top ] #### $soapBindingStyle = "document" [line 40] Soap binding style: rpc|document #### Tags:
access: | private
Type: | string
[ Top ] #### $soapBindingTransport = "http://schemas.xmlsoap.org/soap/http" [line 46] Soap binding transport: which transport of SOAP this binding corresponds to #### Tags:
access: | private
Type: | string
[ Top ] #### $targetNsPrefix = "tns" [line 71] Prefix of target namespace #### Tags:
access: | private
Type: | string
[ Top ] #### $wsdl = [line 28] Instance of Zend_Soap_Wsdl #### Tags:
todo: | consider replace this class - it's not that useful
access: | private
Type: | com\mikebevz\xsd2php\wsdl\AbstractWsdl
[ Top ] #### $xmlSchemaPreffix = "xsd" [line 77] Prefix for XML Schema namespace #### Tags:
access: | private
Type: | string
[ Top ] ### Class Methods ### constructor __construct [line 136]
`void __construct( [string|object $class = null])`
Creates new wsdl for the $class given #### Tags:
access: | public
#### Parameters:
string|object | $class |
[ Top ] ### method addBindingOperations [line 281]
`void addBindingOperations( )`
Add operations to binding #### Tags:
access: | public
[ Top ] ### method addBindings [line 205]
`DomNode addBindings( )`
Add bindings to WSDL #### Tags:
return: | Binding node
access: | private
[ Top ] ### method addImportToSchema [line 523]
`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 addMessages [line 369]
`void addMessages( array $messages)`
Add SOAP messages #### Tags:
throws: | RuntimeException If
throws: | RuntimeException If method does not have any inputs/outputs
access: | public
#### Parameters:
array | $messages | Messages to add
[ Top ] ### method addPortOperations [line 310]
`void addPortOperations( )`
Add Port operations #### Tags:
access: | private
[ Top ] ### method addPortType [line 230]
`DOMNode addPortType( )`
Add port type #### Tags:
return: | portType node
access: | private
[ Top ] ### method addServices [line 485]
`void addServices( )`
Add SOAP Service #### Tags:
access: | private
[ Top ] ### method addType [line 783]
`string addType( string $type)`
#### Tags:
todo: | Check this method
access: | private
#### Parameters:
string | $type | Data type
[ Top ] ### method addTypes [line 242]
`void addTypes( )`
Add XML Schema types #### Tags:
access: | public
[ Top ] ### method composeUrl [line 610]
`string composeUrl( array $parts)`
Compose URL of kind schema://host:port #### Tags:
return: | URL
access: | public
#### Parameters:
array | $parts |
[ Top ] ### method copyToPublic [line 640]
`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 getBaseNsName [line 739]
`string getBaseNsName( string $ns)`
Get base name from URI #### Tags:
return: | Base name
access: | public
#### Parameters:
string | $ns | URI
[ Top ] ### method getBindingName [line 809]
`void getBindingName( )`
Get binding element name #### Tags:
access: | private
[ Top ] ### method getBindingTypeName [line 221]
`string getBindingTypeName( )`
Get binding type name #### Tags:
access: | private
[ Top ] ### method getClassMethods [line 444]
`array getClassMethods( )`
Get service class public methods #### Tags:
access: | private
[ Top ] ### method getClassNamespace [line 752]
`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: | public
#### Parameters:
string | $class | Class name
[ Top ] ### method getDebug [line 884]
`the getDebug( )`
#### Tags:
access: | public
[ Top ] ### method getLocation [line 819]
`string getLocation( )`
Get SOAP service location (service->port->address->location) #### Tags:
access: | public
[ Top ] ### method getMethodIO [line 455]
`array getMethodIO( string $method)`
Return method input/output #### Tags:
access: | private
#### Parameters:
string | $method | Method name
[ Top ] ### method getNamespaceName [line 471]
`void getNamespaceName( $class)`
#### Tags:
access: | private
#### Parameters:
| $class |
[ Top ] ### method getPortName [line 467]
`string getPortName( )`
Get port name #### Tags:
access: | private
[ Top ] ### method getPublicPath [line 899]
`the getPublicPath( )`
#### Tags:
access: | public
[ Top ] ### method getPublicUrl [line 914]
`the getPublicUrl( )`
#### Tags:
access: | public
[ Top ] ### method getSchemaLocation [line 665]
`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 869]
`the getSchemasPath( )`
#### Tags:
access: | public
[ Top ] ### method getServiceName [line 798]
`string getServiceName( )`
Get service element name #### Tags:
access: | private
[ Top ] ### method getShortName [line 769]
`string getShortName( string $longName)`
Get class name without namespace #### Tags:
return: | Class base name
access: | private
#### Parameters:
string | $longName | Class full name
[ Top ] ### method getSoapBindingStyle [line 836]
`string getSoapBindingStyle( )`
Get SOAP binding style #### Tags:
access: | public
[ Top ] ### method getSoapBindingTransport [line 853]
`string getSoapBindingTransport( )`
Get SOAP binding transport #### Tags:
return: | the $soapBindingTransport
access: | public
[ Top ] ### method getTypeName [line 496]
`string getTypeName( string $type)`
Get QName style for given type #### Tags:
throws: | RuntimeException If class of type cannot be found
access: | private
#### Parameters:
string | $type | Type name
[ Top ] ### method getWsdl [line 153]
`string getWsdl( [string|object $class = null])`
Ger WSDL file contents #### Tags:
throws: | RuntimeException If class not defined
throws: | RuntimeException If given class is neither class nor string
throws: | RuntimeException If given class is not found, ie was not included before
access: | public
#### Parameters:
string|object | $class |
[ Top ] ### method importsToAbsUrl [line 572]
`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 isLocalType [line 344]
`boolean isLocalType( string $type)`
Return true if given type is local, false in case the type is not from xsd or tns namespaces #### Tags:
access: | public
#### Parameters:
string | $type | QName type name
[ Top ] ### method isTargetNamespaceEqualsTo [line 713]
`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 475]
`void namespaceToUrn( $namespace)`
#### Tags:
access: | private
#### Parameters:
| $namespace |
[ Top ] ### method setDebug [line 892]
`void setDebug( $debug $debug)`
#### Tags:
access: | public
#### Parameters:
$debug | $debug | the $debug to set
[ Top ] ### method setLocation [line 827]
`void setLocation( $location $location)`
#### Tags:
access: | public
#### Parameters:
$location | $location | the $location to set
[ Top ] ### method setPublicPath [line 907]
`void setPublicPath( $publicPath $publicPath)`
#### Tags:
access: | public
#### Parameters:
$publicPath | $publicPath | the $publicPath to set
[ Top ] ### method setPublicUrl [line 922]
`void setPublicUrl( $publicUrl $publicUrl)`
#### Tags:
access: | public
#### Parameters:
$publicUrl | $publicUrl | the $publicUrl to set
[ Top ] ### method setSchemasPath [line 877]
`void setSchemasPath( $schemasPath $schemasPath)`
#### Tags:
access: | public
#### Parameters:
$schemasPath | $schemasPath | the $schemasPath to set
[ Top ] ### method setSoapBindingStyle [line 844]
`void setSoapBindingStyle( $soapBindingStyle $soapBindingStyle)`
#### Tags:
access: | public
#### Parameters:
$soapBindingStyle | $soapBindingStyle | the $soapBindingStyle to set
[ Top ] ### method setSoapBindingTransport [line 861]
`void setSoapBindingTransport( $soapBindingTransport $soapBindingTransport)`
#### Tags:
access: | public
#### Parameters:
$soapBindingTransport | $soapBindingTransport | the $soapBindingTransport to set
[ Top ] Documentation generated on Tue, 01 Feb 2011 22:29:29 +0100 by phpDocumentor 1.4.3