YetiForceCompany / YetiForceCRM

modules/OSSEmployees/OSSEmployees.php

Doc Comments +7 added lines

@@ -149,6 +149,10 @@ 
 		return $hierarchy;
 	}
 
+	/**
+	 * @param integer $id
+	 * @param integer[] $encountered_accounts
+	 */
 	public function __getParentEmployees($id, &$parent_accounts, &$encountered_accounts)
 	{
 		$adb = PearDatabase::getInstance();
@@ -200,6 +204,9 @@ 
 		return $parent_accounts;
 	}
 
+	/**
+	 * @param integer $id
+	 */
 	public function __getChildEmployees($id, &$child_accounts, $depth)
 	{
 		$adb = PearDatabase::getInstance();

modules/PriceBooks/PriceBooks.php

Doc Comments +1 added lines, -1 removed lines

@@ -197,7 +197,7 @@
 
 	/** 	function used to get whether the pricebook has related with a product or not
 	 * 	@param int $id - product id
-	 * 	@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
+	 * 	@return boolean|null 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
 	 */
 	public function get_pricebook_noproduct($id)
 	{

modules/Products/Products.php

Doc Comments +3 added lines, -2 removed lines

@@ -192,6 +192,9 @@ 
 		$this->db->pquery($query, $params);
 	}
 
+	/**
+	 * @param string $module
+	 */
 	public function insertIntoAttachment($id, $module)
 	{
 		$adb = PearDatabase::getInstance();
@@ -556,8 +559,6 @@ 
 	}
 
 	/** 	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
 	 */
 	public function product_novendor()
 	{

modules/Reports/ReportRun.php

Doc Comments +9 added lines

@@ -103,6 +103,9 @@ 
 		$this->customTables[] = $table;
 	}
 
+	/**
+	 * @param ReportRunQueryDependencyMatrix $dependencies
+	 */
 	public function requireTable($table, $dependencies = null)
 	{
 
@@ -782,6 +785,7 @@ 
 	/** Function to get field that is to be compared in query form for the given Comparator and field
 	 *  @ param $field : field
 	 *  returns the value for the comparator
+	 * @param string $field
 	 */
 	public function getFilterComparedField($field)
 	{
@@ -2308,6 +2312,11 @@ 
 	 * 		HTML strings for
 	 */
 	// Performance Optimization: Added parameter directOutput to avoid building big-string!
+
+	/**
+	 * @param string $outputformat
+	 * @param string $filtersql
+	 */
 	public function GenerateReport($outputformat, $filtersql, $directOutput = false, $startLimit = false, $endLimit = false)
 	{
 		$adb = PearDatabase::getInstance();

modules/Reports/Reports.php

Doc Comments +1 added lines

@@ -387,6 +387,7 @@
 	 *  This function accepts the folderid
 	 *  This Generates the Reports under each Reports module
 	 *  This Returns a HTML sring
+	 * @param boolean $rpt_fldr_id
 	 */
 	public function sgetRptsforFldr($rpt_fldr_id, $paramsList = false)
 	{

modules/Reports/ScheduledReports.php

Doc Comments +3 added lines

@@ -340,6 +340,9 @@
 		return $rolesAndSubHTML;
 	}
 
+	/**
+	 * @param Users $user
+	 */
 	public static function getScheduledReports($adb, $user)
 	{
 

modules/Users/Users.php

Doc Comments +13 added lines, -6 removed lines

@@ -214,7 +214,6 @@ 
 
 	/**
 	 * @return string encrypted password for storage in DB and comparison against DB password.
-	 * @param string $user_name - Must be non null and at least 2 characters
 	 * @param string $user_password - Must be non null and at least 1 character.
 	 * @desc Take an unencrypted username and password and return the encrypted password
 	 * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc..
@@ -304,7 +303,7 @@ 
 	/**
 	 * Checks the config.php AUTHCFG value for login type and forks off to the proper module
 	 *
-	 * @param string $user_password - The password of the user to authenticate
+	 * @param string $userPassword - The password of the user to authenticate
 	 * @return true if the user is authenticated, false otherwise
 	 */
 	public function doLogin($userPassword)
@@ -454,7 +453,6 @@ 
 	}
 
 	/**
-	 * @param string $user name - Must be non null and at least 1 character.
 	 * @param string $userPassword - Must be non null and at least 1 character.
 	 * @param string $newPassword - Must be non null and at least 1 character.
 	 * @return boolean - If passwords pass verification and query succeeds, return true, else return false.
@@ -513,6 +511,9 @@ 
 		return true;
 	}
 
+	/**
+	 * @param string $password
+	 */
 	public function verifyPassword($password)
 	{
 		$query = "SELECT user_name,user_password,crypt_type FROM {$this->table_name} WHERE id=?";
@@ -874,7 +875,7 @@ 
 	}
 
 	/** Function to insert values into the attachment table
-	 * @param $id -- entity id:: Type integer
+	 * @param integer $id -- entity id:: Type integer
 	 * @param $module -- module:: Type varchar
 	 */
 	public function insertIntoAttachment($id, $module)
@@ -894,7 +895,7 @@ 
 
 	/** Function to retreive the user info of the specifed user id The user info will be available in $this->column_fields array
 	 * @param $record -- record id:: Type integer
-	 * @param $module -- module:: Type varchar
+	 * @param string $module -- module:: Type varchar
 	 */
 	public function retrieve_entity_info($record, $module)
 	{
@@ -1139,6 +1140,9 @@ 
 		return $return_array;
 	}
 
+	/**
+	 * @param string $home_string
+	 */
 	public function getDefaultHomeModuleVisibility($home_string, $inVal)
 	{
 		$homeModComptVisibility = 1;
@@ -1152,6 +1156,9 @@ 
 		return $homeModComptVisibility;
 	}
 
+	/**
+	 * @param string $inVal
+	 */
 	public function insertUserdetails($inVal)
 	{
 		$adb = PearDatabase::getInstance();
@@ -1237,7 +1244,7 @@ 
 	}
 
 	/** function to save the order in which the modules have to be displayed in the home page for the specified user id
-	 * @param $id -- user id:: Type integer
+	 * @param integer $id -- user id:: Type integer
 	 */
 	public function saveHomeStuffOrder($id)
 	{

modules/Vtiger/models/ModuleMeta.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
 
 	/**
 	 * Functions returns webservices meta object
-	 * @return webservices meta
+	 * @return boolean meta
 	 */
 	public function getMeta()
 	{

vtlib/Vtiger/Block.php

Doc Comments +4 added lines, -1 removed lines

@@ -78,6 +78,7 @@ 
 	/**
 	 * Create vtiger CRM block
 	 * @access private
+	 * @param boolean $moduleInstance
 	 */
 	public function __create($moduleInstance)
 	{
@@ -150,7 +151,8 @@ 
 	/**
 	 * Add field to this block
 	 * @param Field Instance of field to add to this block.
-	 * @return Reference to this block instance
+	 * @param Field $fieldInstance
+	 * @return Block to this block instance
 	 */
 	public function addField($fieldInstance)
 	{
@@ -226,6 +228,7 @@ 
 	 * Delete all blocks associated with module
 	 * @param Module Instnace of module to use
 	 * @param Boolean true to delete associated fields, false otherwise
+	 * @param ModuleBasic $moduleInstance
 	 * @access private
 	 */
 	static function deleteForModule($moduleInstance, $recursive = true)