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  */
  51 function civicrm_api3_campaign_create($params) {
  52   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Campaign');
  53 }
  54
  55 /**
  56  * Adjust Metadata for Create action
  57  *
  58  * The metadata is used for setting defaults, documentation & validation
  59  * @param array $params
  60  *   Array or parameters determined by getfields.
  61  */
  62 function _civicrm_api3_campaign_create_spec(&$params) {
  63   $params['title']['api.required'] = 1;
  64 }
  65
  66 /**
  67  * Returns array of campaigns  matching a set of one or more group properties
  68  *
  69  * @param array $params
  70  *   Array of one or more valid.
  71  *                       property_name=>value pairs. If $params is set
  72  *                       as null, all campaigns will be returned
  73  *
  74  * @return array
  75  *   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, TRUE, 'Campaign');
  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
  90  *   (reference) array containing id of the group.
  91  *                       to be deleted
  92  *
  93  * @return array
  94  *   (reference) returns flag true if successful, error
  95  *                message otherwise
  96  * {@getfields campaign_delete}
  97  */
  98 function civicrm_api3_campaign_delete($params) {
  99   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 100 }