87 lines
3.1 KiB
PHP
87 lines
3.1 KiB
PHP
|
<?php
|
||
|
/*
|
||
|
+--------------------------------------------------------------------+
|
||
|
| CiviCRM version 4.7 |
|
||
|
+--------------------------------------------------------------------+
|
||
|
| Copyright CiviCRM LLC (c) 2004-2017 |
|
||
|
+--------------------------------------------------------------------+
|
||
|
| This file is a part of CiviCRM. |
|
||
|
| |
|
||
|
| CiviCRM is free software; you can copy, modify, and distribute it |
|
||
|
| under the terms of the GNU Affero General Public License |
|
||
|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
||
|
| |
|
||
|
| CiviCRM is distributed in the hope that it will be useful, but |
|
||
|
| WITHOUT ANY WARRANTY; without even the implied warranty of |
|
||
|
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
||
|
| See the GNU Affero General Public License for more details. |
|
||
|
| |
|
||
|
| You should have received a copy of the GNU Affero General Public |
|
||
|
| License and the CiviCRM Licensing Exception along |
|
||
|
| with this program; if not, contact CiviCRM LLC |
|
||
|
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
||
|
| GNU Affero General Public License or the licensing of CiviCRM, |
|
||
|
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
||
|
+--------------------------------------------------------------------+
|
||
|
*/
|
||
|
|
||
|
/**
|
||
|
* This api exposes CiviCRM WordReplacement records.
|
||
|
*
|
||
|
* 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.
|
||
|
*
|
||
|
* @package CiviCRM_APIv3
|
||
|
*/
|
||
|
|
||
|
/**
|
||
|
* Get CiviCRM Word Replacement details.
|
||
|
*
|
||
|
* @param array $params
|
||
|
*
|
||
|
* @return array
|
||
|
* @throws \API_Exception
|
||
|
*/
|
||
|
function civicrm_api3_word_replacement_get($params) {
|
||
|
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
|
||
|
}
|
||
|
|
||
|
|
||
|
/**
|
||
|
* Create a new Word Replacement.
|
||
|
*
|
||
|
* @param array $params
|
||
|
*
|
||
|
* @return array
|
||
|
*/
|
||
|
function civicrm_api3_word_replacement_create($params) {
|
||
|
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Adjust Metadata for Create action.
|
||
|
*
|
||
|
* The metadata is used for setting defaults, documentation & validation.
|
||
|
*
|
||
|
* @param array $params
|
||
|
* Array of parameters determined by getfields.
|
||
|
*/
|
||
|
function _civicrm_api3_word_replacement_create_spec(&$params) {
|
||
|
$params['find_word']['api.required'] = 1;
|
||
|
$params['replace_word']['api.required'] = 1;
|
||
|
$params['is_active']['api.default'] = 1;
|
||
|
}
|
||
|
|
||
|
/**
|
||
|
* Delete an existing WordReplacement.
|
||
|
*
|
||
|
* @param array $params
|
||
|
* Array containing id of the WordReplacement to be deleted.
|
||
|
*
|
||
|
* @return array
|
||
|
* API result array
|
||
|
*/
|
||
|
function civicrm_api3_word_replacement_delete($params) {
|
||
|
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
|
||
|
}
|