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