api/v3/Survey.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  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.   |
  14  |                                                                    |
  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.        |
  19  |                                                                    |
  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  +--------------------------------------------------------------------+
  27  */
  28
  29 /**
  30  * File for the CiviCRM APIv3 group functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_Survey
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  */
  36
  37
  38 /**
  39  * Create or update a survey
  40  *
  41  * @param array $params
  42  *   Associative array of property.
  43  *                       name/value pairs to insert in new 'survey'
  44  * @example SurveyCreate.php Std Create example
  45  *
  46  * @return array api result array
  47  * {@getfields survey_create}
  48  * @access public
  49  */
  50 function civicrm_api3_survey_create($params) {
  51   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Survey');
  52 }
  53
  54 /**
  55  * Adjust Metadata for Create action
  56  *
  57  * The metadata is used for setting defaults, documentation & validation
  58  * @param array $params
  59  *   Array or parameters determined by getfields.
  60  */
  61 function _civicrm_api3_survey_create_spec(&$params) {
  62   $params['title']['api.required'] = 1;
  63 }
  64
  65 /**
  66  * Returns array of surveys  matching a set of one or more group properties
  67  *
  68  * @param array $params
  69  *   Array of one or more valid.
  70  *                       property_name=>value pairs. If $params is set
  71  *                       as null, all surveys will be returned
  72  *
  73  * @return array  API result Array of matching surveys
  74  * {@getfields survey_get}
  75  * @access public
  76  */
  77 function civicrm_api3_survey_get($params) {
  78   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Survey');
  79 }
  80
  81 /**
  82  * delete an existing survey
  83  *
  84  * This method is used to delete any existing survey. id of the group
  85  * to be deleted is required field in $params array
  86  *
  87  * @param array $params
  88  *   Array containing id of the group.
  89  *                       to be deleted
  90  *
  91  * @return array api result array
  92  * {@getfields survey_delete}
  93  * @access public
  94  */
  95 function civicrm_api3_survey_delete($params) {
  96   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  97 }