api/v3/Campaign.php

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