adamjakab / SuiteCRM

include/SugarFields/Fields/Base/SugarFieldBase.php

Doc Comments +9 added lines

@@ -114,11 +114,17 @@ 
     }
 
 
+    /**
+     * @return string
+     */
     public function unformatField($formattedField, $vardef){
         // The base field doesn't do any formatting, so override it in subclasses for more specific actions
         return $formattedField;
     }
 
+    /**
+     * @param string $view
+     */
     function getSmartyView($parentFieldArray, $vardef, $displayParams, $tabindex = -1, $view){
     	$this->setup($parentFieldArray, $vardef, $displayParams, $tabindex);
 
@@ -376,6 +382,9 @@ 
 
     }
 
+    /**
+     * @param string $fieldType
+     */
     protected function getAccessKey($vardef, $fieldType = null, $module = null) {
         global $app_strings;
 

include/SugarFields/Fields/Bool/SugarFieldBool.php

Doc Comments +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
 class SugarFieldBool extends SugarFieldBase {
 	/**
 	 *
-	 * @return The html for a drop down if the search field is not 'my_items_only' or a dropdown for all other fields.
+	 * @return string html for a drop down if the search field is not 'my_items_only' or a dropdown for all other fields.
 	 *			This strange behavior arises from the special needs of PM. They want the my items to be checkboxes and all other boolean fields to be dropdowns.
 	 * @author Navjeet Singh
 	 * @param $parentFieldArray -

include/SugarFields/Fields/Collection/ViewSugarFieldCollection.php

Doc Comments +9 added lines

@@ -351,6 +351,10 @@ 
      * Check if the template is cached
      * return a bool
      */
+
+    /**
+     * @param string $cacheRowFile
+     */
     function checkTemplate($cacheRowFile){
         if(inDeveloperMode() || !empty($_SESSION['developerMode'])){
             return false;
@@ -502,6 +506,11 @@ 
 
 
 
+    /**
+     * @param string $view
+     *
+     * @return string
+     */
     function findTemplate($view){
         static $tplCache = array();
 

include/SugarFields/Fields/Currency/SugarFieldCurrency.php

Doc Comments +2 added lines, -3 removed lines

@@ -102,9 +102,8 @@
     /**
      * format the currency field based on system locale values for currency
      * Note that this may be different from the precision specified in the vardefs.
-     * @param string $rawfield value of the field
-     * @param string $somewhere vardef for the field being processed
-     * @return number formatted according to currency settings
+     * @param string $rawField value of the field
+     * @return string formatted according to currency settings
      */
     public function formatField($rawField, $vardef)
     {

include/SugarFields/Fields/Enum/SugarFieldEnum.php

Doc Comments +1 added lines

@@ -94,6 +94,7 @@
     
     /**
      * @see SugarFieldBase::importSanitize()
+     * @param string $value
      */
     public function importSanitize(
         $value,

include/SugarFields/Fields/Image/SugarFieldImage.php

Doc Comments +3 added lines

@@ -112,6 +112,9 @@
 
     }
 
+    /**
+     * @param UploadFile $upload_file
+     */
     public function verify_image($upload_file){
         global $sugar_config;
 

include/SugarFields/Parsers/DetailViewMetaParser.php

Doc Comments +1 added lines, -1 removed lines

@@ -66,7 +66,7 @@
 /**
  * parse
  * 
- * @param $filePath The file path of the HTML file to parse
+ * @param string $filePath The file path of the HTML file to parse
  * @param $vardefs The module's vardefs
  * @param $moduleDir The module's directory
  * @param $merge boolean value indicating whether or not to merge the parsed contents

include/SugarFields/Parsers/MetaParser.php

Doc Comments +23 added lines, -7 removed lines

@@ -96,7 +96,7 @@ 
 /**
  * getFormElementsNames
  * Parses for the name values of input, select, textarea types from string content
- * @param $contents The String contents to parse
+ * @param string $contents The String contents to parse
  * @return $matches Array of name/value pairs
  */
 function getFormElementsNames($contents) {
@@ -108,7 +108,7 @@ 
 /**
  * getTagAttribute
  * Returns the name/value of a tag attribute where name is set to $name
- * @param $name The name of the attribute
+ * @param string $name The name of the attribute
  * @param $contents The contents to parse
  * @param $filter Option regular expression to filter value
  * @return Array of name/value for matching attribute
@@ -163,7 +163,7 @@ 
  * and method call getElementsByType("<td>", $contents) returns
  * "<td>Text <table><tr><td>a</td></tr></table></td>"
  *
- * @param $type The type of element to parse out and return
+ * @param string $type The type of element to parse out and return
  * @return a tag element format Array
  */
 function getElementsByType($type, $contents) {
@@ -208,6 +208,7 @@ 
 /**
  * getElementValue
  *
+ * @param string $type
  */
 function getElementValue($type, $contents, $filter = "(.*?)") {
    $exp = "'<".$type."[^>]*?>".$filter."</".$type."[^>]*?>'si";
@@ -244,7 +245,7 @@ 
  * Returns the highest number of <td>...</td> blocks within a <tr>...</tr> block.
  * @param $contents The table contents to parse
  * @param $filter Optional filter to parse for an attribute within the td block.
- * @return The maximum column count
+ * @return integer maximum column count
  */
 function getMaxColumns($contents, $filter) {
    preg_match_all("'(<tr[^>]*?>)(.*?)(</tr[^>]*?>)'si", $contents, $matches, PREG_SET_ORDER);
@@ -281,6 +282,9 @@ 
  * trimHTML
  * This function removes the \r (return), \n (newline) and \t (tab) markup from string
  */
+/**
+ * @param string $contents
+ */
 function trimHTML($contents) {
    $contents = str_replace(array("\r"), array(""), $contents);
    $contents = str_replace(array("\n"), array(""), $contents);
@@ -342,6 +346,9 @@ 
 
 }
 
+/**
+ * @param string $javascript
+ */
 static function parseDelimiters($javascript) {
 	$newJavascript = '';
 	$scriptLength = strlen($javascript);
@@ -441,7 +448,7 @@ 
  * dirList
  * Utility method to list all the files in a given directory.
  *
- * @param $directory The directory to scan
+ * @param string $directory The directory to scan
  * @return $results The files in the directory that were found
  */
 function dirList ($directory) {
@@ -496,6 +503,9 @@ 
    return null;
 }
 
+/**
+ * @param string $moduleDir
+ */
 function applyPreRules($moduleDir, $panels) {
    if(file_exists("include/SugarFields/Parsers/Rules/".$moduleDir."ParseRule.php")) {
 	  require_once("include/SugarFields/Parsers/Rules/".$moduleDir."ParseRule.php");
@@ -506,6 +516,9 @@ 
    return $panels;
 }
 
+/**
+ * @param string $moduleDir
+ */
 function applyRules($moduleDir, $panels) {
    return $this->applyPostRules($moduleDir, $panels);
 }
@@ -537,6 +550,9 @@ 
    return $panels;
 }
 
+/**
+ * @param string $moduleDir
+ */
 function createFileContents($moduleDir, $panels, $templateMeta=array(), $htmlFilePath) {
 
 $header = "<?php\n\n";
@@ -587,7 +603,7 @@ 
  * mergePanels
  * This function merges the $panels Array against the $masterCopy's meta data definition
  * @param $panels meta data Array to merge
- * @param $moduleDir Directory name of the module
+ * @param string $moduleDir Directory name of the module
  * @param $masterCopy file path to the meta data master copy
  * @return Array of merged $panel definition
  */
@@ -680,7 +696,7 @@ 
  * mergeTemplateMeta
  * This function merges the $templateMeta Array against the $masterCopy's meta data definition
  * @param $templateMeta meta data Array to merge
- * @param $moduleDir Directory name of the module
+ * @param string $moduleDir Directory name of the module
  * @param $masterCopy file path to the meta data master copy
  * @return Array of merged $templateMeta definition
  */

include/SugarFields/Parsers/Rules/AddressRule.php

Doc Comments +2 added lines, -2 removed lines

@@ -113,7 +113,7 @@ 
  * have not been moved from the address panel
  * 
  * @param $addressPanel Array of address panel contents
- * @param $suffix The address suffix (billing, shipping, primary, alternate) to check for
+ * @param string $suffix The address suffix (billing, shipping, primary, alternate) to check for
  * @return boolean
  */
 function hasAddressFieldsIntact($addressPanel, $suffix) {
@@ -135,7 +135,7 @@ 
  * This function scans the panels and locates the street address field for the given key
  * and replaces the Array definition (from the merging process) with a String value.
  * @param $panels Array of the view's panels
- * @param $street String key value of the street to search for
+ * @param string $street String key value of the street to search for
  * @returns $panels Array of view's panels with street value substituted
  */
 function removeStreetFieldOverride($panels, $street) {