Zend_Service_StrikeIron_Base Class Reference

Inheritance diagram for Zend_Service_StrikeIron_Base:

Public Member Functions
	__construct ($options=array())
	__call ($method, $params)
	getWsdl ()
	getSoapClient ()
	getLastOutputHeaders ()
	getSubscriptionInfo ($now=false, $queryMethod= 'GetRemainingHits')
Protected Member Functions
	_initSoapClient ()
	_initSoapHeaders ()
	_transformCall ($method, $params)
	_transformResult ($result, $method, $params)
Protected Attributes
	$_options
	$_outputHeaders = array()

---

Detailed Description

Definition at line 37 of file Base.php.

---

Constructor & Destructor Documentation

__construct

(

$

options = array()

)

Class constructor

Parameters:

array

$options

Key/value pair options

Exceptions:

Zend_Service_StrikeIron_Exception

See also:

Zend_Service_StrikeIron_Exception

Definition at line 62 of file Base.php.

Here is the call graph for this function:

---

Member Function Documentation

__call	(	$	method,
		$	params
	)

Proxy method calls to the SOAPClient instance, transforming method calls and responses for convenience.

Parameters:

string	$method	Method name
array	$params	Parameters for method

Returns:

mixed Result

Exceptions:

Zend_Service_StrikeIron_Exception

See also:

Zend_Service_StrikeIron_Exception

Definition at line 87 of file Base.php.

Here is the call graph for this function:

_initSoapClient

(

)

[protected]

Initialize the SOAPClient instance

Returns:

void

Definition at line 119 of file Base.php.

Here is the caller graph for this function:

_initSoapHeaders

(

)

[protected]

Initialize the headers to pass to SOAPClient->__soapCall()

Returns:

void

Exceptions:

Zend_Service_StrikeIron_Exception

See also:

Zend_Service_StrikeIron_Exception

Definition at line 137 of file Base.php.

Here is the caller graph for this function:

_transformCall	(	$	method,
		$	params
	)		[protected]

Transform a method name or method parameters before sending them to the remote service. This can be useful for inflection or other transforms to give the method call a more PHP-like interface.

See also:

__call()

Parameters:

string	$method	Method name called from PHP
mixed	$param	Parameters passed from PHP

Returns:

array [$method, $params] for SOAPClient->__soapCall()

Definition at line 181 of file Base.php.

Here is the caller graph for this function:

_transformResult	(	$	result,
		$	method,
		$	params
	)		[protected]

Transform the result returned from a method before returning it to the PHP caller. This can be useful for transforming the SOAPClient returned result to be more PHP-like.

The $method name and $params passed to the method are provided to allow decisions to be made about how to transform the result based on what was originally called.

See also:

__call()

Parameters:

$result	Raw result returned from SOAPClient_>__soapCall()
$method	Method name that was passed to SOAPClient->__soapCall()
$params	Method parameters that were passed to SOAPClient->__soapCall()

Returns:

mixed Transformed result

Definition at line 201 of file Base.php.

Here is the caller graph for this function:

getLastOutputHeaders

(

)

Get the StrikeIron output headers returned with the last method response.

Returns:

array

Definition at line 236 of file Base.php.

getSoapClient

(

)

Get the SOAP Client instance for this service.

Definition at line 226 of file Base.php.

getSubscriptionInfo	(	$	now = false,
		$	queryMethod = 'GetRemainingHits'
	)

Get the StrikeIron subscription information for this service. If any service method was recently called, the subscription info should have been returned in the SOAP headers so it is cached and returned from the cache. Otherwise, the getRemainingHits() method is called as a dummy to get the subscription info headers.

Parameters:

boolean	$now	Force a call to getRemainingHits instead of cache?
string	$queryMethod	Method that will cause SubscriptionInfo header to be sent

Returns:

Zend_Service_StrikeIron_Decorator Decorated subscription info

Exceptions:

Zend_Service_StrikeIron_Exception

See also:

Zend_Service_StrikeIron_Exception

Definition at line 253 of file Base.php.

getWsdl

(

)

Get the WSDL URL for this service.

Returns:

string

Definition at line 218 of file Base.php.

---

Field Documentation

$_options [protected]

Initial value:

 array('username' => null,
                                'password' => null,
                                'client'   => null,
                                'options'  => null,
                                'headers'  => null,
                                'wsdl'     => null)

Configuration options

Parameters:

array

Reimplemented in Zend_Service_StrikeIron_SalesUseTaxBasic, Zend_Service_StrikeIron_USAddressVerification, and Zend_Service_StrikeIron_ZipCodeInfo.

Definition at line 43 of file Base.php.

$_outputHeaders = array() [protected]

Output headers returned by the last call to SOAPClient->__soapCall()

Parameters:

array

Definition at line 54 of file Base.php.

---

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

• C:/xampp/htdocs/moodle/lib/zend/Zend/Service/StrikeIron/Base.php