adamjakab / SuiteCRM

modules/Contacts/ContactFormBase.php

Doc Comments +4 added lines, -1 removed lines

@@ -61,7 +61,7 @@ 
  * @see checkForDuplicates (method), ContactFormBase.php, LeadFormBase.php, ProspectFormBase.php
  * @param $focus sugarbean
  * @param $prefix String value of prefix that may be present in $_POST variables
- * @return SQL String of the query that should be used for the initial duplicate lookup check
+ * @return string String of the query that should be used for the initial duplicate lookup check
  */
 public function getDuplicateQuery($focus, $prefix='')
 {
@@ -645,6 +645,9 @@ 
 	}
 }
 
+/**
+ * @param string $return_id
+ */
 function handleRedirect($return_id){
 	if(isset($_POST['return_module']) && $_POST['return_module'] != "") {
 		$return_module = urlencode($_POST['return_module']);

modules/Contacts/updatePortal.php

Doc Comments +3 added lines

@@ -48,6 +48,9 @@
         }
     }
 
+ /**
+  * @param string $emailSubject
+  */
  function sendEmail($emailTo, $emailSubject, $emailBody, $altemailBody, SugarBean $relatedBean = null)
 	{
 	   	require_once('modules/Emails/Email.php');

modules/Currencies/Currency.php

Doc Comments +8 added lines, -2 removed lines

@@ -90,7 +90,7 @@ 
      *
      * @param $amount The currency amount to convert to US Dollars
      * @param $precision The rounding precision scale
-     * @return currency value in US Dollars from conversion
+     * @return double value in US Dollars from conversion
      */
 	function convertToDollar($amount, $precision = 6) {
 		return round(($amount / $this->conversion_rate), $precision);
@@ -103,7 +103,7 @@ 
      *
      * @param $amount The currency amount in US Dollars
      * @param $precision The rounding precision scale
-     * @return currency value from US Dollar conversion
+     * @return double value from US Dollar conversion
      */
 	function convertFromDollar($amount, $precision = 6){
 		return round(($amount * $this->conversion_rate), $precision);
@@ -174,6 +174,9 @@ 
 		return $list_form;
 	}
 
+	/**
+	 * @return integer
+	 */
 	function retrieve_id_by_name($name) {
 	 	$query = "select id from currencies where name='$name' and deleted=0;";
 	 	$result = $this->db->query($query);
@@ -405,6 +408,9 @@ 
 
 
 
+/**
+ * @param boolean $symbol_space
+ */
 function format_place_symbol($amount, $symbol, $symbol_space) {
 	if($symbol != '') {
 		if($symbol_space == true) {

modules/DynamicFields/DynamicField.php

Doc Comments +18 added lines, -7 removed lines

@@ -99,7 +99,7 @@ 
     *
     * @param STRING $module
     * @param boolean saveCache Boolean value indicating whether or not to pass saveCache value to saveToVardef, defaults to true
-    * @return unknown
+    * @return boolean
     */
     function buildCache($module = false, $saveCache=true) {
         //We can't build the cache while installing as the required database tables may not exist.
@@ -308,6 +308,9 @@ 
 
     }
 
+   /**
+    * @param string $joinTableAlias
+    */
    function getRelateJoin($field_def, $joinTableAlias, $withIdName = true) {
         if (empty($field_def['type']) || $field_def['type'] != "relate") {
             return false;
@@ -465,7 +468,6 @@ 
     /**
      * Deletes the field from fields_meta_data and drops the database column then it rebuilds the cache
      * Use the widgets get_db_modify_alter_table() method to get the table sql - some widgets do not need any custom table modifications
-     * @param STRING $name - field name
      */
     function deleteField($widget){
         require_once('modules/DynamicFields/templates/Fields/TemplateField.php');
@@ -525,7 +527,7 @@ 
     /**
      * Adds a custom field using a field object
      *
-     * @param Field Object $field
+     * @param Field TemplateField $field
      * @return boolean
      */
     function addFieldObject(&$field){
@@ -605,6 +607,9 @@ 
         return true;
     }
 
+    /**
+     * @param string[] $column_fields
+     */
     function saveExtendedAttributes($field, $column_fields)
     {
             require_once ('modules/ModuleBuilder/parsers/StandardField.php') ;
@@ -686,6 +691,9 @@ 
         }
     }
 
+    /**
+     * @param TemplateField $field
+     */
     protected function removeVardefExtension($field)
     {
         $file_loc = "$this->base_path/sugarfield_{$field->name}.php";
@@ -710,12 +718,12 @@ 
      * @param unknown_type $ext1
      * @param unknown_type $ext2
      * @param unknown_type $ext3
-     * @param unknown_type $audited
-     * @param unknown_type $inline_edit
-     * @param unknown_type $mass_update
+     * @param integer $audited
+     * @param integer $inline_edit
+     * @param integer $mass_update
      * @param unknown_type $ext4
      * @param unknown_type $help
-     * @param unknown_type $duplicate_merge
+     * @param integer $duplicate_merge
      * @param unknown_type $comment
      * @return boolean
      */
@@ -983,6 +991,9 @@ 
 
     }
 
+    /**
+     * @param string $type
+     */
     function getAllFieldsView($view, $type){
          require_once ('modules/DynamicFields/FieldCases.php');
          $results = array();

modules/DynamicFields/templates/Fields/TemplateField.php

Doc Comments +3 added lines

@@ -309,6 +309,9 @@
 		return $GLOBALS['db']->getHelper()->addColumnSQL($table, $this->get_field_def(), true);
 	}
 
+	/**
+	 * @param string $table
+	 */
 	function get_db_delete_alter_table($table)
 	{
 		return $GLOBALS['db']->getHelper()->dropColumnSQL(

modules/DynamicFields/templates/Fields/TemplateRelatedTextField.php

Doc Comments +1 added lines, -1 removed lines

@@ -231,7 +231,7 @@
     /**
      * Delete label of id field
      * @param TemplateField $fieldId
-     * @param $df
+     * @param DynamicField $df
      */
     protected function deleteIdLabel(TemplateField $fieldId, $df)
     {

modules/EAPM/views/view.edit.php

Doc Comments +1 added lines

@@ -107,6 +107,7 @@
 
     /**
 	 * @see SugarView::getModuleTitleIconPath()
+	 * @param string $module
 	 */
 	protected function getModuleTitleIconPath($module) 
     {

modules/EmailMan/EmailMan.php

Doc Comments +8 added lines, -1 removed lines

@@ -131,6 +131,9 @@ 
 
     } // if
 
+    /**
+     * @param string $order_by
+     */
     function create_queue_items_query($order_by, $where,$filter=array(),$params=array(), $show_deleted = 0,$join_type='', $return_array = false,$parentbean=null, $singleSelect = false) {
 
 		if ($return_array) {
@@ -262,6 +265,10 @@ 
     }
 
 
+	/**
+	 * @param string $email_type
+	 * @param string $activity_type
+	 */
 	function set_as_sent($email_address, $delete= true,$email_id=null, $email_type=null,$activity_type=null){
 
 		global $timedate;
@@ -308,7 +315,7 @@ 
      * @param string $subject email subject
      * @param string $body_text Email Body Text
      * @param string $body_html Email Body HTML
-     * @param string $campaign_name Campaign Name
+     * @param string $campagin_name Campaign Name
      * @param string from_address Email address of the sender, usually email address of the configured inbox.
      * @param string sender_id If of the user sending the campaign.
      * @param array  macro_nv array of name value pair, one row for each replacable macro in email template text.

modules/Emails/Email.php

Doc Comments +11 added lines, -4 removed lines

@@ -1158,6 +1158,10 @@ 
 		}
 	}
 
+	/**
+	 * @param string $id
+	 * @param string $type
+	 */
 	function linkEmailToAddress($id, $type) {
 		// TODO: make this update?
 		$q1 = "SELECT * FROM emails_email_addr_rel WHERE email_id = '{$this->id}' AND email_address_id = '{$id}' AND address_type = '{$type}' AND deleted = 0";
@@ -1598,6 +1602,9 @@ 
 	 * @param array addrs_ids (from contacts)
 	 * @param array addrs_names (from contacts);
 	 * @param array addrs_emails (from contacts);
+	 * @param string $addrs_ids
+	 * @param string $addrs_names
+	 * @param string $addrs_emails
 	 * @return array Parsed assoc array to feed to PHPMailer
 	 */
 	function parse_addrs($addrs, $addrs_ids, $addrs_names, $addrs_emails) {
@@ -1940,6 +1947,7 @@ 
 	 * @param object mail SugarPHPMailer object
 	 * @param string mailer_id
 	 * @param string ieId
+	 * @param SugarPHPMailer $mail
 	 * @return object mail SugarPHPMailer object
 	 */
 	function setMailer($mail, $mailer_id='', $ieId='') {
@@ -2645,7 +2653,7 @@ 
      * Determine if an imported email has an attachment by examining the relationship to notes.
      *
      * @param string $id
-     * @return boolean
+     * @return integer
      */
     function doesImportedEmailHaveAttachment($id)
 	{
@@ -3075,8 +3083,7 @@ 
         /**
          * Convert reference to inline image (stored as Note) to URL link
          * Enter description here ...
-         * @param string $note ID of the note
-         * @param string $ext type of the note
+         * @param string $noteId ID of the note
          */
         public function cid2Link($noteId, $noteType)
         {
@@ -3144,7 +3151,7 @@ 
      * Bugs 50972, 50973
      * Set the field def back to the way it was prior to modification
      *
-     * @param $field
+     * @param string $field
      * @return void
      */
     public function revertFieldNullable($field)