Class: soapclientmime

Source Location: /lodel/scripts/nusoapmime.php

Class soapclientmime

Class Overview

soapclientmime client supporting <a href="http://www.w3.org/TR/SOAP-attachments">MIME attachments</a>.

Located in /lodel/scripts/nusoapmime.php [line 49]

nusoap_base
   |
   --mysoapclient
      |
      --soapclientmime

Author(s):

Thanks to Guillaume and Henning Reich for posting great attachment code to the mail list
Scott Nichol <snichol@sourceforge.net>

API Tags:

Access:

public

Information Tags:

Version:

$Id: nusoapmime.php 3705 2006-09-14 16:06:29Z cenou $

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From mysoapclient

mysoapclient::$authtype

mysoapclient::$decode_utf8

mysoapclient::$defaultRpcParams

mysoapclient::$document

mysoapclient::$endpoint

mysoapclient::$endpointType

mysoapclient::$fault

mysoapclient::$faultcode

mysoapclient::$faultdetail

mysoapclient::$faultstring

mysoapclient::$http_encoding

mysoapclient::$operations

mysoapclient::$password

mysoapclient::$persistentConnection

mysoapclient::$proxyhost

mysoapclient::$proxypassword

mysoapclient::$proxyport

mysoapclient::$proxyusername

mysoapclient::$request

mysoapclient::$requestHeaders

mysoapclient::$response

mysoapclient::$responseData

mysoapclient::$responseHeaders

mysoapclient::$response_timeout

mysoapclient::$timeout

mysoapclient::$username

mysoapclient::$xml_encoding

Inherited From nusoap_base

nusoap_base::$charencoding

nusoap_base::$debug_str

nusoap_base::$error_str

nusoap_base::$namespaces

nusoap_base::$revision

nusoap_base::$soap_defencoding

nusoap_base::$title

nusoap_base::$typemap

nusoap_base::$usedNamespaces

nusoap_base::$version

nusoap_base::$xmlEntities

nusoap_base::$XMLSchemaVersion

Inherited From mysoapclient

mysoapclient::mysoapclient()

constructor

mysoapclient::call()

calls method, returns PHP native type

mysoapclient::decodeUTF8()

mysoapclient::getDefaultRpcParams()

gets the default RPC parameter setting.

mysoapclient::getHeaders()

get the response headers

mysoapclient::getHTTPBody()

gets the HTTP body for the current request.

mysoapclient::getHTTPContentType()

gets the HTTP content type for the current request.

mysoapclient::getHTTPContentTypeCharset()

gets the HTTP content type charset for the current request.

mysoapclient::getOperationData()

get available data pertaining to an operation

mysoapclient::getProxy()

dynamically creates proxy class, allowing user to directly call methods from wsdl

mysoapclient::parseResponse()

processes SOAP message returned from server

mysoapclient::send()

send the SOAP message

mysoapclient::setCredentials()

if authenticating, set user credentials here

mysoapclient::setDefaultRpcParams()

sets the default RPC parameter setting.

mysoapclient::setHeaders()

set the SOAP headers

mysoapclient::setHTTPEncoding()

use HTTP encoding

mysoapclient::setHTTPProxy()

set proxy info here

mysoapclient::useHTTPPersistentConnection()

use HTTP persistent connections if possible

Inherited From nusoap_base

nusoap_base::appendDebug()

adds debug data to the instance debug string without formatting

nusoap_base::clearDebug()

clears the current debug data for this instance

nusoap_base::contractQname()

contracts a qualified name

nusoap_base::debug()

adds debug data to the instance debug string with formatting

nusoap_base::expandEntities()

expands entities, e.g. changes '<' to '<'.

nusoap_base::expandQname()

expands a qualified name

nusoap_base::formatDump()

nusoap_base::getDebug()

gets the current debug data for this instance

nusoap_base::getDebugAsXMLComment()

gets the current debug data for this instance as an XML comment this may change the contents of the debug data

nusoap_base::getError()

returns error string if present

nusoap_base::getLocalPart()

returns the local part of a prefixed string returns the original string, if not prefixed

nusoap_base::getmicrotime()

returns the time in ODBC canonical form with microseconds

nusoap_base::getNamespaceFromPrefix()

pass it a prefix, it returns a namespace returns false if no namespace registered with the given prefix

nusoap_base::getPrefix()

returns the prefix part of a prefixed string returns false, if not prefixed

nusoap_base::getPrefixFromNamespace()

returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace

nusoap_base::isArraySimpleOrStruct()

detect if array is a simple array or a struct (associative array)

nusoap_base::serializeEnvelope()

serialize message

nusoap_base::serialize_val()

serializes PHP values in accordance w/ section 5. Type information is not serialized if $use == 'literal'.

nusoap_base::setError()

sets error string

nusoap_base::varDump()

[ Top ]

Property Summary

mixed	$mimeContentType
mixed	$requestAttachments
mixed	$responseAttachments

[ Top ]

Method Summary

string	addAttachment()	adds a MIME attachment to the current request.
void	clearAttachments()	clears the MIME attachments for the current request.
array	getAttachments()	gets the MIME attachments from the current response.
string	getHTTPBody()	gets the HTTP body for the current request.
string	getHTTPContentType()	gets the HTTP content type for the current request.
string	getHTTPContentTypeCharset()	gets the HTTP content type charset for the current request.
mixed	parseResponse()	processes SOAP message returned from server

[ Top ]

Properties

mixed $mimeContentType [line 52]

[ Top ]

mixed $requestAttachments = array() [line 50]

[ Top ]

mixed $responseAttachments [line 51]

[ Top ]

Methods

addAttachment [line 69]

string addAttachment(
string
$data, [string
$filename = ''], [string
$contenttype = 'application/octet-stream'], [string
$cid = false] 
)

adds a MIME attachment to the current request.

If the $data parameter contains an empty string, this method will read the contents of the file named by the $filename parameter.

If the $cid parameter is false, this method will generate the cid.

Parameters:

string	$data:	The data of the attachment
string	$filename:	The filename of the attachment (default is empty string)
string	$contenttype:	The MIME Content-Type of the attachment (default is application/octet-stream)
string	$cid:	The content-id (cid) of the attachment (default is false)

API Tags:

Return:	The content-id (cid) of the attachment
Access:	public

[ Top ]

clearAttachments [line 89]

void clearAttachments(
)

clears the MIME attachments for the current request.

API Tags:

Access:

public

[ Top ]

getAttachments [line 103]

array getAttachments(
)

gets the MIME attachments from the current response.

Each array element in the return is an associative array with keys data, filename, contenttype, cid. These keys correspond to the parameters for addAttachment.

API Tags:

Return:	The attachments.
Access:	public

[ Top ]

getHTTPBody [line 114]

string getHTTPBody(
string
$soapmsg 
)

gets the HTTP body for the current request.

Parameters:

string

$soapmsg:

The SOAP payload

API Tags:

Return:	The HTTP body, which includes the SOAP payload
Access:	protected

Redefinition of:

mysoapclient::getHTTPBody(): gets the HTTP body for the current request.

[ Top ]

getHTTPContentType [line 178]

string getHTTPContentType(
)

gets the HTTP content type for the current request.

Note: getHTTPBody must be called before this.

API Tags:

Return:	the HTTP content type for the current request.
Access:	protected

Redefinition of:

mysoapclient::getHTTPContentType(): gets the HTTP content type for the current request.

[ Top ]

getHTTPContentTypeCharset [line 194]

string 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.

API Tags:

Return:	the HTTP content type charset for the current request.
Access:	protected

Redefinition of:

mysoapclient::getHTTPContentTypeCharset(): gets the HTTP content type charset for the current request.

[ Top ]

parseResponse [line 209]

mixed parseResponse(
array
$headers, string
$data 
)

processes SOAP message returned from server

Parameters:

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

API Tags:

Return:	value of the message, decoded into a PHP type
Access:	protected

Redefinition of:

mysoapclient::parseResponse(): processes SOAP message returned from server

[ Top ]

Documentation generated on Wed, 19 Sep 2007 05:07:20 +0200 by phpDocumentor 1.4.0a2

	default

[ class tree: default ] [ index: default ] [ all elements ]