| 1 | <?php |
| 2 | // $Id$ |
| 3 | |
| 4 | /* |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | CiviCRM version 4.3 | |
| 7 | +--------------------------------------------------------------------+ |
| 8 | | Copyright CiviCRM LLC (c) 2004-2013 | |
| 9 | +--------------------------------------------------------------------+ |
| 10 | | This file is a part of CiviCRM. | |
| 11 | | | |
| 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. | |
| 15 | | | |
| 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. | |
| 20 | | | |
| 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 | +--------------------------------------------------------------------+ |
| 28 | */ |
| 29 | |
| 30 | /** |
| 31 | * File for the CiviCRM APIv3 group functions |
| 32 | * |
| 33 | * @package CiviCRM_APIv3 |
| 34 | * @subpackage API_Campaign |
| 35 | * @copyright CiviCRM LLC (c) 2004-2013 |
| 36 | */ |
| 37 | |
| 38 | require_once 'CRM/Campaign/BAO/Campaign.php'; |
| 39 | |
| 40 | /** |
| 41 | * create/update campaign |
| 42 | * |
| 43 | * This API is used to create new campaign or update any of the existing |
| 44 | * In case of updating existing campaign, id of that particular campaign must |
| 45 | * be in $params array. |
| 46 | * |
| 47 | * @param array $params (referance) Associative array of property |
| 48 | * name/value pairs to insert in new 'campaign' |
| 49 | * |
| 50 | * @return array campaign array |
| 51 | * {@getfields campaign_create} |
| 52 | * @access public |
| 53 | */ |
| 54 | function civicrm_api3_campaign_create($params) { |
| 55 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 56 | } |
| 57 | |
| 58 | /** |
| 59 | * Adjust Metadata for Create action |
| 60 | * |
| 61 | * The metadata is used for setting defaults, documentation & validation |
| 62 | * @param array $params array or parameters determined by getfields |
| 63 | */ |
| 64 | function _civicrm_api3_campaign_create_spec(&$params) { |
| 65 | $params['title']['api.required'] = 1; |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * Returns array of campaigns matching a set of one or more group properties |
| 70 | * |
| 71 | * @param array $params (referance) Array of one or more valid |
| 72 | * property_name=>value pairs. If $params is set |
| 73 | * as null, all campaigns will be returned |
| 74 | * |
| 75 | * @return array (referance) Array of matching campaigns |
| 76 | * @access public |
| 77 | * {@getfields campaign_get} |
| 78 | */ |
| 79 | function civicrm_api3_campaign_get($params) { |
| 80 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 81 | } |
| 82 | |
| 83 | /** |
| 84 | * delete an existing campaign |
| 85 | * |
| 86 | * This method is used to delete any existing campaign. id of the group |
| 87 | * to be deleted is required field in $params array |
| 88 | * |
| 89 | * @param array $params (reference) array containing id of the group |
| 90 | * to be deleted |
| 91 | * |
| 92 | * @return array (referance) returns flag true if successfull, error |
| 93 | * message otherwise |
| 94 | * {@getfields campaign_delete} |
| 95 | * @access public |
| 96 | */ |
| 97 | function civicrm_api3_campaign_delete($params) { |
| 98 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 99 | } |
| 100 | |