X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FWordReplacement.php;h=8ac602784a28d1f6649eeb5ffb244bcb46407b1e;hb=3b7bf9514d92a68e9adb10ae1fe33f8d6ca3da7d;hp=231436139642f0b3b406a9c4bcab25f62dd22211;hpb=22242c8734d20099d181a6a7f28e982adfd96267;p=civicrm-core.git diff --git a/api/v3/WordReplacement.php b/api/v3/WordReplacement.php index 2314361396..8ac602784a 100644 --- a/api/v3/WordReplacement.php +++ b/api/v3/WordReplacement.php @@ -3,7 +3,7 @@ +--------------------------------------------------------------------+ | CiviCRM version 4.6 | +--------------------------------------------------------------------+ - | Copyright CiviCRM LLC (c) 2004-2014 | + | Copyright CiviCRM LLC (c) 2004-2015 | +--------------------------------------------------------------------+ | This file is a part of CiviCRM. | | | @@ -26,13 +26,12 @@ */ /** - * File for the CiviCRM APIv3 domain functions + * This api exposes CiviCRM WordReplacement records. * - * @package CiviCRM_APIv3 - * @subpackage API_WordReplacement + * Word replacements are used to globally alter strings in the CiviCRM UI. + * Note that the original source string is always English, regardless of language settings. * - * @copyright CiviCRM LLC (c) 2004-2014 - * @version $Id: Domain.php 30171 2010-10-14 09:11:27Z mover $ + * @package CiviCRM_APIv3 */ /** @@ -45,10 +44,10 @@ */ function civicrm_api3_word_replacement_get($params) { $bao = new CRM_Core_BAO_WordReplacement(); - _civicrm_api3_dao_set_filter($bao, $params, TRUE, 'WordReplacement'); + _civicrm_api3_dao_set_filter($bao, $params, TRUE); $wordReplacements = _civicrm_api3_dao_to_array($bao, $params, TRUE, 'WordReplacement'); - return civicrm_api3_create_success($wordReplacements, $params, 'word_replacement', 'get', $bao); + return civicrm_api3_create_success($wordReplacements, $params, 'WordReplacement', 'get', $bao); } @@ -69,17 +68,17 @@ function civicrm_api3_word_replacement_create($params) { * The metadata is used for setting defaults, documentation & validation. * * @param array $params - * Array or parameters determined by getfields. + * Array of parameters determined by getfields. */ function _civicrm_api3_word_replacement_create_spec(&$params) { unset($params['version']); } /** - * Delete an existing word_replacement. + * Delete an existing WordReplacement. * * @param array $params - * Array containing id of the word_replacement to be deleted. + * Array containing id of the WordReplacement to be deleted. * * @return array * API result array