Differences

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

Link to this comparison view

security_developers_guide [2013/09/12 22:49] (current)
Line 1: Line 1:
 +==== Expert use the Security System in your modules ==== 
 +The cache_mgr($action,​ $cache, $info, $more) function is used to add and remove information from the security cache. The advanced functions above all use the cache_mgr function to update information. If you are modifying the security database or roster directly in your module (something that in general should not be done) you must use the cache_mgr function to update the security cache as appropriate or your database modifications will not take effect until the bot is restarted. ​
  
 +Description of function parameters:
 +$action: add or rem
 +$cache: Which cache to modify (groups, guests, members, banned, groupmem, orgranks)
 +$info: The information to add (or remove)
 +$more: Extra information needed for some actions. (Optional Parameter)
 +
 +  * Add and remove a guest:
 +<code php>
 +$this -> cache_mgr("​add",​ "​guests",​ "​Glarawyn"​);​
 +$this -> cache_mgr("​rem",​ "​guests",​ "​Glarawyn"​);​
 +</​code>​
 +  * Add and remove a member:
 +<code php>
 +$this -> cache_mgr("​add",​ "​members",​ "​Glarawyn"​);​
 +$this -> cache_mgr("​rem",​ "​members",​ "​Glarawyn"​);​
 +</​code>​
 +  * Add and remove a ban:
 +<code php>
 +$this -> cache_mgr("​add",​ "​banned",​ "​Glarawyn"​);​
 +$this -> cache_mgr("​rem",​ "​banned",​ "​Glarawyn"​);​
 +</​code>​
 +  * Add a group: ​
 +<code php>
 +$tmp = array("​gid"​ => "​10",​ "​name"​ => "​groupname",​ "​description"​ = "​Example Group",​ "​access_level"​ => 2);
 +$this -> cache_mgr("​add",​ "​groups",​ $tmp);
 +</​code>​
 +  * Remove a group: ​
 +<code php>
 +$this -> cache_mgr("​rem",​ "​groups",​ $groupname);​
 +</​code>​
 +  * Add and remove a group member:
 +<code php>
 +$this -> cache_mgr("​add",​ "​groupmem",​ $groupname, $membername);​
 +$this -> cache_mgr("​rem",​ "​groupmem",​ $groupname, $membername);​
 +</​code>​
 +  * Change an org rank's access level:
 +<code php>
 +$this -> cache_mgr("​add",​ "​orgrank",​ "​President",​ "​255"​);​
 +</​code>​
 
security_developers_guide.txt ยท Last modified: 2013/09/12 22:49 (external edit)
[unknown button type]
 
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 3.0 Unported
WikiForumIRCBugs
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki