INFRA-132 - Batch 14 (g)

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

diff --git a/api/v3/Event.php b/api/v3/Event.php
index 410e37068f46c513897a34be9296c3bf520c15dc..cc4f08fe10018bb7eae05323812c58b7a9c545bd 100644 (file)
--- a/api/v3/Event.php
+++ b/api/v3/Event.php
@@ -49,7 +49,6 @@
  *
  * @return array
  *   API result Array.
- * @access public
  */
 function civicrm_api3_event_create($params) {
   civicrm_api3_verify_one_mandatory($params, NULL, array('event_type_id', 'template_id'));
@@ -85,6 +84,7 @@ function _civicrm_api3_event_create_spec(&$params) {
  * The main purpose of the API is to provide integrators a level of stability not provided by
  * the core code or schema - this means we have to provide support for api calls (where possible)
  * across schema changes.
+ * @param array $params
  */
 function _civicrm_api3_event_create_legacy_support_42(&$params) {
   if (!empty($params['payment_processor_id'])) {
@@ -95,15 +95,10 @@ function _civicrm_api3_event_create_legacy_support_42(&$params) {
 /**
  * Get Event record.
  *
- *
  * @param array $params
- *   An associative array of name/value property values of civicrm_event.
- * {@getfields event_get}
  *
  * @return array
  *   Array of all found event property values.
- * @access public
- *
  */
 function civicrm_api3_event_get($params) {
 
@@ -171,6 +166,8 @@ function _civicrm_api3_event_get_spec(&$params) {
  * The main purpose of the API is to provide integrators a level of stability not provided by
  * the core code or schema - this means we have to provide support for api calls (where possible)
  * across schema changes.
+ * @param $event
+ * @param $event_id
  */
 function _civicrm_api3_event_get_legacy_support_42(&$event, $event_id) {
   if (!empty($event[$event_id]['payment_processor'])) {
@@ -186,17 +183,10 @@ function _civicrm_api3_event_get_legacy_support_42(&$event, $event_id) {
  *
  * This API is used for deleting a event
  *
- * @param array $paramsArray containing event_id to be deleted.
- *   Array containing event_id to be deleted.
- *
- * @return boolean
- *   true if success, error otherwise
- * @access public
- *   note API has legacy support for 'event_id'
- *  {@getfields event_delete}
+ * @param array $params
+ * @return array
  */
 function civicrm_api3_event_delete($params) {
-
   return CRM_Event_BAO_Event::del($params['id']) ? civicrm_api3_create_success() : civicrm_api3_create_error(ts('Error while deleting event'));
 }
 /*