[Fmsystem-commits] [9768]

[Torstein]

Revision: 9768
          http://svn.sv.gnu.org/viewvc/?view=rev&root=fmsystem&revision=9768
Author:   vator
Date:     2012-07-11 12:46:18 +0000 (Wed, 11 Jul 2012)
Log Message:
-----------


Modified Paths:
--------------
    trunk/controller/inc/class.socontrol_item_list.inc.php

Modified: trunk/controller/inc/class.socontrol_item_list.inc.php
===================================================================
--- trunk/controller/inc/class.socontrol_item_list.inc.php      2012-07-11 
12:44:53 UTC (rev 9767)
+++ trunk/controller/inc/class.socontrol_item_list.inc.php      2012-07-11 
12:46:18 UTC (rev 9768)
@@ -40,7 +40,7 @@
                /**
                 * Get a static reference to the storage object associated with 
this model object
                 *
-                * @return controller_soparty the storage object
+                * @return controller_socontrol_item_list the storage object
                 */
                public static function get_instance()
                {
@@ -51,10 +51,10 @@
                }
 
                /**
-                * Function for adding a new activity to the database. Updates 
the activity object.
+                * Inserts a new control item list to database
                 *
-                * @param activitycalendar_activity $activity the party to be 
added
-                * @return bool true if successful, false otherwise
+                * @param $control_item_list control item list object to be 
inserted
+                * @return id of inserted control item list if successful, 0 if 
not successful
                 */
                function add(&$control_item_list)
                {
@@ -80,6 +80,12 @@
                        }
                }
 
+               /**
+                * Updates an existing control item list in database
+                *
+                * @param $control_item_list control item list object to be 
updated
+                * @return id of inserted control item list if successful, 0 if 
not successful
+                */
                function update($control_item_list)
                {
                        $id = intval($control_item_list->get_id());
@@ -96,10 +102,10 @@
                }
 
                /**
-                * Get single control_item_list
+                * Get single control_item_list object
                 * 
                 * @param       $id     id of the control_item_list to return
-                * @return a controller_control_item_list
+                * @return  control item list object
                 */
                function get_single($id)
                {
@@ -117,6 +123,13 @@
                        return $control_item_list;
                }
 
+               /**
+                * Get single control_item_list object
+                * 
+                * @param       $control_id     control id
+                * @param       $control_item_id        control id
+                * @return  control item list object
+                */
                function get_single_2($control_id, $control_item_id)
                {
                        $sql = "SELECT cil.* FROM controller_control_item_list 
cil WHERE cil.control_id = " . $control_id . " AND cil.control_item_id = " . 
$control_item_id;
@@ -131,6 +144,13 @@
                        return $control_item_list;
                }
                
+               /**
+                * Get control item objects from database as objects or as 
arrays 
+                * 
+                * @param       $control_group_id       control group id
+                * @param $return_type return data as objects or as arrays
+                * @return  array with control items
+               */
                function get_control_items($control_group_id, $return_type = 
"return_object")
                {
                        $results = array();
@@ -158,6 +178,13 @@
                        return $results;
                }
 
+               /**
+                * Get control item objects from database as objects or as 
arrays 
+                * 
+                * @param       $control_id     control id
+                * @param $return_type return data as objects or as arrays
+                * @return  array with control items
+               */
                function get_control_items_by_control($control_id, $returnType 
= "return_object")
                {
                        $results = array();
@@ -187,6 +214,14 @@
                        return $results;
                }
 
+               /**
+                * Get control item objects from database as objects or as 
arrays 
+                * 
+                * @param       $control_id     control id
+                * @param       $control_group_id       control group id
+                * @param $return_type return data as objects or as arrays
+                * @return  array with control items
+               */
                function get_control_items_by_control_and_group($control_id, 
$control_group_id, $returnType = "return_array")
                {
                        $results = array();
@@ -219,6 +254,14 @@
                        return $results;
                }
 
+               /**
+                * Get control item objects with control item options from 
database as objects or as arrays 
+                * 
+                * @param       $control_id     control id
+                * @param       $control_group_id       control group id
+                * @param $return_type return data as objects or as arrays
+                * @return array with control items
+               */
                function 
get_control_items_and_options_by_control_and_group($control_id, 
$control_group_id, $return_type = "return_array")
                {
                        $results = array();
@@ -286,7 +329,13 @@
                        }
                }
                
-               // Deletes control list item defines by control id and control 
item id
+               /**
+                * Delete a control item list from database 
+                * 
+                * @param       $control_id     control id
+                * @param       $control_group_id       control group id
+                * @return true if successful, false otherwise
+               */
                function delete($control_id, $control_item_id)
                {
                        $result = $this->db->query("DELETE FROM 
controller_control_item_list WHERE control_id = $control_id AND control_item_id 
= $control_item_id", __LINE__,__FILE__);
@@ -294,7 +343,12 @@
                        return isset($result);
                }
                
-               // Deletes all control items that a control has
+               /**
+                * Deletes all control items related to a control 
+                * 
+                * @param       $control_id     control id
+                * @return true if successful, false otherwise
+               */
                function delete_control_items($control_id)
                {
                        $result = $this->db->query("DELETE FROM 
controller_control_item_list WHERE control_id = $control_id");
@@ -302,7 +356,13 @@
                        return isset($result);
                }
 
-               // Deletes all control items that a control has
+               /**
+                * Deletes all control items within a group related to a 
control 
+                * 
+                * @param       $control_id     control id
+                * @param       $control_group_id       control group id
+                * @return true if successful, false otherwise
+               */
                function delete_control_items_for_group_list($control_id, 
$control_group_id)
                {
                        $sql  = "DELETE FROM controller_control_item_list ";