[Vtigercrm-commits] [vtiger-commits] r7987 - /vtigercrm/trunk/modules/CustomView/ListViewTop.php

[vtigercrm-commits at vtiger.fosslabs.com]

Author: richie
Date: Thu Jul 13 09:50:42 2006
New Revision: 7987

Log:
docs added

Modified:
    vtigercrm/trunk/modules/CustomView/ListViewTop.php

Modified: vtigercrm/trunk/modules/CustomView/ListViewTop.php
==============================================================================
--- vtigercrm/trunk/modules/CustomView/ListViewTop.php (original)
+++ vtigercrm/trunk/modules/CustomView/ListViewTop.php Thu Jul 13 09:50:42 2006
@@ -20,6 +20,32 @@
  * Contributor(s): ______________________________________..
  ********************************************************************************/
 
+      /** to get the details of a KeyMetrics on Home page 
+        * @returns  $customviewlist Array in the following format
+	* $values = Array('Title'=>Array(0=>'image name',
+	*				 1=>'Key Metrics',
+	*			 	 2=>'home_metrics'
+	*			 	),
+	*		  'Header'=>Array(0=>'Metrics',
+	*	  			  1=>'Count'
+	*			  	),
+	*		  'Entries'=>Array($cvid=>Array(
+	*			  			0=>$customview name,
+	*						1=>$no of records for the view
+	*					       ),
+	*				   $cvid=>Array(
+        *                                               0=>$customview name,
+        *                                               1=>$no of records for the view
+        *                                              ),
+	*					|
+	*					|
+        *				   $cvid=>Array(
+        *                                               0=>$customview name,
+        *                                               1=>$no of records for the view
+        *                                              )	
+	*				  )
+	*
+       */
 function getKeyMetrics()
 {
 	require_once("data/Tracker.php");
@@ -89,6 +115,15 @@
 		return $values;
 
 }
+	
+	/** to get the details of a customview Entries
+	  * @returns  $metriclists Array in the following format
+	  * $customviewlist []= Array('id'=>custom view id,
+	  *                         'name'=>custom view name,
+	  *                         'module'=>modulename,
+	  			    'count'=>''
+			           )	
+	 */
 function getMetricList()
 {
 	global $adb;