[ Index ] |
PHP Cross Reference of DokuWiki |
[Source view] [Print] [Project Stats]
(no description)
File Size: | 180 lines (6 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
Api:: (6 methods):
getMethods()
getCoreMethods()
getPluginMethods()
call()
ensureApiIsEnabled()
ensureAccessIsAllowed()
getMethods() X-Ref |
Get all available methods with remote access. return: ApiCall[] with information to all available methods |
getCoreMethods($apiCore = null) X-Ref |
Collects all the core methods return: ApiCall[] all core methods. param: ApiCore|MockApiCore $apiCore this parameter is used for testing. |
getPluginMethods() X-Ref |
Collects all the methods of the enabled Remote Plugins return: ApiCall[] all plugin methods. |
call($method, $args = []) X-Ref |
Call a method via remote api. return: mixed result of method call, must be a primitive type. param: string $method name of the method to call. param: array $args arguments to pass to the given method |
ensureApiIsEnabled() X-Ref |
Check that the API is generally enabled return: void |
ensureAccessIsAllowed(ApiCall $method) X-Ref |
Check if the current user is allowed to call the given method return: void param: ApiCall $method |