api/v3/Survey.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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
  33  * @copyright CiviCRM LLC (c) 2004-2014
  34  */
  35
  36
  37 /**
  38  * Create or update a survey.
  39  *
  40  * @param array $params
  41  *   Array per getfields metadata.
  42  *
  43  * @return array
  44  *   api result array
  45  */
  46 function civicrm_api3_survey_create($params) {
  47   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Survey');
  48 }
  49
  50 /**
  51  * Adjust Metadata for Create action.
  52  *
  53  * The metadata is used for setting defaults, documentation & validation.
  54  *
  55  * @param array $params
  56  *   Array or parameters determined by getfields.
  57  */
  58 function _civicrm_api3_survey_create_spec(&$params) {
  59   $params['title']['api.required'] = 1;
  60 }
  61
  62 /**
  63  * Returns array of surveys  matching a set of one or more group properties.
  64  *
  65  * @param array $params
  66  *   Array of one or more valid.
  67  *                       property_name=>value pairs. If $params is set
  68  *                       as null, all surveys 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. id of the group
  81  * to be deleted is required field in $params array
  82  *
  83  * @param array $params
  84  *   Array containing id of the group.
  85  *                       to be deleted
  86  *
  87  * @return array
  88  *   api result array
  89  */
  90 function civicrm_api3_survey_delete($params) {
  91   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  92 }