Commit | Line | Data |
---|---|---|
d615ccf5 | 1 | <?php |
d615ccf5 CW |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
d615ccf5 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
d615ccf5 CW |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
d615ccf5 CW |
27 | |
28 | /** | |
bd876613 | 29 | * This api exposes CiviCRM MailingComponent (header and footer). |
d615ccf5 CW |
30 | * |
31 | * @package CiviCRM_APIv3 | |
d615ccf5 CW |
32 | */ |
33 | ||
34 | /** | |
244bbdd8 | 35 | * Save a MailingComponent. |
dc64d047 | 36 | * |
c490a46a | 37 | * @param array $params |
d9f93da9 EM |
38 | * |
39 | * @throws API_Exception | |
a6c01b45 | 40 | * @return array |
1747ab99 | 41 | * API result array. |
d615ccf5 CW |
42 | */ |
43 | function civicrm_api3_mailing_component_create($params) { | |
807f8008 | 44 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'MailingComponent'); |
d615ccf5 CW |
45 | } |
46 | ||
143fcffa TO |
47 | /** |
48 | * Adjust Metadata for Create action. | |
49 | * | |
50 | * The metadata is used for setting defaults, documentation & validation. | |
51 | * | |
52 | * @param array $spec | |
53 | * Array of parameters determined by getfields. | |
54 | */ | |
55 | function _civicrm_api3_mailing_component_create_spec(&$spec) { | |
56 | $spec['is_active']['api.default'] = 1; | |
df197a56 | 57 | $spec['name']['api.required'] = 1; |
58 | $spec['component_type']['api.required'] = 1; | |
143fcffa TO |
59 | } |
60 | ||
d615ccf5 | 61 | /** |
244bbdd8 | 62 | * Get a MailingComponent. |
d615ccf5 | 63 | * |
c490a46a | 64 | * @param array $params |
d9f93da9 | 65 | * |
a6c01b45 | 66 | * @return array |
1747ab99 | 67 | * API result array. |
d615ccf5 CW |
68 | */ |
69 | function civicrm_api3_mailing_component_get($params) { | |
70 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
71 | } | |
72 | ||
bd876613 CW |
73 | /** |
74 | * Adjust metadata for get. | |
75 | * | |
76 | * @param array $params | |
77 | */ | |
78 | function _civicrm_api3_mailing_component_get_spec(&$params) { | |
79 | // fetch active records by default | |
80 | $params['is_active']['api.default'] = 1; | |
81 | } | |
82 | ||
d615ccf5 | 83 | /** |
244bbdd8 | 84 | * Delete a MailingComponent. |
d615ccf5 | 85 | * |
c490a46a | 86 | * @param array $params |
d9f93da9 EM |
87 | * |
88 | * @throws API_Exception | |
a6c01b45 | 89 | * @return array |
1747ab99 | 90 | * API result array. |
d615ccf5 CW |
91 | */ |
92 | function civicrm_api3_mailing_component_delete($params) { | |
93 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
94 | } |