X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FCampaign.php;h=0f8570b339d3adf8d72743706bb7b0fbdd5d855a;hb=8d219c3680f87e8a50cf28095feeebfbdcd28d17;hp=e33b2edc75522af56afdfe15cdbbbfcf010621ca;hpb=358237633f0cf63b70afac959445c89fed56e75e;p=civicrm-core.git diff --git a/api/v3/Campaign.php b/api/v3/Campaign.php index e33b2edc75..0f8570b339 100644 --- a/api/v3/Campaign.php +++ b/api/v3/Campaign.php @@ -3,7 +3,7 @@ +--------------------------------------------------------------------+ | CiviCRM version 4.6 | +--------------------------------------------------------------------+ - | Copyright CiviCRM LLC (c) 2004-2014 | + | Copyright CiviCRM LLC (c) 2004-2015 | +--------------------------------------------------------------------+ | This file is a part of CiviCRM. | | | @@ -26,15 +26,15 @@ */ /** - * 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 @@ -54,14 +54,14 @@ function civicrm_api3_campaign_create($params) { * The metadata is used for setting defaults, documentation & validation. * * @param array $params - * Array or parameters determined by getfields. + * 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 per getfields @@ -76,8 +76,8 @@ function civicrm_api3_campaign_get($params) { /** * 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 * array containing id of the group to be deleted