adamjakab / SuiteCRM

include/json_config.php

Doc Comments +3 added lines

@@ -53,6 +53,9 @@
 class json_config {
 	var $global_registry_var_name = 'GLOBAL_REGISTRY';
 
+	/**
+	 * @param string $module
+	 */
 	function get_static_json_server($configOnly = true, $getStrings = false, $module = null, $record = null, $scheduler = false) {
 		global $current_user;
 		$str = '';

include/ListView/ListView.php

Doc Comments +34 added lines, -7 removed lines

@@ -105,6 +105,9 @@ 
 }
 
 
+/**
+ * @param string $xTemplateSection
+ */
 function processListView($seed, $xTemplateSection, $html_varName)
 {
     global $sugar_config;
@@ -232,8 +235,8 @@ 
 /**
  * @return void
  * @param unknown $data
- * @param unknown $xTemplateSection
- * @param unknown $html_varName
+ * @param string $xtemplateSection
+ * @param string $html_varName
  * @desc INTERNAL FUNCTION handles the rows
  */
  function process_dynamic_listview_rows($data,$parent_data, $xtemplateSection, $html_varName, $subpanel_def)
@@ -610,6 +613,9 @@ 
  * All Rights Reserved.
  * Contributor(s): ______________________________________.
 */
+ /**
+  * @param string $value
+  */
  function setHeaderText($value) {
     $this->header_text = $value;
 }
@@ -728,6 +734,9 @@ 
  * All Rights Reserved.
  * Contributor(s): ______________________________________.
 */
+ /**
+  * @param string $where
+  */
  function setQuery($where, $limit, $orderBy, $varName, $allowOrderByOveride=true) {
     $this->query_where = $where;
     if($this->getSessionVariable("query", "where") != $where) {
@@ -834,6 +843,9 @@ 
  * All Rights Reserved.
  * Contributor(s): ______________________________________.
 */
+ /**
+  * @param XTemplate $newXTemplate
+  */
  function setXTemplate($newXTemplate) {
     $this->xTemplate = $newXTemplate;
 }
@@ -852,6 +864,9 @@ 
  * All Rights Reserved.
  * Contributor(s): ______________________________________.
 */
+ /**
+  * @param string $name
+  */
  function xTemplateAssign($name, $value) {
 
         if(!isset($this->xTemplate)) {
@@ -906,6 +921,9 @@ 
  * All Rights Reserved.
  * Contributor(s): ______________________________________.
 */
+ /**
+  * @param string $varName
+  */
  function getSessionVariable($localVarName,$varName) {
     //Set any variables pass in through request first
     if(isset($_REQUEST[$this->getSessionVariableName($localVarName, $varName)])) {
@@ -961,7 +979,7 @@ 
 
     /**
 
-    * @return void
+    * @return string
     * @param unknown $localVarName
     * @param unknown $varName
     * @desc INTERNAL FUNCTION returns the session/query variable name
@@ -977,7 +995,7 @@ 
 
     * @return void
     * @param unknown $seed
-    * @param unknown $xTemplateSection
+    * @param unknown $xtemplateSection
     * @param unknown $html_varName
     * @desc INTERNAL FUNCTION Handles List Views using seeds that extend SugarBean
         $XTemplateSection is the section in the XTemplate file that should be parsed usually main
@@ -1169,8 +1187,7 @@ 
     }
     /**
     * @return void
-    * @param unknown $data
-    * @param unknown $xTemplateSection
+    * @param unknown $xtemplateSection
     * @param unknown $html_varName
     * @desc INTERNAL FUNCTION process the List Navigation
     * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
@@ -1550,7 +1567,7 @@ 
     /**
     * @return void
     * @param unknown $data
-    * @param unknown $xTemplateSection
+    * @param unknown $xtemplateSection
     * @param unknown $html_varName
     * @desc INTERNAL FUNCTION handles the rows
     * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
@@ -2036,6 +2053,10 @@ 
      * All Rights Reserved.
      * Contributor(s): ______________________________________.
      */
+
+     /**
+      * @param string $varName
+      */
      function setLocalSessionVariable($localVarName,$varName, $value) {
         $_SESSION[$localVarName."_".$varName] = $value;
      }
@@ -2046,6 +2067,12 @@ 
      * All Rights Reserved.
      * Contributor(s): ______________________________________.
      */
+
+ /**
+  * @param string $varName
+  *
+  * @return string
+  */
  function getLocalSessionVariable($localVarName,$varName) {
     if(isset($_SESSION[$localVarName."_".$varName])) {
         return $_SESSION[$localVarName."_".$varName];

include/ListView/ListViewData.php

Doc Comments +7 added lines, -3 removed lines

@@ -162,7 +162,8 @@ 
 	/**
 	 * based off of a base name it sets base, offset, and order by variable names to retrieve them from requests and sessions
 	 *
-	 * @param unknown_type $baseName
+	 * @param string $baseName
+	 * @param string $where
 	 */
 	function setVariableName($baseName, $where, $listviewName = null){
         global $timedate;
@@ -180,6 +181,9 @@ 
         $_SESSION[strtoupper($baseName) . "_DETAIL_NAV_HISTORY"] = false;
 	}
 
+	/**
+	 * @param string $main_query
+	 */
 	function getTotalCount($main_query){
 		if(!empty($this->count_query)){
 		    $count_query = $this->count_query;
@@ -605,8 +609,8 @@ 
      * generates the additional details values
      *
      * @param unknown_type $fields
-     * @param unknown_type $adFunction
-     * @param unknown_type $editAccess
+     * @param string $adFunction
+     * @param boolean $editAccess
      * @return array string to attach to field
      */
     function getAdditionalDetails($fields, $adFunction, $editAccess)

include/ListView/ListViewDisplay.php

Doc Comments +4 added lines

@@ -75,6 +75,10 @@
 		$this->lvd = new ListViewData();
 		$this->searchColumns = array () ;
 	}
+
+	/**
+	 * @param string $moduleDir
+	 */
 	function shouldProcess($moduleDir){
 		$searching = false;
 		$sessionSearchQuery = "{$moduleDir}2_QUERY_QUERY";

include/Localization/Localization.php

Doc Comments +1 added lines

@@ -122,6 +122,7 @@
 	 * abstraction of precedence
 	 * @param string prefName Name of preference to retrieve based on overrides
 	 * @param object user User in focus, default null (current_user)
+	 * @param string $prefName
 	 * @return string pref Most significant preference
 	 */
 	function getPrecedentPreference($prefName, $user=null, $sugarConfigPrefName = '') {

include/MassUpdate.php

Doc Comments +6 added lines

@@ -1151,6 +1151,9 @@ 
 		return $html;
 	}
 
+	/**
+	 * @param string $value
+	 */
 	function date_to_dateTime($field, $value) {
 		global $timedate;
 	    //Check if none was set
@@ -1180,6 +1183,9 @@ 
 	    return $value." ".$oldTime;
 	}
 
+	/**
+	 * @param string $value
+	 */
 	function checkClearField($field, $value) {
 	    if ($value == 1 && strpos($field, '_flag')) {
 	        $fName = substr($field, -5);

include/MVC/Controller/SugarController.php

Doc Comments +4 added lines, -1 removed lines

@@ -244,6 +244,7 @@ 
 
 	/**
 	 * Generic load method to load mapping arrays.
+	 * @param string $var
 	 */
 	private function loadMapping($var, $merge = false){
 		$$var = sugar_cache_retrieve("CONTROLLER_". $var . "_".$this->module);
@@ -469,7 +470,8 @@ 
 	/**
 	 * Determine if a given function exists on the objects
 	 * @param function - the function to check
-	 * @return true if the method exists on the object, false otherwise
+	 * @param string $function
+	 * @return boolean if the method exists on the object, false otherwise
 	 */
 	protected function hasFunction($function){
 		return method_exists($this, $function);
@@ -777,6 +779,7 @@ 
 
 	/**
 	 * getActionFilename
+	 * @param string $action
 	 */
 	public static function getActionFilename($action) {
 	   if(isset(self::$action_case_file[$action])) {

include/MVC/SugarApplication.php

Doc Comments +2 added lines, -1 removed lines

@@ -668,7 +668,6 @@ 
 	 * Redirect to another URL
 	 *
 	 * @access	public
-	 * @param	string	$url	The URL to redirect to
 	 */
  	public static function appendErrorMessage($error_message)
 	{
@@ -692,6 +691,8 @@ 
 	/**
 	 * Wrapper for the PHP setcookie() function, to handle cases where headers have
 	 * already been sent
+	 * @param string $name
+	 * @param string $domain
 	 */
 	public static function setCookie(
 	    $name,

include/MVC/View/SugarView.php

Doc Comments +6 added lines, -2 removed lines

@@ -1039,6 +1039,7 @@ 
      *
      * @param string option - the option that we want to know the valye of
      * @param bool default - what the default value should be if we do not find the option
+     * @param string $option
      *
      * @return bool - the value of the option
      */
@@ -1273,7 +1274,7 @@ 
     * Return the "breadcrumbs" to display at the top of the page
     *
     * @param  bool $show_help optional, true if we show the help links
-    * @return HTML string containing breadcrumb title
+    * @return string string containing breadcrumb title
     */
     public function getModuleTitle(
         $show_help = true
@@ -1446,6 +1447,9 @@ 
     	}
     }
 
+    /**
+     * @param string $module
+     */
     protected function getModuleTitleIconPath($module)
     {
     	$iconPath = "";
@@ -1496,7 +1500,7 @@ 
     /**
      * Fetch config values to be put into an array for JavaScript
      *
-     * @return array
+     * @return string[]
      */
     protected function getSugarConfigJS(){
         global $sugar_config;