api/v3/Survey.php

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