[Vtigercrm-commits] [vtiger-commits] r8041 - in /vtigercrm/trunk/modules: Invoice/ PriceBooks/ Products/ PurchaseOrder/ Quotes/ SalesOrder/ Vendors/

vtigercrm-commits at vtiger.fosslabs.com vtigercrm-commits at vtiger.fosslabs.com
Fri Jul 14 04:37:50 EDT 2006


Author: saraj
Date: Fri Jul 14 02:37:35 2006
New Revision: 8041

Log:
* Modified the API docs

Modified:
    vtigercrm/trunk/modules/Invoice/Invoice.php
    vtigercrm/trunk/modules/PriceBooks/PriceBook.php
    vtigercrm/trunk/modules/Products/Product.php
    vtigercrm/trunk/modules/PurchaseOrder/PurchaseOrder.php
    vtigercrm/trunk/modules/Quotes/ListTopQuotes.php
    vtigercrm/trunk/modules/Quotes/Quote.php
    vtigercrm/trunk/modules/SalesOrder/ListTopSalesOrder.php
    vtigercrm/trunk/modules/SalesOrder/SalesOrder.php
    vtigercrm/trunk/modules/Vendors/Vendor.php

Modified: vtigercrm/trunk/modules/Invoice/Invoice.php
==============================================================================
--- vtigercrm/trunk/modules/Invoice/Invoice.php (original)
+++ vtigercrm/trunk/modules/Invoice/Invoice.php Fri Jul 14 02:37:35 2006
@@ -102,9 +102,8 @@
 		$this->log->debug("Exiting Invoice method ...");
 	}
 
-	// Mike Crowe Mod --------------------------------------------------------Default ordering for us
 	/**	Function used to get the sort order for Invoice listview
-	 *	return string	$sorder	- first check the $_REQUEST['sorder'] if request value is empty then check in the $_SESSION['INVOICE_SORT_ORDER'] if this session value is empty then default sort order will be returned. 
+	 *	@return string	$sorder	- first check the $_REQUEST['sorder'] if request value is empty then check in the $_SESSION['INVOICE_SORT_ORDER'] if this session value is empty then default sort order will be returned. 
 	 */
 	function getSortOrder()
 	{
@@ -119,7 +118,7 @@
 	}
 
 	/**	Function used to get the order by value for Invoice listview
-	 *	return string	$order_by  - first check the $_REQUEST['order_by'] if request value is empty then check in the $_SESSION['INVOICE_ORDER_BY'] if this session value is empty then default order by will be returned. 
+	 *	@return string	$order_by  - first check the $_REQUEST['order_by'] if request value is empty then check in the $_SESSION['INVOICE_ORDER_BY'] if this session value is empty then default order by will be returned. 
 	 */
 	function getOrderBy()
 	{
@@ -135,7 +134,7 @@
 
 
 	/**	function used to get the name of the current object
-	 *	return string $this->name - name of the current object
+	 *	@return string $this->name - name of the current object
 	 */
 	function get_summary_text()
 	{
@@ -148,7 +147,7 @@
 
 	/**	function used to get the list of activities which are related to the invoice
 	 *	@param int $id - invoice id
-	 *	return array - array which will be returned from the function GetRelatedList
+	 *	@return array - return an array which will be returned from the function GetRelatedList
 	 */
 	function get_activities($id)
 	{
@@ -169,7 +168,7 @@
 
 	/**	function used to get the the activity history related to the quote
 	 *	@param int $id - invoice id
-	 *	return array - array which will be returned from the function GetHistory
+	 *	@return array - return an array which will be returned from the function GetHistory
 	 */
 	function get_history($id)
 	{
@@ -196,17 +195,15 @@
 	}
 
 
-	/**	function used to get the attachment which are related to the invoice
+	/**	function used to get the attachments which are related to the invoice
 	 *	@param int $id - invoice id to which we want to retrieve the attachments and notes
-         *      @return array - array which will be returned from the function getAttachmentsAndNotes with parameters module, query, invoice id
+         *      @return array - return an array which will be returned from the function getAttachmentsAndNotes
         **/
 	function get_attachments($id)
 	{
 		global $log;
 		$log->debug("Entering get_attachments(".$id.") method ...");
-		// Armando Lüscher 18.10.2005 -> §visibleDescription
-		// Desc: Inserted crm2.createdtime, vtiger_notes.notecontent description, vtiger_users.user_name
-		// Inserted inner join vtiger_users on crm2.smcreatorid= vtiger_users.id
+		
 		$query = "select vtiger_notes.title,'Notes      '  ActivityType, vtiger_notes.filename,
 		vtiger_attachments.type  FileType,crm2.modifiedtime lastmodified,
 		vtiger_seattachmentsrel.attachmentsid attachmentsid, vtiger_notes.notesid crmid,
@@ -219,11 +216,9 @@
 			left join vtiger_attachments on vtiger_seattachmentsrel.attachmentsid = vtiger_attachments.attachmentsid
 			inner join vtiger_users on crm2.smcreatorid= vtiger_users.id
 		where vtiger_crmentity.crmid=".$id;
+		
 		$query .= ' union all ';
-		// Armando Lüscher 18.10.2005 -> §visibleDescription
-		// Desc: Inserted crm2.createdtime, vtiger_attachments.description, vtiger_users.user_name
-		// Inserted inner join vtiger_users on crm2.smcreatorid= vtiger_users.id
-		// Inserted order by createdtime desc
+
 		$query .= "select vtiger_attachments.description  title ,'Attachments'  ActivityType,
 		vtiger_attachments.name filename, vtiger_attachments.type FileType, crm2.modifiedtime lastmodified,
 		vtiger_attachments.attachmentsid attachmentsid, vtiger_seattachmentsrel.attachmentsid crmid,
@@ -234,13 +229,14 @@
 			inner join vtiger_crmentity crm2 on crm2.crmid=vtiger_attachments.attachmentsid
 			inner join vtiger_users on crm2.smcreatorid= vtiger_users.id
 		where vtiger_crmentity.crmid=".$id;
+
 		$log->debug("Exiting get_attachments method ...");
 		return getAttachmentsAndNotes('Invoice',$query,$id);
 	}
 
 	/**	Function used to get the Status history of the Invoice
 	 *	@param $id - invoice id
-	 *	return $return_data - array with header and the entries in format Array('header'=>$header,'entries'=>$entries_list) where as $header and $entries_list are array which contains all the column values of an row
+	 *	@return $return_data - array with header and the entries in format Array('header'=>$header,'entries'=>$entries_list) where as $header and $entries_list are arrays which contains header values and all column values of all entries
 	 */
 	function get_invoicestatushistory($id)
 	{	

Modified: vtigercrm/trunk/modules/PriceBooks/PriceBook.php
==============================================================================
--- vtigercrm/trunk/modules/PriceBooks/PriceBook.php (original)
+++ vtigercrm/trunk/modules/PriceBooks/PriceBook.php Fri Jul 14 02:37:35 2006
@@ -27,7 +27,7 @@
 
 	var $sortby_fields = Array('bookname');		  
 
-        // This is the list of vtiger_fields that are in the lists.
+        // This is the list of fields that are in the lists.
 	var $list_fields = Array(
                                 'Price Book Name'=>Array('pricebook'=>'bookname'),
                                 'Active'=>Array('pricebook'=>'active')
@@ -59,9 +59,8 @@
 		$this->log->debug("Exiting PriceBook method ...");
 	}
 
-	// Mike Crowe Mod --------------------------------------------------------Default ordering for us
-	/**	Function used to get the sort order for Product listview
-	 *	return string	$sorder	- first check the $_REQUEST['sorder'] if request value is empty then check in the $_SESSION['PRICEBOOK_SORT_ORDER'] if this session value is empty then default sort order will be returned. 
+	/**	Function used to get the sort order for PriceBook listview
+	 *	@return string	$sorder	- first check the $_REQUEST['sorder'] if request value is empty then check in the $_SESSION['PRICEBOOK_SORT_ORDER'] if this session value is empty then default sort order will be returned. 
 	 */
 	function getSortOrder()
 	{
@@ -75,8 +74,8 @@
 		return $sorder;
 	}
 
-	/**	Function used to get the order by value for Product listview
-	 *	return string	$order_by  - first check the $_REQUEST['order_by'] if request value is empty then check in the $_SESSION['PRICEBOOK_ORDER_BY'] if this session value is empty then default order by will be returned. 
+	/**	Function used to get the order by value for PriceBook listview
+	 *	@return string	$order_by  - first check the $_REQUEST['order_by'] if request value is empty then check in the $_SESSION['PRICEBOOK_ORDER_BY'] if this session value is empty then default order by will be returned. 
 	 */
 	function getOrderBy()
 	{
@@ -92,7 +91,7 @@
 
 	/**	function used to get the products which are related to the pricebook
 	 *	@param int $id - pricebook id
-         *      @return array - array which will be returned from the function getPriceBookRelatedProducts with parameters query, product object and returnset value
+         *      @return array - return an array which will be returned from the function getPriceBookRelatedProducts
         **/
 	function get_pricebook_products($id)
 	{
@@ -113,7 +112,7 @@
 
 	/**	function used to get whether the pricebook has related with a product or not
 	 *	@param int $id - product id
-	 *	return true or false - return false if there are no pricebooks available or associated pricebooks for the product is equal to total number of pricebooks elase return true
+	 *	@return true or false - if there are no pricebooks available or associated pricebooks for the product is equal to total number of pricebooks then return false, else return true
 	 */
 	function get_pricebook_noproduct($id)
 	{

Modified: vtigercrm/trunk/modules/Products/Product.php
==============================================================================
--- vtigercrm/trunk/modules/Products/Product.php (original)
+++ vtigercrm/trunk/modules/Products/Product.php Fri Jul 14 02:37:35 2006
@@ -80,7 +80,7 @@
 	}
 
 	/**	Function used to get the sort order for Product listview
-	 *	return string	$sorder	- first check the $_REQUEST['sorder'] if request value is empty then check in the $_SESSION['HELPDESK_SORT_ORDER'] if this session value is empty then default sort order will be returned. 
+	 *	@return string	$sorder	- first check the $_REQUEST['sorder'] if request value is empty then check in the $_SESSION['PRODUCTS_SORT_ORDER'] if this session value is empty then default sort order will be returned. 
 	 */
 	function getSortOrder()
 	{
@@ -95,7 +95,7 @@
 	}
 
 	/**	Function used to get the order by value for Product listview
-	 *	return string	$order_by  - first check the $_REQUEST['order_by'] if request value is empty then check in the $_SESSION['HELPDESK_ORDER_BY'] if this session value is empty then default order by will be returned. 
+	 *	@return string	$order_by  - first check the $_REQUEST['order_by'] if request value is empty then check in the $_SESSION['PRODUCTS_ORDER_BY'] if this session value is empty then default order by will be returned. 
 	 */
 	function getOrderBy()
 	{
@@ -111,7 +111,7 @@
 
 	/**	function used to get the attachment which are related to the product
 	 *	@param int $id - product id to which we want to retrieve the attachments and notes
-         *      @return array - array which will be returned from the function getAttachmentsAndNotes with parameters module, query, product id
+         *      @return array - array which will be returned from the function getAttachmentsAndNotes
         **/
 	function get_attachments($id)
 	{
@@ -167,8 +167,7 @@
 
 	/**	function used to get the list of potentials which are related to the product
 	 *	@param int $id - product id 
-	 *	@return void
-	 *	 but this function will call the function renderRelatedPotentials with parameter query
+	 *	@return void - but this function will call the function renderRelatedPotentials with parameter query
 	 */
 	function get_opportunities($id)
 	{
@@ -194,7 +193,7 @@
 
 	/**	function used to get the list of tickets which are related to the product
 	 *	@param int $id - product id
-	 *	return array - array which will be returned from the function GetRelatedList
+	 *	@return array - array which will be returned from the function GetRelatedList
 	 */
 	function get_tickets($id)
 	{
@@ -234,7 +233,7 @@
 
 	/**	function used to get the list of activities which are related to the product
 	 *	@param int $id - product id
-	 *	return array - array which will be returned from the function GetRelatedList
+	 *	@return array - array which will be returned from the function GetRelatedList
 	 */
 	function get_activities($id)
 	{
@@ -288,7 +287,7 @@
 
 	/**	function used to get the list of quotes which are related to the product
 	 *	@param int $id - product id
-	 *	return array - array which will be returned from the function GetRelatedList
+	 *	@return array - array which will be returned from the function GetRelatedList
 	 */
 	function get_quotes($id)
 	{
@@ -328,7 +327,7 @@
 
 	/**	function used to get the list of purchase orders which are related to the product
 	 *	@param int $id - product id
-	 *	return array - array which will be returned from the function GetRelatedList
+	 *	@return array - array which will be returned from the function GetRelatedList
 	 */
 	function get_purchase_orders($id)
 	{
@@ -365,7 +364,7 @@
 
 	/**	function used to get the list of sales orders which are related to the product
 	 *	@param int $id - product id
-	 *	return array - array which will be returned from the function GetRelatedList
+	 *	@return array - array which will be returned from the function GetRelatedList
 	 */
 	function get_salesorder($id)
 	{
@@ -404,7 +403,7 @@
 
 	/**	function used to get the list of invoices which are related to the product
 	 *	@param int $id - product id
-	 *	return array - array which will be returned from the function GetRelatedList
+	 *	@return array - array which will be returned from the function GetRelatedList
 	 */
 	function get_invoices($id)
 	{
@@ -441,7 +440,7 @@
 
 	/**	function used to get the list of pricebooks which are related to the product
 	 *	@param int $id - product id
-	 *	return array - array which will be returned from the function GetRelatedList
+	 *	@return array - array which will be returned from the function GetRelatedList
 	 */
 	function get_product_pricebooks($id)
 	{     
@@ -470,7 +469,7 @@
 
 	/**	function used to get the number of vendors which are related to the product
 	 *	@param int $id - product id
-	 *	return int number of rows - return the number of products which do not have relationship with vendor
+	 *	@return int number of rows - return the number of products which do not have relationship with vendor
 	 */
 	function product_novendor()
 	{
@@ -490,7 +489,7 @@
 	/**	function used to get the export query for product
 	 *	@param reference &$order_by - reference of the order by variable which will be added with the query
 	 *	@param reference &$where - reference of the where variable which will be added with the query
-	 *	return string $query - return the query which will give the list of products to export
+	 *	@return string $query - return the query which will give the list of products to export
 	 */	
 	function create_export_query(&$order_by, &$where)
 	{

Modified: vtigercrm/trunk/modules/PurchaseOrder/PurchaseOrder.php
==============================================================================
--- vtigercrm/trunk/modules/PurchaseOrder/PurchaseOrder.php (original)
+++ vtigercrm/trunk/modules/PurchaseOrder/PurchaseOrder.php Fri Jul 14 02:37:35 2006
@@ -99,9 +99,8 @@
 		$this->column_fields = getColumnFields('PurchaseOrder');
 	}
 
-	// Mike Crowe Mod --------------------------------------------------------Default ordering for us
 	/**	Function used to get the sort order for Purchase Order listview
-	 *	return string	$sorder	- first check the $_REQUEST['sorder'] if request value is empty then check in the $_SESSION['PURCHASEORDER_SORT_ORDER'] if this session value is empty then default sort order will be returned. 
+	 *	@return string	$sorder	- first check the $_REQUEST['sorder'] if request value is empty then check in the $_SESSION['PURCHASEORDER_SORT_ORDER'] if this session value is empty then default sort order will be returned. 
 	 */
 	function getSortOrder()
 	{
@@ -116,7 +115,7 @@
 	}
 
 	/**	Function used to get the order by value for Purchase Order listview
-	 *	return string	$order_by  - first check the $_REQUEST['order_by'] if request value is empty then check in the $_SESSION['PURCHASEORDER_ORDER_BY'] if this session value is empty then default order by will be returned. 
+	 *	@return string	$order_by  - first check the $_REQUEST['order_by'] if request value is empty then check in the $_SESSION['PURCHASEORDER_ORDER_BY'] if this session value is empty then default order by will be returned. 
 	 */
 	function getOrderBy()
 	{
@@ -130,7 +129,7 @@
 		return $order_by;
 	}	
 
-	/** Function to get activities associated with the id
+	/** Function to get activities associated with the Purchase Order
 	 *  This function accepts the id as arguments and execute the MySQL query using the id
 	 *  and sends the query and the id as arguments to renderRelatedActivities() method 
 	 */
@@ -151,7 +150,7 @@
 		return GetRelatedList('PurchaseOrder','Activities',$focus,$query,$button,$returnset);
 	}
 
-	/** Function to get history associated with the id
+	/** Function to get the activities history associated with the Purchase Order
 	 *  This function accepts the id as arguments and execute the MySQL query using the id
 	 *  and sends the query and the id as arguments to renderRelatedHistory() method
 	 */
@@ -179,7 +178,7 @@
 		return getHistory('PurchaseOrder',$query,$id);
 	}
 
-	/** Function to get vtiger_attachments associated with the id
+	/** Function to get the attachments associated with the Purchase Order
 	 *  This function accepts the id as arguments and execute the MySQL query using the id
 	 *  and sends the query and the id as arguments to renderRelatedAttachments() method.
 	 */
@@ -187,9 +186,7 @@
 	{
 		global $log;
 		$log->debug("Entering get_attachments(".$id.") method ...");
-		// Armando Lüscher 18.10.2005 -> §visibleDescription
-		// Desc: Inserted crm2.createdtime, vtiger_notes.notecontent description, vtiger_users.user_name
-		// Inserted inner join vtiger_users on crm2.smcreatorid= vtiger_users.id
+
 		$query = "select vtiger_notes.title, 'Notes      '  ActivityType, vtiger_notes.filename,
 		vtiger_attachments.type FileType, crm2.modifiedtime lastmodified,
 		vtiger_seattachmentsrel.attachmentsid attachmentsid, vtiger_notes.notesid crmid,
@@ -202,11 +199,9 @@
 			left join vtiger_attachments on vtiger_seattachmentsrel.attachmentsid = vtiger_attachments.attachmentsid
 			inner join vtiger_users on crm2.smcreatorid= vtiger_users.id
 		where vtiger_crmentity.crmid=".$id;
+		
 		$query .= ' union all ';
-		// Armando Lüscher 18.10.2005 -> §visibleDescription
-		// Desc: Inserted crm2.createdtime, vtiger_attachments.description, vtiger_users.user_name
-		// Inserted inner join vtiger_users on crm2.smcreatorid= vtiger_users.id
-		// Inserted order by createdtime desc
+
 		$query .= "select vtiger_attachments.description  title ,'Attachments'  ActivityType,
 		vtiger_attachments.name  filename, vtiger_attachments.type  FileType, crm2.modifiedtime  lastmodified,
 		vtiger_attachments.attachmentsid  attachmentsid, vtiger_seattachmentsrel.attachmentsid crmid,
@@ -218,13 +213,14 @@
 			inner join vtiger_users on crm2.smcreatorid= vtiger_users.id
 		where vtiger_crmentity.crmid=".$id."
 		order by createdtime desc";
+
 		$log->debug("Exiting get_attachments method ...");
 		return getAttachmentsAndNotes('PurchaseOrder',$query,$id,$sid='purchaseorderid');
 	}
 
 	/**	Function used to get the Status history of the Purchase Order
 	 *	@param $id - purchaseorder id
-	 *	return $return_data - array with header and the entries in format Array('header'=>$header,'entries'=>$entries_list) where as $header and $entries_list are array which contains all the column values of an row
+	 *	@return $return_data - array with header and the entries in format Array('header'=>$header,'entries'=>$entries_list) where as $header and $entries_list are arrays which contains header values and all column values of all entries
 	 */
 	function get_postatushistory($id)
 	{	

Modified: vtigercrm/trunk/modules/Quotes/ListTopQuotes.php
==============================================================================
--- vtigercrm/trunk/modules/Quotes/ListTopQuotes.php (original)
+++ vtigercrm/trunk/modules/Quotes/ListTopQuotes.php Fri Jul 14 02:37:35 2006
@@ -13,8 +13,8 @@
  * Contributor(s): ______________________________________.
  ********************************************************************************/
 
-/**	function used to get the top 5 quotes
- *	return array $values - array with the title, header and entries like  Array('Title'=>$title,'Header'=>$listview_header,'Entries'=>$listview_entries) where as listview_header and listview_entries are arrays of header and entity values which are returned from function getListViewHeader and getListViewEntries
+/**	function used to get the top 5 quotes from the ListView query
+ *	@return array $values - array with the title, header and entries like  Array('Title'=>$title,'Header'=>$listview_header,'Entries'=>$listview_entries) where as listview_header and listview_entries are arrays of header and entity values which are returned from function getListViewHeader and getListViewEntries
  */
 function getTopQuotes()
 {

Modified: vtigercrm/trunk/modules/Quotes/Quote.php
==============================================================================
--- vtigercrm/trunk/modules/Quotes/Quote.php (original)
+++ vtigercrm/trunk/modules/Quotes/Quote.php Fri Jul 14 02:37:35 2006
@@ -105,9 +105,8 @@
 		$this->column_fields = getColumnFields('Quotes');
 	}
 	
-	// Mike Crowe Mod --------------------------------------------------------Default ordering for us
 	/**	Function used to get the sort order for Quote listview
-	 *	return string	$sorder	- first check the $_REQUEST['sorder'] if request value is empty then check in the $_SESSION['QUOTES_SORT_ORDER'] if this session value is empty then default sort order will be returned. 
+	 *	@return string	$sorder	- first check the $_REQUEST['sorder'] if request value is empty then check in the $_SESSION['QUOTES_SORT_ORDER'] if this session value is empty then default sort order will be returned. 
 	 */
 	function getSortOrder()
 	{
@@ -122,7 +121,7 @@
 	}
 
 	/**	Function used to get the order by value for Quotes listview
-	 *	return string	$order_by  - first check the $_REQUEST['order_by'] if request value is empty then check in the $_SESSION['QUOTES_ORDER_BY'] if this session value is empty then default order by will be returned. 
+	 *	@return string	$order_by  - first check the $_REQUEST['order_by'] if request value is empty then check in the $_SESSION['QUOTES_ORDER_BY'] if this session value is empty then default order by will be returned. 
 	 */
 	function getOrderBy()
 	{
@@ -135,11 +134,10 @@
 		$log->debug("Exiting getOrderBy method ...");
 		return $order_by;
 	}	
-	// Mike Crowe Mod --------------------------------------------------------
 
 	/**	function used to get the list of sales orders which are related to the Quotes
 	 *	@param int $id - quote id
-	 *	return array - array which will be returned from the function GetRelatedList
+	 *	@return array - return an array which will be returned from the function GetRelatedList
 	 */
 	function get_salesorder($id)
 	{
@@ -159,7 +157,7 @@
 
 	/**	function used to get the list of activities which are related to the Quotes
 	 *	@param int $id - quote id
-	 *	return array - array which will be returned from the function GetRelatedList
+	 *	@return array - return an array which will be returned from the function GetRelatedList
 	 */
 	function get_activities($id)
 	{	
@@ -180,7 +178,7 @@
 
 	/**	function used to get the the activity history related to the quote
 	 *	@param int $id - quote id
-	 *	return array - array which will be returned from the function GetHistory
+	 *	@return array - return an array which will be returned from the function GetHistory
 	 */
 	function get_history($id)
 	{
@@ -210,7 +208,7 @@
 
 	/**	Function used to get the Quote Stage history of the Quotes
 	 *	@param $id - quote id
-	 *	return $return_data - array with header and the entries in format Array('header'=>$header,'entries'=>$entries_list) where as $header and $entries_list are array which contains all the column values of an row
+	 *	@return $return_data - array with header and the entries in format Array('header'=>$header,'entries'=>$entries_list) where as $header and $entries_list are arrays which contains header values and all column values of all entries
 	 */
 	function get_quotestagehistory($id)
 	{	

Modified: vtigercrm/trunk/modules/SalesOrder/ListTopSalesOrder.php
==============================================================================
--- vtigercrm/trunk/modules/SalesOrder/ListTopSalesOrder.php (original)
+++ vtigercrm/trunk/modules/SalesOrder/ListTopSalesOrder.php Fri Jul 14 02:37:35 2006
@@ -14,8 +14,8 @@
  ********************************************************************************/
 
 
-/**	function used to get the top 5 sales orders
- *	return array $values - array with the title, header and entries like  Array('Title'=>$title,'Header'=>$listview_header,'Entries'=>$listview_entries) where as listview_header and listview_entries are arrays of header and entity values which are returned from function getListViewHeader and getListViewEntries
+/**	function used to get the top 5 sales orders from Listview query
+ *	@return array $values - array with the title, header and entries like  Array('Title'=>$title,'Header'=>$listview_header,'Entries'=>$listview_entries) where as listview_header and listview_entries are arrays of header and entity values which are returned from function getListViewHeader and getListViewEntries
  */
 function getTopSalesOrder()
 {

Modified: vtigercrm/trunk/modules/SalesOrder/SalesOrder.php
==============================================================================
--- vtigercrm/trunk/modules/SalesOrder/SalesOrder.php (original)
+++ vtigercrm/trunk/modules/SalesOrder/SalesOrder.php Fri Jul 14 02:37:35 2006
@@ -106,9 +106,8 @@
 		$this->column_fields = getColumnFields('SalesOrder');
 	}
 	
-	// Mike Crowe Mod --------------------------------------------------------Default ordering for us
 	/**	Function used to get the sort order for Sales Order listview
-	 *	return string	$sorder	- first check the $_REQUEST['sorder'] if request value is empty then check in the $_SESSION['SALESORDER_SORT_ORDER'] if this session value is empty then default sort order will be returned. 
+	 *	@return string	$sorder	- first check the $_REQUEST['sorder'] if request value is empty then check in the $_SESSION['SALESORDER_SORT_ORDER'] if this session value is empty then default sort order will be returned. 
 	 */
 	function getSortOrder()
 	{
@@ -123,7 +122,7 @@
 	}
 
 	/**	Function used to get the order by value for Sales Order listview
-	 *	return string	$order_by  - first check the $_REQUEST['order_by'] if request value is empty then check in the $_SESSION['SALESORDER_ORDER_BY'] if this session value is empty then default order by will be returned. 
+	 *	@return string	$order_by  - first check the $_REQUEST['order_by'] if request value is empty then check in the $_SESSION['SALESORDER_ORDER_BY'] if this session value is empty then default order by will be returned. 
 	 */
 	function getOrderBy()
 	{
@@ -136,9 +135,8 @@
 		$log->debug("Exiting getOrderBy method ...");
 		return $order_by;
 	}	
-	// Mike Crowe Mod --------------------------------------------------------
-
-	/** Function to get activities associated with the id
+
+	/** Function to get activities associated with the Sales Order
 	 *  This function accepts the id as arguments and execute the MySQL query using the id
 	 *  and sends the query and the id as arguments to renderRelatedActivities() method
 	 */
@@ -159,7 +157,7 @@
 		return GetRelatedList('SalesOrder','Activities',$focus,$query,$button,$returnset);
 	}
 
-	/** Function to get history associated with the id
+	/** Function to get the activities history associated with the Sales Order
 	 *  This function accepts the id as arguments and execute the MySQL query using the id
 	 *  and sends the query and the id as arguments to renderRelatedHistory() method
 	 */
@@ -187,7 +185,7 @@
 		return getHistory('SalesOrder',$query,$id);
 	}
 
-	/** Function to get vtiger_attachments associated with the id
+	/** Function to get vtiger_attachments associated with the Sales Order
 	 *  This function accepts the id as arguments and execute the MySQL query using the id
 	 *  and sends the query and the id as arguments to renderRelatedAttachments() method.
 	 */
@@ -195,9 +193,7 @@
 	{
 		global $log;
 		$log->debug("Entering get_attachments(".$id.") method ...");
-		// Armando Lüscher 18.10.2005 -> §visibleDescription
-		// Desc: Inserted vtiger_crmentity.createdtime, vtiger_notes.notecontent description, vtiger_users.user_name
-		// Inserted inner join vtiger_users on vtiger_crmentity.smcreatorid= vtiger_users.id
+
 		$query = "select vtiger_notes.title,'Notes      '  ActivityType, vtiger_notes.filename,
 		vtiger_attachments.type  FileType,crm2.modifiedtime lastmodified,
 		vtiger_seattachmentsrel.attachmentsid attachmentsid, vtiger_notes.notesid crmid,
@@ -210,11 +206,9 @@
 			left join vtiger_attachments on vtiger_seattachmentsrel.attachmentsid = vtiger_attachments.attachmentsid
 			inner join vtiger_users on vtiger_crmentity.smcreatorid= vtiger_users.id
 		where vtiger_crmentity.crmid=".$id;
+
 		$query .= ' union all ';
-		// Armando Lüscher 18.10.2005 -> §visibleDescription
-		// Desc: Inserted vtiger_crmentity.createdtime, vtiger_attachments.description, vtiger_users.user_name
-		// Inserted inner join vtiger_users on vtiger_crmentity.smcreatorid= vtiger_users.id
-		// Inserted order by createdtime desc
+
 		$query .= "select vtiger_attachments.description  title ,'Attachments'  ActivityType,
 		vtiger_attachments.name  filename, vtiger_attachments.type  FileType, crm2.modifiedtime lastmodified,
 		vtiger_attachments.attachmentsid  attachmentsid, vtiger_seattachmentsrel.attachmentsid crmid,
@@ -226,11 +220,12 @@
 			inner join vtiger_users on vtiger_crmentity.smcreatorid= vtiger_users.id
 		where vtiger_crmentity.crmid=".$id."
 		order by createdtime desc";
-	$log->debug("Exiting get_attachments method ...");
-	return getAttachmentsAndNotes('SalesOrder',$query,$id,$sid='salesorderid');
-	}
-
-	/** Function to get vtiger_invoices associated with the id
+
+		$log->debug("Exiting get_attachments method ...");
+		return getAttachmentsAndNotes('SalesOrder',$query,$id,$sid='salesorderid');
+	}
+
+	/** Function to get the invoices associated with the Sales Order
 	 *  This function accepts the id as arguments and execute the MySQL query using the id
 	 *  and sends the query and the id as arguments to renderRelatedInvoices() method.
 	 */
@@ -254,7 +249,7 @@
 
 	/**	Function used to get the Status history of the Sales Order
 	 *	@param $id - salesorder id
-	 *	return $return_data - array with header and the entries in format Array('header'=>$header,'entries'=>$entries_list) where as $header and $entries_list are array which contains all the column values of an row
+	 *	@return $return_data - array with header and the entries in format Array('header'=>$header,'entries'=>$entries_list) where as $header and $entries_list are arrays which contains header values and all column values of all entries
 	 */
 	function get_sostatushistory($id)
 	{	

Modified: vtigercrm/trunk/modules/Vendors/Vendor.php
==============================================================================
--- vtigercrm/trunk/modules/Vendors/Vendor.php (original)
+++ vtigercrm/trunk/modules/Vendors/Vendor.php Fri Jul 14 02:37:35 2006
@@ -67,7 +67,7 @@
 
 	/**	function used to get the list of products which are related to the vendor
 	 *	@param int $id - vendor id
-	 *	return array - array which will be returned from the function GetRelatedList
+	 *	@return array - array which will be returned from the function GetRelatedList
 	 */
 	function get_products($id)
 	{
@@ -88,7 +88,7 @@
 
 	/**	function used to get the list of purchase orders which are related to the vendor
 	 *	@param int $id - vendor id
-	 *	return array - array which will be returned from the function GetRelatedList
+	 *	@return array - array which will be returned from the function GetRelatedList
 	 */
 	function get_purchase_orders($id)
 	{
@@ -109,7 +109,7 @@
 
 	/**	function used to get the list of contacts which are related to the vendor
 	 *	@param int $id - vendor id
-	 *	return array - array which will be returned from the function GetRelatedList
+	 *	@return array - array which will be returned from the function GetRelatedList
 	 */
 	function get_contacts($id)
 	{





More information about the vtigercrm-commits mailing list