Overview

Packages

  • akismet
  • None
  • PHP
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • plugins
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Signatures
    • Signed
    • Transport
  • wa-apps
    • blog
      • actions
        • backend
        • blog
        • comment
        • cron
        • design
        • frontend
        • page
        • plugin
        • post
      • api
        • v1
      • cli
      • layout
      • model
      • plugin
        • aksimet
        • category
        • emailsubscription
        • favorite
        • gravatar
        • import
        • markdown
        • myposts
        • tag
        • troll
      • settings
    • checklists
      • backend
      • json
    • contacts
      • backend
    • developer
    • dummy
    • guestbook
    • guestbook2
    • photos
      • album
      • api
        • v1
      • backend
      • design
      • dialog
      • frontend
      • page
      • photo
      • plugin
        • comment
        • imageeffects
        • import
        • publicgallery
        • watermark
      • search
      • settings
      • stack
      • tag
      • upload
    • site
      • backend
      • blocks
      • config
      • design
      • domains
      • files
      • frontend
      • helper
      • layout
      • pages
      • routing
      • setting
    • stickies
      • api
        • v1
      • sheet
      • stiky
  • wa-plugin
    • payment
    • shipping
    • sms
  • wa-plugins
    • shipping
      • usps
  • wa-system
    • API
    • Auth
      • Adapters
    • Autoload
    • Cache
      • Adapter
    • Captcha
    • Config
    • Contact
    • controller
    • currency
    • database
    • datetime
    • design
    • event
    • exception
    • files
    • image
    • layout
    • locale
    • log
    • mail
    • page
      • action
      • model
    • payment
    • plugin
    • request
    • response
    • routing
    • shipping
    • sms
    • storage
    • user
    • util
    • validator
    • view
    • webasyst
      • api
      • backend
      • cli
      • config
      • layout
      • login
      • model
      • password
      • payment
      • profile
      • settings
      • shipment
    • widget
    • workflow
  • waPlugins
    • Payment
  • webasyst
    • wa-system
      • helper

Classes

  • cancelBill
  • cancelBillResponse
  • checkBill
  • checkBillResponse
  • createBill
  • createBillResponse
  • getBillList
  • getBillListResponse
  • idna_convert
  • IShopClientWSService
  • IShopServerWSService
  • nusoap_base
  • nusoap_client
  • nusoap_fault
  • nusoap_parser
  • nusoap_server
  • nusoap_xmlschema
  • ReCaptchaResponse
  • Smarty_Internal_Configfileparser
  • Smarty_Internal_Templateparser
  • soap_fault
  • soap_parser
  • soap_server
  • soap_transport_http
  • soapclient
  • soapval
  • TP_yyStackEntry
  • TPC_yyStackEntry
  • updateBill
  • updateBillResponse
  • waIdna
  • wsdl
  • xmlrpc_client
  • xmlrpcmsg
  • xmlrpcresp
  • xmlrpcval
  • XMLSchema

Functions

  • _recaptcha_aes_encrypt
  • _recaptcha_aes_pad
  • _recaptcha_http_post
  • _recaptcha_mailhide_email_parts
  • _recaptcha_mailhide_urlbase64
  • _recaptcha_qsencode
  • _swiftmailer_init
  • decode_chunked
  • generateUpToDateMimeArray
  • guess_encoding
  • is_valid_charset
  • iso8601_decode
  • iso8601_encode
  • iso8601_to_timestamp
  • php_xmlrpc_decode
  • php_xmlrpc_decode_xml
  • php_xmlrpc_encode
  • recaptcha_check_answer
  • recaptcha_get_html
  • recaptcha_get_signup_url
  • recaptcha_mailhide_html
  • recaptcha_mailhide_url
  • smarty_block_wa_js
  • smarty_function_escape_special_chars
  • smarty_function_wa_action
  • smarty_function_wa_block
  • smarty_function_wa_header
  • smarty_function_wa_pagination
  • smarty_function_wa_print_tree
  • smarty_function_wa_snippet
  • smarty_gettext_s_translate
  • smarty_gettext_translate
  • smarty_prefilter_content_nofilter
  • smarty_prefilter_translate
  • timestamp_to_iso8601
  • usleepWindows
  • wa_array_diff_r
  • wa_currency_html
  • xmlrpc_cd
  • xmlrpc_dh
  • xmlrpc_ee
  • xmlrpc_ee_fast
  • xmlrpc_encode_entitites
  • xmlrpc_se
  • xmlrpc_se_any
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class nusoap_client

[nu]soapclient higher level class for easy usage.

usage:

// instantiate client with server info $soapclient = new nusoap_client( string path [ ,mixed wsdl] );

// call method, get results echo $soapclient->call( string methodname [ ,array parameters] );

// bye bye client unset($soapclient);

nusoap_base
Extended by nusoap_client

Direct known subclasses

IShopServerWSService, soapclient
Author: Dietrich Ayala <dietrich@ganx4.com>
Author: Scott Nichol <snichol@users.sourceforge.net>
Version: $Id: nusoap.php,v 1.123 2010/04/26 20:15:08 snichol Exp $
Located at wa-plugins/payment/qiwi/vendors/nusoap/nusoap.php
Methods summary
public
# __construct( mixed $endpoint, mixed $wsdl = false, string $proxyhost = false, string $proxyport = false, string $proxyusername = false, string $proxypassword = false, integer $timeout = 0, integer $response_timeout = 30, string $portName = '' )

constructor

constructor

Parameters

$endpoint
mixed
$endpoint SOAP server or WSDL URL (string), or wsdl instance (object)
$wsdl
mixed
$wsdl optional, set to 'wsdl' or true if using WSDL
$proxyhost
string
$proxyhost optional
$proxyport
string
$proxyport optional
$proxyusername
string
$proxyusername optional
$proxypassword
string
$proxypassword optional
$timeout
integer
$timeout set the connection timeout
$response_timeout
integer
$response_timeout set the response timeout
$portName
string
$portName optional portName in WSDL document
public mixed
# call( string $operation, mixed $params = array(), string $namespace = 'http://tempuri.org', string $soapAction = '', mixed $headers = false, boolean $rpcParams = null, string $style = 'rpc', string $use = 'encoded' )

calls method, returns PHP native type

calls method, returns PHP native type

Parameters

$operation
string
$operation SOAP server URL or path
$params
mixed
$params An array, associative or simple, of the parameters for the method call, or a string that is the XML for the call. For rpc style, this call will wrap the XML in a tag named after the method, as well as the SOAP Envelope and Body. For document style, this will only wrap with the Envelope and Body. IMPORTANT: when using an array with document style, in which case there is really one parameter, the root of the fragment used in the call, which encloses what programmers normally think of parameters. A parameter array must include the wrapper.
$namespace
string
$namespace optional method namespace (WSDL can override)
$soapAction
string
$soapAction optional SOAPAction value (WSDL can override)
$headers
mixed
$headers optional string of XML with SOAP header content, or array of soapval objects for SOAP headers, or associative array
$rpcParams
boolean
$rpcParams optional (no longer used)
$style
string
$style optional (rpc|document) the style to use when serializing parameters (WSDL can override)
$use
string
$use optional (encoded|literal) the use when serializing parameters (WSDL can override)

Returns

mixed
response from SOAP call, normally an associative array mirroring the structure of the XML response, false for certain fatal errors
public
# checkWSDL( )

check WSDL passed as an instance or pulled from an endpoint

check WSDL passed as an instance or pulled from an endpoint

public
# loadWSDL( )

instantiate wsdl object and parse wsdl file

instantiate wsdl object and parse wsdl file

public array
# getOperationData( string $operation )

get available data pertaining to an operation

get available data pertaining to an operation

Parameters

$operation
string
$operation operation name

Returns

array
array of data pertaining to the operation
public mixed
# send( string $msg, string $soapaction = '', integer $timeout = 0, integer $response_timeout = 30 )

send the SOAP message

send the SOAP message

Note: if the operation has multiple return values the return value of this method will be an array of those values.

Parameters

$msg
string
$msg a SOAPx4 soapmsg object
$soapaction
string
$soapaction SOAPAction value
$timeout
integer
$timeout set connection timeout in seconds
$response_timeout
integer
$response_timeout set response timeout in seconds

Returns

mixed
native PHP types.
public mixed
# parseResponse( array $headers, string $data )

processes SOAP message returned from server

processes SOAP message returned from server

Parameters

$headers
array
$headers The HTTP headers
$data
string
$data unprocessed response data from server

Returns

mixed
value of the message, decoded into a PHP type
public
# setCurlOption( mixed $option, mixed $value )

sets user-specified cURL options

sets user-specified cURL options

Parameters

$option
mixed
$option The cURL option (always integer?)
$value
mixed
$value The cURL option value
public
# setEndpoint( string $endpoint )

sets the SOAP endpoint, which can override WSDL

sets the SOAP endpoint, which can override WSDL

Parameters

$endpoint
string
$endpoint The endpoint URL to use, or empty string or false to prevent override
public
# setHeaders( mixed $headers )

set the SOAP headers

set the SOAP headers

Parameters

$headers
mixed
$headers String of XML with SOAP header content, or array of soapval objects for SOAP headers
public string
# getHeaders( )

get the SOAP response headers (namespace resolution incomplete)

get the SOAP response headers (namespace resolution incomplete)

Returns

string
public mixed
# getHeader( )

get the SOAP response Header (parsed)

get the SOAP response Header (parsed)

Returns

mixed
public
# setHTTPProxy( string $proxyhost, string $proxyport, string $proxyusername = '', string $proxypassword = '' )

set proxy info here

set proxy info here

Parameters

$proxyhost
string
$proxyhost
$proxyport
string
$proxyport
$proxyusername
string
$proxyusername
$proxypassword
string
$proxypassword
public
# setCredentials( string $username, string $password, string $authtype = 'basic', array $certRequest = array() )

if authenticating, set user credentials here

if authenticating, set user credentials here

Parameters

$username
string
$username
$password
string
$password
$authtype
string
$authtype (basic|digest|certificate|ntlm)
$certRequest
array
$certRequest (keys must be cainfofile (optional), sslcertfile, sslkeyfile, passphrase, verifypeer (optional), verifyhost (optional): see corresponding options in cURL docs)
public
# setHTTPEncoding( string $enc = 'gzip, deflate' )

use HTTP encoding

use HTTP encoding

Parameters

$enc
string
$enc HTTP encoding
public
# setUseCURL( boolean $use )

Set whether to try to use cURL connections if possible

Set whether to try to use cURL connections if possible

Parameters

$use
boolean
$use Whether to try to use cURL
public
# useHTTPPersistentConnection( )

use HTTP persistent connections if possible

use HTTP persistent connections if possible

public boolean
# getDefaultRpcParams( )

gets the default RPC parameter setting. If true, default is that call params are like RPC even for document style. Each call() can override this value.

gets the default RPC parameter setting. If true, default is that call params are like RPC even for document style. Each call() can override this value.

This is no longer used.

Deprecated

Returns

boolean
public
# setDefaultRpcParams( boolean $rpcParams )

sets the default RPC parameter setting. If true, default is that call params are like RPC even for document style Each call() can override this value.

sets the default RPC parameter setting. If true, default is that call params are like RPC even for document style Each call() can override this value.

This is no longer used.

Deprecated

Parameters

$rpcParams
boolean
$rpcParams
public object
# getProxy( )

dynamically creates an instance of a proxy class, allowing user to directly call methods from wsdl

dynamically creates an instance of a proxy class, allowing user to directly call methods from wsdl

Returns

object
soap_proxy object
public string
# _getProxyClassCode( mixed $r )

dynamically creates proxy class code

dynamically creates proxy class code

Returns

string
PHP/NuSOAP code for the proxy class
public string
# getProxyClassCode( )

dynamically creates proxy class code

dynamically creates proxy class code

Returns

string
PHP/NuSOAP code for the proxy class
public string
# getHTTPBody( string $soapmsg )

gets the HTTP body for the current request.

gets the HTTP body for the current request.

Parameters

$soapmsg
string
$soapmsg The SOAP payload

Returns

string
The HTTP body, which includes the SOAP payload
public string
# getHTTPContentType( )

gets the HTTP content type for the current request.

gets the HTTP content type for the current request.

Note: getHTTPBody must be called before this.

Returns

string
the HTTP content type for the current request.
public string
# getHTTPContentTypeCharset( )

gets the HTTP content type charset for the current request. returns false for non-text content types.

gets the HTTP content type charset for the current request. returns false for non-text content types.

Note: getHTTPBody must be called before this.

Returns

string
the HTTP content type charset for the current request.
public
# decodeUTF8( mixed $bool )
public boolean
# setCookie( string $name, string $value )

adds a new Cookie into $this->cookies array

adds a new Cookie into $this->cookies array

Parameters

$name
string
$name Cookie Name
$value
string
$value Cookie Value

Returns

boolean
if cookie-set was successful returns true, else false
public array
# getCookies( )

gets all Cookies

gets all Cookies

Returns

array
with all internal cookies
public boolean
# checkCookies( )

checks all Cookies and delete those which are expired

checks all Cookies and delete those which are expired

Returns

boolean
always return true
public boolean
# UpdateCookies( array $cookies )

updates the current cookies with a new set

updates the current cookies with a new set

Parameters

$cookies
array
$cookies new cookies with which to update current ones

Returns

boolean
always return true
Methods inherited from nusoap_base
__toString(), appendDebug(), clearDebug(), contractQname(), debug(), expandEntities(), expandQname(), formatDump(), getDebug(), getDebugAsXMLComment(), getDebugLevel(), getError(), getGlobalDebugLevel(), getLocalPart(), getNamespaceFromPrefix(), getPrefix(), getPrefixFromNamespace(), getmicrotime(), isArraySimpleOrStruct(), nusoap_base(), serializeEnvelope(), serialize_val(), setDebugLevel(), setError(), setGlobalDebugLevel(), varDump()
Properties summary
public string $username ''
#
public string $password ''
#
public string $authtype ''
#
public array $certRequest array()
#
public boolean $requestHeaders false
#
public string $responseHeaders ''
#
public mixed $responseHeader NULL
#
public string $document ''
#
public mixed $endpoint
#
public string $forceEndpoint ''
#
public string $proxyhost ''
#
public string $proxyport ''
#
public string $proxyusername ''
#
public string $proxypassword ''
#
public string $portName ''
#
public string $xml_encoding ''
#
public boolean $http_encoding false
#
public integer $timeout 0
#
public integer $response_timeout 30
#
public string $endpointType ''
#
public boolean $persistentConnection false
#
public boolean $defaultRpcParams false
#
public string $request ''
#
public string $response ''
#
public string $responseData ''
#
public array $cookies array()
#
public boolean $decode_utf8 true
#
public array $operations array()
#
public array $curl_options array()
#
public string $bindingType ''
#
public boolean $use_curl false
#
public nusoap_client::$fault $fault
#
public nusoap_client::$faultcode $faultcode
#
public nusoap_client::$faultstring $faultstring
#
public nusoap_client::$faultdetail $faultdetail
#
Properties inherited from nusoap_base
$XMLSchemaVersion, $charencoding, $debugLevel, $debug_str, $error_str, $namespaces, $revision, $soap_defencoding, $title, $typemap, $usedNamespaces, $version, $xmlEntities
My fork of Webasyst Framework API documentation generated by ApiGen 2.8.0