api/v3/Note.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * File for the CiviCRM APIv3 note functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Note
  33  *
  34  * @copyright CiviCRM LLC (c) 2004-2014
  35  * @version $Id: Note.php 30879 2010-11-22 15:45:55Z shot $
  36  *
  37  */
  38
  39 /**
  40  * Create Note
  41  *
  42  * This API is used for creating a note.
  43  * Required parameters : entity_id AND note
  44  *
  45  * @param array $params
  46  *   An associative array of name/value property values of civicrm_note.
  47  * {@getfields note_create}
  48  *
  49  * @return array
  50  *   API result array
  51  */
  52 function civicrm_api3_note_create($params) {
  53   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  54 }
  55
  56 /**
  57  * Adjust Metadata for Create action.
  58  *
  59  * The metadata is used for setting defaults, documentation & validation.
  60  *
  61  * @param array $params
  62  *   Array or parameters determined by getfields.
  63  */
  64 function _civicrm_api3_note_create_spec(&$params) {
  65   $params['entity_table']['api.default'] = "civicrm_contact";
  66   $params['modified_date']['api.default'] = "now";
  67   $params['note']['api.required'] = 1;
  68   $params['entity_id']['api.required'] = 1;
  69 }
  70
  71 /**
  72  * Deletes an existing note
  73  *
  74  * This API is used for deleting a note
  75  *
  76  * @param array $params
  77  *   Including id of the note to be deleted.
  78  * {@getfields note_delete}
  79  *
  80  * @return null
  81  */
  82 function civicrm_api3_note_delete($params) {
  83
  84   $result = new CRM_Core_BAO_Note();
  85   return $result->del($params['id']) ? civicrm_api3_create_success() : civicrm_api3_create_error('Error while deleting Note');
  86 }
  87
  88 /**
  89  * Retrieve a specific note, given a set of input params
  90  *
  91  * @param array $params
  92  *   Input parameters.
  93  *
  94  * @return array
  95  *   array of properties,
  96  *   if error an array with an error id and error message
  97  *
  98  *   {@getfields note_get}
  99  */
 100 function civicrm_api3_note_get($params) {
 101
 102   return _civicrm_api3_basic_get('CRM_Core_BAO_Note', $params);
 103 }
 104
 105 /**
 106  * Adjust Metadata for Get action
 107  *
 108  * The metadata is used for setting defaults, documentation & validation.
 109  *
 110  * @param array $params
 111  *   Array or parameters determined by getfields.
 112  */
 113 function _civicrm_api3_note_get_spec(&$params) {
 114   $params['entity_table']['api.default'] = "civicrm_contact";
 115 }
 116
 117 /**
 118  * Get all descendents of given note
 119  *
 120  * @param array $params
 121  *   Associative array; only required 'id' parameter is used.
 122  *
 123  * @return array
 124  *   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 }