[Vtigercrm-commits] [vtiger-commits] r8042 - in /vtigercrm/trunk/modules: Faq/Faq.php HelpDesk/HelpDesk.php Import/Forms.php Import/ImportMap.php Import/UsersLastImport.php Import/parse_utils.php Migration/Migration.php
vtigercrm-commits at vtiger.fosslabs.com
vtigercrm-commits at vtiger.fosslabs.com
Fri Jul 14 05:07:40 EDT 2006
Author: saraj
Date: Fri Jul 14 03:07:31 2006
New Revision: 8042
Log:
* Modified the API docs
Modified:
vtigercrm/trunk/modules/Faq/Faq.php
vtigercrm/trunk/modules/HelpDesk/HelpDesk.php
vtigercrm/trunk/modules/Import/Forms.php
vtigercrm/trunk/modules/Import/ImportMap.php
vtigercrm/trunk/modules/Import/UsersLastImport.php
vtigercrm/trunk/modules/Import/parse_utils.php
vtigercrm/trunk/modules/Migration/Migration.php
Modified: vtigercrm/trunk/modules/Faq/Faq.php
==============================================================================
--- vtigercrm/trunk/modules/Faq/Faq.php (original)
+++ vtigercrm/trunk/modules/Faq/Faq.php Fri Jul 14 03:07:31 2006
@@ -88,7 +88,7 @@
/** Function to get the list of comments for the given FAQ id
* @param int $faqid - FAQ id
- * @return list $list - the list of comments which are formed as boxed info with div tags.
+ * @return list $list - return the list of comments and comment informations as a html output where as these comments and comments informations will be formed in div tag.
**/
function getFAQComments($faqid)
{
Modified: vtigercrm/trunk/modules/HelpDesk/HelpDesk.php
==============================================================================
--- vtigercrm/trunk/modules/HelpDesk/HelpDesk.php (original)
+++ vtigercrm/trunk/modules/HelpDesk/HelpDesk.php Fri Jul 14 03:07:31 2006
@@ -83,9 +83,8 @@
$this->log->debug("Exiting HelpDesk method ...");
}
- // Mike Crowe Mod --------------------------------------------------------Default ordering for us
/** Function used to get the sort order for HelpDesk 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['HELPDESK_SORT_ORDER'] if this session value is empty then default sort order will be returned.
*/
function getSortOrder()
{
@@ -100,7 +99,7 @@
}
/** Function used to get the order by value for HelpDesk 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['HELPDESK_ORDER_BY'] if this session value is empty then default order by will be returned.
*/
function getOrderBy()
{
@@ -116,8 +115,7 @@
/** Function to form the query to get the list of activities
* @param int $id - ticket id
- * @return void
- * but this function will call the function renderRelatedActivities with parameters query and ticket id
+ * @return array - return an array which will be returned from the function GetRelatedList
**/
function get_activities($id)
{
@@ -140,7 +138,7 @@
/** Function to get the Ticket History information as in array format
* @param int $ticketid - ticket id
- * return array with title and the ticket history informations in the following format
+ * @return array - return an array with title and the ticket history informations in the following format
array(
header=>array('0'=>'title'),
entries=>array('0'=>'info1','1'=>'info2',etc.,)
@@ -166,10 +164,9 @@
return $return_value;
}
- /** Function to form the query to get the list of vtiger_attachments and vtiger_notes
+ /** Function to form the query to get the list of attachments and notes
* @param int $id - ticket id
- * @return void
- * but this function will call the function renderRelatedAttachments with parameters query and ticket id
+ * @return array - return an array which will be returned from the function getAttachmentsAndNotes
**/
function get_attachments($id)
{
@@ -243,7 +240,7 @@
/** Function to form the query which will give the list of tickets based on customername and id ie., contactname and contactid
* @param string $user_name - name of the customer ie., contact name
* @param int $id - contact id
- * @return array which is return from the function process_list_query
+ * @return array - return an array which will be returned from the function process_list_query
**/
function get_user_tickets_list($user_name,$id,$where='',$match='')
{
@@ -296,7 +293,7 @@
return $this->process_list_query($query);
}
- /** Function to process the query and return the result with number of rows
+ /** Function to process the list query and return the result with number of rows
* @param string $query - query
* @return array $response - array( list => array(
$i => array(key => val)
@@ -345,8 +342,8 @@
return $response;
}
- /** Function to get the HelpDesk vtiger_field labels in caps letters without space
- * return array $mergeflds - array( key => val ) where key=0,1,2..n & val = ASSIGNEDTO,RELATEDTO, .,etc
+ /** Function to get the HelpDesk field labels in caps letters without space
+ * @return array $mergeflds - array( key => val ) where key=0,1,2..n & val = ASSIGNEDTO,RELATEDTO, .,etc
**/
function getColumnNames_Hd()
{
@@ -368,7 +365,7 @@
/** Function to get the list of comments for the given ticket id
* @param int $ticketid - Ticket id
- * @return list $list - the list of comments which are formed as boxed info with div tags.
+ * @return list $list - return the list of comments and comment informations as a html output where as these comments and comments informations will be formed in div tag.
**/
function getCommentInformation($ticketid)
{
@@ -417,7 +414,7 @@
return $list;
}
- /** Function to get the Customer Name who has made comment to the ticket from the vtiger_portal
+ /** Function to get the Customer Name who has made comment to the ticket from the customer portal
* @param int $id - Ticket id
* @return string $customername - The contact name
**/
@@ -435,7 +432,7 @@
/** Function used to get the Activity History
* @param int $id - ticket id to which we want to display the activity history
- * return 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)
{
Modified: vtigercrm/trunk/modules/Import/Forms.php
==============================================================================
--- vtigercrm/trunk/modules/Import/Forms.php (original)
+++ vtigercrm/trunk/modules/Import/Forms.php Fri Jul 14 03:07:31 2006
@@ -181,7 +181,7 @@
* @param string $suggest_field - field to show as selected in the combo box
* @param array $translated_fields - list of fields which are available to map
* @param string $module - tablename for the import module
- * return the combo box with the fields which are available to map
+ * @return picklist $output - return the combo box ie., picklist with the fields which are available to map
*/
function getFieldSelect(&$column_fields,$colnum,&$required_fields,$suggest_field,$translated_fields,$module)
{
Modified: vtigercrm/trunk/modules/Import/ImportMap.php
==============================================================================
--- vtigercrm/trunk/modules/Import/ImportMap.php (original)
+++ vtigercrm/trunk/modules/Import/ImportMap.php Fri Jul 14 03:07:31 2006
@@ -69,7 +69,7 @@
}
/** function used to get the id, name, module and content as string
- * return string Object:ImportMap id=$this->id name=$this->name module=$this->module content=$this->content
+ * @return string Object:ImportMap id=$this->id name=$this->name module=$this->module content=$this->content
*/
function toString()
{
@@ -82,7 +82,7 @@
* @param string $module - module name in which we have saved the mapping
* @param string $has_header - has_header value
* @param string $content - all fields which are concatenated with & symbol
- * return int $result - return 1 if the mapping contents updated
+ * @return int $result - return 1 if the mapping contents updated
*/
function save_map( $owner_id, $name, $module, $has_header,$content )
{
@@ -109,7 +109,7 @@
/** function used to publish or unpublish the mapping
* @param int $user_id - user id who is publishing the map
* @param string $flag - yes or no
- * return value - if flag is yes then update the db and return 1 otherwise return -1
+ * @return value - if flag is yes then update the db and return 1 otherwise return -1
*/
function mark_published($user_id,$flag)
{
@@ -148,7 +148,7 @@
/** function to retrieve all the column fields and set as properties
* @param array $fields_array - fields array of the corresponding module
- * return array $obj_arr - object which contains the retrieved column_field values as properties
+ * @return array $obj_arr - return an array which contains the retrieved column_field values as properties
*/
function retrieve_all_by_string_fields($fields_array)
{
@@ -176,7 +176,7 @@
/** function used to get the list of saved mappings
* @param string $module - module name which we currently importing
- * return array $map_lists - return the list of mappings in the format of [id]=>name
+ * @return array $map_lists - return the list of mappings in the format of [id]=>name
*/
function getSavedMappingsList($module)
{
@@ -193,7 +193,7 @@
/** function used to retrieve the mapping content for the passed mapid
* @param int $mapid - mapid for the selected map
- * return array $mapping_arr - return the array which contains the mapping_arr[name]=value from the content of the map
+ * @return array $mapping_arr - return the array which contains the mapping_arr[name]=value from the content of the map
*/
function getSavedMappingContent($mapid)
{
Modified: vtigercrm/trunk/modules/Import/UsersLastImport.php
==============================================================================
--- vtigercrm/trunk/modules/Import/UsersLastImport.php (original)
+++ vtigercrm/trunk/modules/Import/UsersLastImport.php Fri Jul 14 03:07:31 2006
@@ -65,6 +65,7 @@
/** function used to delete ie., update the deleted as 1 in vtiger_users_last_import table
* @param int $user_id - user id to whom's last imported records to delete
+ * @return void
*/
function mark_deleted_by_user_id($user_id)
{
@@ -75,7 +76,7 @@
/** function used to get the list query of the imported records
* @param reference &$order_by - reference of the variable order_by to add with the query
* @param reference &$where - where condition to add with the query
- * return string $query - list query to get the imported records list with the passed where and order by
+ * @return string $query - return the list query to get the imported records list
*/
function create_list_query(&$order_by, &$where)
{
@@ -195,7 +196,7 @@
/** function used to delete (update deleted=1 in crmentity table) the last imported records of the current user
* @param int $user_id - user id, whose last imported records want to be deleted
- * return int $count - number of total deleted records (contacts, accounts, opportunities, leads and products)
+ * @return int $count - return the number of total deleted records (contacts, accounts, opportunities, leads and products)
*/
function undo($user_id)
{
@@ -212,7 +213,7 @@
/** function used to delete (update deleted=1 in crmentity table) the last imported contacts of the current user
* @param int $user_id - user id, whose last imported contacts want to be deleted
- * return int $count - number of deleted contacts
+ * @return int $count - return the number of deleted contacts
*/
function undo_contacts($user_id)
{
@@ -239,7 +240,7 @@
/** function used to delete (update deleted=1 in crmentity table) the last imported leads of the current user
* @param int $user_id - user id, whose last imported leads want to be deleted
- * return int $count - number of deleted leads
+ * @return int $count - return the number of deleted leads
*/
function undo_leads($user_id)
{
@@ -266,7 +267,7 @@
/** function used to delete (update deleted=1 in crmentity table) the last imported accounts of the current user
* @param int $user_id - user id, whose last imported accounts want to be deleted
- * return int $count - number of deleted accounts
+ * @return int $count - return the number of deleted accounts
*/
function undo_accounts($user_id)
{
@@ -294,7 +295,7 @@
/** function used to delete (update deleted=1 in crmentity table) the last imported potentials of the current user
* @param int $user_id - user id, whose last imported potentials want to be deleted
- * return int $count - number of deleted potentials
+ * @return int $count - return the number of deleted potentials
*/
function undo_opportunities($user_id)
{
@@ -322,7 +323,7 @@
/** function used to delete (update deleted=1 in crmentity table) the last imported products of the current user
* @param int $user_id - user id, whose last imported products want to be deleted
- * return int $count - number of deleted products
+ * @return int $count - return the number of deleted products
*/
function undo_products($user_id)
{
Modified: vtigercrm/trunk/modules/Import/parse_utils.php
==============================================================================
--- vtigercrm/trunk/modules/Import/parse_utils.php (original)
+++ vtigercrm/trunk/modules/Import/parse_utils.php Fri Jul 14 03:07:31 2006
@@ -23,7 +23,7 @@
* @param character $delimiter - delimiter of the csv file
* @param int $max_lines - maximum number of lines to parse
* @param int $has_header - if the file has header then 1 otherwise 0
- * return array $ret_array which will be "rows"=>&$rows, "field_count"=>$field_count where as &rows is the reference of rows which contains all the parsed rows and $field_count is the number of fields available per row
+ * @return array $ret_array - return an array which will be "rows"=>&$rows, "field_count"=>$field_count where as &rows is the reference of rows which contains all the parsed rows and $field_count is the number of fields available per row
*/
function parse_import($file_name,$delimiter,$max_lines,$has_header)
{
@@ -86,7 +86,7 @@
* @param character $delimiter - delimiter of the csv file
* @param int $max_lines - maximum number of lines to parse
* @param int $has_header - if the file has header then 1 otherwise 0
- * return array $ret_array which will be "rows"=>&$rows, "field_count"=>$field_count where as &rows is the reference of rows which contains all the parsed rows and $field_count is the number of fields available per row
+ * @return array $ret_array - return an array which will be "rows"=>&$rows, "field_count"=>$field_count where as &rows is the reference of rows which contains all the parsed rows and $field_count is the number of fields available per row
*/
function parse_import_act($file_name,$delimiter,$max_lines,$has_header)
{
Modified: vtigercrm/trunk/modules/Migration/Migration.php
==============================================================================
--- vtigercrm/trunk/modules/Migration/Migration.php (original)
+++ vtigercrm/trunk/modules/Migration/Migration.php Fri Jul 14 03:07:31 2006
@@ -51,6 +51,7 @@
* @param string $mysql_username - old database mysql user name
* @param string $mysql_password - old database mysql password
* @param string $dbname - old database name
+ * @return void
*/
function setOldDatabaseParams($hostname,$mysql_port,$mysql_username,$mysql_password,$dbname)
{
@@ -68,6 +69,7 @@
* @param string $mysql_username - new database mysql user name
* @param string $mysql_password - new database mysql password
* @param string $dbname - new database name
+ * @return void
*/
function setNewDatabaseParams($hostname,$mysql_port,$mysql_username,$mysql_password,$dbname)
{
@@ -85,6 +87,7 @@
* @param string $mysql_username - mysql user name
* @param string $mysql_password - mysql password
* @param string $dbname - database name
+ * @return string $dump_filename - return the dump filename
*/
function takeDatabaseDump($host_name,$mysql_port,$mysql_username,$mysql_password,$dbname)
{
@@ -132,6 +135,7 @@
/** function used to drop the database
* @param object $conn - adodb object which is connected with the current(new) database
* @param string $dbname - database name which we want to drop
+ * @return void
*/
function dropDatabase($conn,$dbname)
{
@@ -145,6 +149,7 @@
/** function used to create the database
* @param object $conn - adodb object which is connected with the current(new) database
* @param string $dbname - database name which we want to drop
+ * @return void
*/
function createDatabase($conn,$dbname)
{
@@ -165,6 +170,7 @@
* @param string $mysql_password - mysql password
* @param string $dbname - database name to which we want to apply the dump
* @param string $dumpfile - dump file which contains the data dump of a database
+ * @return void
*/
function applyDumpData($host_name,$mysql_port,$mysql_username,$mysql_password,$dbname,$dumpfile)
{
@@ -205,7 +211,7 @@
/** function used to get the tabid
* @param string $module - module to which we want to get the tabid
- * return int $tabid - tabid of the module
+ * @return int $tabid - return the tabid of the module
*/
function localGetTabID($module)
{
@@ -219,7 +225,7 @@
}
/** function used to get the table count of the new database
- * return int $tables - number of tables available in the new database
+ * @return int $tables - return the number of tables available in the new database
*/
function getTablesCountInNewDatabase()
{
@@ -232,7 +238,7 @@
}
/** function used to get the table count of the old database
- * return int $tables - number of tables available in the old database
+ * @return int $tables - return the number of tables available in the old database
*/
function getTablesCountInOldDatabase()
{
@@ -246,6 +252,7 @@
/** function used to modify the database from old version to match with new version
* @param object $conn - adodb object which is connected with the current(new) database
+ * @return void
*/
function modifyDatabase($conn)
{
@@ -273,6 +280,7 @@
* @param int $same_databases - 1 if both databases are same otherwise 0
* @param string $option - selected migration option (dbsource or dumpsource)
* @param string $old_dump_file_name - dump file name of the old database which is optional when we use dbsource
+ * @return void
*/
function migrate($same_databases, $option, $old_dump_file_name='')
{
More information about the vtigercrm-commits
mailing list