Differences

This shows you the differences between two versions of the page.

--- plugin:attribute [2015-09-04 09:12] – created wilminator
+++ plugin:attribute [2018-08-06 08:24] – wilminator
@@ Line 1: / Line 1: @@
-====== attribute Plugin ======
+====== Attribute Plugin ======
 ---- plugin ----
-description: Arbitrary attribute definition and storage for user associated data.
+description: Arbitrary attribute definition and storage for user associated data
-author     : Mike Wilmes
+author     : Michael Wilmes
-email      : mwilmes@avc.edu, mwilmes@wilminator.com
+email      : mwilmes@wilminator.com
 type       : Helper
-lastupdate : 2015-09-04
+lastupdate : 2016-01-06
-compatible : 2015-08-10a "Detritus"
+compatible : 2018-04-22 "Greebo", 2015-08-10a "Detritus", 2017-02-19 "Frusterick Manners", 2016-06-26 "Elenor Of Tsort"
 depends    :
 conflicts  :
 similar    :
-tags       : data storage user persistent
+tags       : data, storage, users, persistent
-downloadurl: http://github.com/wilminator/dokuwiki-plugin-attribute/zipball/master
+downloadurl: https://github.com/wilminator/dokuwiki-plugin-attribute/zipball/master
-bugtracker : http://github.com/wilminator/dokuwiki-plugin-attribute/issues
+bugtracker : https://github.com/wilminator/dokuwiki-plugin-attribute/issues
-sourcerepo : http://github.com/wilminator/dokuwiki-plugin-attribute/
+sourcerepo : https://github.com/wilminator/dokuwiki-plugin-attribute/
 donationurl:
@@ Line 23: / Line 23: @@
 ===== Installation =====
-Install 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.
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
 After installing the plugin, it will work without additional configuration.  However the two existing options allow the wiki administrator to choose a location to store the user data and whether to disable compression.  The admin should only disable compression when developing a plugin that uses the attribute module because user data is then exposed in plaintext.  It is strongly advised to store user data in a location that is not served by the web server; this can only be achieved by web server configuration, eg .htaccess files and the like.
@@ Line 33: / Line 33: @@
 This module does not provide any admin panel to manage stored attribute data.  The developer using this plugin is responsible for all attribute manipulation.
-<code>
+<code php>
 class action_plugin_profilecount extends DokuWiki_Action_Plugin {
     function __construct() {
@@ Line 73: / Line 73: @@
 <code>public function enumerateAttributes($namespace, $user = null)</code>
-Generates a list of users that have assigned attributes in the specified namespace.
+Generates a list of attributes that have assigned values for the specified user in
-Returns false on failure or an array of of attribute names the user has.
+the specified namespace. Returns false on failure or an array of of attribute names
+the user has.
 <code>public function exists($namespace, $attribute, $user = null)</code>
@@ Line 100: / Line 101: @@
 ===== Configuration and Settings =====
-<code local.defaults.php>
+<code php local.defaults.php>
 $conf['store'] = 'data/attribute'; // Point to where the data will be stored. Absolute paths are ok.
 $conf['no_compress'] = 0; // Set to 1 to not compress data. ALL DATA WILL BE SAVED IN PLAINTEXT!!!
@@ Line 114: / Line 115: @@
 === ToDo/Wish List ===
+I need to create a unit test script. Yuck.
 Things I was considering:
-* allow for data to be exchanged/stored on an external system, eg database or LDAP
+  * Allow for data to be exchanged/stored on an external system, eg database or LDAP
-* potential integration with the memcache module to reduce the number of disk accesses used.
+  * Potential integration with the memcache module to reduce the number of disk accesses used.
-However, at this time there are no plans for any additional features.
+At this time there are no plans for any additional features.
 ===== Discussion =====
-Feel free to write anything constructive.  My hope is that this plugin will provide may developers with useful functionality.
+Feel free to write anything constructive.  My hope is that this plugin will provide many developers with useful functionality.