gforge-commits
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Gforge-commits] gforge/common/include Group.class, 1.63, 1.64 User.clas


From: gsmet
Subject: [Gforge-commits] gforge/common/include Group.class, 1.63, 1.64 User.class, 1.35, 1.36
Date: Tue, 21 Sep 2004 10:53:15 -0500

Update of /cvsroot/gforge/gforge/common/include
In directory db.perdue.net:/tmp/cvs-serv11496/common/include

Modified Files:
        Group.class User.class 
Log Message:
applied [#677] add documentation comments for the plugin functions in 
User.class and Group.class by Lars Ehrhardt


Index: Group.class
===================================================================
RCS file: /cvsroot/gforge/gforge/common/include/Group.class,v
retrieving revision 1.63
retrieving revision 1.64
diff -u -d -r1.63 -r1.64
--- Group.class 20 Sep 2004 11:05:54 -0000      1.63
+++ Group.class 21 Sep 2004 15:53:13 -0000      1.64
@@ -1122,6 +1122,11 @@
                }
        }
 
+       /**
+        *  getPlugins -  get a list of all available group plugins
+        *
+        *  @return     array   array containing plugin_id => plugin_name
+        */
        function getPlugins() {
                if (!isset($this->plugins_data)) {
                        $this->plugins_data = array () ;
@@ -1140,6 +1145,12 @@
                return $this->plugins_data ;
        }
 
+       /**
+        *  usesPlugin - returns true if the group uses a particular plugin 
+        *
+        *  @param      string  name of the plugin
+        *  @return     boolean whether plugin is being used or not
+        */
        function usesPlugin($pluginname) {
                $plugins_data = $this->getPlugins() ;
                foreach ($plugins_data as $p_id => $p_name) {
@@ -1150,6 +1161,13 @@
                return false ;
        }
 
+       /**
+        *  setPluginUse - enables/disables plugins for the group
+        *
+        *  @param      string  name of the plugin
+        *  @param      boolean the new state
+        *  @return     string  database result 
+        */
        function setPluginUse($pluginname, $val=true) {
                if ($val == $this->usesPlugin($pluginname)) {
                        // State is already good, returning

Index: User.class
===================================================================
RCS file: /cvsroot/gforge/gforge/common/include/User.class,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -d -r1.35 -r1.36
--- User.class  14 Sep 2004 19:58:11 -0000      1.35
+++ User.class  21 Sep 2004 15:53:13 -0000      1.36
@@ -1167,6 +1167,11 @@
                return !$this->data_array['block_ratings'];
        }
 
+       /**
+        *  getPlugins -  get a list of all available user plugins
+        *
+        *  @return array array containing plugin_id => plugin_name
+        */
        function getPlugins() {
                if (!isset($this->plugins_data)) {
                        $this->plugins_data = array () ;
@@ -1185,6 +1190,12 @@
                return $this->plugins_data ;
        }
 
+       /**
+        *  usesPlugin - returns true if the user uses a particular plugin 
+        *
+        *  @param      string  name of the plugin
+        *  @return     boolean whether plugin is being used or not
+        */
        function usesPlugin($pluginname) {
                $plugins_data = $this->getPlugins() ;
                foreach ($plugins_data as $p_name) {
@@ -1195,6 +1206,13 @@
                return false ;
        }
 
+       /**
+        *  setPluginUse - enables/disables plugins for the user
+        *
+        *  @param      string  name of the plugin
+        *  @param      boolean the new state
+        *  @return     string  database result
+        */
        function setPluginUse($pluginname, $val=true) {
                if ($val == $this->usesPlugin($pluginname)) {
                        // State is already good, returning





reply via email to

[Prev in Thread] Current Thread [Next in Thread]