3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright Tech To The People (c) 2010 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM Survey Respondant.
31 * @deprecated - api currently not supported
33 * @package CiviCRM_APIv3
37 * Notify caller of deprecated function.
39 * @deprecated api notice
41 * String output indicates this entire api entity as deprecated
43 function _civicrm_api3_survey_respondant_deprecation() {
44 return 'The SurveyRespondant api is not currently supported.';
48 * Get the list of signatories.
50 * @deprecated - api currently not supported
52 * @param array $params
57 function civicrm_api3_survey_respondant_get(&$params) {
59 civicrm_api3_verify_one_mandatory($params, NULL, array('survey_id', 'id'));
61 if (array_key_exists('survey_id', $params)) {
62 $surveyID = $params['survey_id'];
65 $surveyID = $params['id'];
68 $interviewerID = NULL;
69 if (array_key_exists('interviewer_id', $params)) {
70 $interviewerID = $params['interviewer_id'];
74 if (array_key_exists('status_id', $params)) {
75 $statusIds = explode(',', $params['status_id']);
78 $respondants = CRM_Campaign_BAO_Survey
::getSurveyActivities($surveyID, $interviewerID, $statusIds);
80 return (civicrm_api3_create_success($respondants, $params, 'SurveyRespondant', 'get'));
84 * Count survey respondents.
86 * @deprecated - api currently not supported
88 * @param array $params
91 function &civicrm_api3_survey_respondant_count($params) {
93 $petition = new CRM_Campaign_BAO_Petition();
94 if (array_key_exists('groupby', $params) &&
95 $params['groupby'] == 'country'
97 $signaturesCount = $petition->getPetitionSignatureTotalbyCountry($params['survey_id']);
100 $signaturesCount = $petition->getPetitionSignatureTotal($params['survey_id']);
102 return ($signaturesCount);