[ Index ] |
PHP Cross Reference of DokuWiki |
[Source view] [Print] [Project Stats]
(no description)
File Size: | 1119 lines (34 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
ApiCore:: (32 methods):
__construct()
getRemoteInfo()
getVersion()
getTime()
rawPage()
getAttachment()
getAttachmentInfo()
htmlPage()
listPages()
readNamespace()
search()
getTitle()
listAttachments()
listBackLinks()
pageInfo()
putPage()
appendPage()
createUser()
deleteUsers()
putAttachment()
deleteAttachment()
aclCheck()
listLinks()
getRecentChanges()
getRecentMediaChanges()
pageVersions()
wikiRpcVersion()
setLocks()
getAPIVersion()
login()
logoff()
resolvePageId()
__construct(Api $api) X-Ref |
param: Api $api |
getRemoteInfo() X-Ref |
Returns details about the core methods return: array |
getVersion() X-Ref |
return: string |
getTime() X-Ref |
return: int unix timestamp |
rawPage($id, $rev = '') X-Ref |
Return a raw wiki page return: string page text. param: string $id wiki page id param: int|string $rev revision timestamp of the page or empty string |
getAttachment($id) X-Ref |
Return a media file author: Gina Haeussge <osd@foosel.net> return: mixed media file param: string $id file id |
getAttachmentInfo($id) X-Ref |
Return info about a media file author: Gina Haeussge <osd@foosel.net> return: array param: string $id page id |
htmlPage($id, $rev = '') X-Ref |
Return a wiki page rendered to html return: null|string html param: string $id page id param: string|int $rev revision timestamp or empty string |
listPages() X-Ref |
List all pages - we use the indexer list here return: array |
readNamespace($ns, $opts = []) X-Ref |
List all pages in the given namespace (and below) return: array param: string $ns param: array $opts |
search($query) X-Ref |
List all pages in the given namespace (and below) return: array param: string $query |
getTitle() X-Ref |
Returns the wiki title. return: string |
listAttachments($ns, $options = []) X-Ref |
List all media files. Available options are 'recursive' for also including the subnamespaces in the listing, and 'pattern' for filtering the returned files against a regular expression matching their name. author: Gina Haeussge <osd@foosel.net> return: array param: string $ns param: array $options |
listBackLinks($id) X-Ref |
Return a list of backlinks return: array param: string $id page id |
pageInfo($id, $rev = '') X-Ref |
Return some basic data about a page return: array param: string $id page id param: string|int $rev revision timestamp or empty string |
putPage($id, $text, $params = []) X-Ref |
Save a wiki page author: Michael Klier <chi@chimeric.de> return: bool param: string $id page id param: string $text wiki text param: array $params parameters: summary, minor edit |
appendPage($id, $text, $params = []) X-Ref |
Appends text to a wiki page. return: bool|string param: string $id page id param: string $text wiki text param: array $params such as summary,minor |
createUser($userStruct) X-Ref |
Create one or more users return: boolean Create state param: array[] $userStruct User struct |
deleteUsers($usernames) X-Ref |
Remove one or more users from the list of registered users return: bool param: string[] $usernames List of usernames to remove |
putAttachment($id, $file, $params = []) X-Ref |
Uploads a file to the wiki. Michael Klier <chi@chimeric.de> return: false|string param: string $id page id param: string $file param: array $params such as overwrite |
deleteAttachment($id) X-Ref |
Deletes a file from the wiki. author: Gina Haeussge <osd@foosel.net> return: int param: string $id page id |
aclCheck($id, $user = null, $groups = null) X-Ref |
Returns the permissions of a given wiki page for the current user or another user return: int permission level param: string $id page id param: string|null $user username param: array|null $groups array of groups |
listLinks($id) X-Ref |
Lists all links contained in a wiki page author: Michael Klier <chi@chimeric.de> return: array param: string $id page id |
getRecentChanges($timestamp) X-Ref |
Returns a list of recent changes since give timestamp author: Michael Klier <chi@chimeric.de> author: Michael Hamann <michael@content-space.de> return: array param: int $timestamp unix timestamp |
getRecentMediaChanges($timestamp) X-Ref |
Returns a list of recent media changes since give timestamp author: Michael Klier <chi@chimeric.de> author: Michael Hamann <michael@content-space.de> return: array param: int $timestamp unix timestamp |
pageVersions($id, $first = 0) X-Ref |
Returns a list of available revisions of a given wiki page Number of returned pages is set by $conf['recent'] However not accessible pages are skipped, so less than $conf['recent'] could be returned author: Michael Klier <chi@chimeric.de> return: array param: string $id page id param: int $first skip the first n changelog lines |
wikiRpcVersion() X-Ref |
The version of Wiki RPC API supported |
setLocks($set) X-Ref |
Locks or unlocks a given batch of pages Give an associative array with two keys: lock and unlock. Both should contain a list of pages to lock or unlock Returns an associative array with the keys locked, lockfail, unlocked and unlockfail, each containing lists of pages. return: array param: array[] $set list pages with array('lock' => array, 'unlock' => array) |
getAPIVersion() X-Ref |
Return API version return: int |
login($user, $pass) X-Ref |
Login return: int param: string $user param: string $pass |
logoff() X-Ref |
Log off return: int |
resolvePageId($id) X-Ref |
Resolve page id return: string param: string $id page id |