Zend_Service_StrikeIron_Base Class Reference

Public Member Functions
	__construct ($options=array())
	Class constructor.
	__call ($method, $params)
	Proxy method calls to the SOAPClient instance, transforming method calls and responses for convenience.
	getWsdl ()
	Get the WSDL URL for this service.
	getSoapClient ()
	Get the SOAP Client instance for this service.
	getLastOutputHeaders ()
	Get the StrikeIron output headers returned with the last method response.
	getSubscriptionInfo ($now=false, $queryMethod= 'GetRemainingHits')
	Get the StrikeIron subscription information for this service.

Protected Member Functions
	_initSoapClient ()
	Initialize the SOAPClient instance.
	_initSoapHeaders ()
	Initialize the headers to pass to SOAPClient->__soapCall()
	_transformCall ($method, $params)
	Transform a method name or method parameters before sending them to the remote service.
	_transformResult ($result, $method, $params)
	Transform the result returned from a method before returning it to the PHP caller.

Protected Attributes
	$_options
	Configuration options.
	$_outputHeaders = array()
	Output headers returned by the last call to SOAPClient->__soapCall()

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

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

_initSoapClient ( )

protected

Initialize the SOAPClient instance.

Returns

void

_initSoapHeaders ( )

protected

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

Returns

void

Exceptions

Zend_Service_StrikeIron_Exception

See Also

Zend_Service_StrikeIron_Exception

_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()

_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

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

Returns

mixed Transformed result

getLastOutputHeaders

(

)

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

Returns

array

getSoapClient

(

)

Get the SOAP Client instance for this service.

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

getWsdl

(

)

Get the WSDL URL for this service.

Returns

string

Member Data Documentation

$_options

protected

Initial value:

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

Configuration options.

Parameters

array

$_outputHeaders = array()

protected

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

Parameters

array