Commit | Line | Data |
---|---|---|
d615ccf5 CW |
1 | <?php |
2 | ||
3 | /* | |
4 | +--------------------------------------------------------------------+ | |
731a0992 | 5 | | CiviCRM version 4.5 | |
d615ccf5 | 6 | +--------------------------------------------------------------------+ |
731a0992 | 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
d615ccf5 CW |
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 | * | |
d9f93da9 EM |
44 | * @param $params |
45 | * | |
46 | * @throws API_Exception | |
d615ccf5 CW |
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 | * Get a mailing_component | |
56 | * | |
57 | * Allowed @params array keys are: | |
58 | * {@getfields mailing_component_get} | |
59 | * @example mailing_componentCreate.php | |
60 | * | |
d9f93da9 EM |
61 | * @param $params |
62 | * | |
d615ccf5 CW |
63 | * @return array of retrieved mailing_component property values. |
64 | * @access public | |
65 | */ | |
66 | function civicrm_api3_mailing_component_get($params) { | |
67 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
68 | } | |
69 | ||
70 | /** | |
71 | * Delete a mailing_component | |
72 | * | |
73 | * Allowed @params array keys are: | |
74 | * {@getfields mailing_component_delete} | |
75 | * @example mailing_componentCreate.php | |
76 | * | |
d9f93da9 EM |
77 | * @param $params |
78 | * | |
79 | * @throws API_Exception | |
d615ccf5 CW |
80 | * @return array of deleted values. |
81 | * @access public | |
82 | */ | |
83 | function civicrm_api3_mailing_component_delete($params) { | |
84 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
85 | } |