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 * File for the CiviCRM APIv3 Survey Respondant functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_Survey
36 * @deprecated api notice
38 * to indicate this entire api entity is deprecated
40 function _civicrm_api3_survey_respondant_deprecation() {
41 return 'The survey_respondant api is not currently supported.';
45 * Get the list of signatories
47 * @param array $params
48 * (reference ) input parameters.
51 * (reference ) contribution_id of created or updated record
53 * @deprecated - api currently not supported
55 function civicrm_api3_survey_respondant_get(&$params) {
57 civicrm_api3_verify_one_mandatory($params, NULL, array('survey_id', 'id'));
59 if (array_key_exists('survey_id', $params)) {
60 $surveyID = $params['survey_id'];
63 $surveyID = $params['id'];
66 $interviewerID = NULL;
67 if (array_key_exists('interviewer_id', $params)) {
68 $interviewerID = $params['interviewer_id'];
72 if (array_key_exists('status_id', $params)) {
73 $statusIds = explode(',', $params['status_id']);
76 $respondants = CRM_Campaign_BAO_Survey
::getSurveyActivities($surveyID, $interviewerID, $statusIds);
78 return (civicrm_api3_create_success($respondants, $params));
82 * @deprecated - api currently not supported
84 function &civicrm_api3_survey_respondant_count($params) {
86 $petition = new CRM_Campaign_BAO_Petition();
87 if (array_key_exists('groupby', $params) &&
88 $params['groupby'] == 'country'
90 $signaturesCount = $petition->getPetitionSignatureTotalbyCountry($params['survey_id']);
93 $signaturesCount = $petition->getPetitionSignatureTotal($params['survey_id']);
95 return ($signaturesCount);