+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
*/
/**
- * File for the CiviCRM APIv3 note functions
+ * This api exposes CiviCRM note.
*
* @package CiviCRM_APIv3
- * @subpackage API_Note
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Note.php 30879 2010-11-22 15:45:55Z shot $
*/
/**
*
* @param array $params
* An associative array of name/value property values of civicrm_note.
- * {@getfields note_create}
*
* @return array
* API result array
* The metadata is used for setting defaults, documentation & validation.
*
* @param array $params
- * Array or parameters determined by getfields.
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_note_create_spec(&$params) {
$params['entity_table']['api.default'] = "civicrm_contact";
* @return array
*/
function civicrm_api3_note_delete($params) {
-
$result = new CRM_Core_BAO_Note();
return $result->del($params['id']) ? civicrm_api3_create_success() : civicrm_api3_create_error('Error while deleting Note');
}
* if error an array with an error id and error message
*/
function civicrm_api3_note_get($params) {
-
return _civicrm_api3_basic_get('CRM_Core_BAO_Note', $params);
}
* The metadata is used for setting defaults, documentation & validation.
*
* @param array $params
- * Array or parameters determined by getfields.
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_note_get_spec(&$params) {
$params['entity_table']['api.default'] = "civicrm_contact";
* Nested associative array beginning with direct children of given note.
*/
function &civicrm_api3_note_tree_get($params) {
-
civicrm_api3_verify_mandatory($params, NULL, array('id'));
if (!is_numeric($params['id'])) {