| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.6 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
| 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 | * File for the CiviCRM APIv3 domain functions |
| 30 | * |
| 31 | * @package CiviCRM_APIv3 |
| 32 | * @subpackage API_WordReplacement |
| 33 | * |
| 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
| 35 | * @version $Id: Domain.php 30171 2010-10-14 09:11:27Z mover $ |
| 36 | * |
| 37 | */ |
| 38 | |
| 39 | /** |
| 40 | * Get CiviCRM Word Replacement details |
| 41 | * {@getfields word_replacement_create} |
| 42 | * @param array $params |
| 43 | * @return array |
| 44 | * @throws \API_Exception |
| 45 | */ |
| 46 | function civicrm_api3_word_replacement_get($params) { |
| 47 | $bao = new CRM_Core_BAO_WordReplacement(); |
| 48 | _civicrm_api3_dao_set_filter($bao, $params, TRUE, 'WordReplacement'); |
| 49 | $wordReplacements = _civicrm_api3_dao_to_array($bao, $params, TRUE, 'WordReplacement'); |
| 50 | |
| 51 | return civicrm_api3_create_success($wordReplacements, $params, 'word_replacement', 'get', $bao); |
| 52 | } |
| 53 | |
| 54 | |
| 55 | /** |
| 56 | * Create a new Word Replacement |
| 57 | * |
| 58 | * @param array $params |
| 59 | * |
| 60 | * @return array |
| 61 | * |
| 62 | * {@getfields word_replacement_create} |
| 63 | */ |
| 64 | function civicrm_api3_word_replacement_create($params) { |
| 65 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * Adjust Metadata for Create action |
| 70 | * |
| 71 | * The metadata is used for setting defaults, documentation & validation |
| 72 | * @param array $params |
| 73 | * Array or parameters determined by getfields. |
| 74 | */ |
| 75 | function _civicrm_api3_word_replacement_create_spec(&$params) { |
| 76 | unset($params['version']); |
| 77 | } |
| 78 | |
| 79 | /** |
| 80 | * delete an existing word_replacement |
| 81 | * |
| 82 | * |
| 83 | * @param array $params |
| 84 | * Array containing id of the word_replacement. |
| 85 | * to be deleted |
| 86 | * |
| 87 | * @return array |
| 88 | * api result array |
| 89 | * |
| 90 | */ |
| 91 | function civicrm_api3_word_replacement_delete($params) { |
| 92 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 93 | } |