4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.5 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 note functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_Note
35 * @copyright CiviCRM LLC (c) 2004-2014
36 * @version $Id: Note.php 30879 2010-11-22 15:45:55Z shot $
41 * Files required for this package
47 * This API is used for creating a note.
48 * Required parameters : entity_id AND note
50 * @param array $params an associative array of name/value property values of civicrm_note
51 * {@getfields note_create}
53 * @return array API result array
55 * @example NoteCreate.php Create example
59 function civicrm_api3_note_create($params) {
60 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
64 * Adjust Metadata for Create action
66 * The metadata is used for setting defaults, documentation & validation
67 * @param array $params array or parameters determined by getfields
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;
77 * Deletes an existing note
79 * This API is used for deleting a note
81 * @params array $paramsarray including id of the note to be deleted
82 * {@getfields note_delete}
89 function civicrm_api3_note_delete($params) {
91 $result = new CRM_Core_BAO_Note();
92 return $result->del($params['id']) ?
civicrm_api3_create_success() : civicrm_api3_create_error('Error while deleting Note');
96 * Retrieve a specific note, given a set of input params
98 * @param array $params input parameters
100 * @return array array of properties,
101 * if error an array with an error id and error message
102 * {@getfields note_get}
106 function civicrm_api3_note_get($params) {
108 return _civicrm_api3_basic_get('CRM_Core_BAO_Note', $params);
112 * Adjust Metadata for Get action
114 * The metadata is used for setting defaults, documentation & validation
115 * @param array $params 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 Associative array; only required 'id' parameter is used
126 * @return array Nested associative array beginning with direct children of given note.
128 function &civicrm_api3_note_tree_get($params) {
130 civicrm_api3_verify_mandatory($params, NULL, array('id'));
132 if (!is_numeric($params['id'])) {
133 return civicrm_api3_create_error(ts("Invalid note ID"));
135 if (!isset($params['max_depth'])) {
136 $params['max_depth'] = 0;
138 if (!isset($params['snippet'])) {
139 $params['snippet'] = FALSE;
141 $noteTree = CRM_Core_BAO_Note
::getNoteTree($params['id'], $params['max_depth'], $params['snippet']);
142 return civicrm_api3_create_success($noteTree, $params);