Merge pull request #4923 from colemanw/invoice_id

[civicrm-core.git] / api / v3 / ParticipantStatusType.php

diff --git a/api/v3/ParticipantStatusType.php b/api/v3/ParticipantStatusType.php
index 43b8b30534cfd6c2f51fa09a08dc692e30d13bec..e789623e0f0a436773a873f5a7b0e66cfb6c05f6 100644 (file)
--- a/api/v3/ParticipantStatusType.php
+++ b/api/v3/ParticipantStatusType.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -34,8 +33,6 @@
  * @copyright CiviCRM LLC (c) 2004-2014
  */
 
-require_once 'api/v3/utils.php';
-
 /**
  * create/update participant_status
  *
@@ -43,29 +40,31 @@ require_once 'api/v3/utils.php';
  * In case of updating existing participant_status, id of that particular participant_status must
  * be in $params array.
  *
- * @param array $params  (referance) Associative array of property
+ * @param array $params
+ *   Associative array of property.
  *                       name/value pairs to insert in new 'participant_status'
  *
- * @return array   participant_status array
+ * @return array
+ *   participant_status array
  * {@getfields ParticipantStatusType_create}
  * @example ParticipantStatusTypeCreate.php
- * @access public
  */
 function civicrm_api3_participant_status_type_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Returns array of participant_statuss  matching a set of one or more group properties
+ * Returns array of participant_statuses  matching a set of one or more group properties
  *
- * @param array $params  (referance) Array of one or more valid
+ * @param array $params
+ *   Array of one or more valid.
  *                       property_name=>value pairs. If $params is set
- *                       as null, all participant_statuss will be returned
+ *                       as null, all participant_statuses will be returned
  *
- * @return array  (referance) Array of matching participant_statuses
+ * @return array
+ *   Array of matching participant_statuses
  * {@getfields ParticipantStatusType_get}
  * @example ParticipantStatusTypeGet.php
- * @access public
  */
 function civicrm_api3_participant_status_type_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -77,14 +76,14 @@ function civicrm_api3_participant_status_type_get($params) {
  * This method is used to delete any existing participant_status. id of the group
  * to be deleted is required field in $params array
  *
- * @param array $params  (reference) array containing id of the group
+ * @param array $params
+ *   (reference) array containing id of the group.
  *                       to be deleted
  *
- * @return array  (referance) returns flag true if successfull, error
- *                message otherwise
+ * @return array
+ *   api result array
  * {@getfields ParticipantStatusType_delete}
  * @example ParticipantStatusTypeDelete.php
- * @access public
  */
 function civicrm_api3_participant_status_type_delete($params) {
   if (CRM_Event_BAO_ParticipantStatusType::deleteParticipantStatusType($params['id'])) {
@@ -93,4 +92,3 @@ function civicrm_api3_participant_status_type_delete($params) {
 
   return civicrm_api3_create_error(TRUE);
 }
-