| [ Index ] |
PHP Cross Reference of DokuWiki |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 179 lines (4 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
ApiCall:: (11 methods):
__construct()
__invoke()
getDocs()
isPublic()
setPublic()
getArgs()
getReturn()
getSummary()
getDescription()
getCategory()
namedArgsToPositional()
| __construct($method, $category = '') X-Ref |
| Make the given method available as an API call param: string|array $method Either [object,'method'] or 'function' param: string $category The category this call belongs to |
| __invoke($args) X-Ref |
| Call the method Important: access/authentication checks need to be done before calling this! param: array $args return: mixed |
| getDocs() X-Ref |
| Access the method documentation This lazy loads the docs only when needed return: DocBlockMethod |
| isPublic() X-Ref |
| Is this a public method? Public methods can be called without authentication return: bool |
| setPublic(bool $isPublic = true) X-Ref |
| Set the public flag param: bool $isPublic return: $this |
| getArgs() X-Ref |
| Get information about the argument of this call return: array |
| getReturn() X-Ref |
| Get information about the return value of this call return: array |
| getSummary() X-Ref |
| Get the summary of this call return: string |
| getDescription() X-Ref |
| Get the description of this call return: string |
| getCategory() X-Ref |
| Get the category of this call return: string |
| namedArgsToPositional($params) X-Ref |
| Converts named arguments to positional arguments param: array $params return: array |