[Fmsystem-commits] [8941]

[Torstein]

Revision: 8941
          http://svn.sv.gnu.org/viewvc/?view=rev&root=fmsystem&revision=8941
Author:   vator
Date:     2012-02-21 11:16:14 +0000 (Tue, 21 Feb 2012)
Log Message:
-----------


Modified Paths:
--------------
    trunk/controller/inc/class.uicalendar.inc.php
    trunk/controller/inc/class.uicheck_list.inc.php
    trunk/controller/inc/class.uicontrol.inc.php

Modified: trunk/controller/inc/class.uicalendar.inc.php
===================================================================
--- trunk/controller/inc/class.uicalendar.inc.php       2012-02-21 11:15:54 UTC 
(rev 8940)
+++ trunk/controller/inc/class.uicalendar.inc.php       2012-02-21 11:16:14 UTC 
(rev 8941)
@@ -225,9 +225,6 @@
        
                        $controls_calendar_array = 
$this->calendar_builder->build_calendar_array( $controls_for_location_array, 
12, "view_months" );
                        
-                       
-                       print_r($controls_calendar_array);
-                       
                        $location_array = 
execMethod('property.bolocation.read_single', array('location_code' => 
$location_code));
                        
                        $heading_array = array("Jan", "Feb", "Mar", "Apr", 
"Mai", "Jun", "Jul", "Aug", "Sep", "Okt", "Nov", "Des");

Modified: trunk/controller/inc/class.uicheck_list.inc.php
===================================================================
--- trunk/controller/inc/class.uicheck_list.inc.php     2012-02-21 11:15:54 UTC 
(rev 8940)
+++ trunk/controller/inc/class.uicheck_list.inc.php     2012-02-21 11:16:14 UTC 
(rev 8941)
@@ -91,6 +91,12 @@
                        
self::set_active_menu('controller::control::check_list');
                }       
                
+               /**
+                * Public function for displaying checklists  
+                * 
+                * @param HTTP:: phpgw_return_as
+                * @return data array
+               */
                public function index()
                {
                        if(phpgw::get_var('phpgw_return_as') == 'json') {
@@ -182,6 +188,12 @@
                        self::render_template_xsl('datatable', $data);
                }
                
+               /**
+                * Public function for displaying the add check list form  
+                * 
+                * @param HTTP:: location code, control id, date
+                * @return data array
+               */
                function add_check_list(){
                        $location_code = phpgw::get_var('location_code');
                        $control_id = phpgw::get_var('control_id');
@@ -233,6 +245,12 @@
                        
self::render_template_xsl(array('check_list/check_list_tab_menu','check_list/add_check_list'),
 $data);
                }
                
+               /**
+                * Public function for displaying the edit check list form  
+                * 
+                * @param HTTP:: check list id
+                * @return data array
+               */
                function edit_check_list(){
                        $check_list_id = phpgw::get_var('check_list_id');
 
@@ -266,6 +284,12 @@
                        
self::render_template_xsl(array('check_list/check_list_tab_menu','check_list/edit_check_list'),
 $data);
                }
                
+               /**
+                * Public function for displaying the edit check list form
+                * 
+                * @param HTTP:: check list id
+                * @return data array
+               */
                function view_cases_for_check_list(){
                        $check_list_id = phpgw::get_var('check_list_id');
                        
@@ -295,6 +319,12 @@
                        
self::render_template_xsl(array('check_list/check_list_tab_menu', 
'check_list/view_cases_for_check_list'), $data);
                }
                
+               /**
+                * Public function for saving a check list
+                * 
+                * @param HTTP:: location code, control id, status etc.. (check 
list details) 
+                * @return data array
+               */
                function save_check_list(){
                        $location_code = phpgw::get_var('location_code');
                        $control_id = phpgw::get_var('control_id');
@@ -329,6 +359,12 @@
                        $this->redirect(array('menuaction' => 
'controller.uicheck_list.edit_check_list', 'check_list_id'=>$check_list_id));
                }
                
+               /**
+                * Public function for displaying the create message form
+                * 
+                * @param HTTP:: check list id 
+                * @return data array
+               */
                function create_case_message(){
                        $check_list_id = phpgw::get_var('check_list_id');
                                                
@@ -361,6 +397,12 @@
                        self::render_template_xsl('create_case_messsage', 
$data);
                }
                
+               /**
+                * Public function for displaying the create message form
+                * 
+                * @param HTTP:: check list id 
+                * @return data array
+               */
                public function view_control_info(){
                        $check_list_id = phpgw::get_var('check_list_id');
                        

Modified: trunk/controller/inc/class.uicontrol.inc.php
===================================================================
--- trunk/controller/inc/class.uicontrol.inc.php        2012-02-21 11:15:54 UTC 
(rev 8940)
+++ trunk/controller/inc/class.uicontrol.inc.php        2012-02-21 11:16:14 UTC 
(rev 8941)
@@ -96,6 +96,12 @@
                        self::set_active_menu('controller::control');
                }
                
+               /**
+                * Fetches controls and returns to datatable 
+                *
+                * @param HTTP::phpgw_return_as specifies how data should be 
returned
+                * @return data array
+                */
                public function control_list()
                {
                        if(phpgw::get_var('phpgw_return_as') == 'json') {
@@ -266,6 +272,12 @@
                        self::render_template_xsl('datatable', $data);
                }
                
+               /**
+                * Fetches control details from db and returns to view 
+                *
+                * @param HTTP:: control id
+                * @return data array 
+                */
                public function view_control_details()
                {
                        $control_id = phpgw::get_var('id');
@@ -330,6 +342,12 @@
                        $this->use_yui_editor(array('description'));
                }
                
+               /**
+                * Public function for saving control details 
+                *
+                * @param HTTP:: control id, control details fields
+                * @return redirect to function view_control_groups
+                */
                public function save_control_details(){
                        $control_id = phpgw::get_var('control_id');
                        
@@ -367,7 +385,13 @@
                        }
                }
                                                
-               // Displays control groups based on previously chosen control 
area
+               /**
+                * Public function for viewing control groups 
+                * Displays control groups by chosen control area  
+                *
+                * @param HTTP:: control id 
+                * @return data array 
+                */
                public function view_control_groups(){
                        $control_id = phpgw::get_var('control_id');
                        $control = $this->so->get_single($control_id);  
@@ -416,12 +440,10 @@
                }
                
                /**
-                * Public function for saving control groups. Saves 
-                * the database and the virtual file system (vfs).
+                * Public function for saving control groups. 
                 * 
-                * @param HTTP::id      the document id
-                * @return true if successful, false if error, permission 
denied message on
-                *                      not enough privileges
+                * @param HTTP::id      the control_id, and a comma seperated 
list of group ids
+                * @return redirect to function view_control_items
                 */
                public function save_control_groups(){
                        $control_id = phpgw::get_var('control_id');
@@ -442,14 +464,6 @@
                                }
                        }
                        
-                       /*
-                       // Deleting earlier saved control groups
-                       
$this->so_control_group_list->delete_control_groups($control_id);
-                       
-                       // Deleting earlier saved control items
-                       
$this->so_control_item_list->delete_control_items($control_id);
-                       */
-                       
                        $group_order_nr = 1;
 
                        // Saving control groups 
@@ -473,7 +487,12 @@
                        $this->redirect(array('menuaction' => 
'controller.uicontrol.view_control_items', 'control_id'=>$control_id));   
                }
                
-               // Gets a comma separated list of control groups, and displays 
control items for these groups
+               /**
+                * Public function for viewing control items 
+                * 
+                * @param HTTP::id      the control_id
+                * @return redirect to function view_control_items
+                */
                public function view_control_items(){
                        $control_id = phpgw::get_var('control_id', 'int');
                        $control = $this->so->get_single($control_id);
@@ -531,7 +550,12 @@
                        self::render_template_xsl(array('control/control_tabs', 
'control_item/choose_control_items'), $data); 
                }
                
-               // Saves chosen control items through receiving a comma 
separated list of control tags (1:2, control_group_id:control_item_id) 
+               /**
+                * Public function for saving control items 
+                * 
+                * @param HTTP::id      the control_id and a comma separated 
list of tags (1:2, control_group_id:control_item_id)
+                * @return redirect to function view_control_items
+                */ 
                public function save_control_items(){
                        $control_id = phpgw::get_var('control_id');
                        
@@ -560,7 +584,13 @@
        
                        $this->redirect(array('menuaction' => 
'controller.uicontrol.view_check_list', 'control_id'=>$control_id ));     
                }
-               
+
+               /**
+                * Public function for viewing chosen control items
+                * 
+                * @param HTTP::id the control_id
+                * @return data array 
+               */ 
                public function view_check_list(){
                        $control_id = phpgw::get_var('control_id');
                        $control = $this->so->get_single($control_id);
@@ -655,8 +685,13 @@
                        
                        return $tabs;
                } 
-               
-               // Returns control list info as JSON
+
+               /**
+                * Public function for retrieving controls that has a certain 
control area  
+                * 
+                * @param HTTP:: control area id
+                * @return array of controls as json 
+               */ 
                public function get_controls_by_control_area()
                {
                        $control_area_id = phpgw::get_var('control_area_id');
@@ -669,7 +704,12 @@
                                return null;
                }
                
-               // Returns locations for a control
+               /**
+                * Public function for retrieving locations that is assigned to 
a control  
+                * 
+                * @param HTTP:: control id
+                * @return array of locations as json 
+               */
                public function get_locations_for_control()
                {
                        $control_id = phpgw::get_var('control_id');
@@ -697,6 +737,13 @@
                        return $this->yui_results($results);
                }
                
+               /**
+                * Add data for context menu
+                *
+                * @param $value pointer to
+                * @param $key ?
+                * @param $params [type of query, editable]
+                */
                public function add_actions(&$value, $key, $params)
                {
                        unset($value['query_location']);