Static Public Member Functions
static	_store_results ($object, $prefix= 'soap_', &$soap_response_keywords=Array(), $file_keywords)

static	_parse_type ($type, $types)

static	_parse_type_recursive ($param, $types, &$node)

static	_is_complex_type ($param, $types, &$is_array=FALSE)

static	_formatXmlString ($xml)

static	_parse_response_keywords (&$response_xml, $prefix= '')

static	_getSoapOptions ($settings, $form=NULL)

static	testSoapRequest ($client, $settings, $function, $form=NULL)

static	_save_file ($content)

static	toArray ($data)

Detailed Description

Definition at line 36 of file soap_common.inc.

Member Function Documentation

static _formatXmlString ( $xml )

static

This function formats a xml, inserts indentation, newlines for better display

Returns: string private

Definition at line 216 of file soap_common.inc.

static _getSoapOptions	(	$settings,
		$form = `NULL`
	)

static

Get soap options from setting, e.g http auth, https cert.

Parameters

array	$settings	the settings of our action we need to extract information from
object	$form	optionally pass a form object to store the error in

Returns: array private

Definition at line 293 of file soap_common.inc.

static _is_complex_type	(		$param,
			$types,
		&	$is_array = `FALSE`
	)

static

This function checks if a param is of complex type from types list, if so, return the sub types

Returns: false | array private

Definition at line 180 of file soap_common.inc.

static _parse_response_keywords	(	&	$response_xml,
			$prefix = `''`
	)

static

This function recursively extarcts available session keywords from response message

Returns: string private

Definition at line 264 of file soap_common.inc.

static _parse_type	(	$type,
		$types
	)

static

This function returns XML representation of param struct

Returns: object | void public

Definition at line 84 of file soap_common.inc.

static _parse_type_recursive	(		$param,
			$types,
		&	$node
	)

static

This function recursively parse the complex param type

Returns: null private

Definition at line 136 of file soap_common.inc.

static _save_file ( $content )

static

This function will save the file in data/private directory and give us a ./?SQ_ACTION=get_soap_downloaded_file&soap_filename=XXXXXXX type url as our keyword replacement to view this file

Parameters

string $content the file content we get in the response of SOAP

Returns: string public

Definition at line 391 of file soap_common.inc.

static _store_results	(		$object,
			$prefix = `'soap_'`,
		&	$soap_response_keywords = `Array()`,
			$file_keywords
	)

static

This function recursively checks an object properties and store them in session

Returns: void private

Definition at line 49 of file soap_common.inc.

static testSoapRequest	(	$client,
		$settings,
		$function,
		$form = `NULL`
	)

static

Get sample SOAP request/response

Returns: array public

Definition at line 337 of file soap_common.inc.

static toArray ( $data )

static

Converts xml object to array Replace file content keyword

Returns: array public

Definition at line 417 of file soap_common.inc.

The documentation for this class was generated from the following file:

/Users/webmaster/Desktop/squiz_matrix/packages/web_services/api/lib/soap_common.inc

Static Public Member Functions

Detailed Description

Member Function Documentation