Merge pull request #4923 from colemanw/invoice_id

[civicrm-core.git] / api / v3 / SurveyRespondant.php

diff --git a/api/v3/SurveyRespondant.php b/api/v3/SurveyRespondant.php
index b81ca55af5ac95abf85451840b29028c459d7161..11cd9170de39f83edc64c73f9ab54aba7d1a7ce4 100644 (file)
--- a/api/v3/SurveyRespondant.php
+++ b/api/v3/SurveyRespondant.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright Tech To The People (c) 2010                              |
  +--------------------------------------------------------------------+
@@ -33,15 +32,23 @@
  * @subpackage API_Survey
  */
 
+/**
+ * @deprecated api notice
+ * @return string
+ *   to indicate this entire api entity is deprecated
+ */
+function _civicrm_api3_survey_respondant_deprecation() {
+  return 'The survey_respondant api is not currently supported.';
+}
+
 /**
  * Get the list of signatories
- *
- * @param  array   $params           (reference ) input parameters
- *
- * @return array (reference )        contribution_id of created or updated record
- * @static void
- * @access public
  * @deprecated - api currently not supported
+ * @param array $params
+ *   (reference ) input parameters.
+ *
+ * @return array
+ *  contribution_id of created or updated record
  */
 function civicrm_api3_survey_respondant_get(&$params) {
 
@@ -57,7 +64,7 @@ function civicrm_api3_survey_respondant_get(&$params) {
   $interviewerID = NULL;
   if (array_key_exists('interviewer_id', $params)) {
     $interviewerID = $params['interviewer_id'];
-}
+  }
 
   $statusIds = array();
   if (array_key_exists('status_id', $params)) {
@@ -71,6 +78,8 @@ function civicrm_api3_survey_respondant_get(&$params) {
 
 /**
  * @deprecated - api currently not supported
+ * @param array $params
+ * @return array
  */
 function &civicrm_api3_survey_respondant_count($params) {
 
@@ -85,4 +94,3 @@ function &civicrm_api3_survey_respondant_count($params) {
   }
   return ($signaturesCount);
 }
-