4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.3 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2013 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
11 | CiviCRM is free software; you can copy, modify, and distribute it |
12 | under the terms of the GNU Affero General Public License |
13 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
15 | CiviCRM is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
18 | See the GNU Affero General Public License for more details. |
20 | You should have received a copy of the GNU Affero General Public |
21 | License and the CiviCRM Licensing Exception along |
22 | with this program; if not, contact CiviCRM LLC |
23 | at info[AT]civicrm[DOT]org. If you have questions about the |
24 | GNU Affero General Public License or the licensing of CiviCRM, |
25 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
26 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 group functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_Survey
34 * @copyright CiviCRM LLC (c) 2004-2013
39 * Create or update a survey
41 * @param array $params Associative array of property
42 * name/value pairs to insert in new 'survey'
43 * @example SurveyCreate.php Std Create example
45 * @return array api result array
46 * {@getfields survey_create}
49 function civicrm_api3_survey_create($params) {
50 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
54 * Adjust Metadata for Create action
56 * The metadata is used for setting defaults, documentation & validation
57 * @param array $params array or parameters determined by getfields
59 function _civicrm_api3_survey_create_spec(&$params) {
60 $params['title']['api.required'] = 1;
64 * Returns array of surveys matching a set of one or more group properties
66 * @param array $params (referance) Array of one or more valid
67 * property_name=>value pairs. If $params is set
68 * as null, all surveys will be returned
70 * @return array (referance) Array of matching surveys
71 * {@getfields survey_get}
74 function civicrm_api3_survey_get($params) {
75 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
79 * delete an existing survey
81 * This method is used to delete any existing survey. id of the group
82 * to be deleted is required field in $params array
84 * @param array $params (reference) array containing id of the group
87 * @return array (referance) returns flag true if successfull, error
89 * {@getfields survey_delete}
92 function civicrm_api3_survey_delete($params) {
93 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);