3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * This api exposes CiviCRM word replacement.
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.
34 * @package CiviCRM_APIv3
38 * Get CiviCRM Word Replacement details.
40 * @param array $params
43 * @throws \API_Exception
45 function civicrm_api3_word_replacement_get($params) {
46 $bao = new CRM_Core_BAO_WordReplacement();
47 _civicrm_api3_dao_set_filter($bao, $params, TRUE, 'WordReplacement');
48 $wordReplacements = _civicrm_api3_dao_to_array($bao, $params, TRUE, 'WordReplacement');
50 return civicrm_api3_create_success($wordReplacements, $params, 'word_replacement', 'get', $bao);
55 * Create a new Word Replacement.
57 * @param array $params
61 function civicrm_api3_word_replacement_create($params) {
62 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
66 * Adjust Metadata for Create action.
68 * The metadata is used for setting defaults, documentation & validation.
70 * @param array $params
71 * Array of parameters determined by getfields.
73 function _civicrm_api3_word_replacement_create_spec(&$params) {
74 unset($params['version']);
78 * Delete an existing word_replacement.
80 * @param array $params
81 * Array containing id of the word_replacement to be deleted.
86 function civicrm_api3_word_replacement_delete($params) {
87 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);