API Documentation

Service/StrikeIron/Base.php

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service  
subpackage
StrikeIron  
version
$Id: Base.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Service_StrikeIron_Base

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service  
subpackage
StrikeIron  

Properties

Propertyprotected  $_options= 'array'

Configuration options

Default valuearrayDetails
Type
$_options
array
Propertyprotected  $_outputHeaders= 'array'

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

Default valuearrayDetails
Type
$_outputHeaders
array

Methods

methodpublic__call( string $method, array $params ) : mixed

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

Parameters
Name Type Description
$method string Method name
$params array Parameters for method
Returns
Type Description
mixed Result
Throws
Exception Description
\Zend_Service_StrikeIron_Exception
methodpublic__construct( array $options = array ) : void

Class constructor

Parameters
Name Type Description
$options array

Key/value pair options

Throws
Exception Description
\Zend_Service_StrikeIron_Exception
methodprotected_initSoapClient( ) : void

Initialize the SOAPClient instance

methodprotected_initSoapHeaders( ) : void

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

Throws
Exception Description
\Zend_Service_StrikeIron_Exception
methodprotected_transformCall( string $method,  $params ) : array

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.

Parameters
Name Type Description
$method string Method name called from PHP
$params
Returns
Type Description
array [$method, $params] for SOAPClient->__soapCall()
Details
see
\__call()  
methodprotected_transformResult( object $result, string $method, array $params ) : mixed

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.

Parameters
Name Type Description
$result object

Raw result returned from SOAPClient_>__soapCall()

$method string

Method name that was passed to SOAPClient->__soapCall()

$params array

Method parameters that were passed to SOAPClient->__soapCall()

Returns
Type Description
mixed Transformed result
Details
see
\__call()  
methodpublicgetLastOutputHeaders( ) : array

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

Returns
Type Description
array
methodpublicgetSoapClient( ) : void

Get the SOAP Client instance for this service.

methodpublicgetSubscriptionInfo( boolean $now = false, string $queryMethod = GetRemainingHits ) : \Zend_Service_StrikeIron_Decorator

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
Name Type Description
$now boolean

Force a call to getRemainingHits instead of cache?

$queryMethod string Method that will cause SubscriptionInfo header to be sent
Returns
Type Description
\Zend_Service_StrikeIron_Decorator Decorated subscription info
Throws
Exception Description
\Zend_Service_StrikeIron_Exception
methodpublicgetWsdl( ) : string

Get the WSDL URL for this service.

Returns
Type Description
string
Documentation was generated by DocBlox 0.13.3.