Merge pull request #6356 from monishdeb/CRM-16931

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

diff --git a/api/v3/Campaign.php b/api/v3/Campaign.php
index 336d1eb4ef1114611c5fdb7c8b227dfc031ce74f..0f8570b339d3adf8d72743706bb7b0fbdd5d855a 100644 (file)
--- a/api/v3/Campaign.php
+++ b/api/v3/Campaign.php
@@ -1,10 +1,9 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -27,71 +26,64 @@
  */
 
 /**
- * File for the CiviCRM APIv3 group functions
+ * This api exposes CiviCRM Campaign records.
+ *
+ * @note Campaign component must be enabled.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Campaign
- * @copyright CiviCRM LLC (c) 2004-2014
  */
 
 /**
- * create/update campaign
+ * Create/update Campaign.
  *
  * This API is used to create new campaign or update any of the existing
  * In case of updating existing campaign, id of that particular campaign must
  * be in $params array.
  *
- * @param array $params  (reference) Associative array of property
- *                       name/value pairs to insert in new 'campaign'
+ * @param array $params
  *
- * @return array   campaign array
- * {@getfields campaign_create}
- * @access public
+ * @return array
  */
 function civicrm_api3_campaign_create($params) {
-  return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+  return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Campaign');
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
  *
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * The metadata is used for setting defaults, documentation & validation.
+ *
+ * @param array $params
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_campaign_create_spec(&$params) {
   $params['title']['api.required'] = 1;
 }
 
 /**
- * Returns array of campaigns  matching a set of one or more group properties
+ * Returns array of campaigns matching a set of one or more properties.
  *
- * @param array $params Array of one or more valid
- *                       property_name=>value pairs. If $params is set
- *                       as null, all campaigns will be returned
+ * @param array $params
+ *   Array per getfields
  *
- * @return array  Array of matching campaigns
- * @access public
- * {@getfields campaign_get}
+ * @return array
+ *   Array of matching campaigns
  */
 function civicrm_api3_campaign_get($params) {
-  return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
+  return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Campaign');
 }
 
 /**
- * delete an existing campaign
+ * Delete an existing campaign.
  *
- * This method is used to delete any existing campaign. id of the group
- * to be deleted is required field in $params array
+ * This method is used to delete any existing campaign.
+ * Id of the campaign to be deleted is required field in $params array
  *
- * @param array $params  (reference) array containing id of the group
- *                       to be deleted
+ * @param array $params
+ *   array containing id of the group to be deleted
  *
- * @return array  (reference) returns flag true if successful, error
- *                message otherwise
- * {@getfields campaign_delete}
- * @access public
+ * @return array
  */
 function civicrm_api3_campaign_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-