[Vtigercrm-commits] [vtiger-commits] r7988 - in /vtigercrm/trunk/include: ComboUtil.php FormValidationUtil.php PopulateComboValues.php RelatedListView.php upload_file.php

[vtigercrm-commits at vtiger.fosslabs.com]

Author: saraj
Date: Thu Jul 13 09:58:27 2006
New Revision: 7988

Log:
api add for function

Modified:
    vtigercrm/trunk/include/ComboUtil.php
    vtigercrm/trunk/include/FormValidationUtil.php
    vtigercrm/trunk/include/PopulateComboValues.php
    vtigercrm/trunk/include/RelatedListView.php
    vtigercrm/trunk/include/upload_file.php

Modified: vtigercrm/trunk/include/ComboUtil.php
==============================================================================
--- vtigercrm/trunk/include/ComboUtil.php (original)
+++ vtigercrm/trunk/include/ComboUtil.php Thu Jul 13 09:58:27 2006
@@ -10,6 +10,10 @@
  ********************************************************************************/
 
 require_once('include/database/PearDatabase.php');
+/** Function to  returns the combo field values in array format
+  * @param $combofieldNames -- combofieldNames:: Type string array
+  * @returns $comboFieldArray -- comboFieldArray:: Type string array
+ */
 function getComboArray($combofieldNames)
 {
 	global $log;

Modified: vtigercrm/trunk/include/FormValidationUtil.php
==============================================================================
--- vtigercrm/trunk/include/FormValidationUtil.php (original)
+++ vtigercrm/trunk/include/FormValidationUtil.php Thu Jul 13 09:58:27 2006
@@ -13,6 +13,13 @@
  * File containing methods to proceed with the ui validation for all the forms
  *
  */
+/** Function to get the details for fieldlabels for a given table array
+  * @param $tablearray -- tablearray:: Type string array (table names in array)
+  * @param $tabid -- tabid:: Type integer 
+  * @returns $fieldName_array -- fieldName_array:: Type string array (field name details)
+  *
+ */
+
 
 function getDBValidationData($tablearray,$tabid='')
 {

Modified: vtigercrm/trunk/include/PopulateComboValues.php
==============================================================================
--- vtigercrm/trunk/include/PopulateComboValues.php (original)
+++ vtigercrm/trunk/include/PopulateComboValues.php Thu Jul 13 09:58:27 2006
@@ -25,6 +25,8 @@
 
 	/** 
 	 * To populate the default combo values for the combo vtiger_tables
+	 * @param $values -- values:: Type string array
+	 * @param $tableName -- tablename:: Type string 
 	 */
 	function insertComboValues($values, $tableName)
 	{

Modified: vtigercrm/trunk/include/RelatedListView.php
==============================================================================
--- vtigercrm/trunk/include/RelatedListView.php (original)
+++ vtigercrm/trunk/include/RelatedListView.php Thu Jul 13 09:58:27 2006
@@ -14,6 +14,20 @@
 require_once("include/utils/utils.php");
 require_once("include/ListView/ListViewSession.php");
 
+/** Function to get related list entries in detailed array format
+  * @param $module -- modulename:: Type string
+  * @param $relatedmodule -- relatedmodule:: Type string
+  * @param $focus -- focus:: Type object
+  * @param $query -- query:: Type string
+  * @param $button -- buttons:: Type string
+  * @param $returnset -- returnset:: Type string
+  * @param $id -- id:: Type string
+  * @param $edit_val -- edit value:: Type string
+  * @param $del_val -- delete value:: Type string
+  * @returns $related_entries -- related entires:: Type string array
+  *
+  */
+
 function GetRelatedList($module,$relatedmodule,$focus,$query,$button,$returnset,$id='',$edit_val='',$del_val='')
 {
 	$log = LoggerManager::getLogger('account_list');
@@ -204,6 +218,14 @@
 	}
 }
 
+/** Function to get related list entries in detailed array format
+  * @param $parentmodule -- parentmodulename:: Type string
+  * @param $query -- query:: Type string
+  * @param $id -- id:: Type string
+  * @returns $entries_list -- entries list:: Type string array
+  *
+  */
+
 function getAttachmentsAndNotes($parentmodule,$query,$id,$sid='')
 {
 	global $log;
@@ -304,6 +326,14 @@
 	return $return_data;
 
 }
+
+/** Function to get related list entries in detailed array format
+  * @param $parentmodule -- parentmodulename:: Type string
+  * @param $query -- query:: Type string
+  * @param $id -- id:: Type string
+  * @returns $return_data -- return data:: Type string array
+  *
+  */
 
 function getHistory($parentmodule,$query,$id)
 {

Modified: vtigercrm/trunk/include/upload_file.php
==============================================================================
--- vtigercrm/trunk/include/upload_file.php (original)
+++ vtigercrm/trunk/include/upload_file.php Thu Jul 13 09:58:27 2006
@@ -33,7 +33,13 @@
 		$this->field_name = $field_name;
 		$log->debug("Exiting UploadFile method ...");
         }
-
+	
+	/** Function to get the url of the attachment
+	  * @param $stored_file_name -- stored_file_name:: Type string
+	  * @param $bean_id -- bean_id:: Type integer
+	  * @returns urlstring -- urlstring:: Type string
+	  *
+	  */
 	function get_url($stored_file_name,$bean_id)
 	{
 		global $log;
@@ -47,6 +53,13 @@
                 //return $site_URL.'/'.$upload_dir.$bean_id.$stored_file_name;
 	}
 
+	/** Function to duplicate and copy a file to another location
+	  * @param $old_id -- old_id:: Type integer
+	  * @param $new_id -- new_id:: Type integer
+	  * @param $file_name -- filename:: Type string
+	  *
+	  */
+
 	function duplicate_file($old_id, $new_id, $file_name)
 	{
 		global $log;
@@ -59,6 +72,10 @@
 		$log->debug("Exiting duplicate_file method ...");
 	}
 	
+	/** Function to get the status of the file upload
+	  * @returns boolean
+	  */
+
 	function confirm_upload()
 	{
 		global $log;
@@ -90,6 +107,9 @@
 		return true;
 	}
 
+	/** Function to get the stored file name
+	  */
+
 	function get_stored_file_name()
 	{
 		global $log;
@@ -97,6 +117,9 @@
 		$log->debug("Exiting get_stored_file_name method ...");
 		return $this->stored_file_name;
 	}
+
+	/** Function to generate a filename for storing
+	  */
 
 	function create_stored_filename()
 	{
@@ -116,6 +139,12 @@
 		$log->debug("Exiting create_stored_filename method ...");
 		return $stored_file_name;
 	}
+
+	/** Function is to move a file and store it in given location
+	  * @param $bean_id -- $bean_id:: Type integer
+	  * @returns boolean
+	  *
+	  */
 
 	function final_move($bean_id)
 	{
@@ -138,6 +167,13 @@
 
 	}
 
+	/** Function deletes a file for a given file name
+	  * @param $bean_id -- bean_id:: Type integer
+	  * @param $file_name -- file name:: Type string
+	  * @returns boolean
+	  *
+	  */
+
 	function unlink_file($bean_id,$file_name)
         {
 		global $log;