Pepperminty Wiki Module API

stats

Table of Contents

update_statistics()  : mixed
Updates the wiki's statistics.
stats_load()  : object
Loads and returns the statistics cache file.
stats_save()  : bool
Saves the statistics back to disk.

Functions

update_statistics()

Updates the wiki's statistics.

update_statistics([bool $update_all = false ][, bool $force = false ]) : mixed
Parameters
$update_all : bool = false

Whether all the statistics should be checked and recalculated, or just as many as we have time for according to the settings.

$force : bool = false

Whether we should recalculate statistics that don't currently require recalculating anyway.

Return values
mixed

stats_load()

Loads and returns the statistics cache file.

stats_load() : object
Return values
object

The loaded & decoded statistics.

stats_save()

Saves the statistics back to disk.

stats_save(mixed $stats) : bool
Parameters
$stats : mixed
Return values
bool

Whether saving succeeded or not.

Search results