adamjakab / SuiteCRM

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)

modules/Emails/EmailUI.php

Doc Comments +19 added lines, -15 removed lines

@@ -297,7 +297,7 @@ 
 	 * Generate the frame needed for the quick compose email UI.  This frame is loaded dynamically
 	 * by an ajax call.
 	 *
-	 * @return JSON An object containing html markup and js script variables.
+	 * @return string An object containing html markup and js script variables.
 	 */
 	function displayQuickComposeEmailFrame()
 	{
@@ -346,7 +346,7 @@ 
      * UI.
      *
      * @param String $emailLinkUrl
-     * @return JSON Object containing the composePackage and full link url
+     * @return string Object containing the composePackage and full link url
      */
     function generateComposePackageForQuickCreateFromComposeUrl($emailLinkUrl, $lazyLoad=false)
     {
@@ -369,7 +369,7 @@ 
      * @param String $fullLinkUrl A link that contains all pertinant information so the user can be
      *                              directed to the full compose screen if needed
      * @param SugarBean $bean Optional - the parent object bean with data
-     * @return JSON Object containg composePackage and fullLinkUrl
+     * @return string Object containg composePackage and fullLinkUrl
      */
     function generateComposePackageForQuickCreate($composeData,$fullLinkUrl, $lazyLoad=false, $bean = null)
     {
@@ -798,7 +798,6 @@ 
 	/**
 	 * Creates a new Sugar folder
 	 * @param string $nodeLabel New sugar folder name
-	 * @param string $parentLabel Parent folder name
 	 */
 	function saveNewFolder($nodeLabel, $parentId, $isGroup=0) {
 		global $current_user;
@@ -921,8 +920,7 @@ 
 
 	/**
 	 * returns an array of nodes that correspond to IMAP mailboxes.
-	 * @param bool $forceRefresh
-	 * @return object TreeView object
+	 * @return Tree TreeView object
 	 */
 	function getMailboxNodes() {
 		global $sugar_config;
@@ -1052,7 +1050,8 @@ 
 	 * @param string nodePath Serialized path from root node to current node
 	 * @param bool isGroup
 	 * @param bool forceRefresh
-	 * @return mixed
+	 * @param boolean $isGroup
+	 * @return ExtNode
 	 */
 	function buildTreeNode($key, $label, $mbox, $ieId, $nodePath, $isGroup, $ie) {
 		global $sugar_config;
@@ -1114,6 +1113,7 @@ 
 
 	/**
 	 * Totals the unread emails
+	 * @param string $mailbox
 	 */
 	function getUnreadCount(&$ie, $mailbox) {
 		global $sugar_config;
@@ -1203,7 +1203,7 @@ 
 	 * Renders the QuickCreate form from Smarty and returns HTML
 	 * @param array $vars request variable global
 	 * @param object $email Fetched email object
-	 * @param bool $addToAddressBook
+	 * @param bool $addToAddressBookButton
 	 * @return array
 	 */
 	function getQuickCreateForm($vars, $email, $addToAddressBookButton=false) {
@@ -1340,9 +1340,8 @@ 
 	/**
      * Renders the Import form from Smarty and returns HTML
      * @param array $vars request variable global
-     * @param object $email Fetched email object
-     * @param bool $addToAddressBook
-     * @return array
+     * @param Email $email Fetched email object
+     * @return string
      */
     function getImportForm($vars, $email, $formName = 'ImportEditView') {
 		require_once("include/EditView/EditView2.php");
@@ -1786,6 +1785,9 @@ 
 	return $counts;
 } // fn
 
+/**
+ * @param InboundEmail $ie
+ */
 function getLastRobin($ie) {
 	$lastRobin = "";
 	if($this->validCacheFileExists($ie->id, 'folders', "robin.cache.php")) {
@@ -1794,6 +1796,9 @@ 
 	return $lastRobin;
 } // fn
 
+/**
+ * @param InboundEmail $ie
+ */
 function setLastRobin($ie, $lastRobin) {
     global $sugar_config;
     $cacheFolderPath = sugar_cached("modules/Emails/{$ie->id}/folders");
@@ -1996,6 +2001,7 @@ 
 	 * Formats email body on reply/forward
 	 * @param object email Email object in focus
 	 * @param string type
+	 * @param Email $email
 	 * @return object email
 	 */
 	function handleReplyType($email, $type) {
@@ -2283,7 +2289,7 @@ 
 
 	/**
 	 * Cleans UID lists
-	 * @param mixed $uids
+	 * @param string $uids
 	 * @param bool $returnString False will return an array
 	 * @return mixed
 	 */
@@ -2582,7 +2588,7 @@ 
      * This function will return all the accounts this user has access to based on the
      * match of the emailId passed in as a parameter
      *
-     * @param unknown_type $ie
+     * @param InboundEmail $ie
      * @return unknown
      */
 	function getFromAllAccountsArray($ie, $ret) {
@@ -3030,8 +3036,6 @@ 
      * Generate to/cc addresses string in email detailview.
      *
      * @param string $str
-     * @param string $target values: to, cc
-     * @param int $defaultNum
      * @return string $str
      */
 	function generateExpandableAddrs($str) {

modules/Employees/views/view.list.php

Doc Comments +1 added lines, -1 removed lines

@@ -68,7 +68,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)
     {

modules/FP_events/controller.php

Doc Comments +6 added lines

@@ -598,6 +598,12 @@
     }
 
     //handles sending the emails
+
+    /**
+     * @param string $emailToname
+     * @param string $emailBody
+     * @param string $altemailBody
+     */
     public function sendEmail($emailTo, $emailSubject, $emailToname, $emailBody, $altemailBody, SugarBean $relatedBean = null, $attachments = array()){
        
         $emailObj = new Email();

modules/Home/Dashlets/RSSDashlet/RSSDashlet.php

Doc Comments +3 added lines

@@ -142,6 +142,9 @@
         return $options;
     }
 
+    /**
+     * @param string $url
+     */
     protected function getRSSOutput(
         $url
         )

modules/Home/QuickSearch.php

Doc Comments +3 added lines, -4 removed lines

@@ -78,7 +78,7 @@ 
      *        'order' => 'name', // order by
      *        'limit' => '30', // limit, number of records to return
      *       )
-     * @return array list of elements returned
+     * @return string list of elements returned
      */
     public function query($args)
     {
@@ -107,7 +107,7 @@ 
      * Returns the list of users, faster than using query method for Users module
      *
      * @param array $args arguments used to construct query, see query() for example
-     * @return array list of users returned
+     * @return string list of users returned
      */
     public function get_user_array($args)
     {
@@ -122,7 +122,7 @@ 
      * Returns search results from external API
      *
      * @param array $args
-     * @return array
+     * @return string
      */
     public function externalApi($args)
     {
@@ -496,7 +496,6 @@ 
     /**
      * Returns prepared arguments. Should be redefined in child classes.
      *
-     * @param array $arguments
      * @return array
      */
     protected function prepareArguments($args)

modules/Home/UnifiedSearch.php

Doc Comments +6 added lines

@@ -188,6 +188,9 @@ 
     $output = preg_replace(array('/(?<=[^A-Z])([A-Z])/', '/(?<=[^0-9])([0-9])/'), $sep.'$0', $input);
     return ucwords($output);
 }
+/**
+ * @param string $module
+ */
 function getModuleLabel($module){
     return translate('LBL_MODULE_NAME', $module);
 }
@@ -197,6 +200,9 @@ 
     sugar_file_put_contents_atomic($file, $out);
 }
 
+/**
+ * @param string $filePath
+ */
 function getCorrectMTime($filePath){
     $time = filemtime($filePath);
     $isDST = (date('I', $time) == 1);