@@ -74,7 +74,7 @@ discard block |
||
| 74 | 74 | * @param $linkName String name of a link field in the module's vardefs |
| 75 | 75 | * @param $bean SugarBean focus bean for this link (one half of a relationship) |
| 76 | 76 | * @param $linkDef Array Optional vardef for the link in case it can't be found in the passed in bean for the global dictionary |
| 77 | - * @return void |
|
| 77 | + * @return false|null |
|
| 78 | 78 | * |
| 79 | 79 | */ |
| 80 | 80 | function __construct($linkName, $bean, $linkDef = false){ |
@@ -356,7 +356,7 @@ discard block |
||
| 356 | 356 | /** |
| 357 | 357 | * @param array $params optional parameters. Possible Values; |
| 358 | 358 | * 'return_as_array': returns the query broken into |
| 359 | - * @return String/Array query to grab just ids for this relationship |
|
| 359 | + * @return string query to grab just ids for this relationship |
|
| 360 | 360 | */ |
| 361 | 361 | function getQuery($params = array()) |
| 362 | 362 | { |
@@ -686,6 +686,7 @@ discard block |
||
| 686 | 686 | /** |
| 687 | 687 | * @deprecated |
| 688 | 688 | * Gets the vardef for the relationship of this link. |
| 689 | + * @param string $def_name |
|
| 689 | 690 | */ |
| 690 | 691 | public function _get_link_table_definition($table_name, $def_name) { |
| 691 | 692 | |
@@ -365,8 +365,8 @@ discard block |
||
| 365 | 365 | |
| 366 | 366 | /** |
| 367 | 367 | * Removes the reversed version of this relationship |
| 368 | - * @param $lhs |
|
| 369 | - * @param $rhs |
|
| 368 | + * @param SugarBean $lhs |
|
| 369 | + * @param SugarBean $rhs |
|
| 370 | 370 | * @param array $additionalFields |
| 371 | 371 | * @return void |
| 372 | 372 | */ |
@@ -383,7 +383,7 @@ discard block |
||
| 383 | 383 | } |
| 384 | 384 | |
| 385 | 385 | /** |
| 386 | - * @param $link Link2 loads the relationship for this link. |
|
| 386 | + * @param Link2 $link Link2 loads the relationship for this link. |
|
| 387 | 387 | * @return void |
| 388 | 388 | */ |
| 389 | 389 | public function load($link, $params = array()) |
@@ -532,7 +532,7 @@ discard block |
||
| 532 | 532 | /** |
| 533 | 533 | * Similar to getQuery or Get join, except this time we are starting from the related table and |
| 534 | 534 | * searching for items with id's matching the $link->focus->id |
| 535 | - * @param $link |
|
| 535 | + * @param Link2 $link |
|
| 536 | 536 | * @param array $params |
| 537 | 537 | * @param bool $return_array |
| 538 | 538 | * @return String|Array |
@@ -119,7 +119,7 @@ |
||
| 119 | 119 | * @param $lhs SugarBean left side bean to add to the relationship. |
| 120 | 120 | * @param $rhs SugarBean right side bean to add to the relationship. |
| 121 | 121 | * @param $additionalFields key=>value pairs of fields to save on the relationship |
| 122 | - * @return boolean true if successful |
|
| 122 | + * @return boolean|null true if successful |
|
| 123 | 123 | */ |
| 124 | 124 | public function add($lhs, $rhs, $additionalFields = array()) |
| 125 | 125 | { |
@@ -197,7 +197,7 @@ discard block |
||
| 197 | 197 | |
| 198 | 198 | /** |
| 199 | 199 | * @param array $row values to be inserted into the relationship |
| 200 | - * @return bool|void null if new row was inserted and true if an existing row was updated |
|
| 200 | + * @return resource|null null if new row was inserted and true if an existing row was updated |
|
| 201 | 201 | */ |
| 202 | 202 | protected function addRow($row) |
| 203 | 203 | { |
@@ -399,8 +399,6 @@ discard block |
||
| 399 | 399 | |
| 400 | 400 | /** |
| 401 | 401 | * @param $optional_array clause to add to the where query when populating this relationship. It should be in the |
| 402 | - * @param string $add_and |
|
| 403 | - * @param string $prefix |
|
| 404 | 402 | * @return string |
| 405 | 403 | */ |
| 406 | 404 | protected function getOptionalWhereClause($optional_array) { |
@@ -342,6 +342,9 @@ |
||
| 342 | 342 | return $this->_source; |
| 343 | 343 | } |
| 344 | 344 | |
| 345 | + /** |
|
| 346 | + * @param source $source |
|
| 347 | + */ |
|
| 345 | 348 | public function setSource($source){ |
| 346 | 349 | $this->_source = $source; |
| 347 | 350 | } |
@@ -63,6 +63,7 @@ |
||
| 63 | 63 | * Split the class name by _ and go through the class name |
| 64 | 64 | * which represents the inheritance structure to load up all required parents. |
| 65 | 65 | * @param string $class the root class we want to load. |
| 66 | + * @param string $type |
|
| 66 | 67 | */ |
| 67 | 68 | public static function load($class, $type){ |
| 68 | 69 | self::loadClass($class, $type); |
@@ -47,6 +47,9 @@ |
||
| 47 | 47 | |
| 48 | 48 | static $filter_map = array(); |
| 49 | 49 | |
| 50 | + /** |
|
| 51 | + * @param string $source_name |
|
| 52 | + */ |
|
| 50 | 53 | public static function getInstance($source_name, $filter_name=''){ |
| 51 | 54 | require_once('include/connectors/filters/default/filter.php'); |
| 52 | 55 | $key = $source_name . $filter_name; |
@@ -318,6 +318,9 @@ discard block |
||
| 318 | 318 | return !empty($this->_config['properties'][$name]); |
| 319 | 319 | } |
| 320 | 320 | |
| 321 | + /** |
|
| 322 | + * @param string $name |
|
| 323 | + */ |
|
| 321 | 324 | public function getProperty($name) |
| 322 | 325 | { |
| 323 | 326 | if(!empty($this->_config) && isset($this->_config['properties'][$name])) { |
@@ -336,7 +339,7 @@ discard block |
||
| 336 | 339 | * This method is used to indicate whether or not a data source has testing enabled so that |
| 337 | 340 | * the administration interface may call the test method on the data source instance |
| 338 | 341 | * |
| 339 | - * @return enabled boolean value indicating whether or not testing is enabled |
|
| 342 | + * @return boolean boolean value indicating whether or not testing is enabled |
|
| 340 | 343 | */ |
| 341 | 344 | public function hasTestingEnabled() { |
| 342 | 345 | return $this->_has_testing_enabled; |
@@ -348,7 +351,7 @@ discard block |
||
| 348 | 351 | * It is up to subclasses to implement a test and set _has_testing_enabled to true so that |
| 349 | 352 | * a test button is rendered in the administration interface |
| 350 | 353 | * |
| 351 | - * @return result boolean result of the test function |
|
| 354 | + * @return boolean boolean result of the test function |
|
| 352 | 355 | */ |
| 353 | 356 | public function test() { |
| 354 | 357 | return false; |
@@ -48,7 +48,6 @@ |
||
| 48 | 48 | |
| 49 | 49 | /** |
| 50 | 50 | * Given a source param, load the correct source and return the object |
| 51 | - * @param string $source string representing the source to load |
|
| 52 | 51 | * @return source |
| 53 | 52 | */ |
| 54 | 53 | public static function getSource($class, $call_init = true) { |