Commit | Line | Data |
---|---|---|
d83a3991 | 1 | <?php |
d83a3991 | 2 | /* |
3 | +--------------------------------------------------------------------+ | |
81621fee | 4 | | CiviCRM version 4.7 | |
d83a3991 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
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) { | |
0298287b | 46 | // NEVER COPY THIS. No idea why a newish api would not use basic_get. |
d83a3991 | 47 | $bao = new CRM_Core_BAO_WordReplacement(); |
244bbdd8 | 48 | _civicrm_api3_dao_set_filter($bao, $params, TRUE); |
35671d00 | 49 | $wordReplacements = _civicrm_api3_dao_to_array($bao, $params, TRUE, 'WordReplacement'); |
d83a3991 | 50 | |
244bbdd8 | 51 | return civicrm_api3_create_success($wordReplacements, $params, 'WordReplacement', 'get', $bao); |
d83a3991 | 52 | } |
53 | ||
54 | ||
55 | /** | |
9d32e6f7 | 56 | * Create a new Word Replacement. |
d83a3991 | 57 | * |
58 | * @param array $params | |
59 | * | |
60 | * @return array | |
d83a3991 | 61 | */ |
62 | function civicrm_api3_word_replacement_create($params) { | |
63 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
64 | } | |
65 | ||
66 | /** | |
0aa0303c EM |
67 | * Adjust Metadata for Create action. |
68 | * | |
69 | * The metadata is used for setting defaults, documentation & validation. | |
d83a3991 | 70 | * |
cf470720 | 71 | * @param array $params |
b081365f | 72 | * Array of parameters determined by getfields. |
d83a3991 | 73 | */ |
74 | function _civicrm_api3_word_replacement_create_spec(&$params) { | |
75 | unset($params['version']); | |
76 | } | |
77 | ||
78 | /** | |
244bbdd8 | 79 | * Delete an existing WordReplacement. |
d83a3991 | 80 | * |
cf470720 | 81 | * @param array $params |
244bbdd8 | 82 | * Array containing id of the WordReplacement to be deleted. |
d83a3991 | 83 | * |
a6c01b45 | 84 | * @return array |
9d32e6f7 | 85 | * API result array |
d83a3991 | 86 | */ |
87 | function civicrm_api3_word_replacement_delete($params) { | |
88 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
e9d619eb | 89 | } |