[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/lib/plugins/popularity/ -> helper.php (summary)

(no description)

File Size: 292 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

helper_plugin_popularity:: (8 methods):
  __construct()
  isAutoSubmitEnabled()
  sendData()
  lastSentTime()
  gatherAsString()
  gather()
  addPluginUsageData()
  searchCountCallback()


Class: helper_plugin_popularity  - X-Ref

Popularity Feedback Plugin

__construct()   X-Ref
helper_plugin_popularity constructor.


isAutoSubmitEnabled()   X-Ref
Check if autosubmit is enabled

return: boolean TRUE if we should send data once a month, FALSE otherwise

sendData($data)   X-Ref
Send the data, to the submit url

param: string $data The popularity data
return: string An empty string if everything worked fine, a string describing the error otherwise

lastSentTime()   X-Ref
Compute the last time the data was sent. If it has never been sent, we return 0.

return: int

gatherAsString()   X-Ref
Gather all information

return: string The popularity data as a string

gather()   X-Ref
Gather all information

return: array The popularity data as an array

addPluginUsageData(&$data)   X-Ref
Triggers event to let plugins add their own data

param: $data

searchCountCallback(&$data, $base, $file, $type, $lvl, $opts)   X-Ref
Callback to search and count the content of directories in DokuWiki

param: array &$data  Reference to the result data structure
param: string $base  Base usually $conf['datadir']
param: string $file  current file or directory relative to $base
param: string $type  Type either 'd' for directory or 'f' for file
param: int    $lvl   Current recursion depht
param: array  $opts  option array as given to search()
return: bool