adamjakab / SuiteCRM

data/Link.php

Doc Comments +17 added lines

@@ -386,6 +386,9 @@ 
 		else return '';
 	}
 
+	/**
+	 * @param string $optional_array
+	 */
 	function _add_optional_where_clause($optional_array, $add_and='',$prefix='') {
 
 		if (!empty($prefix)) $prefix.='.';
@@ -612,6 +615,9 @@ 
 		return $this->_bean->build_related_list($query, $template);
 	}
 
+	/**
+	 * @param boolean $bean_is_lhs
+	 */
 	function _add_one_to_many_table_based($key,$bean_is_lhs) {
 
 		if ($bean_is_lhs) {
@@ -825,6 +831,9 @@ 
 		$result=$this->_db->query($query, true);
 	}
 
+	/**
+	 * @param string $where
+	 */
 	function _update_row(&$value_array,$table_name,$where) {
 
 		$query='UPDATE '.$table_name.' SET ';
@@ -1053,6 +1062,10 @@ 
 
 	/*
 	 */
+
+	/**
+	 * @param string $def_name
+	 */
 	function _get_link_table_definition($table_name,$def_name) {
 	    global $dictionary;
 
@@ -1096,6 +1109,10 @@ 
      * Return the name of the role field for the passed many to many table.
      * if there is no role filed : return false
      */
+
+    /**
+     * @return string
+     */
     function _get_link_table_role_field($table_name) {
         $varDefs = $this->_get_link_table_definition($table_name, 'fields');
         $role_field = false;

data/Link2.php

Doc Comments +3 added lines, -2 removed lines

@@ -74,7 +74,7 @@ 
      * @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 for the global dictionary
-     * @return void
+     * @return false|null
      *
      */
     function __construct($linkName, $bean, $linkDef = false){
@@ -356,7 +356,7 @@ 
     /**
      * @param array $params optional parameters. Possible Values;
      * 'return_as_array': returns the query broken into
-     * @return String/Array query to grab just ids for this relationship
+     * @return string query to grab just ids for this relationship
      */
     function getQuery($params = array())
     {
@@ -686,6 +686,7 @@ 
     /**
      * @deprecated
      * Gets the vardef for the relationship of this link.
+     * @param string $def_name
      */
     public function _get_link_table_definition($table_name, $def_name) {
 

data/Relationships/M2MRelationship.php

Doc Comments +4 added lines, -4 removed lines

@@ -365,8 +365,8 @@ 
 
     /**
      * Removes the reversed version of this relationship
-     * @param $lhs
-     * @param $rhs
+     * @param SugarBean $lhs
+     * @param SugarBean $rhs
      * @param array $additionalFields
      * @return void
      */
@@ -383,7 +383,7 @@ 
     }
 
     /**
-     * @param  $link Link2 loads the relationship for this link.
+     * @param  Link2 $link Link2 loads the relationship for this link.
      * @return void
      */
     public function load($link, $params = array())
@@ -532,7 +532,7 @@ 
     /**
      * 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  Link2 $link
      * @param array $params
      * @param bool $return_array
      * @return String|Array

data/Relationships/One2MRelationship.php

Doc Comments +1 added lines, -1 removed lines

@@ -119,7 +119,7 @@
      * @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
-     * @return boolean true if successful
+     * @return boolean|null true if successful
      */
     public function add($lhs, $rhs, $additionalFields = array())
     {

data/Relationships/SugarRelationship.php

Doc Comments +1 added lines, -3 removed lines

@@ -197,7 +197,7 @@ 
 
     /**
      * @param array $row values to be inserted into the relationship
-     * @return bool|void null if new row was inserted and true if an existing row was updated
+     * @return resource|null null if new row was inserted and true if an existing row was updated
      */
     protected function addRow($row)
     {
@@ -399,8 +399,6 @@ 
 
     /**
      * @param $optional_array clause to add to the where query when populating this relationship. It should be in the
-     * @param string $add_and
-     * @param string $prefix
      * @return string
      */
     protected function getOptionalWhereClause($optional_array) {

data/SugarBean.php

Doc Comments +29 added lines, -19 removed lines

@@ -394,8 +394,7 @@ 
      *
      * All implementing classes must set a value for the object_name variable.
      *
-     * @param array $arr row of data fetched from the database.
-     * @return  nothing
+     * @return  string
      *
      */
     function getObjectName()
@@ -1036,7 +1035,6 @@ 
      * Method will load the relationship if not done so already.
      *
      * @param string $field_name relationship to be loaded.
-     * @param string $bean name  class name of the related bean.legacy
      * @param string $order_by, Optional, default empty.
      * @param int $begin_index Optional, default 0, unused.
      * @param int $end_index Optional, default -1
@@ -2279,7 +2277,7 @@ 
      * The fetched data is then set into the bean. The function also processes the fetched data by formattig
      * date/time and numeric values.
      *
-     * @param string $id Optional, default -1, is set to -1 id value from the bean is used, else, passed value is used
+     * @param integer $id Optional, default -1, is set to -1 id value from the bean is used, else, passed value is used
      * @param boolean $encode Optional, default true, encodes the values fetched from the database.
      * @param boolean $deleted Optional, default true, if set to false deleted filter will not be added.
      *
@@ -2502,9 +2500,9 @@ 
     * @param string $order_by
     * @param string $where Additional where clause
     * @param int $row_offset Optaional,default 0, starting row number
-    * @param init $limit Optional, default -1
+    * @param integer $limit Optional, default -1
     * @param int $max Optional, default -1
-    * @param boolean $show_deleted Optional, default 0, if set to 1 system will show deleted records.
+    * @param integer $show_deleted Optional, default 0, if set to 1 system will show deleted records.
     * @return array Fetched data.
     *
     * Internal function, do not override.
@@ -2629,9 +2627,9 @@ 
     * @param string $order_by
     * @param string $where Additional where clause
     * @param int $row_offset Optaional,default 0, starting row number
-    * @param init $limit Optional, default -1
+    * @param integer $limit Optional, default -1
     * @param int $max Optional, default -1
-    * @param boolean $show_deleted Optioanl, default 0, if set to 1 system will show deleted records.
+    * @param integer $show_deleted Optioanl, default 0, if set to 1 system will show deleted records.
     * @return array Fetched data.
     *
     * Internal function, do not override.
@@ -2756,6 +2754,11 @@ 
     }
 
 
+    /**
+     * @param aSubPanel $subpanel_def
+     * @param SugarBean $parentbean
+     * @param string $order_by
+     */
     protected static function build_sub_queries_for_union($subpanel_list, $subpanel_def, $parentbean, $order_by)
     {
         global $layout_edit_mode, $beanFiles, $beanList;
@@ -3928,15 +3931,15 @@ 
      * executes the query and returns fetched data.
      *
      * Internal function, do not override.
-     * @param object $parent_bean
+     * @param SugarBean $parent_bean
      * @param string $query query to be processed.
      * @param int $row_offset
      * @param int $limit optional, default -1
      * @param int $max_per_page Optional, default -1
      * @param string $where Custom where clause.
-     * @param array $subpanel_def definition of sub-panel to be processed
+     * @param aSubPanel $subpanel_def definition of sub-panel to be processed
      * @param string $query_row_count
-     * @param array $seconday_queries
+     * @param array $secondary_queries
      * @return array Fetched data.
      */
     function process_union_list_query($parent_bean, $query,
@@ -4577,6 +4580,7 @@ 
      * Restores data deleted by call to mark_deleted() function.
      *
      * Internal function, do not override.
+    * @param string $id
     */
     function mark_undeleted($id)
     {
@@ -4609,7 +4613,7 @@ 
     /**
      * Returns path for files of bean or false on error
      *
-     * @return bool|string
+     * @return false|string
      */
     public function deleteFileDirectory()
     {
@@ -4941,8 +4945,8 @@ 
     * Internal function, do not override.
     *
     * @param string $query - the query that should be executed to build the list
-    * @param object $template - The object that should be used to copy the records
-    * @param array $field_list List of  fields.
+    * @param Contact $template - The object that should be used to copy the records
+    * @param string[] $field_list List of  fields.
     * @return array
     */
     function build_related_list2($query, &$template, &$field_list)
@@ -5088,7 +5092,7 @@ 
      * @param array @fields_array  array of name value pairs used to construct query.
      * @param boolean $encode Optional, default true, encode fetched data.
      * @param boolean $deleted Optional, default true, if set to false deleted filter will not be added.
-     * @return object Instance of this bean with fetched data.
+     * @return null|SugarBean Instance of this bean with fetched data.
      */
     function retrieve_by_string_fields($fields_array, $encode=true, $deleted=true)
     {
@@ -5259,6 +5263,9 @@ 
     * 	RELATIONSHIP HANDLING
     */
 
+    /**
+     * @param string $table
+     */
     function set_relationship($table, $relate_values, $check_duplicates = true,$do_update=false,$data_values=null)
     {
         $where = '';
@@ -5364,6 +5371,7 @@ 
     * 		$bean - $this bean passed in by reference.
     *		$event - The string for the current event (i.e. before_save)
     * 		$arguments - An array of arguments that are specific to the event.
+    * @param string $event
     */
     function call_custom_logic($event, $arguments = null)
     {
@@ -5765,7 +5773,7 @@ 
     *
     * @param string $order_by original order by from the query
     * @param string $qualify prefix for columns in the order by list.
-    * @return  prefixed
+    * @return  string
     *
     * Internal function do not override.
     */
@@ -5851,6 +5859,7 @@ 
     /**
     * Moved from save() method, functionality is the same, but this is intended to handle
     * Optimistic locking functionality.
+    * @param boolean $isUpdate
     */
     private function _checkOptimisticLocking($action, $isUpdate){
         if($this->optimistic_lock && !isset($_SESSION['o_lock_fs'])){
@@ -5891,6 +5900,7 @@ 
 
     /**
     * Send assignment notifications and invites for meetings and calls
+    * @param boolean $check_notify
     */
     private function _sendNotifications($check_notify){
         if($check_notify || (isset($this->notify_inworkflow) && $this->notify_inworkflow == true) // cn: bug 5795 - no invites sent to Contacts, and also bug 25995, in workflow, it will set the notify_on_save=true.
@@ -5961,9 +5971,9 @@ 
      * bean files and have since been moved to separate files. Was previously in include/CacheHandler.php
      *
      * @deprecated
-     * @param $module_dir string the module directory
-     * @param $module string the name of the module
-     * @param $key string the type of field array we are referencing, i.e. list_fields, column_fields, required_fields
+     * @param string $module_dir string the module directory
+     * @param string $module string the name of the module
+     * @param string $key string the type of field array we are referencing, i.e. list_fields, column_fields, required_fields
      **/
     private function _loadCachedArray(
         $module_dir,

include/connectors/component.php

Doc Comments +3 added lines

@@ -342,6 +342,9 @@
  		return $this->_source;
  	}
 
+ 	/**
+ 	 * @param source $source
+ 	 */
  	public function setSource($source){
  		$this->_source = $source;
  	}

include/connectors/ConnectorFactory.php

Doc Comments +1 added lines

@@ -63,6 +63,7 @@
 	 * Split the class name by _ and go through the class name
 	 * which represents the inheritance structure to load up all required parents.
 	 * @param string $class the root class we want to load.
+	 * @param string $type
 	 */
 	public static function load($class, $type){
 		self::loadClass($class, $type);

include/connectors/filters/FilterFactory.php

Doc Comments +3 added lines

@@ -47,6 +47,9 @@
 
 	static $filter_map = array();
 
+	/**
+	 * @param string $source_name
+	 */
 	public static function getInstance($source_name, $filter_name=''){
 		require_once('include/connectors/filters/default/filter.php');
 		$key = $source_name . $filter_name;