Commit | Line | Data |
---|---|---|
d83a3991 | 1 | <?php |
d83a3991 | 2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
d83a3991 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
d83a3991 | 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 | */ |
d83a3991 | 27 | |
28 | /** | |
244bbdd8 | 29 | * This api exposes CiviCRM WordReplacement records. |
d83a3991 | 30 | * |
244bbdd8 | 31 | * Word replacements are used to globally alter strings in the CiviCRM UI. |
b081365f | 32 | * Note that the original source string is always English, regardless of language settings. |
d83a3991 | 33 | * |
b081365f | 34 | * @package CiviCRM_APIv3 |
d83a3991 | 35 | */ |
36 | ||
37 | /** | |
9d32e6f7 EM |
38 | * Get CiviCRM Word Replacement details. |
39 | * | |
d0997921 | 40 | * @param array $params |
9d32e6f7 | 41 | * |
645ee340 EM |
42 | * @return array |
43 | * @throws \API_Exception | |
d83a3991 | 44 | */ |
45 | function civicrm_api3_word_replacement_get($params) { | |
df197a56 | 46 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
d83a3991 | 47 | } |
48 | ||
d83a3991 | 49 | /** |
9d32e6f7 | 50 | * Create a new Word Replacement. |
d83a3991 | 51 | * |
52 | * @param array $params | |
53 | * | |
54 | * @return array | |
d83a3991 | 55 | */ |
56 | function civicrm_api3_word_replacement_create($params) { | |
1237d8d7 | 57 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'WordReplacement'); |
d83a3991 | 58 | } |
59 | ||
60 | /** | |
0aa0303c EM |
61 | * Adjust Metadata for Create action. |
62 | * | |
63 | * The metadata is used for setting defaults, documentation & validation. | |
d83a3991 | 64 | * |
cf470720 | 65 | * @param array $params |
b081365f | 66 | * Array of parameters determined by getfields. |
d83a3991 | 67 | */ |
68 | function _civicrm_api3_word_replacement_create_spec(&$params) { | |
df197a56 | 69 | $params['find_word']['api.required'] = 1; |
70 | $params['replace_word']['api.required'] = 1; | |
71 | $params['is_active']['api.default'] = 1; | |
d83a3991 | 72 | } |
73 | ||
74 | /** | |
244bbdd8 | 75 | * Delete an existing WordReplacement. |
d83a3991 | 76 | * |
cf470720 | 77 | * @param array $params |
244bbdd8 | 78 | * Array containing id of the WordReplacement to be deleted. |
d83a3991 | 79 | * |
a6c01b45 | 80 | * @return array |
9d32e6f7 | 81 | * API result array |
d83a3991 | 82 | */ |
83 | function civicrm_api3_word_replacement_delete($params) { | |
84 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
e9d619eb | 85 | } |