api/v3/ParticipantStatusType.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_Event
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  */
  36
  37 /**
  38  * create/update participant_status
  39  *
  40  * This API is used to create new participant_status or update any of the existing
  41  * In case of updating existing participant_status, id of that particular participant_status must
  42  * be in $params array.
  43  *
  44  * @param array $params
  45  *   Associative array of property.
  46  *                       name/value pairs to insert in new 'participant_status'
  47  *
  48  * @return array   participant_status array
  49  * {@getfields ParticipantStatusType_create}
  50  * @example ParticipantStatusTypeCreate.php
  51  * @access public
  52  */
  53 function civicrm_api3_participant_status_type_create($params) {
  54   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  55 }
  56
  57 /**
  58  * Returns array of participant_statuses  matching a set of one or more group properties
  59  *
  60  * @param array $params
  61  *   Array of one or more valid.
  62  *                       property_name=>value pairs. If $params is set
  63  *                       as null, all participant_statuses will be returned
  64  *
  65  * @return array Array of matching participant_statuses
  66  * {@getfields ParticipantStatusType_get}
  67  * @example ParticipantStatusTypeGet.php
  68  * @access public
  69  */
  70 function civicrm_api3_participant_status_type_get($params) {
  71   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  72 }
  73
  74 /**
  75  * delete an existing participant_status
  76  *
  77  * This method is used to delete any existing participant_status. id of the group
  78  * to be deleted is required field in $params array
  79  *
  80  * @param array $params
  81  *   (reference) array containing id of the group.
  82  *                       to be deleted
  83  *
  84  * @return array api result array
  85  * {@getfields ParticipantStatusType_delete}
  86  * @example ParticipantStatusTypeDelete.php
  87  * @access public
  88  */
  89 function civicrm_api3_participant_status_type_delete($params) {
  90   if (CRM_Event_BAO_ParticipantStatusType::deleteParticipantStatusType($params['id'])) {
  91     return civicrm_api3_create_success(TRUE);
  92   }
  93
  94   return civicrm_api3_create_error(TRUE);
  95 }
  96