YetiForceCompany / YetiForceCRM

include/CRMEntity.php

Doc Comments +9 added lines, -3 removed lines

@@ -374,6 +374,11 @@ 
 	}
 
 	// Function which returns the value based on result type (array / ADODB ResultSet)
+
+	/**
+	 * @param integer $index
+	 * @param string $columnname
+	 */
 	private function resolve_query_result_value($result, $index, $columnname)
 	{
 		$adb = PearDatabase::getInstance();
@@ -633,7 +638,7 @@ 
 	}
 
 	/** Function to delete a record in the specifed table
-	 * @param $table_name -- table name:: Type varchar
+	 * @param string $table_name -- table name:: Type varchar
 	 * The function will delete a record .The id is obtained from the class variable $this->id and the columnname got from $this->tab_name_index[$table_name]
 	 */
 	public function deleteRelation($table_name)
@@ -817,6 +822,7 @@ 
 
 	/** Function to saves the values in all the tables mentioned in the class variable $tab_name for the specified module
 	 * @param $module -- module:: Type varchar
+	 * @param string $module_name
 	 */
 	public function save($module_name, $fileid = '')
 	{
@@ -2562,10 +2568,10 @@ 
 
 	/**
 	 *
-	 * @param <type> $module
-	 * @param <type> $user
+	 * @param Users $user
 	 * @param <type> $parentRole
 	 * @param <type> $userGroups
+	 * @param string $tableName
 	 */
 	protected function setupTemporaryTable($tableName, $tabId, $user, $parentRole, $userGroups)
 	{

include/Loader.php

Doc Comments +1 added lines, -1 removed lines

@@ -98,7 +98,7 @@
 
 	/**
 	 * Function to get the class name of a given Component, of given Type, for a given Module
-	 * @param <String> $componentType
+	 * @param string $componentType
 	 * @param <String> $componentName
 	 * @param <String> $moduleName
 	 * @return <String> Required Class Name

include/main/WebUI.php

Doc Comments +9 added lines

@@ -54,6 +54,9 @@ 
 		return $user;
 	}
 
+	/**
+	 * @param Vtiger_Request $request
+	 */
 	protected function triggerCheckPermission($handler, $request)
 	{
 		$moduleName = $request->getModule();
@@ -73,6 +76,9 @@ 
 		throw new \Exception\NoPermitted('LBL_NOT_ACCESSIBLE');
 	}
 
+	/**
+	 * @param Vtiger_Request $request
+	 */
 	protected function triggerPreProcess($handler, $request)
 	{
 		if ($request->isAjax()) {
@@ -82,6 +88,9 @@ 
 		$handler->preProcess($request);
 	}
 
+	/**
+	 * @param Vtiger_Request $request
+	 */
 	protected function triggerPostProcess($handler, $request)
 	{
 		if ($request->isAjax()) {

include/RelatedListView.php

Doc Comments +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
 
 /** 	Function to display the Products which are related to the PriceBook
  * 	@param string $query - query to get the list of products which are related to the current PriceBook
- * 	@param object $focus - PriceBook object which contains all the information of the current PriceBook
+ * 	@param PriceBooks $focus - PriceBook object which contains all the information of the current PriceBook
  * 	@param string $returnset - return_module, return_action and return_id which are sequenced with & to pass to the URL which is optional
  * 	return array $return_data which will be formed like array('header'=>$header,'entries'=>$entries_list) where as $header contains all the header columns and $entries_list will contain all the Product entries
  */

include/simplehtmldom/simple_html_dom.php

Doc Comments +35 added lines

@@ -120,6 +120,9 @@ 
 	public $tag_start = 0;
 	private $dom = null;
 
+	/**
+	 * @param simple_html_dom $dom
+	 */
 	public function __construct($dom)
 	{
 		$this->dom = $dom;
@@ -1553,6 +1556,10 @@ 
 }
 
 // parse attributes
+/**
+ * @param simple_html_dom_node $node
+ * @param string[] $space
+ */
 protected function parse_attr($node, $name, &$space)
 {
 // Per sourceforge: http://sourceforge.net/tracker/?func=detail&aid=3061408&group_id=218559&atid=1044037
@@ -1589,6 +1596,10 @@ 
 }
 
 // link node's parent
+/**
+ * @param simple_html_dom_node $node
+ * @param boolean $is_child
+ */
 protected function link_nodes(&$node, $is_child)
 {
 $node->parent = $this->parent;
@@ -1599,6 +1610,9 @@ 
 }
 
 // as a text node
+/**
+ * @param string $tag
+ */
 protected function as_text_node($tag)
 {
 $node = new simple_html_dom_node($this);
@@ -1609,12 +1623,18 @@ 
 return true;
 }
 
+/**
+ * @param string $chars
+ */
 protected function skip($chars)
 {
 $this->pos += strspn($this->doc, $chars, $this->pos);
 $this->char = ($this->pos < $this->size) ? $this->doc[$this->pos] : null; // next
 }
 
+/**
+ * @param string $chars
+ */
 protected function copy_skip($chars)
 {
 $pos = $this->pos;
@@ -1626,6 +1646,9 @@ 
 return substr($this->doc, $pos, $len);
 }
 
+/**
+ * @param string $chars
+ */
 protected function copy_until($chars)
 {
 $pos = $this->pos;
@@ -1635,6 +1658,9 @@ 
 return substr($this->doc, $pos, $len);
 }
 
+/**
+ * @param string $char
+ */
 protected function copy_until_char($char)
 {
 if ($this->char === null)
@@ -1655,6 +1681,9 @@ 
 return substr($this->doc, $pos_old, $pos - $pos_old);
 }
 
+/**
+ * @param string $char
+ */
 protected function copy_until_char_escape($char)
 {
 if ($this->char === null)
@@ -1686,6 +1715,9 @@ 
 
 // remove noise from html content
 // save the noise in the $this->noise array.
+/**
+ * @param string $pattern
+ */
 protected function remove_noise($pattern, $remove_tag = false)
 {
 global $debugObject;
@@ -1713,6 +1745,9 @@ 
 }
 
 // restore noise to html content
+/**
+ * @param string|null $text
+ */
 function restore_noise($text)
 {
 global $debugObject;

include/Tracker.php

Doc Comments +2 added lines

@@ -59,6 +59,8 @@
 	 * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
 	 * All Rights Reserved.
 	 * Contributor(s): ______________________________________..
+	 * @param string $item_id
+	 * @param string $item_summary
 	 */
 	public function track_view($user_id, $current_module, $item_id, $item_summary)
 	{

include/utils/ListViewUtils.php

Doc Comments +5 added lines

@@ -378,6 +378,11 @@
  * Returns an string value
  */
 
+/**
+ * @param string $url_qry
+ * @param string $module
+ * @param string $related_module
+ */
 function getRelatedTableHeaderNavigation($navigation_array, $url_qry, $module, $related_module, $recordid)
 {
 	$log = LoggerManager::getInstance();

include/utils/VTCacheUtils.php

Doc Comments +28 added lines

@@ -395,6 +395,9 @@ 
 	/** Report module information based on used. */
 	static $_reportmodule_infoperuser_cache = [];
 
+	/**
+	 * @param string $reportid
+	 */
 	static function lookupReport_Info($userid, $reportid)
 	{
 
@@ -406,6 +409,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $reportid
+	 */
 	static function updateReport_Info($userid, $reportid, $primarymodule, $secondarymodules, $reporttype, $reportname, $description, $folderid, $owner)
 	{
 		if (!isset(self::$_reportmodule_infoperuser_cache[$userid])) {
@@ -428,6 +434,9 @@ 
 	/** Report module sub-ordinate users information. */
 	static $_reportmodule_subordinateuserid_cache = [];
 
+	/**
+	 * @param string $reportid
+	 */
 	static function lookupReport_SubordinateUsers($reportid)
 	{
 		if (isset(self::$_reportmodule_subordinateuserid_cache[$reportid])) {
@@ -436,6 +445,9 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $reportid
+	 */
 	static function updateReport_SubordinateUsers($reportid, $userids)
 	{
 		self::$_reportmodule_subordinateuserid_cache[$reportid] = $userids;
@@ -444,6 +456,9 @@ 
 	/** Report module information based on used. */
 	static $_reportmodule_scheduledinfoperuser_cache = [];
 
+	/**
+	 * @param string $reportid
+	 */
 	static function lookupReport_ScheduledInfo($userid, $reportid)
 	{
 
@@ -455,6 +470,10 @@ 
 		return false;
 	}
 
+	/**
+	 * @param string $reportid
+	 * @param boolean $isScheduled
+	 */
 	static function updateReport_ScheduledInfo($userid, $reportid, $isScheduled, $scheduledFormat, $scheduledInterval, $scheduledRecipients, $scheduledTime)
 	{
 		if (!isset(self::$_reportmodule_scheduledinfoperuser_cache[$userid])) {
@@ -479,6 +498,9 @@ 
 		self::$_userSignature[$userName] = $signature;
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function getUserSignature($userName)
 	{
 		return self::$_userSignature[$userName];
@@ -491,6 +513,9 @@ 
 		self::$_userFullName[$userName] = $fullName;
 	}
 
+	/**
+	 * @return string
+	 */
 	public static function getUserFullName($userName)
 	{
 		return self::$_userFullName[$userName];
@@ -503,6 +528,9 @@ 
 		return self::$_report_field_bylabel[$module][$label];
 	}
 
+	/**
+	 * @param string $label
+	 */
 	public static function setReportFieldByLabel($module, $label, $fieldInfo)
 	{
 		self::$_report_field_bylabel[$module][$label] = $fieldInfo;

include/Webservices/DataTransform.php

Doc Comments +3 added lines

@@ -48,6 +48,9 @@
 		return $row;
 	}
 
+	/**
+	 * @param boolean $t
+	 */
 	public static function sanitizeData($newRow, $meta, $t = null)
 	{