Service/StrikeIron/Base.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service
subpackage: StrikeIron
version: $Id: Base.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Service_StrikeIron_Base

Description

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.

Zend_Service_StrikeIron_Base
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service
subpackage: StrikeIron
Properties: $_options; $_outputHeaders
Methods: __construct; __call; _initSoapClient; _initSoapHeaders; _transformCall; _transformResult; getWsdl; getSoapClient; getLastOutputHeaders; getSubscriptionInfo

Description

Properties

$_options
jump to class

$_options = 'array'

Configuration options

Details

visibility: protected
default: array
final: false
static: false
$_options: array

$_outputHeaders
jump to class

$_outputHeaders = 'array'

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

Details

visibility: protected
default: array
final: false
static: false
$_outputHeaders: array

Methods

__call
jump to class

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

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

Arguments

$method: string
Method name
$params: array
Parameters for method

Output

mixed: Result

Details

visibility: public
final: false
static: false
throws

__construct
jump to class

__construct(
          array $options
              =
              array
          )
        
        :

Class constructor

Arguments

$options: array
Key/value pair options

Details

visibility: public
final: false
static: false
throws

_initSoapClient
jump to class

_initSoapClient(
          
          )
        
        :
        void

Initialize the SOAPClient instance

Details

visibility: protected
final: false
static: false

_initSoapHeaders
jump to class

_initSoapHeaders(
          
          )
        
        :
        void

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

Details

visibility: protected
final: false
static: false
throws

_transformCall
jump to class

_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.

Arguments

$method: string
Method name called from PHP
$params

Output

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

Details

visibility: protected
final: false
static: false
see: __call()

_transformResult
jump to class

_transformResult(
          $result $result, $method $method, $params $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.

Arguments

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

Output

mixed: Transformed result

Details

visibility: protected
final: false
static: false
see: __call()

getLastOutputHeaders
jump to class

getLastOutputHeaders(
          
          )
        
        :
        array

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

Output

array

Details

visibility: public
final: false
static: false

getSoapClient
jump to class

getSoapClient(
          
          )
        
        :

Get the SOAP Client instance for this service.

Details

visibility: public
final: false
static: false

getSubscriptionInfo
jump to class

getSubscriptionInfo(
          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.

Arguments

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

Output

Zend_Service_StrikeIron_Decorator: Decorated subscription info

Details

visibility: public
final: false
static: false
throws

getWsdl
jump to class

getWsdl(
          
          )
        
        :
        string

Get the WSDL URL for this service.

Output

string

Details

visibility: public
final: false
static: false

API Documentation

Service/StrikeIron/Base.php

Description

Zend_Service_StrikeIron_Basejump to top

Description

Properties

$_optionsjump to class

Details

$_outputHeadersjump to class

Details

Methods

__calljump to class

Arguments

Output

Details

__constructjump to class

Arguments

Details

_initSoapClientjump to class

Details

_initSoapHeadersjump to class

Details

_transformCalljump to class

Arguments

Output

Details

_transformResultjump to class

Arguments

Output

Details

getLastOutputHeadersjump to class

Output

Details

getSoapClientjump to class

Details

getSubscriptionInfojump to class

Arguments

Output

Details

getWsdljump to class

Output

Details

Zend_Service_StrikeIron_Base
jump to top

$_options
jump to class

$_outputHeaders
jump to class

__call
jump to class

__construct
jump to class

_initSoapClient
jump to class

_initSoapHeaders
jump to class

_transformCall
jump to class

_transformResult
jump to class

getLastOutputHeaders
jump to class

getSoapClient
jump to class

getSubscriptionInfo
jump to class

getWsdl
jump to class