Service/StrikeIron/Base.php

Show: PublicProtectedPrivateinherited
Table of Contents
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service  
Subpackage
StrikeIron  
Version
$Id$  

\Zend_Service_StrikeIron_Base

Package: Zend_Service\StrikeIron
Children
\Zend_Service_StrikeIron_USAddressVerification
\Zend_Service_StrikeIron_SalesUseTaxBasic
\Zend_Service_StrikeIron_ZipCodeInfo
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$_options = array('username' => null, 'password' => null, 'client' => null, 'options' => null, 'headers' => null, 'wsdl' => null)
Configuration options
Default valuearray('username' => null, 'password' => null, 'client' => null, 'options' => null, 'headers' => null, 'wsdl' => null)Details
Type
n/a
$_options
array

>VPropertyprotected$_outputHeaders = array()
Output headers returned by the last call to SOAPClient->__soapCall()
Default valuearray()Details
Type
n/a
$_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
NameTypeDescription
$methodstring

Method name

$paramsarray

Parameters for method

Returns
TypeDescription
mixedResult
Throws
ExceptionDescription
\Zend_Service_StrikeIron_Exception
methodpublic__construct(array $options = array()) : void

Class constructor

Parameters
NameTypeDescription
$optionsarray

Key/value pair options

Throws
ExceptionDescription
\Zend_Service_StrikeIron_Exception
methodprotected_initSoapClient() : void

Initialize the SOAPClient instance

methodprotected_initSoapHeaders() : void

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

Throws
ExceptionDescription
\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
NameTypeDescription
$methodstring

Method name called from PHP

$params
Returns
TypeDescription
array[$method, $params] for SOAPClient->__soapCall()
Details
See
 
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
NameTypeDescription
$resultobject

Raw result returned from SOAPClient_>__soapCall()

$methodstring

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

$paramsarray

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

Returns
TypeDescription
mixedTransformed result
Details
See
 
methodpublicgetLastOutputHeaders() : array

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

Returns
TypeDescription
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
NameTypeDescription
$nowboolean

Force a call to getRemainingHits instead of cache?

$queryMethodstring

Method that will cause SubscriptionInfo header to be sent

Returns
TypeDescription
\Zend_Service_StrikeIron_DecoratorDecorated subscription info
Throws
ExceptionDescription
\Zend_Service_StrikeIron_Exception
methodpublicgetWsdl() : string

Get the WSDL URL for this service.

Returns
TypeDescription
string
Documentation was generated by phpDocumentor 2.2.0 .