Docs For Class AkActionWebserviceApi

Description

AkObject
   |
   --AkActionWebserviceApi

Located in File: /AkActionWebService/AkActionWebServiceApi.php

A web service API class specifies the methods that will be available for invocation for an API. It also contains metadata such as the method type signature hints.

It is not intended to be instantiated.

It is attached to web service implementation classes like AkActionWebService and AkActionController derivatives by using <tt>container::web_service_api</tt>, where <tt>container</tt> is an AkActionController or an AkActionWebService.

See AkActionWebService/AkDirectContainer.php class methods for an example of use.

author: - Bermi Ferrer <a.t akelos c.om bermi a.t akelos c.om>
copyright: - Copyright (c) 2002-2005, Akelos Media, S.L. http://www.akelos.org

Class Variables

Summary:

mixed $default_api_method

mixed $inflect_names

mixed $localize_documentation

mixed $_api_methods

mixed $_api_public_method_names

$default_api_method (line 50)

Data type : mixed

If present, the name of a method to call when the remote caller tried to call a nonexistent method.

$inflect_names = true (line 39)

Data type : mixed

Whether to transform the public API method names into camel-cased names

$localize_documentation = true (line 44)

Data type : mixed

Whether to localize the API documentation automatically.

$_api_methods = array() (line 52)

Data type : mixed

$_api_public_method_names = array() (line 53)

Data type : mixed

Class Constants

Summary:

Method Detail

Summary:

void addApiMethod ( $name, [ $options = array()])

void &getApiMethodInstance ( $method_name)

void getApiMethodName ( $public_name)

void &getApiMethods ()

void &getDefaultApiMethodInstance ()

void &getPublicApiMethodInstance ( $public_method_name)

void getPublicApiMethodName ( $name)

void hasApiMethod ( $name)

void hasPublicApiMethod ( $public_name)

void _getApiPublicMethodNames ()

void _validateOptions ( $valid_option_keys, $supplied_option_keys)

Method addApiMethod (line 84)

void addApiMethod( $name, [ $options = array()])

API methods have a +name+, which must be the PHP method name to use when performing the invocation on the web service object.

The signatures for the method input parameters and return value can by specified in +options+.

A signature is an array of one or more parameter specifiers. A parameter specifier can be one of the following:

* A string representing one of the Action Web Service base types. See AkActionWebService/AkSignatureTypes.php for a canonical list of the base types. * The Class object of the parameter type * A single-element Array containing one of the two preceding items. This will cause Action Web Service to treat the parameter at that position as an array containing only values of the given type. * An Array containing as key the name of the parameter, and as value one of the three preceding items

If no method input parameter or method return value signatures are given, the method is assumed to take no parameters and/or return no values of interest, and any values that are received by the server will be discarded and ignored.

Valid options: <tt>expects</tt> Signature for the method input parameters <tt>returns</tt> Signature for the method return value <tt>expects_and_returns</tt> Signature for both input parameters and return value

Parameters

$name:
$options:

Info

Method getApiMethodInstance (line 153)

void &getApiMethodInstance( $method_name)

The Method instance for the given API method name, if any

Parameters

$method_name:

Info

Method getApiMethodName (line 128)

void getApiMethodName( $public_name)

The corresponding service method name for the given public method name

Parameters

$public_name:

Info

Method getApiMethods (line 137)

void &getApiMethods( )

An array containing all service methods on this API, and their associated metadata.

Info

Method getDefaultApiMethodInstance (line 161)

void &getDefaultApiMethodInstance( )

The Method instance for the default API method, if any

Info

Method getPublicApiMethodInstance (line 145)

void &getPublicApiMethodInstance( $public_method_name)

The Method instance for the given public API method name, if any

Parameters

$public_method_name:

Info

Method getPublicApiMethodName (line 120)

void getPublicApiMethodName( $name)

The corresponding public method name for the given service method name

Parameters

$name:

Info

Method hasApiMethod (line 103)

void hasApiMethod( $name)

Whether the given method name is a service method on this API

Parameters

$name:

Info

Method hasPublicApiMethod (line 112)

void hasPublicApiMethod( $public_name)

Whether the given public method name has a corresponding service method

on this API

Parameters

$public_name:

Info

Method _getApiPublicMethodNames (line 177)

void _getApiPublicMethodNames( )

Info

Method _validateOptions (line 182)

void _validateOptions( $valid_option_keys, $supplied_option_keys)

Parameters

$valid_option_keys:
$supplied_option_keys:

Info

Inherited Variables

Inherited Class Variable Summary

Inherited Methods

Inherited Method Summary

Inherited From Class AkObject

AkObject::AkObject() - A hack to support __construct() on PHP 4

AkObject::__construct() - Class constructor, overriden in descendant classes

AkObject::freeMemory() - Unsets circular reference children that are not freed from memory when calling unset() or when the parent object is garbage collected.

Class AkActionWebserviceApi

Description

A web service API class specifies the methods that will be available for invocation for an API. It also contains metadata such as the method type signature hints.

Class Variables

$default_api_method (line 50)

Data type : mixed

If present, the name of a method to call when the remote caller tried to call a nonexistent method.

$inflect_names = true (line 39)

Data type : mixed

Whether to transform the public API method names into camel-cased names

$localize_documentation = true (line 44)

Data type : mixed

Whether to localize the API documentation automatically.

$_api_methods = array() (line 52)

Data type : mixed

$_api_public_method_names = array() (line 53)

Data type : mixed

Class Constants

Method Detail

Method addApiMethod (line 84)

void addApiMethod( $name, [ $options = array()])

API methods have a +name+, which must be the PHP method name to use when performing the invocation on the web service object.

Parameters

Info

Method getApiMethodInstance (line 153)

void &getApiMethodInstance( $method_name)

The Method instance for the given API method name, if any

Parameters

Info

Method getApiMethodName (line 128)

void getApiMethodName( $public_name)

The corresponding service method name for the given public method name

Parameters

Info

Method getApiMethods (line 137)

void &getApiMethods( )

An array containing all service methods on this API, and their associated metadata.

Info

Method getDefaultApiMethodInstance (line 161)

void &getDefaultApiMethodInstance( )

The Method instance for the default API method, if any

Info

Method getPublicApiMethodInstance (line 145)

void &getPublicApiMethodInstance( $public_method_name)

The Method instance for the given public API method name, if any

Parameters

Info

Method getPublicApiMethodName (line 120)

void getPublicApiMethodName( $name)

The corresponding public method name for the given service method name

Parameters

Info

Method hasApiMethod (line 103)

void hasApiMethod( $name)

Whether the given method name is a service method on this API

Parameters

Info

Method hasPublicApiMethod (line 112)

void hasPublicApiMethod( $public_name)

Whether the given public method name has a corresponding service method

Parameters

Info

Method _getApiPublicMethodNames (line 177)

void _getApiPublicMethodNames( )

Info

Method _validateOptions (line 182)

void _validateOptions( $valid_option_keys, $supplied_option_keys)

Parameters

Info

Inherited Variables

Inherited Class Variable Summary

Inherited Methods

Inherited Method Summary

Inherited From Class AkObject

AkObject::AkObject() - A hack to support __construct() on PHP 4

AkObject::__construct() - Class constructor, overriden in descendant classes

AkObject::freeMemory() - Unsets circular reference children that are not freed from memory when calling unset() or when the parent object is garbage collected.

AkObject::log() -

AkObject::toString() - Object-to-string conversion

AkObject::__clone() - Clone class (Zend Engine 2 compatibility trick)