<?php
-
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
*/
/**
- * 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 $
- *
- */
-
-/**
- * Files required for this package
*/
/**
- * Create Note
+ * Create Note.
*
* This API is used for creating a note.
* Required parameters : entity_id AND note
*
- * @param array $params an associative array of name/value property values of civicrm_note
- * {@getfields note_create}
- *
- * @return array API result array
- * @access public
- * @example NoteCreate.php Create example
- *
+ * @param array $params
+ * An associative array of name/value property values of civicrm_note.
*
+ * @return array
+ * API result array
*/
function civicrm_api3_note_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_note_create_spec(&$params) {
$params['entity_table']['api.default'] = "civicrm_contact";
}
/**
- * Deletes an existing note
+ * Deletes an existing note.
*
* This API is used for deleting a note
*
- * @params array $paramsarray including id of the note to be deleted
- * {@getfields note_delete}
+ * @param array $params
+ * Including id of the note to be deleted.
*
- * @return null
- * @access public
+ * @return array
*/
function civicrm_api3_note_delete($params) {
}
/**
- * Retrieve a specific note, given a set of input params
+ * Retrieve a specific note or notes, given a set of input params.
*
- * @param array $params input parameters
+ * @param array $params
+ * Input parameters.
*
- * @return array array of properties,
- * if error an array with an error id and error message
- * {@getfields note_get}
- * @static void
- * @access public
+ * @return array
+ * array of properties,
+ * if error an array with an error id and error message
*/
function civicrm_api3_note_get($params) {
}
/**
- * Adjust Metadata for Get action
+ * Adjust Metadata for Get action.
*
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * The metadata is used for setting defaults, documentation & validation.
+ *
+ * @param array $params
+ * Array of parameters determined by getfields.
*/
function _civicrm_api3_note_get_spec(&$params) {
$params['entity_table']['api.default'] = "civicrm_contact";
}
/**
- * Get all descendents of given note
+ * Get all descendants of given note.
*
- * @param array $params Associative array; only required 'id' parameter is used
+ * @param array $params
+ * array; only required 'id' parameter is used.
*
- * @return array Nested associative array beginning with direct children of given note.
+ * @return array
+ * Nested associative array beginning with direct children of given note.
*/
function &civicrm_api3_note_tree_get($params) {
$noteTree = CRM_Core_BAO_Note::getNoteTree($params['id'], $params['max_depth'], $params['snippet']);
return civicrm_api3_create_success($noteTree, $params);
}
-