PHPXRef 0.6 : Akelos Framework : Detail view of AkActionWebServiceApi.php

(no description)

Author:	Bermi Ferrer
Copyright:	Copyright (c) 2002-2006, Akelos Media, S.L. http://www.akelos.org
License:	GNU Lesser General Public License
File Size:	252 lines (9 kb)
Included or required:	2 times
Referenced:	0 times
Includes or requires:	0 files

Defines 2 classes

AkActionWebserviceApi:: (11 methods):
  addApiMethod()
  hasApiMethod()
  hasPublicApiMethod()
  getPublicApiMethodName()
  getApiMethodName()
  getApiMethods()
  getPublicApiMethodInstance()
  getApiMethodInstance()
  getDefaultApiMethodInstance()
  _getApiPublicMethodNames()
  _validateOptions()

AkActionWebServiceMethod:: (4 methods):
  AkActionWebServiceMethod()
  _extractDocumentationFromExpects()
  _extractDocumentationFromReturns()
  _extractDocumentationFromMethod()

Class: AkActionWebserviceApi - X-Ref

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.

addApiMethod($name, $options = array() X-Ref

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

hasApiMethod($name) X-Ref

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

hasPublicApiMethod($public_name) X-Ref

Whether the given public method name has a corresponding service method
on this API

getPublicApiMethodName($name) X-Ref

The corresponding public method name for the given service method name

getApiMethodName($public_name) X-Ref

The corresponding service method name for the given public method name

getApiMethods() X-Ref

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

getPublicApiMethodInstance($public_method_name) X-Ref

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