[Vtigercrm-commits] [vtiger-commits] r8008 - in /vtigercrm/trunk/modules/Reports: Delete.php ReportGrouping.php ReportRun.php SaveAndRun.php StandardFilter.php
vtigercrm-commits at vtiger.fosslabs.com
vtigercrm-commits at vtiger.fosslabs.com
Thu Jul 13 15:25:53 EDT 2006
Author: richie
Date: Thu Jul 13 13:25:47 2006
New Revision: 8008
Log:
docs added
Modified:
vtigercrm/trunk/modules/Reports/Delete.php
vtigercrm/trunk/modules/Reports/ReportGrouping.php
vtigercrm/trunk/modules/Reports/ReportRun.php
vtigercrm/trunk/modules/Reports/SaveAndRun.php
vtigercrm/trunk/modules/Reports/StandardFilter.php
Modified: vtigercrm/trunk/modules/Reports/Delete.php
==============================================================================
--- vtigercrm/trunk/modules/Reports/Delete.php (original)
+++ vtigercrm/trunk/modules/Reports/Delete.php Thu Jul 13 13:25:47 2006
@@ -28,6 +28,11 @@
header("Location: index.php?action=ReportsAjax&file=ListView&mode=ajaxdelete&module=Reports");
}
+/** To Delete a Report
+ * @param $reportid -- The report id
+ * @returns nothing
+ */
+
function DeleteReport($reportid)
{
global $adb;
Modified: vtigercrm/trunk/modules/Reports/ReportGrouping.php
==============================================================================
--- vtigercrm/trunk/modules/Reports/ReportGrouping.php (original)
+++ vtigercrm/trunk/modules/Reports/ReportGrouping.php Thu Jul 13 13:25:47 2006
@@ -66,6 +66,12 @@
}
+ /** Function to get the combo values for the Primary module Columns
+ * @ param $module(module name) :: Type String
+ * @ param $selected (<selected or ''>) :: Type String
+ * This function generates the combo values for the columns for the given module
+ * and return a HTML string
+ */
function getPrimaryColumns_GroupingHTML($module,$selected="")
{
@@ -109,6 +115,12 @@
return $shtml;
}
+ /** Function to get the combo values for the Secondary module Columns
+ * @ param $module(module name) :: Type String
+ * @ param $selected (<selected or ''>) :: Type String
+ * This function generates the combo values for the columns for the given module
+ * and return a HTML string
+ */
function getSecondaryColumns_GroupingHTML($module,$selected="")
{
global $ogReport;
Modified: vtigercrm/trunk/modules/Reports/ReportRun.php
==============================================================================
--- vtigercrm/trunk/modules/Reports/ReportRun.php (original)
+++ vtigercrm/trunk/modules/Reports/ReportRun.php Thu Jul 13 13:25:47 2006
@@ -34,6 +34,10 @@
var $reportname;
var $totallist;
+ /** Function to set reportid,primarymodule,secondarymodule,reporttype,reportname, for given reportid
+ * This function accepts the $reportid as argument
+ * It sets reportid,primarymodule,secondarymodule,reporttype,reportname for the given reportid
+ */
function ReportRun($reportid)
{
$oReport = new Reports($reportid);
@@ -44,6 +48,15 @@
$this->reportname = $oReport->reportname;
}
+ /** Function to get the columns for the reportid
+ * This function accepts the $reportid
+ * This function returns $columnslist Array($tablename:$columnname:$fieldlabel:$fieldname:$typeofdata=>$tablename.$columnname As Header value,
+ * $tablename1:$columnname1:$fieldlabel1:$fieldname1:$typeofdata1=>$tablename1.$columnname1 As Header value,
+ * |
+ * $tablenamen:$columnnamen:$fieldlabeln:$fieldnamen:$typeofdatan=>$tablenamen.$columnnamen As Header value
+ * )
+ *
+ */
function getQueryColumnsList($reportid)
{
global $adb;
@@ -75,6 +88,10 @@
return $columnslist;
}
+ /** Function to get Escapedcolumns for the field in case of multiple parents
+ * @ param $selectedfields : Type Array
+ * returns the case query for the escaped columns
+ */
function getEscapedColumns($selectedfields)
{
$fieldname = $selectedfields[3];
@@ -97,6 +114,10 @@
return $querycolumn;
}
+ /** Function to get selectedcolumns for the given reportid
+ * @ param $reportid : Type Integer
+ * returns the query of columnlist for the selected columns
+ */
function getSelectedColumnsList($reportid)
{
@@ -146,6 +167,11 @@
return $sSQL;
}
+ /** Function to get advanced comparator in query form for the given Comparator and value
+ * @ param $comparator : Type String
+ * @ param $value : Type String
+ * returns the check query for the comparator
+ */
function getAdvComparator($comparator,$value)
{
@@ -203,6 +229,17 @@
$log->info("ReportRun :: Successfully returned getAdvComparator");
return $rtvalue;
}
+
+ /** Function to get the advanced filter columns for the reportid
+ * This function accepts the $reportid
+ * This function returns $columnslist Array($columnname => $tablename:$columnname:$fieldlabel:$fieldname:$typeofdata=>$tablename.$columnname filtercriteria,
+ * $tablename1:$columnname1:$fieldlabel1:$fieldname1:$typeofdata1=>$tablename1.$columnname1 filtercriteria,
+ * |
+ * $tablenamen:$columnnamen:$fieldlabeln:$fieldnamen:$typeofdatan=>$tablenamen.$columnnamen filtercriteria
+ * )
+ *
+ */
+
function getAdvFilterList($reportid)
{
@@ -248,6 +285,13 @@
return $advfilterlist;
}
+ /** Function to get the Standard filter columns for the reportid
+ * This function accepts the $reportid datatype Integer
+ * This function returns $stdfilterlist Array($columnname => $tablename:$columnname:$fieldlabel:$fieldname:$typeofdata=>$tablename.$columnname filtercriteria,
+ * $tablename1:$columnname1:$fieldlabel1:$fieldname1:$typeofdata1=>$tablename1.$columnname1 filtercriteria,
+ * )
+ *
+ */
function getStdFilterList($reportid)
{
global $adb;
@@ -291,6 +335,15 @@
$log->info("ReportRun :: Successfully returned getStdFilterList".$reportid);
return $stdfilterlist;
}
+
+ /** Function to get the RunTime filter columns for the given $filtercolumn,$filter,$startdate,$enddate
+ * @ param $filtercolumn : Type String
+ * @ param $filter : Type String
+ * @ param $startdate: Type String
+ * @ param $enddate : Type String
+ * This function returns $stdfilterlist Array($columnname => $tablename:$columnname:$fieldlabel=>$tablename.$columnname 'between' $startdate 'and' $enddate)
+ *
+ */
function RunTimeFilter($filtercolumn,$filter,$startdate,$enddate)
{
if($filtercolumn != "none")
@@ -319,6 +372,12 @@
return $stdfilterlist;
}
+
+ /** Function to get standardfilter for the given reportid
+ * @ param $reportid : Type Integer
+ * returns the query of columnlist for the selected columns
+ */
+
function getStandardCriterialSql($reportid)
{
global $adb;
@@ -362,6 +421,13 @@
$log->info("ReportRun :: Successfully returned getStandardCriterialSql".$reportid);
return $sSQL;
}
+
+ /** Function to get standardfilter startdate and enddate for the given type
+ * @ param $type : Type String
+ * returns the $datevalue Array in the given format
+ * $datevalue = Array(0=>$startdate,1=>$enddate)
+ */
+
function getStandarFiltersStartAndEndDate($type)
{
@@ -563,6 +629,16 @@
return $datevalue;
}
+ /** Function to get getGroupingList for the given reportid
+ * @ param $reportid : Type Integer
+ * returns the $grouplist Array in the following format
+ * $grouplist = Array($tablename:$columnname:$fieldlabel:fieldname:typeofdata=>$tablename:$columnname $sorder,
+ * $tablename1:$columnname1:$fieldlabel1:fieldname1:typeofdata1=>$tablename1:$columnname1 $sorder,
+ * $tablename2:$columnname2:$fieldlabel2:fieldname2:typeofdata2=>$tablename2:$columnname2 $sorder)
+ * This function also sets the return value in the class variable $this->groupbylist
+ */
+
+
function getGroupingList($reportid)
{
global $adb;
@@ -601,6 +677,13 @@
return $grouplist;
}
+ /** function to get the selectedorderbylist for the given reportid
+ * @ param $reportid : type integer
+ * this returns the columns query for the sortorder columns
+ * this function also sets the return value in the class variable $this->orderbylistsql
+ */
+
+
function getSelectedOrderbyList($reportid)
{
@@ -646,6 +729,12 @@
$log->info("ReportRun :: Successfully returned getSelectedOrderbyList".$reportid);
return $sSQL;
}
+
+ /** function to get secondary Module for the given Primary module and secondary module
+ * @ param $module : type String
+ * @ param $secmodule : type String
+ * this returns join query for the given secondary module
+ */
function getRelatedModulesQuery($module,$secmodule)
{
@@ -944,6 +1033,11 @@
$log->info("ReportRun :: Successfully returned getRelatedModulesQuery".$secmodule);
return $query;
}
+ /** function to get report query for the given module
+ * @ param $module : type String
+ * this returns join query for the given module
+ */
+
function getReportsQuery($module)
{
global $log;
@@ -1108,6 +1202,14 @@
$log->info("ReportRun :: Successfully returned getReportsQuery".$module);
return $query;
}
+
+
+ /** function to get query for the given reportid,filterlist,type
+ * @ param $reportid : Type integer
+ * @ param $filterlist : Type Array
+ * @ param $module : Type String
+ * this returns join query for the report
+ */
function sGetSQLforReport($reportid,$filterlist,$type='')
{
@@ -1205,6 +1307,17 @@
return $reportquery;
}
+
+ /** function to get the report output in HTML,PDF,TOTAL,PRINT,PRINTTOTAL formats depends on the argument $outputformat
+ * @ param $outputformat : Type String (valid parameters HTML,PDF,TOTAL,PRINT,PRINT_TOTAL)
+ * @ param $filterlist : Type Array
+ * This returns HTML Report if $outputformat is HTML
+ * Array for PDF if $outputformat is PDF
+ * HTML strings for TOTAL if $outputformat is TOTAL
+ * Array for PRINT if $outputformat is PRINT
+ * HTML strings for TOTAL fields if $outputformat is PRINTTOTAL
+ * HTML strings for
+ */
function GenerateReport($outputformat,$filterlist)
{
@@ -1649,6 +1762,12 @@
}
//<<<<<<new>>>>>>>>>
+
+ /** function to get query for the columns to total for the given reportid
+ * @ param $reportid : Type integer
+ * This returns columnstoTotal query for the reportid
+ */
+
function getColumnsToTotalColumns($reportid)
{
global $adb;
Modified: vtigercrm/trunk/modules/Reports/SaveAndRun.php
==============================================================================
--- vtigercrm/trunk/modules/Reports/SaveAndRun.php (original)
+++ vtigercrm/trunk/modules/Reports/SaveAndRun.php Thu Jul 13 13:25:47 2006
@@ -91,6 +91,13 @@
{
echo $mod_strings['LBL_NO_PERMISSION']." ".$primarymodule." ".$secondarymodule;
}
+
+ /** Function to get the StdfilterHTML strings for the given primary module
+ * @ param $module : Type String
+ * @ param $selected : Type String(optional)
+ * This Generates the HTML Combo strings for the standard filter for the given reports module
+ * This Returns a HTML sring
+ */
function getPrimaryStdFilterHTML($module,$selected="")
{
global $app_list_strings;
@@ -130,6 +137,12 @@
return $shtml;
}
+ /** Function to get the StdfilterHTML strings for the given secondary module
+ * @ param $module : Type String
+ * @ param $selected : Type String(optional)
+ * This Generates the HTML Combo strings for the standard filter for the given reports module
+ * This Returns a HTML sring
+ */
function getSecondaryStdFilterHTML($module,$selected="")
{
global $app_list_strings;
@@ -173,6 +186,11 @@
}
return $shtml;
}
+ /** Function to get the reports under a report folder
+ * @ param $folderid : Type Integer
+ * This Returns $reports_array in the following format
+ * $reports_array = array ($reportid=>$reportname,$reportid=>$reportname1,.............,$reportidn=>$reportname)
+ */
function getReportsinFolder($folderid)
{
global $adb;
Modified: vtigercrm/trunk/modules/Reports/StandardFilter.php
==============================================================================
--- vtigercrm/trunk/modules/Reports/StandardFilter.php (original)
+++ vtigercrm/trunk/modules/Reports/StandardFilter.php Thu Jul 13 13:25:47 2006
@@ -48,6 +48,11 @@
}
+ /** Function to get the HTML strings for the primarymodule standard filters
+ * @ param $module : Type String
+ * @ param $selected : Type String(optional)
+ * This Returns a HTML combo srings
+ */
function getPrimaryStdFilterHTML($module,$selected="")
{
global $app_list_strings;
@@ -87,6 +92,11 @@
return $shtml;
}
+ /** Function to get the HTML strings for the secondary standard filters
+ * @ param $module : Type String
+ * @ param $selected : Type String(optional)
+ * This Returns a HTML combo srings for the secondary modules
+ */
function getSecondaryStdFilterHTML($module,$selected="")
{
global $app_list_strings;
More information about the vtigercrm-commits
mailing list