Solutions Open Source

Référence de la classe soapclient

Graphe d'héritage de soapclient:

Inheritance graph
[légende]
Graphe de collaboration de soapclient:

Collaboration graph
[légende]

Liste de tous les membres

Fonctions membres publiques

 soapclient ($endpoint, $wsdl=false, $proxyhost=false, $proxyport=false, $proxyusername=false, $proxypassword=false, $timeout=0, $response_timeout=30)
 call ($operation, $params=array(), $namespace='http://tempuri.org', $soapAction='', $headers=false, $rpcParams=null, $style='rpc', $use='encoded')
 getOperationData ($operation)
 send ($msg, $soapaction= '', $timeout=0, $response_timeout=30)
 parseResponse ($headers, $data)
 setEndpoint ($endpoint)
 setHeaders ($headers)
 getHeaders ()
 setHTTPProxy ($proxyhost, $proxyport, $proxyusername= '', $proxypassword= '')
 setCredentials ($username, $password, $authtype= 'basic', $certRequest=array())
 setHTTPEncoding ($enc='gzip, deflate')
 useHTTPPersistentConnection ()
 getDefaultRpcParams ()
 setDefaultRpcParams ($rpcParams)
 getProxy ()
 _getProxyClassCode ($r)
 getProxyClassCode ()
 getHTTPBody ($soapmsg)
 getHTTPContentType ()
 getHTTPContentTypeCharset ()
 decodeUTF8 ($bool)
 setCookie ($name, $value)
 getCookies ()
 checkCookies ()
 UpdateCookies ($cookies)

Attributs publics

 $username = ''
 $password = ''
 $authtype = ''
 $certRequest = array()
 $requestHeaders = false
 $responseHeaders = ''
 $document = ''
 $endpoint
 $forceEndpoint = ''
 $proxyhost = ''
 $proxyport = ''
 $proxyusername = ''
 $proxypassword = ''
 $xml_encoding = ''
 $http_encoding = false
 $timeout = 0
 $response_timeout = 30
 $endpointType = ''
 $persistentConnection = false
 $defaultRpcParams = false
 $request = ''
 $response = ''
 $responseData = ''
 $cookies = array()
 $decode_utf8 = true
 $operations = array()
 $fault
 $faultcode
 $faultstring
 $faultdetail

Description détaillée

soapclient higher level class for easy usage.

usage:

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

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

// bye bye client unset($soapclient);

Auteur:
Dietrich Ayala <dietrich@ganx4.com>
Version:
Id
public

Documentation des fonctions membres

soapclient::soapclient ( $  endpoint,
$  wsdl = false,
$  proxyhost = false,
$  proxyport = false,
$  proxyusername = false,
$  proxypassword = false,
$  timeout = 0,
$  response_timeout = 30 
)

constructor

Paramètres:
mixed $endpoint SOAP server or WSDL URL (string), or wsdl instance (object)
bool $wsdl optional, set to true if using WSDL
int $portName optional portName in WSDL document
string $proxyhost
string $proxyport
string $proxyusername
string $proxypassword
integer $timeout set the connection timeout
integer $response_timeout set the response timeout public

soapclient::call ( $  operation,
$  params = array(),
$  namespace = 'http://tempuri.org',
$  soapAction = '',
$  headers = false,
$  rpcParams = null,
$  style = 'rpc',
$  use = 'encoded' 
)

calls method, returns PHP native type

Paramètres:
string $method SOAP server URL or path
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.
string $namespace optional method namespace (WSDL can override)
string $soapAction optional SOAPAction value (WSDL can override)
mixed $headers optional string of XML with SOAP header content, or array of soapval objects for SOAP headers
boolean $rpcParams optional (no longer used)
string $style optional (rpc|document) the style to use when serializing parameters (WSDL can override)
string $use optional (encoded|literal) the use when serializing parameters (WSDL can override)
Renvoie:
mixed response from SOAP call public

soapclient::getOperationData ( $  operation  ) 

get available data pertaining to an operation

Paramètres:
string $operation operation name
Renvoie:
array array of data pertaining to the operation public

soapclient::send ( $  msg,
$  soapaction = '',
$  timeout = 0,
$  response_timeout = 30 
)

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.

Paramètres:
string $msg a SOAPx4 soapmsg object
string $soapaction SOAPAction value
integer $timeout set connection timeout in seconds
integer $response_timeout set response timeout in seconds
Renvoie:
mixed native PHP types. private

soapclient::parseResponse ( $  headers,
$  data 
)

processes SOAP message returned from server

Paramètres:
array $headers The HTTP headers
string $data unprocessed response data from server
Renvoie:
mixed value of the message, decoded into a PHP type private

soapclient::setEndpoint ( $  endpoint  ) 

sets the SOAP endpoint, which can override WSDL

Paramètres:
$endpoint string The endpoint URL to use, or empty string or false to prevent override public

soapclient::setHeaders ( $  headers  ) 

set the SOAP headers

Paramètres:
$headers mixed String of XML with SOAP header content, or array of soapval objects for SOAP headers public

soapclient::getHeaders (  ) 

get the SOAP response headers (namespace resolution incomplete)

Renvoie:
string public

soapclient::setHTTPProxy ( $  proxyhost,
$  proxyport,
$  proxyusername = '',
$  proxypassword = '' 
)

set proxy info here

Paramètres:
string $proxyhost
string $proxyport
string $proxyusername
string $proxypassword public

soapclient::setCredentials ( $  username,
$  password,
$  authtype = 'basic',
$  certRequest = array() 
)

if authenticating, set user credentials here

Paramètres:
string $username
string $password
string $authtype (basic|digest|certificate)
array $certRequest (keys must be cainfofile (optional), sslcertfile, sslkeyfile, passphrase, verifypeer (optional), verifyhost (optional): see corresponding options in cURL docs) public

soapclient::setHTTPEncoding ( $  enc = 'gzip,
deflate'   
)

use HTTP encoding

Paramètres:
string $enc public

soapclient::useHTTPPersistentConnection (  ) 

use HTTP persistent connections if possible

public

soapclient::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.

This is no longer used.

Renvoie:
boolean public
Obsolète:

soapclient::setDefaultRpcParams ( $  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.

This is no longer used.

Paramètres:
boolean $rpcParams public
Obsolète:

soapclient::getProxy (  ) 

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

Renvoie:
object soap_proxy object public

soapclient::_getProxyClassCode ( $  r  ) 

dynamically creates proxy class code

Renvoie:
string PHP/NuSOAP code for the proxy class private

soapclient::getProxyClassCode (  ) 

dynamically creates proxy class code

Renvoie:
string PHP/NuSOAP code for the proxy class public

soapclient::getHTTPBody ( $  soapmsg  ) 

gets the HTTP body for the current request.

Paramètres:
string $soapmsg The SOAP payload
Renvoie:
string The HTTP body, which includes the SOAP payload private

soapclient::getHTTPContentType (  ) 

gets the HTTP content type for the current request.

Note: getHTTPBody must be called before this.

Renvoie:
string the HTTP content type for the current request. private

soapclient::getHTTPContentTypeCharset (  ) 

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

Note: getHTTPBody must be called before this.

Renvoie:
string the HTTP content type charset for the current request. private

soapclient::decodeUTF8 ( $  bool  ) 

soapclient::setCookie ( $  name,
$  value 
)

adds a new Cookie into $this->cookies array

Paramètres:
string $name Cookie Name
string $value Cookie Value
Renvoie:
if cookie-set was successful returns true, else false public

soapclient::getCookies (  ) 

gets all Cookies

Renvoie:
array with all internal cookies public

soapclient::checkCookies (  ) 

checks all Cookies and delete those which are expired

Renvoie:
always return true private

soapclient::UpdateCookies ( $  cookies  ) 

updates the current cookies with a new set

Paramètres:
array $cookies new cookies with which to update current ones
Renvoie:
always return true private

Documentation des données membres

soapclient::$username = ''

soapclient::$password = ''

soapclient::$authtype = ''

soapclient::$certRequest = array()

soapclient::$requestHeaders = false

soapclient::$responseHeaders = ''

soapclient::$document = ''

soapclient::$endpoint

soapclient::$forceEndpoint = ''

soapclient::$proxyhost = ''

soapclient::$proxyport = ''

soapclient::$proxyusername = ''

soapclient::$proxypassword = ''

soapclient::$xml_encoding = ''

soapclient::$http_encoding = false

soapclient::$timeout = 0

soapclient::$response_timeout = 30

soapclient::$endpointType = ''

soapclient::$persistentConnection = false

soapclient::$defaultRpcParams = false

soapclient::$request = ''

soapclient::$response = ''

soapclient::$responseData = ''

soapclient::$cookies = array()

soapclient::$decode_utf8 = true

soapclient::$operations = array()

soapclient::$fault

soapclient::$faultcode

soapclient::$faultstring

soapclient::$faultdetail

La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Fri Aug 31 11:41:56 2007 pour OBLADY - Typo3 API v4.1.2 par  doxygen 1.5.3