Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
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 | /** | |
29 | * File for the CiviCRM APIv3 group functions | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | * @subpackage API_Survey | |
731a0992 | 33 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
34 | */ |
35 | ||
36 | ||
37 | /** | |
2e66abf8 | 38 | * Create or update a survey. |
6a488035 | 39 | * |
cf470720 | 40 | * @param array $params |
2e66abf8 | 41 | * Array per getfields metadata. |
6a488035 | 42 | * |
a6c01b45 | 43 | * @return array |
72b3a70c | 44 | * api result array |
6a488035 TO |
45 | */ |
46 | function civicrm_api3_survey_create($params) { | |
bf38705f | 47 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Survey'); |
6a488035 | 48 | } |
11e09c59 TO |
49 | |
50 | /** | |
0aa0303c EM |
51 | * Adjust Metadata for Create action. |
52 | * | |
53 | * The metadata is used for setting defaults, documentation & validation. | |
6a488035 | 54 | * |
cf470720 TO |
55 | * @param array $params |
56 | * Array or parameters determined by getfields. | |
6a488035 TO |
57 | */ |
58 | function _civicrm_api3_survey_create_spec(&$params) { | |
59 | $params['title']['api.required'] = 1; | |
60 | } | |
61 | ||
62 | /** | |
2e66abf8 | 63 | * Returns array of surveys matching a set of one or more group properties. |
6a488035 | 64 | * |
cf470720 TO |
65 | * @param array $params |
66 | * Array of one or more valid. | |
6a488035 TO |
67 | * property_name=>value pairs. If $params is set |
68 | * as null, all surveys will be returned | |
69 | * | |
a6c01b45 | 70 | * @return array |
72b3a70c | 71 | * API result Array of matching surveys |
6a488035 TO |
72 | */ |
73 | function civicrm_api3_survey_get($params) { | |
bf38705f | 74 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Survey'); |
6a488035 TO |
75 | } |
76 | ||
77 | /** | |
2e66abf8 | 78 | * Delete an existing survey. |
6a488035 TO |
79 | * |
80 | * This method is used to delete any existing survey. id of the group | |
81 | * to be deleted is required field in $params array | |
82 | * | |
cf470720 TO |
83 | * @param array $params |
84 | * Array containing id of the group. | |
6a488035 TO |
85 | * to be deleted |
86 | * | |
a6c01b45 | 87 | * @return array |
72b3a70c | 88 | * api result array |
6a488035 TO |
89 | */ |
90 | function civicrm_api3_survey_delete($params) { | |
91 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
92 | } |