api/v3/MailingComponent.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 mailing_component functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_mailing_component
  34  *
  35  */
  36
  37 /**
  38  * Save a mailing_component
  39  *
  40  * Allowed @params array keys are:
  41  * {@getfields mailing_component_create}
  42  * @example mailing_componentCreate.php
  43  *
  44  * @param $params
  45  *
  46  * @throws API_Exception
  47  * @return array of newly created mailing_component property values.
  48  * @access public
  49  */
  50 function civicrm_api3_mailing_component_create($params) {
  51   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  52 }
  53
  54
  55 /**
  56  * Adjust Metadata for Create action.
  57  *
  58  * The metadata is used for setting defaults, documentation & validation.
  59  *
  60  * @param array $spec
  61  *   Array of parameters determined by getfields.
  62  */
  63 function _civicrm_api3_mailing_component_create_spec(&$spec) {
  64   $spec['is_active']['api.default'] = 1;
  65 }
  66
  67 /**
  68  * Get a mailing_component
  69  *
  70  * Allowed @params array keys are:
  71  * {@getfields mailing_component_get}
  72  * @example mailing_componentCreate.php
  73  *
  74  * @param $params
  75  *
  76  * @return array of retrieved mailing_component property values.
  77  * @access public
  78  */
  79 function civicrm_api3_mailing_component_get($params) {
  80   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  81 }
  82
  83 /**
  84  * Delete a mailing_component
  85  *
  86  * Allowed @params array keys are:
  87  * {@getfields mailing_component_delete}
  88  * @example mailing_componentCreate.php
  89  *
  90  * @param $params
  91  *
  92  * @throws API_Exception
  93  * @return array of deleted values.
  94  * @access public
  95  */
  96 function civicrm_api3_mailing_component_delete($params) {
  97   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  98 }