api/v3/Campaign.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   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
  45  *   (reference) Associative array of property.
  46  *                       name/value pairs to insert in new 'campaign'
  47  *
  48  * @return array
  49  *   campaign array
  50  * {@getfields campaign_create}
  51  * @access public
  52  */
  53 function civicrm_api3_campaign_create($params) {
  54   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Campaign');
  55 }
  56
  57 /**
  58  * Adjust Metadata for Create action
  59  *
  60  * The metadata is used for setting defaults, documentation & validation
  61  * @param array $params
  62  *   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
  72  *   Array of one or more valid.
  73  *                       property_name=>value pairs. If $params is set
  74  *                       as null, all campaigns will be returned
  75  *
  76  * @return array
  77  *   Array of matching campaigns
  78  * @access public
  79  * {@getfields campaign_get}
  80  */
  81 function civicrm_api3_campaign_get($params) {
  82   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Campaign');
  83 }
  84
  85 /**
  86  * delete an existing campaign
  87  *
  88  * This method is used to delete any existing campaign. id of the group
  89  * to be deleted is required field in $params array
  90  *
  91  * @param array $params
  92  *   (reference) array containing id of the group.
  93  *                       to be deleted
  94  *
  95  * @return array
  96  *   (reference) returns flag true if successful, error
  97  *                message otherwise
  98  * {@getfields campaign_delete}
  99  * @access public
 100  */
 101 function civicrm_api3_campaign_delete($params) {
 102   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 103 }