| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.7 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
| 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 | * This api exposes CiviCRM survey/petition records. |
| 30 | * |
| 31 | * @note Campaign component must be enabled. |
| 32 | * @note There is no "petition" api. |
| 33 | * Surveys and petitions are the same basic object and this api is used for both. |
| 34 | * |
| 35 | * @package CiviCRM_APIv3 |
| 36 | */ |
| 37 | |
| 38 | |
| 39 | /** |
| 40 | * Create or update a survey. |
| 41 | * |
| 42 | * @param array $params |
| 43 | * Array per getfields metadata. |
| 44 | * |
| 45 | * @return array |
| 46 | * api result array |
| 47 | */ |
| 48 | function civicrm_api3_survey_create($params) { |
| 49 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Survey'); |
| 50 | } |
| 51 | |
| 52 | /** |
| 53 | * Adjust Metadata for Create action. |
| 54 | * |
| 55 | * The metadata is used for setting defaults, documentation & validation. |
| 56 | * |
| 57 | * @param array $params |
| 58 | * Array of parameters determined by getfields. |
| 59 | */ |
| 60 | function _civicrm_api3_survey_create_spec(&$params) { |
| 61 | $params['title']['api.required'] = 1; |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * Returns array of surveys matching a set of one or more group properties. |
| 66 | * |
| 67 | * @param array $params |
| 68 | * Array of properties. If empty, all records will be returned. |
| 69 | * |
| 70 | * @return array |
| 71 | * API result Array of matching surveys |
| 72 | */ |
| 73 | function civicrm_api3_survey_get($params) { |
| 74 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Survey'); |
| 75 | } |
| 76 | |
| 77 | /** |
| 78 | * Delete an existing survey. |
| 79 | * |
| 80 | * This method is used to delete any existing survey given its id. |
| 81 | * |
| 82 | * @param array $params |
| 83 | * [id] |
| 84 | * |
| 85 | * @return array |
| 86 | * api result array |
| 87 | */ |
| 88 | function civicrm_api3_survey_delete($params) { |
| 89 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Set default getlist parameters. |
| 94 | * |
| 95 | * @see _civicrm_api3_generic_getlist_defaults |
| 96 | * |
| 97 | * @param array $request |
| 98 | * |
| 99 | * @return array |
| 100 | */ |
| 101 | function _civicrm_api3_survey_getlist_defaults(&$request) { |
| 102 | return array( |
| 103 | 'description_field' => array( |
| 104 | 'campaign_id', |
| 105 | ), |
| 106 | 'params' => array( |
| 107 | 'is_active' => 1, |
| 108 | ), |
| 109 | ); |
| 110 | } |