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  *   Associative array of property.
  42  *                       name/value pairs to insert in new 'survey'
  43  * @example SurveyCreate.php Std Create example
  44  *
  45  * @return array
  46  *   api result array
  47  *   {@getfields survey_create}
  48  */
  49 function civicrm_api3_survey_create($params) {
  50   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Survey');
  51 }
  52
  53 /**
  54  * Adjust Metadata for Create action
  55  *
  56  * The metadata is used for setting defaults, documentation & validation
  57  * @param array $params
  58  *   Array or 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 one or more valid.
  69  *                       property_name=>value pairs. If $params is set
  70  *                       as null, all surveys will be returned
  71  *
  72  * @return array
  73  *   API result Array of matching surveys
  74  *   {@getfields survey_get}
  75  */
  76 function civicrm_api3_survey_get($params) {
  77   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Survey');
  78 }
  79
  80 /**
  81  * delete an existing survey
  82  *
  83  * This method is used to delete any existing survey. id of the group
  84  * to be deleted is required field in $params array
  85  *
  86  * @param array $params
  87  *   Array containing id of the group.
  88  *                       to be deleted
  89  *
  90  * @return array
  91  *   api result array
  92  *   {@getfields survey_delete}
  93  */
  94 function civicrm_api3_survey_delete($params) {
  95   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  96 }