3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * File for the CiviCRM APIv3 note functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_Note
34 * @copyright CiviCRM LLC (c) 2004-2014
35 * @version $Id: Note.php 30879 2010-11-22 15:45:55Z shot $
42 * This API is used for creating a note.
43 * Required parameters : entity_id AND note
45 * @param array $params
46 * An associative array of name/value property values of civicrm_note.
47 * {@getfields note_create}
52 * @example NoteCreate.php Create example
56 function civicrm_api3_note_create($params) {
57 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
61 * Adjust Metadata for Create action
63 * The metadata is used for setting defaults, documentation & validation
64 * @param array $params
65 * Array or parameters determined by getfields.
67 function _civicrm_api3_note_create_spec(&$params) {
68 $params['entity_table']['api.default'] = "civicrm_contact";
69 $params['modified_date']['api.default'] = "now";
70 $params['note']['api.required'] = 1;
71 $params['entity_id']['api.required'] = 1;
75 * Deletes an existing note
77 * This API is used for deleting a note
79 * @param array $params
80 * Including id of the note to be deleted.
81 * {@getfields note_delete}
86 function civicrm_api3_note_delete($params) {
88 $result = new CRM_Core_BAO_Note();
89 return $result->del($params['id']) ?
civicrm_api3_create_success() : civicrm_api3_create_error('Error while deleting Note');
93 * Retrieve a specific note, given a set of input params
95 * @param array $params
99 * array of properties,
100 * if error an array with an error id and error message
101 * {@getfields note_get}
105 function civicrm_api3_note_get($params) {
107 return _civicrm_api3_basic_get('CRM_Core_BAO_Note', $params);
111 * Adjust Metadata for Get action
113 * The metadata is used for setting defaults, documentation & validation
114 * @param array $params
115 * Array or parameters determined by getfields.
117 function _civicrm_api3_note_get_spec(&$params) {
118 $params['entity_table']['api.default'] = "civicrm_contact";
122 * Get all descendents of given note
124 * @param array $params
125 * Associative array; only required 'id' parameter is used.
128 * Nested associative array beginning with direct children of given note.
130 function &civicrm_api3_note_tree_get($params) {
132 civicrm_api3_verify_mandatory($params, NULL, array('id'));
134 if (!is_numeric($params['id'])) {
135 return civicrm_api3_create_error(ts("Invalid note ID"));
137 if (!isset($params['max_depth'])) {
138 $params['max_depth'] = 0;
140 if (!isset($params['snippet'])) {
141 $params['snippet'] = FALSE;
143 $noteTree = CRM_Core_BAO_Note
::getNoteTree($params['id'], $params['max_depth'], $params['snippet']);
144 return civicrm_api3_create_success($noteTree, $params);