api/v3/ParticipantStatusType.php

   1 <?php
   2 // $Id$
   3
   4 /*
   5  +--------------------------------------------------------------------+
   6  | CiviCRM version 4.3                                                |
   7  +--------------------------------------------------------------------+
   8  | Copyright CiviCRM LLC (c) 2004-2013                                |
   9  +--------------------------------------------------------------------+
  10  | This file is a part of CiviCRM.                                    |
  11  |                                                                    |
  12  | CiviCRM is free software; you can copy, modify, and distribute it  |
  13  | under the terms of the GNU Affero General Public License           |
  14  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  15  |                                                                    |
  16  | CiviCRM is distributed in the hope that it will be useful, but     |
  17  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  18  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  19  | See the GNU Affero General Public License for more details.        |
  20  |                                                                    |
  21  | You should have received a copy of the GNU Affero General Public   |
  22  | License and the CiviCRM Licensing Exception along                  |
  23  | with this program; if not, contact CiviCRM LLC                     |
  24  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  25  | GNU Affero General Public License or the licensing of CiviCRM,     |
  26  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  27  +--------------------------------------------------------------------+
  28  */
  29
  30 /**
  31  * File for the CiviCRM APIv3 group functions
  32  *
  33  * @package CiviCRM_APIv3
  34  * @subpackage API_Event
  35  * @copyright CiviCRM LLC (c) 2004-2013
  36  */
  37
  38 require_once 'CRM/Event/BAO/ParticipantStatusType.php';
  39 require_once 'api/v3/utils.php';
  40
  41 /**
  42  * create/update participant_status
  43  *
  44  * This API is used to create new participant_status or update any of the existing
  45  * In case of updating existing participant_status, id of that particular participant_status must
  46  * be in $params array.
  47  *
  48  * @param array $params  (referance) Associative array of property
  49  *                       name/value pairs to insert in new 'participant_status'
  50  *
  51  * @return array   participant_status array
  52  * {@getfields ParticipantStatusType_create}
  53  * @example ParticipantStatusTypeCreate.php
  54  * @access public
  55  */
  56 function civicrm_api3_participant_status_type_create($params) {
  57   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  58 }
  59
  60 /**
  61  * Returns array of participant_statuss  matching a set of one or more group properties
  62  *
  63  * @param array $params  (referance) Array of one or more valid
  64  *                       property_name=>value pairs. If $params is set
  65  *                       as null, all participant_statuss will be returned
  66  *
  67  * @return array  (referance) Array of matching participant_statuses
  68  * {@getfields ParticipantStatusType_get}
  69  * @example ParticipantStatusTypeGet.php
  70  * @access public
  71  */
  72 function civicrm_api3_participant_status_type_get($params) {
  73   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  74 }
  75
  76 /**
  77  * delete an existing participant_status
  78  *
  79  * This method is used to delete any existing participant_status. id of the group
  80  * to be deleted is required field in $params array
  81  *
  82  * @param array $params  (reference) array containing id of the group
  83  *                       to be deleted
  84  *
  85  * @return array  (referance) returns flag true if successfull, error
  86  *                message otherwise
  87  * {@getfields ParticipantStatusType_delete}
  88  * @example ParticipantStatusTypeDelete.php
  89  * @access public
  90  */
  91 function civicrm_api3_participant_status_type_delete($params) {
  92   if (CRM_Event_BAO_ParticipantStatusType::deleteParticipantStatusType($params['id'])) {
  93     return civicrm_api3_create_success(TRUE);
  94   }
  95
  96   return civicrm_api3_create_error(TRUE);
  97 }
  98