crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/api/v3/ParticipantStatusType.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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  * This api exposes CiviCRM participant status options.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Create/update participant_status.
  36  *
  37  * This API is used to create new participant_status or update any of the existing
  38  * In case of updating existing participant_status, id of that particular participant_status must
  39  * be in $params array.
  40  *
  41  * @param array $params
  42  *   name/value pairs to insert in new 'participant_status'
  43  *
  44  * @return array
  45  *   participant_status array
  46  */
  47 function civicrm_api3_participant_status_type_create($params) {
  48   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  49 }
  50
  51 /**
  52  * Returns array of participant_statuses matching a set of one or more group properties.
  53  *
  54  * @param array $params
  55  *   Array of properties. If empty, all records will be returned.
  56  *
  57  * @return array
  58  *   Array of matching participant_statuses
  59  */
  60 function civicrm_api3_participant_status_type_get($params) {
  61   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  62 }
  63
  64 /**
  65  * Delete an existing participant_status.
  66  *
  67  * This method is used to delete any existing participant_status given its id.
  68  *
  69  * @param array $params
  70  *   [id]
  71  *
  72  * @return array
  73  *   api result array
  74  */
  75 function civicrm_api3_participant_status_type_delete($params) {
  76   if (CRM_Event_BAO_ParticipantStatusType::deleteParticipantStatusType($params['id'])) {
  77     return civicrm_api3_create_success(TRUE);
  78   }
  79
  80   return civicrm_api3_create_error(TRUE);
  81 }