5 +--------------------------------------------------------------------+
6 | CiviCRM version 4.3 |
7 +--------------------------------------------------------------------+
8 | Copyright CiviCRM LLC (c) 2004-2013 |
9 +--------------------------------------------------------------------+
10 | This file is a part of CiviCRM. |
12 | CiviCRM is free software; you can copy, modify, and distribute it |
13 | under the terms of the GNU Affero General Public License |
14 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
16 | CiviCRM is distributed in the hope that it will be useful, but |
17 | WITHOUT ANY WARRANTY; without even the implied warranty of |
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
19 | See the GNU Affero General Public License for more details. |
21 | You should have received a copy of the GNU Affero General Public |
22 | License and the CiviCRM Licensing Exception along |
23 | with this program; if not, contact CiviCRM LLC |
24 | at info[AT]civicrm[DOT]org. If you have questions about the |
25 | GNU Affero General Public License or the licensing of CiviCRM, |
26 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
27 +--------------------------------------------------------------------+
31 * File for the CiviCRM APIv3 group functions
33 * @package CiviCRM_APIv3
34 * @subpackage API_Campaign
35 * @copyright CiviCRM LLC (c) 2004-2013
39 * create/update campaign
41 * This API is used to create new campaign or update any of the existing
42 * In case of updating existing campaign, id of that particular campaign must
43 * be in $params array.
45 * @param array $params (referance) Associative array of property
46 * name/value pairs to insert in new 'campaign'
48 * @return array campaign array
49 * {@getfields campaign_create}
52 function civicrm_api3_campaign_create($params) {
53 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
57 * Adjust Metadata for Create action
59 * The metadata is used for setting defaults, documentation & validation
60 * @param array $params array or parameters determined by getfields
62 function _civicrm_api3_campaign_create_spec(&$params) {
63 $params['title']['api.required'] = 1;
67 * Returns array of campaigns matching a set of one or more group properties
69 * @param array $params (referance) Array of one or more valid
70 * property_name=>value pairs. If $params is set
71 * as null, all campaigns will be returned
73 * @return array (referance) Array of matching campaigns
75 * {@getfields campaign_get}
77 function civicrm_api3_campaign_get($params) {
78 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
82 * delete an existing campaign
84 * This method is used to delete any existing campaign. id of the group
85 * to be deleted is required field in $params array
87 * @param array $params (reference) array containing id of the group
90 * @return array (referance) returns flag true if successfull, error
92 * {@getfields campaign_delete}
95 function civicrm_api3_campaign_delete($params) {
96 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);