]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/extra/m_sqlutils.h
Add extra parameter to OnUserPreNotice and OnUserPrePrivmsg, CUList &exempt_list...
[user/henk/code/inspircd.git] / src / modules / extra / m_sqlutils.h
index bf13e4635e3b33a740acd79fc70c47260189763b..255e92122cded830b3722b45b5c4cd405004cabc 100644 (file)
 #define SQLUTILGC "SQLutil GetAssocChan"
 #define SQLUTILSUCCESS "You shouldn't be reading this (success)"
 
+/** Used to associate an SQL query with a user
+ */
 class AssociateUser : public Request
 {
 public:
+       /** Query ID
+        */
        unsigned long id;
+       /** User
+        */
        userrec* user;
        
-       AssociateUser(Module* s, Module* d, userrec* u, unsigned long i)
-       : Request(SQLUTILAU, s, d), id(i), user(u)
+       AssociateUser(Module* s, Module* d, unsigned long i, userrec* u)
+       : Request(s, d, SQLUTILAU), id(i), user(u)
        {
        }
        
@@ -28,14 +34,20 @@ public:
        }
 };
 
+/** Used to associate an SQL query with a channel
+ */
 class AssociateChan : public Request
 {
 public:
+       /** Query ID
+        */
        unsigned long id;
+       /** Channel
+        */
        chanrec* chan;
        
-       AssociateChan(Module* s, Module* d, chanrec* u, unsigned long i)
-       : Request(SQLUTILAC, s, d), id(i), chan(u)
+       AssociateChan(Module* s, Module* d, unsigned long i, chanrec* u)
+       : Request(s, d, SQLUTILAC), id(i), chan(u)
        {
        }
        
@@ -46,13 +58,17 @@ public:
        }
 };
 
+/** Unassociate a user or  class from an SQL query
+ */
 class UnAssociate : public Request
 {
 public:
+       /** The query ID
+        */
        unsigned long id;
 
        UnAssociate(Module* s, Module* d, unsigned long i)
-       : Request(SQLUTILUA, s, d), id(i)
+       : Request(s, d, SQLUTILUA), id(i)
        {
        }
        
@@ -63,14 +79,20 @@ public:
        }
 };
 
+/** Get the user associated with an SQL query ID
+ */
 class GetAssocUser : public Request
 {
 public:
+       /** The query id
+        */
        unsigned long id;
+       /** The user
+        */
        userrec* user;
 
        GetAssocUser(Module* s, Module* d, unsigned long i)
-       : Request(SQLUTILGU, s, d), id(i), user(NULL)
+       : Request(s, d, SQLUTILGU), id(i), user(NULL)
        {
        }
        
@@ -81,14 +103,20 @@ public:
        }
 };
 
+/** Get the channel associated with an SQL query ID
+ */
 class GetAssocChan : public Request
 {
 public:
+       /** The query id
+        */
        unsigned long id;
+       /** The channel
+        */
        chanrec* chan;
 
        GetAssocChan(Module* s, Module* d, unsigned long i)
-       : Request(SQLUTILGC, s, d), id(i), chan(NULL)
+       : Request(s, d, SQLUTILGC), id(i), chan(NULL)
        {
        }