Fix #8700 - Various problems in PHPDocs throughout the codebase.

Api/V8/Helper/ModuleListProvider.php

@@ -120,7 +120,8 @@ class ModuleListProvider
     }
 
     /**
-     * @param $actions
+     * @param mixed $moduleName
+     * @param mixed $actions
      * @return array
      */
     private function buildAccessArray($moduleName, $actions)
@@ -136,8 +137,8 @@ class ModuleListProvider
     }
 
     /**
-     * @param $level
-     * @param $module
+     * @param mixed $level
+     * @param mixed $module
      * @return bool
      */
     private function hasACL($level, $module)

ModuleInstall/PackageManager/ListViewPackages.php

@@ -69,8 +69,15 @@ class ListViewPackages extends ListViewSmarty
     /**
      * Override the setup method in ListViewSmarty since we are not passing in a bean
      *
-     * @param data  the data to display on the page
-     * @param file  the template file to parse
+     * @param mixed $data the data to display on the page
+     * @param mixed $file the template file to parse
+     * @param mixed $where
+     * @param mixed $params
+     * @param mixed $offset
+     * @param mixed $limit
+     * @param mixed $filter_fields
+     * @param mixed $id_field
+     * @param null|mixed $id
      */
     public function setup($data, $file, $where, $params = array(), $offset = 0, $limit = -1, $filter_fields = array(), $id_field = 'id', $id=null)
     {
@@ -80,6 +87,8 @@ class ListViewPackages extends ListViewSmarty
 
     /**
      * Override the display method
+     * 
+     * @param boolean $end
      */
     public function display($end = true)
     {

ModuleInstall/PackageManager/PackageManagerDownloader.php

@@ -46,12 +46,12 @@ class PackageManagerDownloader
     /**
      * Using curl we will download the file from the depot server
      *
-     * @param session_id		the session_id this file is queued for
-     * @param file_name			the file_name to download
-     * @param save_dir			(optional) if specified it will direct where to save the file once downloaded
-     * @param download_sever	(optional) if specified it will direct the url for the download
+     * @param mixed $session_id the session_id this file is queued for
+     * @param mixed $file_name the file_name to download
+     * @param mixed $save_dir (optional) if specified it will direct where to save the file once downloaded
+     * @param mixed $download_server (optional) if specified it will direct the url for the download
      *
-     * @return the full path of the saved file
+     * @return string the full path of the saved file
      */
     public function download($session_id, $file_name, $save_dir = '', $download_server = '')
     {

data/Link2.php

@@ -76,9 +76,9 @@ class Link2
     protected $tempBeans = array();
 
     /**
-     * @param  $linkName String name of a link field in the module's vardefs
-     * @param  $bean SugarBean focus bean for this link (one half of a relationship)
-     * @param  $linkDef array Optional vardef for the link in case it can't be found in the passed in bean
+     * @param string $linkName name of a link field in the module's vardefs
+     * @param SugarBean $bean focus bean for this link (one half of a relationship)
+     * @param array $linkDef Optional vardef for the link in case it can't be found in the passed in bean
      * for the global dictionary
      */
     public function __construct($linkName, $bean, $linkDef = array())
@@ -613,7 +613,7 @@ class Link2
     /**
      * Marks the relationship deleted for this given record pair.
      *
-     * @param $id string id of the Parent/Focus SugarBean
+     * @param string $id id of the Parent/Focus SugarBean
      * @param string $related_id id or SugarBean to unrelate. Pass a SugarBean if you have it.
      *
      * @return bool true if delete was successful or false if it was not

data/Relationships/EmailAddressRelationship.php

@@ -52,9 +52,10 @@ class EmailAddressRelationship extends M2MRelationship
 {
     /**
      * For Email Addresses, there is only a link from the left side, so we need a new add function that ignores rhs
-     * @param  $lhs SugarBean left side bean to add to the relationship.
-     * @param  $rhs SugarBean right side bean to add to the relationship.
-     * @param  $additionalFields key=>value pairs of fields to save on the relationship
+     *
+     * @param SugarBean $lhs left side bean to add to the relationship.
+     * @param SugarBean $rhs right side bean to add to the relationship.
+     * @param mixed $additionalFields key=>value pairs of fields to save on the relationship
      * @return boolean true if successful
      */
     public function add($lhs, $rhs, $additionalFields = array())

data/Relationships/M2MRelationship.php

@@ -130,9 +130,9 @@ class M2MRelationship extends SugarRelationship
         return $links[0];
     }
     /**
-     * @param  $lhs SugarBean left side bean to add to the relationship.
-     * @param  $rhs SugarBean right side bean to add to the relationship.
-     * @param  $additionalFields key=>value pairs of fields to save on the relationship
+     * @param SugarBean $lhs left side bean to add to the relationship.
+     * @param SugarBean $rhs right side bean to add to the relationship.
+     * @param mixed $additionalFields key=>value pairs of fields to save on the relationship
      * @return boolean true if successful
      */
     public function add($lhs, $rhs, $additionalFields = array())
@@ -375,7 +375,7 @@ class M2MRelationship extends SugarRelationship
     }
 
     /**
-     * @param  $link Link2 loads the relationship for this link.
+     * @param Link2 $link loads the relationship for this link.
      * @return void
      */
     public function load($link, $params = array())
@@ -556,7 +556,7 @@ class M2MRelationship extends SugarRelationship
     /**
      * Similar to getQuery or Get join, except this time we are starting from the related table and
      * searching for items with id's matching the $link->focus->id
-     * @param  $link
+     * @param mixed $link
      * @param array $params
      * @param bool $return_array
      * @return String|Array
@@ -625,8 +625,8 @@ class M2MRelationship extends SugarRelationship
     }
 
     /**
-     * @param  $lhs
-     * @param  $rhs
+     * @param $lhs
+     * @param $rhs
      * @return bool
      */
     public function relationship_exists($lhs, $rhs)

data/Relationships/One2MBeanRelationship.php

@@ -59,9 +59,9 @@ class One2MBeanRelationship extends One2MRelationship
     }
 
     /**
-     * @param  $lhs SugarBean left side bean to add to the relationship.
-     * @param  $rhs SugarBean right side bean to add to the relationship.
-     * @param  $additionalFields key=>value pairs of fields to save on the relationship
+     * @param SugarBean $lhs left side bean to add to the relationship.
+     * @param SugarBean $rhs right side bean to add to the relationship.
+     * @param mixed $additionalFields key=>value pairs of fields to save on the relationship
      * @return boolean true if successful
      */
     public function add($lhs, $rhs, $additionalFields = array())
@@ -176,7 +176,7 @@ class One2MBeanRelationship extends One2MRelationship
     }
 
     /**
-     * @param  $link Link2 loads the relationship for this link.
+     * @param Link2 $link loads the relationship for this link.
      * @return void
      */
     public function load($link, $params = array())

data/Relationships/One2MRelationship.php

@@ -120,9 +120,9 @@ class One2MRelationship extends M2MRelationship
     }
 
     /**
-     * @param  $lhs SugarBean left side bean to add to the relationship.
-     * @param  $rhs SugarBean right side bean to add to the relationship.
-     * @param  $additionalFields key=>value pairs of fields to save on the relationship
+     * @param SugarBean $lhs left side bean to add to the relationship.
+     * @param SugarBean $rhs right side bean to add to the relationship.
+     * @param mixed $additionalFields key=>value pairs of fields to save on the relationship
      * @return boolean true if successful
      */
     public function add($lhs, $rhs, $additionalFields = array())

data/Relationships/One2OneBeanRelationship.php

@@ -55,9 +55,9 @@ class One2OneBeanRelationship extends One2MBeanRelationship
         parent::__construct($def);
     }
     /**
-     * @param  $lhs SugarBean left side bean to add to the relationship.
-     * @param  $rhs SugarBean right side bean to add to the relationship.
-     * @param  $additionalFields key=>value pairs of fields to save on the relationship
+     * @param SugarBean $lhs left side bean to add to the relationship.
+     * @param SugarBean $rhs right side bean to add to the relationship.
+     * @param mixed $additionalFields key=>value pairs of fields to save on the relationship
      * @return boolean true if successful
      */
     public function add($lhs, $rhs, $additionalFields = array())

data/Relationships/One2OneRelationship.php

@@ -56,9 +56,9 @@ class One2OneRelationship extends M2MRelationship
         parent::__construct($def);
     }
     /**
-     * @param  $lhs SugarBean left side bean to add to the relationship.
-     * @param  $rhs SugarBean right side bean to add to the relationship.
-     * @param  $additionalFields key=>value pairs of fields to save on the relationship
+     * @param SugarBean $lhs left side bean to add to the relationship.
+     * @param SugarBean $rhs right side bean to add to the relationship.
+     * @param mixed $additionalFields key=>value pairs of fields to save on the relationship
      * @return boolean true if successful
      */
     public function add($lhs, $rhs, $additionalFields = array())

data/Relationships/RelationshipFactory.php

@@ -92,7 +92,7 @@ class SugarRelationshipFactory
     }
 
     /**
-     * @param  $relationshipName String name of relationship to load
+     * @param string $relationshipName name of relationship to load
      *
      * @return SugarRelationship|bool
      */
@@ -146,7 +146,7 @@ class SugarRelationshipFactory
     }
 
     /**
-     * @param $relationshipName
+     * @param string $relationshipName
      * @return bool
      */
     public function getRelationshipDef($relationshipName)

data/Relationships/SugarRelationship.php

@@ -87,8 +87,8 @@ abstract class SugarRelationship
     /**
      * @abstract
      *
-     * @param  $lhs SugarBean
-     * @param  $rhs SugarBean
+     * @param SugarBean $lhs
+     * @param SugarBean $rhs
      *
      * @return bool
      */
@@ -97,7 +97,7 @@ abstract class SugarRelationship
     /**
      * @abstract
      *
-     * @param $link Link2 loads the rows for this relationship that match the given link
+     * @param Link2 $link loads the rows for this relationship that match the given link
      * @param array $params
      */
     abstract public function load($link, $params = array());
@@ -109,7 +109,7 @@ abstract class SugarRelationship
      *
      * @abstract
      *
-     * @param  $link Link2 Object to get query for.
+     * @param Link2 $link Object to get query for.
      * @param array $params
      *
      * @return array|string query used to load this relationship
@@ -145,7 +145,7 @@ abstract class SugarRelationship
     abstract public function getRelationshipTable();
 
     /**
-     * @param  $link Link2 removes all the beans associated with this link from the relationship
+     * @param Link2 $link removes all the beans associated with this link from the relationship
      *
      * @return bool true if all beans were successfully removed or there
      *              were not related beans, false otherwise
@@ -173,7 +173,7 @@ abstract class SugarRelationship
     }
 
     /**
-     * @param $rowID string id of SugarBean to remove from the relationship
+     * @param string $rowID id of SugarBean to remove from the relationship
      */
     public function removeById($rowID)
     {
@@ -250,8 +250,8 @@ abstract class SugarRelationship
     }
 
     /**
-     * @param $id string id of row to update
-     * @param $values array values to insert into row
+     * @param string $id id of row to update
+     * @param array $values values to insert into row
      *
      * @return resource result of update statement
      */
@@ -276,7 +276,7 @@ abstract class SugarRelationship
     /**
      * Removes one or more rows from the relationship table.
      *
-     * @param $where array of field=>value pairs to match
+     * @param array $where array of field=>value pairs to match
      *
      * @return bool|resource
      */
@@ -301,7 +301,7 @@ abstract class SugarRelationship
     /**
      * Checks for an existing row who's keys match the one passed in.
      *
-     * @param  $row
+     * @param $row
      *
      * @return array|bool returns false if now row is found, otherwise the row is returned
      */

data/SugarBean.php

@@ -6040,7 +6040,7 @@ class SugarBean
 
     /**
      * Check whether the user has access to a particular view for the current bean/module
-     * @param $view string required, the view to determine access for i.e. DetailView, ListView...
+     * @param string $view required, the view to determine access for i.e. DetailView, ListView...
      * @param bool|string $is_owner bool optional, this is part of the ACL check if the current user
      * is an owner they will receive different access
      * @param bool|string $in_group

include/EditView/SubpanelQuickCreate.php

@@ -200,8 +200,8 @@ class SubpanelQuickCreate
      *  3. custom/module/editviewdefs.php
      *  4. module/editviewdefs.php
      *
-     * @param $module
-     * @param $view
+     * @param string $module
+     * @param string $view
      * @return string The path to the viewdefs file to use
      */
     public function getModuleViewDefsSourceFile($module, $view)

include/database/MssqlManager.php

@@ -997,7 +997,7 @@ class MssqlManager extends DBManager
 
     /**
      * Get tables like expression
-     * @param $like string
+     * @param string $like
      * @return array
      */
     public function tablesLike($like)

include/database/MysqlManager.php

@@ -460,7 +460,7 @@ class MysqlManager extends DBManager
 
     /**
      * Get tables like expression
-     * @param $like string
+     * @param string $like
      * @return array
      */
     public function tablesLike($like)

include/export_utils.php

@@ -451,8 +451,8 @@ function export($type, $records = null, $members = false, $sample=false)
 
 /**
  * Parse custom related fields
- * @param $line string CSV line
- * @param $record array of current line
+ * @param string $line CSV line
+ * @param array $record of current line
  * @return mixed string CSV line
  */
 function parseRelateFields($line, $record, $customRelateFields)

include/externalAPI/Base/ExternalAPIBase.php

@@ -211,8 +211,8 @@ abstract class ExternalAPIBase implements ExternalAPIPlugin
      * that are being checked deal with handling the behavior of closing/hiding windows/tabs that
      * are displayed when prompting for OAUTH validation
      *
-     * @param $callback_url String value of callback URL
-     * @return String value of URL with applicable formatting
+     * @param string $callback_url value of callback URL
+     * @return string value of URL with applicable formatting
      */
     protected function formatCallbackURL($callback_url)
     {

include/generic/SugarWidgets/SugarWidgetFieldcurrency.php

@@ -243,7 +243,7 @@ class SugarWidgetFieldCurrency extends SugarWidgetFieldInt
 
     /**
      * Return currency for layout_def
-     * @param $layout_def mixed
+     * @param mixed $layout_def
      * @return array Array with currency symbol and currency ID
      */
     protected function getCurrency($layout_def)

modules/Administration/Administration.php

@@ -224,9 +224,9 @@ class Administration extends SugarBean
     }
 
     /**
-     * @param $category string
-     * @param $key string
-     * @param $value string
+     * @param string $category
+     * @param string $key
+     * @param string $value
      * @return int
      */
     public function saveSetting($category, $key, $value)