projects / civicrm-core.git / blame
| Commit | Line | Data |
|---|---|---|
| d83a3991 | 1 | <?php |
| 2 | ||
| 3 | /* | |
| 4 | +--------------------------------------------------------------------+ | |
| 731a0992 | 5 | | CiviCRM version 4.5 | |
| d83a3991 | 6 | +--------------------------------------------------------------------+ |
| 731a0992 | 7 | | Copyright CiviCRM LLC (c) 2004-2014 | |
| d83a3991 | 8 | +--------------------------------------------------------------------+ |
| 9 | | This file is a part of CiviCRM. | | |
| 10 | | | | |
| 11 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
| 12 | | under the terms of the GNU Affero General Public License | | |
| 13 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
| 14 | | | | |
| 15 | | CiviCRM is distributed in the hope that it will be useful, but | | |
| 16 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
| 17 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
| 18 | | See the GNU Affero General Public License for more details. | | |
| 19 | | | | |
| 20 | | You should have received a copy of the GNU Affero General Public | | |
| 21 | | License and the CiviCRM Licensing Exception along | | |
| 22 | | with this program; if not, contact CiviCRM LLC | | |
| 23 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
| 24 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
| 25 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
| 26 | +--------------------------------------------------------------------+ | |
| 27 | */ | |
| 28 | ||
| 29 | /** | |
| 30 | * File for the CiviCRM APIv3 domain functions | |
| 31 | * | |
| 32 | * @package CiviCRM_APIv3 | |
| 33 | * @subpackage API_WordReplacement | |
| 34 | * | |
| 731a0992 | 35 | * @copyright CiviCRM LLC (c) 2004-2014 |
| d83a3991 | 36 | * @version $Id: Domain.php 30171 2010-10-14 09:11:27Z mover $ |
| 37 | * | |
| 38 | */ | |
| 39 | ||
| 40 | /** | |
| 41 | * Get CiviCRM Word Replacement details | |
| 42 | * {@getfields word_replacement_create} | |
| e9d619eb | 43 | * |
| d83a3991 | 44 | */ |
| 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'); | |
| 49 | ||
| 50 | return civicrm_api3_create_success($wordReplacements, $params, 'word_replacement', 'get', $bao); | |
| 51 | } | |
| 52 | ||
| 53 | ||
| 54 | /** | |
| 55 | * Create a new Word Replacement | |
| 56 | * | |
| 57 | * @param array $params | |
| 58 | * | |
| 59 | * @return array | |
| e9d619eb | 60 | * |
| d83a3991 | 61 | * {@getfields word_replacement_create} |
| 62 | */ | |
| 63 | function civicrm_api3_word_replacement_create($params) { | |
| 64 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 65 | } | |
| 66 | ||
| 67 | /** | |
| 68 | * Adjust Metadata for Create action | |
| 69 | * | |
| 70 | * The metadata is used for setting defaults, documentation & validation | |
| 71 | * @param array $params array or parameters determined by getfields | |
| 72 | */ | |
| 73 | function _civicrm_api3_word_replacement_create_spec(&$params) { | |
| 74 | unset($params['version']); | |
| 75 | } | |
| 76 | ||
| 77 | /** | |
| 78 | * delete an existing word_replacement | |
| 79 | * | |
| 80 | * | |
| e9d619eb EM |
81 | * @param array $params array containing id of the word_replacement |
| 82 | * to be deleted | |
| d83a3991 | 83 | * |
| e9d619eb | 84 | * @return array api result array |
| d83a3991 | 85 | * |
| 86 | * @access public | |
| 87 | */ | |
| 88 | function civicrm_api3_word_replacement_delete($params) { | |
| 89 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| e9d619eb | 90 | } |