[Vtigercrm-commits] [vtiger-commits] r8031 - in /vtigercrm/trunk/modules/Settings: ListModuleOwners.php PickList.php

[vtigercrm-commits at vtiger.fosslabs.com]

Author: richie
Date: Thu Jul 13 15:36:13 2006
New Revision: 8031

Log:
API docs added

Modified:
    vtigercrm/trunk/modules/Settings/ListModuleOwners.php
    vtigercrm/trunk/modules/Settings/PickList.php

Modified: vtigercrm/trunk/modules/Settings/ListModuleOwners.php
==============================================================================
--- vtigercrm/trunk/modules/Settings/ListModuleOwners.php (original)
+++ vtigercrm/trunk/modules/Settings/ListModuleOwners.php Thu Jul 13 15:36:13 2006
@@ -78,6 +78,11 @@
 else
 	$smarty->display("Settings/ModuleOwnersContents.tpl");
 	
+	/** Function to get the module owner for the tabid
+	 *  @ param $tabid
+	 *  It gets the module owner for the given tabid from vtiger_moduleowners table
+	 *  returns the userid of the module owner for the given tabid
+	 */
 function getModuleOwner($tabid)
 {
 	global $adb;
@@ -87,7 +92,9 @@
 
 	return $userid;
 }
-
+	/** Function to get the module List to which the owners can be assigned 
+	 *  It gets the module list and returns in an array 
+	 */
 function getModuleNameList()
 {
 	global $adb;
@@ -101,6 +108,12 @@
 	}
 	return $mod_array;
 }
+	/** Function to get combostrings of users 
+	 *  @ $user_array : type Array
+	 *  @ $modulename : Type String 
+	 *  returns the html string for module owners for the given module owners
+	 */
+
 function getUserCombo($user_array,$name)
 {
 	global $adb;

Modified: vtigercrm/trunk/modules/Settings/PickList.php
==============================================================================
--- vtigercrm/trunk/modules/Settings/PickList.php (original)
+++ vtigercrm/trunk/modules/Settings/PickList.php Thu Jul 13 15:36:13 2006
@@ -43,6 +43,12 @@
 else
 	$smarty->display("Settings/PickListContents.tpl");
 	
+	/** Function to get picklist fields for the given module 
+	 *  @ param $fld_module
+	 *  It gets the picklist details array for the given module in the given format
+	 *  			$fieldlist = Array(Array('fieldlabel'=>$fieldlabel,'generatedtype'=>$generatedtype,'columnname'=>$columnname,'fieldname'=>$fieldname,'value'=>picklistvalues))	
+	 */
+
 function getUserFldArray($fld_module)
 {
 	global $adb;
@@ -100,6 +106,12 @@
     return $fieldlist;
 }
 
+	/** Function to get picklist values for the given field  
+	 *  @ param $tablename
+	 *  It gets the picklist values for the given fieldname
+	 *  			$fldVal = Array(0=>value,1=>value1,-------------,n=>valuen)	
+	 */
+
 function getPickListValues($tablename)
 {
 	global $adb;	
@@ -112,6 +124,10 @@
 	}
 	return $fldVal;
 }
+	/** Function to get modules which has picklist values  
+	 *  It gets the picklist modules and return in an array in the following format 
+	 *  			$modules = Array($tabid=>$tablabel,$tabid1=>$tablabel1,$tabid2=>$tablabel2,-------------,$tabidn=>$tablabeln)	
+	 */
 function getPickListModules()
 {
 	global $adb;