Author: mmbrich
Date: Wed Jul 12 04:02:41 2006
New Revision: 7965
Log:
phpdoc comments for Campaigns module
Modified:
branches/VTIGERCRM-5.0.2-MMBRICH/modules/Campaigns/Campaign.php
Modified: branches/VTIGERCRM-5.0.2-MMBRICH/modules/Campaigns/Campaign.php
==============================================================================
--- branches/VTIGERCRM-5.0.2-MMBRICH/modules/Campaigns/Campaign.php (original)
+++ branches/VTIGERCRM-5.0.2-MMBRICH/modules/Campaigns/Campaign.php Wed Jul 12 04:02:41 2006
@@ -72,6 +72,7 @@
$this->column_fields = getColumnFields('Campaigns');
}
+ /* internal function used by UI creator to display related entites */
function get_contacts($id)
{
global $log;
@@ -86,6 +87,7 @@
$log->debug("Exiting get_contacts method ...");
return GetRelatedList('Campaigns','Contacts',$focus,$query,$button,$returnset);
}
+ /* internal function used by UI creator to display related entites */
function get_leads($id)
{
global $log;
@@ -100,6 +102,7 @@
$query = $this->get_related_leads_query($id);
return GetRelatedList('Campaigns','Leads',$focus,$query,$button,$returnset);
}
+ /* internal function used by UI creator to display related entites */
function get_opportunities($id)
{
global $log;
@@ -117,11 +120,30 @@
return GetRelatedList('Campaigns','Potentials',$focus,$query,$button,$returnset);
}
+ /* internal function used by UI creator to display related entites */
+ function get_activities($id)
+ {
+ global $log;
+ $log->debug("Entering get_activities(".$id.") method ...");
+ global $app_strings;
+
+ require_once('modules/Activities/Activity.php');
+
+ $focus = new Activity();
+
+ $button = '';
+
+ $returnset = '&return_module=Campaigns&return_action=CallRelatedList&return_id='.$id;
+
+ $query = $this->get_related_activities_query($id);
+
+ $log->debug("Exiting get_activities method ...");
+ return GetRelatedList('Campaigns','Activities',$focus,$query,$button,$returnset);
+ }
/*
* @param integer - id of campaign to retrieve list from
* @return array - array of all db rows from the get_related_[leads,contacts]_query function
- *
*/
function get_related_entities($id) {
$ret = array();
@@ -147,6 +169,10 @@
function get_related_oportunities($id) {
}
+ /*
+ * @param integer - id of campaign to retrieve query from
+ * @return string - SQL query to retrieve records
+ */
function get_related_leads_query($id) {
global $log;
$log->debug("Entering get_leads_query(".$id.") method ...");
@@ -176,6 +202,10 @@
$log->debug("Exiting get_leads method ...");
return $query;
}
+ /*
+ * @param integer - id of campaign to retrieve query from
+ * @return string - SQL query to retrieve records
+ */
function get_related_contacts_query($id) {
global $log;
$log->debug("Entering get_contacts_query(".$id.") method ...");
@@ -205,6 +235,10 @@
return $query;
}
+ /*
+ * @param integer - id of campaign to retrieve query from
+ * @return string - SQL query to retrieve records
+ */
function get_related_opportunities_query($id) {
global $log;
$log->debug("Entering get_related_opportunities_query(".$id.") method ...");
@@ -229,6 +263,10 @@
;
return $query;
}
+ /*
+ * @param integer - id of campaign to retrieve query from
+ * @return string - SQL query to retrieve records
+ */
function get_related_activities_query($id) {
global $log;
$log->debug("Entering get_related_activities_query(".$id.") method ...");
@@ -266,25 +304,5 @@
;
return $query;
}
- function get_activities($id)
- {
- global $log;
- $log->debug("Entering get_activities(".$id.") method ...");
- global $app_strings;
-
- require_once('modules/Activities/Activity.php');
-
- $focus = new Activity();
-
- $button = '';
-
- $returnset = '&return_module=Campaigns&return_action=CallRelatedList&return_id='.$id;
-
- $query = $this->get_related_activities_query($id);
-
- $log->debug("Exiting get_activities method ...");
- return GetRelatedList('Campaigns','Activities',$focus,$query,$button,$returnset);
- }
-
}
?>