1====== usecounter Plugin ======
2
3---- plugin ----
4description: Provides a helper that can be used in other plugins to count the occurences of any object with an arbitrary identifier.
5author     : Thomas Schäfer
6email      : thomas@hilbershome.de
7type       : helper
8lastupdate : 2023-01-31
9compatible : 2020-07-29 "Hogfather",2022-07-31 "Igor"
10depends    :
11conflicts  :
12similar    :
13tags       : helper
14
15downloadurl: https://github.com/ternite/dokuwiki-plugin-usecounter/archive/v0.8.zip
16bugtracker : https://github.com/ternite/dokuwiki-plugin-usecounter/issues
17sourcerepo : https://github.com/ternite/dokuwiki-plugin-usecounter
18donationurl:
19
20screenshot_img :
21----
22
23===== Installation =====
24
25Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
26
27===== What's it for? =====
28
29This plugin provides a helper class that manages the amount of occurences of any given object.
30
31There are two simple mechanics that can be used.
32
33  - incUsageOf(string $id) - indicates to the helper that the object with the given identifier is used (once more). The helper internally counts the amount of uses for this identifier.
34  - amountOfUses(string $id) - returns an integer value of the amount of uses.
35
36The helper is implemented as a Singleton instance, so a particular identifier could be used accross multiple plugins. Keep this in mind when choosing an identifier.
37
38===== Syntax =====
39
40There is no wiki syntax involved.
41
42===== Configuration and Settings =====
43
44**No configuration settings available.**
45
46===== Development =====
47
48[[https://github.com/ternite/dokuwiki-plugin-usecounter|Sources]] on github.
49
50=== Change Log ===
51
52  * **2023-01-31**
53    * v0.8 (Initial release)
54
55=== Known Bugs and Issues ===
56
57See [[https://github.com/ternite/dokuwiki-plugin-usecounter/issues|issue tracker]] on github.
58
59===== FAQ =====
60
61None, yet.
62
63===== Discussion =====
64
65Start here.