Xinc-Api
[ class tree: Xinc-Api ] [ index: Xinc-Api ] [ all elements ]

Class: Xinc_Api_Module_Interface

Source Location: /Xinc/Api/Module/Interface.php

Interface Overview




Methods



Class Details

[line 33]


[ Top ]


Class Methods


constructor __construct [line 45]

Xinc_Api_Module_Interface __construct( Xinc_Plugin_Interface $plugin)

Constructor for the Module

The plugin passed itself as a variable to the constructor.

The Api Module can access the plugins shared functionality




Tags:

access:  public


Parameters:

Xinc_Plugin_Interface   $plugin  

[ Top ]

method getMethods [line 67]

void getMethods( )

returns the Methods of this Api Module

getName() returns 'mymodule'; getMethod() returns array('get', 'set'); Api can handle: http://mydomain.com/api/mymodule/get/ AND http://mydomain.com/api/mymodule/set/




Tags:

access:  public


[ Top ]

method getName [line 76]

String getName( )

get the name of the module as it should be used in api calls



Tags:

access:  public


[ Top ]

method processCall [line 54]

void processCall( String $methodName, [array $params = array()])

The Xinc_Api_Handler passes the called methodName and the parameters to the api module



Tags:

access:  public


Parameters:

String   $methodName  
array   $params  

[ Top ]


Documentation generated on Sun, 09 Dec 2012 21:49:28 +0100 by phpDocumentor 1.4.4