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  * Create Note.
  40  *
  41  * This API is used for creating a note.
  42  * Required parameters : entity_id AND note
  43  *
  44  * @param array $params
  45  *   An associative array of name/value property values of civicrm_note.
  46  * {@getfields note_create}
  47  *
  48  * @return array
  49  *   API result array
  50  */
  51 function civicrm_api3_note_create($params) {
  52   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  53 }
  54
  55 /**
  56  * Adjust Metadata for Create action.
  57  *
  58  * The metadata is used for setting defaults, documentation & validation.
  59  *
  60  * @param array $params
  61  *   Array or parameters determined by getfields.
  62  */
  63 function _civicrm_api3_note_create_spec(&$params) {
  64   $params['entity_table']['api.default'] = "civicrm_contact";
  65   $params['modified_date']['api.default'] = "now";
  66   $params['note']['api.required'] = 1;
  67   $params['entity_id']['api.required'] = 1;
  68 }
  69
  70 /**
  71  * Deletes an existing note
  72  *
  73  * This API is used for deleting a note
  74  *
  75  * @param array $params
  76  *   Including id of the note to be deleted.
  77  * {@getfields note_delete}
  78  *
  79  * @return null
  80  */
  81 function civicrm_api3_note_delete($params) {
  82
  83   $result = new CRM_Core_BAO_Note();
  84   return $result->del($params['id']) ? civicrm_api3_create_success() : civicrm_api3_create_error('Error while deleting Note');
  85 }
  86
  87 /**
  88  * Retrieve a specific note, given a set of input params
  89  *
  90  * @param array $params
  91  *   Input parameters.
  92  *
  93  * @return array
  94  *   array of properties,
  95  *   if error an array with an error id and error message
  96  *
  97  *   {@getfields note_get}
  98  */
  99 function civicrm_api3_note_get($params) {
 100
 101   return _civicrm_api3_basic_get('CRM_Core_BAO_Note', $params);
 102 }
 103
 104 /**
 105  * Adjust Metadata for Get action
 106  *
 107  * The metadata is used for setting defaults, documentation & validation.
 108  *
 109  * @param array $params
 110  *   Array or parameters determined by getfields.
 111  */
 112 function _civicrm_api3_note_get_spec(&$params) {
 113   $params['entity_table']['api.default'] = "civicrm_contact";
 114 }
 115
 116 /**
 117  * Get all descendents of given note
 118  *
 119  * @param array $params
 120  *   Associative array; only required 'id' parameter is used.
 121  *
 122  * @return array
 123  *   Nested associative array beginning with direct children of given note.
 124  */
 125 function &civicrm_api3_note_tree_get($params) {
 126
 127   civicrm_api3_verify_mandatory($params, NULL, array('id'));
 128
 129   if (!is_numeric($params['id'])) {
 130     return civicrm_api3_create_error(ts("Invalid note ID"));
 131   }
 132   if (!isset($params['max_depth'])) {
 133     $params['max_depth'] = 0;
 134   }
 135   if (!isset($params['snippet'])) {
 136     $params['snippet'] = FALSE;
 137   }
 138   $noteTree = CRM_Core_BAO_Note::getNoteTree($params['id'], $params['max_depth'], $params['snippet']);
 139   return civicrm_api3_create_success($noteTree, $params);
 140 }