api/v3/Campaign.php

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