From 1cfa04c4ad9aeb45b857ef36fb606f44f1a06378 Mon Sep 17 00:00:00 2001
From: Eileen McNaughton <eileen@fuzion.co.nz>
Date: Wed, 30 Apr 2014 14:52:57 -0700
Subject: [PATCH] comment fixes only
---
CRM/Activity/BAO/Activity.php | 27 ++++++++++++++++-----------
CRM/Contact/BAO/Relationship.php | 4 ++--
api/v3/Case.php | 8 +++-----
api/v3/utils.php | 8 +++++++-
4 files changed, 28 insertions(+), 19 deletions(-)
diff --git a/CRM/Activity/BAO/Activity.php b/CRM/Activity/BAO/Activity.php
index dc34ec4cc6..bc4cd67b9f 100644
--- a/CRM/Activity/BAO/Activity.php
+++ b/CRM/Activity/BAO/Activity.php
@@ -77,9 +77,10 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
* of time. This is the inverse function of create. It also stores all the retrieved
* values in the default array
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $defaults (reference ) an assoc array to hold the flattened values
- * @param string $activityType activity type
+ * @param array $params (reference ) an assoc array of name/value pairs
+ * @param array $defaults (reference ) an assoc array to hold the flattened values
+ *
+ * @internal param string $activityType activity type
*
* @return object CRM_Core_BAO_Meeting object
* @access public
@@ -271,14 +272,15 @@ class CRM_Activity_BAO_Activity extends CRM_Activity_DAO_Activity {
/**
* Function to process the activities
*
- * @param object $form form object
- * @param array $params associated array of the submitted values
- * @param array $ids array of ids
- * @param string $activityType activity Type
- * @param boolean $record true if it is Record Activity
+ * @param array $params associated array of the submitted values
+ *
+ * @internal param object $form form object
+ * @internal param array $ids array of ids
+ * @internal param string $activityType activity Type
+ * @internal param bool $record true if it is Record Activity
* @access public
*
- * @return
+ * @return $this|null|object
*/
public static function create(&$params) {
// check required params
@@ -1751,10 +1753,13 @@ WHERE activity.id IN ($activityIds)";
/**
* Function to add activity for Membership/Event/Contribution
*
- * @param object $activity (reference) particular component object
- * @param string $activityType for Membership Signup or Renewal
+ * @param object $activity (reference) particular component object
+ * @param string $activityType for Membership Signup or Renewal
+ *
*
+ * @param null $targetContactID
*
+ * @return bool
* @static
* @access public
*/
diff --git a/CRM/Contact/BAO/Relationship.php b/CRM/Contact/BAO/Relationship.php
index 42e5cf864d..a9906e2f15 100644
--- a/CRM/Contact/BAO/Relationship.php
+++ b/CRM/Contact/BAO/Relationship.php
@@ -1112,8 +1112,8 @@ LEFT JOIN civicrm_country ON (civicrm_address.country_id = civicrm_country.id)
}
$values[$rid]['action'] = CRM_Core_Action::formLink(
- $links,
- $mask,
+ $links,
+ $mask,
$replace,
ts('more'),
FALSE,
diff --git a/api/v3/Case.php b/api/v3/Case.php
index d595f23ac9..9ad41360ab 100644
--- a/api/v3/Case.php
+++ b/api/v3/Case.php
@@ -175,8 +175,8 @@ function _civicrm_api3_case_delete_spec(&$params) {
*
* Please provide one (and only one) of the four get/search parameters:
*
- * @param array(
- 'id' => if set, will get all available info about a case, including contacts and activities
+ * @param array (
+ * 'id' => if set, will get all available info about a case, including contacts and activities
*
* // if no case_id provided, this function will use one of the following search parameters:
* 'client_id' => finds all cases with a specific client
@@ -185,12 +185,10 @@ function _civicrm_api3_case_delete_spec(&$params) {
*
* {@getfields case_get}
*
- * @return (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found
- * @access public
+ * @return array (get mode, case_id provided): Array with case details, case roles, case activity ids, (search mode, case_id not provided): Array of cases found@access public
* @todo Erik Hommel 16 dec 2010 check if all DB fields are returned
*/
function civicrm_api3_case_get($params) {
- $options = _civicrm_api3_get_options_from_params($params);
//search by client
if (!empty($params['contact_id'])) {
diff --git a/api/v3/utils.php b/api/v3/utils.php
index 31c5d626da..673f2c3783 100644
--- a/api/v3/utils.php
+++ b/api/v3/utils.php
@@ -657,6 +657,7 @@ function _civicrm_api3_apply_filters_to_dao($filterField, $filterValue, &$dao) {
* @param string $entity
* @param string $action
*
+ * @throws API_Exception
* @return array $options options extracted from params
*/
function _civicrm_api3_get_options_from_params(&$params, $queryObject = FALSE, $entity = '', $action = '') {
@@ -804,11 +805,13 @@ function _civicrm_api3_get_unique_name_array(&$bao) {
/**
* Converts an DAO object to an array
*
- * @param object $dao (reference )object to convert
+ * @param object $dao (reference )object to convert
* @param null $params
* @param bool $uniqueFields
* @param string $entity
*
+ * @param bool $autoFind
+ *
* @return array
*
* @params array of arrays (key = id) of array of fields
@@ -999,9 +1002,12 @@ function _civicrm_api3_basic_get($bao_name, &$params, $returnAsSuccess = TRUE, $
/**
* Function to do a 'standard' api create - when the api is only doing a $bao::create then use this
+ *
* @param string $bao_name Name of BAO Class
* @param array $params parameters passed into the api call
* @param string $entity Entity - pass in if entity is non-standard & required $ids array
+ *
+ * @throws API_Exception
* @return array
*/
function _civicrm_api3_basic_create($bao_name, &$params, $entity = NULL) {
--
2.25.1