| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | +--------------------------------------------------------------------+ |
| 5 | | CiviCRM version 4.4 | |
| 6 | +--------------------------------------------------------------------+ |
| 7 | | Copyright CiviCRM LLC (c) 2004-2013 | |
| 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 note functions |
| 31 | * |
| 32 | * @package CiviCRM_APIv3 |
| 33 | * @subpackage API_Note |
| 34 | * |
| 35 | * @copyright CiviCRM LLC (c) 2004-2013 |
| 36 | * @version $Id: Note.php 30879 2010-11-22 15:45:55Z shot $ |
| 37 | * |
| 38 | */ |
| 39 | |
| 40 | /** |
| 41 | * Files required for this package |
| 42 | */ |
| 43 | |
| 44 | /** |
| 45 | * Create Note |
| 46 | * |
| 47 | * This API is used for creating a note. |
| 48 | * Required parameters : entity_id AND note |
| 49 | * |
| 50 | * @param array $params an associative array of name/value property values of civicrm_note |
| 51 | * {@getfields note_create} |
| 52 | * |
| 53 | * @return array API result array |
| 54 | * @access public |
| 55 | * @example NoteCreate.php Create example |
| 56 | * |
| 57 | * |
| 58 | */ |
| 59 | function civicrm_api3_note_create($params) { |
| 60 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Adjust Metadata for Create action |
| 65 | * |
| 66 | * The metadata is used for setting defaults, documentation & validation |
| 67 | * @param array $params array or parameters determined by getfields |
| 68 | */ |
| 69 | function _civicrm_api3_note_create_spec(&$params) { |
| 70 | $params['entity_table']['api.default'] = "civicrm_contact"; |
| 71 | $params['modified_date']['api.default'] = "now"; |
| 72 | $params['note']['api.required'] = 1; |
| 73 | $params['entity_id']['api.required'] = 1; |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * Deletes an existing note |
| 78 | * |
| 79 | * This API is used for deleting a note |
| 80 | * |
| 81 | * @params array $paramsarray including id of the note to be deleted |
| 82 | * {@getfields note_delete} |
| 83 | * |
| 84 | * @return null |
| 85 | * @access public |
| 86 | */ |
| 87 | function civicrm_api3_note_delete($params) { |
| 88 | |
| 89 | $result = new CRM_Core_BAO_Note(); |
| 90 | return $result->del($params['id']) ? civicrm_api3_create_success() : civicrm_api3_create_error('Error while deleting Note'); |
| 91 | } |
| 92 | |
| 93 | /** |
| 94 | * Retrieve a specific note, given a set of input params |
| 95 | * |
| 96 | * @param array $params input parameters |
| 97 | * |
| 98 | * @return array array of properties, |
| 99 | * if error an array with an error id and error message |
| 100 | * {@getfields note_get} |
| 101 | * @static void |
| 102 | * @access public |
| 103 | */ |
| 104 | function civicrm_api3_note_get($params) { |
| 105 | |
| 106 | return _civicrm_api3_basic_get('CRM_Core_BAO_Note', $params); |
| 107 | } |
| 108 | |
| 109 | /** |
| 110 | * Adjust Metadata for Get action |
| 111 | * |
| 112 | * The metadata is used for setting defaults, documentation & validation |
| 113 | * @param array $params array or parameters determined by getfields |
| 114 | */ |
| 115 | function _civicrm_api3_note_get_spec(&$params) { |
| 116 | $params['entity_table']['api.default'] = "civicrm_contact"; |
| 117 | } |
| 118 | |
| 119 | /** |
| 120 | * Get all descendents of given note |
| 121 | * |
| 122 | * @param array $params Associative array; only required 'id' parameter is used |
| 123 | * |
| 124 | * @return array Nested associative array beginning with direct children of given note. |
| 125 | */ |
| 126 | function &civicrm_api3_note_tree_get($params) { |
| 127 | |
| 128 | civicrm_api3_verify_mandatory($params, NULL, array('id')); |
| 129 | |
| 130 | if (!is_numeric($params['id'])) { |
| 131 | return civicrm_api3_create_error(ts("Invalid note ID")); |
| 132 | } |
| 133 | if (!isset($params['max_depth'])) { |
| 134 | $params['max_depth'] = 0; |
| 135 | } |
| 136 | if (!isset($params['snippet'])) { |
| 137 | $params['snippet'] = FALSE; |
| 138 | } |
| 139 | $noteTree = CRM_Core_BAO_Note::getNoteTree($params['id'], $params['max_depth'], $params['snippet']); |
| 140 | return civicrm_api3_create_success($noteTree, $params); |
| 141 | } |
| 142 | |