Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 TO |
5 | +--------------------------------------------------------------------+ |
6 | | Copyright Tech To The People (c) 2010 | | |
7 | +--------------------------------------------------------------------+ | |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
c28e1768 | 29 | * This api exposes CiviCRM Survey Respondant. |
6a488035 | 30 | * |
b081365f CW |
31 | * @deprecated - api currently not supported |
32 | * | |
6a488035 | 33 | * @package CiviCRM_APIv3 |
6a488035 TO |
34 | */ |
35 | ||
a14e9d08 | 36 | /** |
22242c87 EM |
37 | * Notify caller of deprecated function. |
38 | * | |
a14e9d08 | 39 | * @deprecated api notice |
a6c01b45 | 40 | * @return string |
244bbdd8 | 41 | * String output indicates this entire api entity as deprecated |
a14e9d08 CW |
42 | */ |
43 | function _civicrm_api3_survey_respondant_deprecation() { | |
244bbdd8 | 44 | return 'The SurveyRespondant api is not currently supported.'; |
a14e9d08 CW |
45 | } |
46 | ||
6a488035 | 47 | /** |
dc64d047 EM |
48 | * Get the list of signatories. |
49 | * | |
c23f45d3 | 50 | * @deprecated - api currently not supported |
22242c87 | 51 | * |
cf470720 | 52 | * @param array $params |
22242c87 | 53 | * input parameters. |
6a488035 | 54 | * |
a6c01b45 | 55 | * @return array |
6a488035 TO |
56 | */ |
57 | function civicrm_api3_survey_respondant_get(&$params) { | |
58 | ||
59 | civicrm_api3_verify_one_mandatory($params, NULL, array('survey_id', 'id')); | |
60 | ||
61 | if (array_key_exists('survey_id', $params)) { | |
62 | $surveyID = $params['survey_id']; | |
63 | } | |
64 | else { | |
65 | $surveyID = $params['id']; | |
66 | } | |
67 | ||
68 | $interviewerID = NULL; | |
69 | if (array_key_exists('interviewer_id', $params)) { | |
70 | $interviewerID = $params['interviewer_id']; | |
35671d00 | 71 | } |
6a488035 TO |
72 | |
73 | $statusIds = array(); | |
74 | if (array_key_exists('status_id', $params)) { | |
75 | $statusIds = explode(',', $params['status_id']); | |
76 | } | |
77 | ||
78 | $respondants = CRM_Campaign_BAO_Survey::getSurveyActivities($surveyID, $interviewerID, $statusIds); | |
79 | ||
a6ec24c4 | 80 | return (civicrm_api3_create_success($respondants, $params, 'SurveyRespondant', 'get')); |
6a488035 TO |
81 | } |
82 | ||
11e09c59 | 83 | /** |
dc64d047 EM |
84 | * Count survey respondents. |
85 | * | |
6a488035 | 86 | * @deprecated - api currently not supported |
dc64d047 | 87 | * |
d0997921 | 88 | * @param array $params |
645ee340 | 89 | * @return array |
6a488035 TO |
90 | */ |
91 | function &civicrm_api3_survey_respondant_count($params) { | |
92 | ||
93 | $petition = new CRM_Campaign_BAO_Petition(); | |
94 | if (array_key_exists('groupby', $params) && | |
95 | $params['groupby'] == 'country' | |
96 | ) { | |
97 | $signaturesCount = $petition->getPetitionSignatureTotalbyCountry($params['survey_id']); | |
98 | } | |
99 | else { | |
100 | $signaturesCount = $petition->getPetitionSignatureTotal($params['survey_id']); | |
101 | } | |
102 | return ($signaturesCount); | |
103 | } |