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 xmlrpc_client

Located at wa-apps/blog/plugins/import/vendors/xmlrpc/lib/xmlrpc.php
Methods summary
public
# xmlrpc_client( string $path, string $server = '', integer $port = '', string $method = '' )

Parameters

$path
string
$path either the complete server URL or the PATH part of the xmlrc server URL, e.g. /xmlrpc/server.php
$server
string
$server the server name / ip address
$port
integer
$port the port the server is listening on, defaults to 80 or 443 depending on protocol used
$method
string
$method the http protocol variant: defaults to 'http', 'https' and 'http11' can be used if CURL is installed
public
# setDebug( integer $in )

Enables/disables the echoing to screen of the xmlrpc responses received

Enables/disables the echoing to screen of the xmlrpc responses received

Parameters

$in
integer
$debug values 0, 1 and 2 are supported (2 = echo sent msg too, before received response)
public
# setCredentials( string $u, string $p, integer $t = 1 )

Add some http BASIC AUTH credentials, used by the client to authenticate

Add some http BASIC AUTH credentials, used by the client to authenticate

Parameters

$u
string
$u username
$p
string
$p password
$t
integer
$t auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC (basic auth)
public
# setCertificate( string $cert, string $certpass )

Add a client-side https certificate

Add a client-side https certificate

Parameters

$cert
string
$cert
$certpass
string
$certpass
public
# setCaCertificate( string $cacert, boolean $is_dir = false )

Add a CA certificate to verify server with (see man page about CURLOPT_CAINFO for more details

Add a CA certificate to verify server with (see man page about CURLOPT_CAINFO for more details

Parameters

$cacert
string
$cacert certificate file name (or dir holding certificates)
$is_dir
boolean
$is_dir set to true to indicate cacert is a dir. defaults to false
public
# setKey( string $key, string $keypass )

Set attributes for SSL communication: private SSL key NB: does not work in older php/curl installs Thanks to Daniel Convissor

Set attributes for SSL communication: private SSL key NB: does not work in older php/curl installs Thanks to Daniel Convissor

Parameters

$key
string
$key The name of a file containing a private SSL key
$keypass
string
$keypass The secret password needed to use the private SSL key
public
# setSSLVerifyPeer( boolean $i )

Set attributes for SSL communication: verify server certificate

Set attributes for SSL communication: verify server certificate

Parameters

$i
boolean
$i enable/disable verification of peer certificate
public
# setSSLVerifyHost( integer $i )

Set attributes for SSL communication: verify match of server cert w. hostname

Set attributes for SSL communication: verify match of server cert w. hostname

Parameters

$i
integer
$i
public
# setProxy( string $proxyhost, string $proxyport, string $proxyusername = '', string $proxypassword = '', integer $proxyauthtype = 1 )

Set proxy info

Set proxy info

Parameters

$proxyhost
string
$proxyhost
$proxyport
string
$proxyport Defaults to 8080 for HTTP and 443 for HTTPS
$proxyusername
string
$proxyusername Leave blank if proxy has public access
$proxypassword
string
$proxypassword Leave blank if proxy has public access
$proxyauthtype
integer
$proxyauthtype set to constant CURLAUTH_NTLM to use NTLM auth with proxy
public
# setAcceptedCompression( string $compmethod )

Enables/disables reception of compressed xmlrpc responses. Note that enabling reception of compressed responses merely adds some standard http headers to xmlrpc requests. It is up to the xmlrpc server to return compressed responses when receiving such requests.

Enables/disables reception of compressed xmlrpc responses. Note that enabling reception of compressed responses merely adds some standard http headers to xmlrpc requests. It is up to the xmlrpc server to return compressed responses when receiving such requests.

Parameters

$compmethod
string
$compmethod either 'gzip', 'deflate', 'any' or ''
public
# setRequestCompression( string $compmethod )

Enables/disables http compression of xmlrpc request. Take care when sending compressed requests: servers might not support them (and automatic fallback to uncompressed requests is not yet implemented)

Enables/disables http compression of xmlrpc request. Take care when sending compressed requests: servers might not support them (and automatic fallback to uncompressed requests is not yet implemented)

Parameters

$compmethod
string
$compmethod either 'gzip', 'deflate' or ''
public
# setCookie( string $name, string $value = '', string $path = '', string $domain = '', integer $port = null )

Adds a cookie to list of cookies that will be sent to server. NB: setting any param but name and value will turn the cookie into a 'version 1' cookie: do not do it unless you know what you are doing

Adds a cookie to list of cookies that will be sent to server. NB: setting any param but name and value will turn the cookie into a 'version 1' cookie: do not do it unless you know what you are doing

Parameters

$name
string
$name
$value
string
$value
$path
string
$path
$domain
string
$domain
$port
integer
$port

Todo

check correctness of urlencoding cookie value (copied from php way of doing it...)
public
# SetCurlOptions( mixed $options )

Directly set cURL options, for extra flexibility It allows eg. to bind client to a specific IP interface / address

Directly set cURL options, for extra flexibility It allows eg. to bind client to a specific IP interface / address

Parameters

$options
mixed
$options array
public
# SetUserAgent( mixed $agentstring )

Set user-agent string that will be used by this client instance in http headers sent to the server

Set user-agent string that will be used by this client instance in http headers sent to the server

public xmlrpcresp &
# send( mixed $msg, integer $timeout = 0, string $method = '' )

Send an xmlrpc request

Send an xmlrpc request

Parameters

$msg
mixed
$msg The message object, or an array of messages for using multicall, or the complete xml representation of a request
$timeout
integer
$timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply
$method
string
$method if left unspecified, the http protocol chosen during creation of the object will be used

Returns

xmlrpcresp
public &
# sendPayloadHTTP10( mixed $msg, mixed $server, mixed $port, mixed $timeout = 0, mixed $username = '', mixed $password = '', mixed $authtype = 1, mixed $proxyhost = '', mixed $proxyport = 0, mixed $proxyusername = '', mixed $proxypassword = '', mixed $proxyauthtype = 1 )
public &
# sendPayloadHTTPS( mixed $msg, mixed $server, mixed $port, mixed $timeout = 0, mixed $username = '', mixed $password = '', mixed $authtype = 1, mixed $cert = '', mixed $certpass = '', mixed $cacert = '', mixed $cacertdir = '', mixed $proxyhost = '', mixed $proxyport = 0, mixed $proxyusername = '', mixed $proxypassword = '', mixed $proxyauthtype = 1, mixed $keepalive = false, mixed $key = '', mixed $keypass = '' )
public &
# sendPayloadCURL( mixed $msg, mixed $server, mixed $port, mixed $timeout = 0, mixed $username = '', mixed $password = '', mixed $authtype = 1, mixed $cert = '', mixed $certpass = '', mixed $cacert = '', mixed $cacertdir = '', mixed $proxyhost = '', mixed $proxyport = 0, mixed $proxyusername = '', mixed $proxypassword = '', mixed $proxyauthtype = 1, mixed $method = 'https', mixed $keepalive = false, mixed $key = '', mixed $keypass = '' )

Contributed by Justin Miller <justin@voxel.net> Requires curl to be built into PHP NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers!

Contributed by Justin Miller <justin@voxel.net> Requires curl to be built into PHP NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers!

public array
# multicall( array $msgs, integer $timeout = 0, string $method = '', boolean $fallback = true )

Send an array of request messages and return an array of responses. Unless $this->no_multicall has been set to true, it will try first to use one single xmlrpc call to server method system.multicall, and revert to sending many successive calls in case of failure. This failure is also stored in $this->no_multicall for subsequent calls. Unfortunately, there is no server error code universally used to denote the fact that multicall is unsupported, so there is no way to reliably distinguish between that and a temporary failure. If you are sure that server supports multicall and do not want to fallback to using many single calls, set the fourth parameter to FALSE.

Send an array of request messages and return an array of responses. Unless $this->no_multicall has been set to true, it will try first to use one single xmlrpc call to server method system.multicall, and revert to sending many successive calls in case of failure. This failure is also stored in $this->no_multicall for subsequent calls. Unfortunately, there is no server error code universally used to denote the fact that multicall is unsupported, so there is no way to reliably distinguish between that and a temporary failure. If you are sure that server supports multicall and do not want to fallback to using many single calls, set the fourth parameter to FALSE.

NB: trying to shoehorn extra functionality into existing syntax has resulted in pretty much convoluted code...

Parameters

$msgs
array
$msgs an array of xmlrpcmsg objects
$timeout
integer
$timeout connection timeout (in seconds)
$method
string
$method the http protocol variant to be used
$fallback
boolean
fallback When true, upon receiveing an error during multicall, multiple single calls will be attempted

Returns

array
public
# _try_multicall( mixed $msgs, mixed $timeout, mixed $method )

Attempt to boxcar $msgs via system.multicall. Returns either an array of xmlrpcreponses, an xmlrpc error response or false (when received response does not respect valid multicall syntax)

Attempt to boxcar $msgs via system.multicall. Returns either an array of xmlrpcreponses, an xmlrpc error response or false (when received response does not respect valid multicall syntax)

Properties summary
public mixed $path
#
public mixed $server
#
public integer $port 0
#
public string $method 'http'
#
public mixed $errno
#
public mixed $errstr
#
public integer $debug 0
#
public string $username ''
#
public string $password ''
#
public integer $authtype 1
#
public string $cert ''
#
public string $certpass ''
#
public string $cacert ''
#
public string $cacertdir ''
#
public string $key ''
#
public string $keypass ''
#
public boolean $verifypeer true
#
public integer $verifyhost 1
#
public boolean $no_multicall false
#
public string $proxy ''
#
public integer $proxyport 0
#
public string $proxy_user ''
#
public string $proxy_pass ''
#
public integer $proxy_authtype 1
#
public array $cookies array()
#
public array $extracurlopts array()
#
public array $accepted_compression array()
#

List of http compression methods accepted by the client for responses. NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib

List of http compression methods accepted by the client for responses. NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib

NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since in those cases it will be up to CURL to decide the compression methods it supports. You might check for the presence of 'zlib' in the output of curl_version() to determine wheter compression is supported or not

public string $request_compression ''
#

Name of compression scheme to be used for sending requests. Either null, gzip or deflate

Name of compression scheme to be used for sending requests. Either null, gzip or deflate

public mixed $xmlrpc_curl_handle null
#

CURL handle: used for keep-alive connections (PHP 4.3.8 up, see: http://curl.haxx.se/docs/faq.html#7.3)

CURL handle: used for keep-alive connections (PHP 4.3.8 up, see: http://curl.haxx.se/docs/faq.html#7.3)

public boolean $keepalive false
#
public array $accepted_charset_encodings array()
#
public string $request_charset_encoding ''
#
public string $return_type 'xmlrpcvals'
#

Decides the content of xmlrpcresp objects returned by calls to send() valid strings are 'xmlrpcvals', 'phpvals' or 'xml'

Decides the content of xmlrpcresp objects returned by calls to send() valid strings are 'xmlrpcvals', 'phpvals' or 'xml'

public mixed $user_agent
#

Sent to servers in http headers

Sent to servers in http headers

My fork of Webasyst Framework API documentation generated by ApiGen 2.8.0