3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * BAO object for crm_note table
39 class CRM_Core_BAO_Note
extends CRM_Core_DAO_Note
{
42 * Const the max number of notes we display at any given time
48 * Given a note id, retrieve the note text
50 * @param int $id id of the note to retrieve
52 * @return string the note text or null if note not found
57 static function getNoteText($id) {
58 return CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Note', $id, 'note');
62 * Given a note id, retrieve the note subject
64 * @param int $id id of the note to retrieve
66 * @return string the note subject or null if note not found
71 static function getNoteSubject($id) {
72 return CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_Note', $id, 'subject');
76 * Given a note id, decide if the note should be displayed based on privacy setting
78 * @param object $note Either the id of the note to retrieve, or the CRM_Core_DAO_Note object itself
80 * @return boolean TRUE if the note should be displayed, otherwise FALSE
85 static function getNotePrivacyHidden($note) {
86 if (CRM_Core_Permission
::check('view all notes')) {
90 $noteValues = array();
91 if (is_object($note) && get_class($note) == 'CRM_Core_DAO_Note') {
92 CRM_Core_DAO
::storeValues($note, $noteValues);
95 $noteDAO = new CRM_Core_DAO_Note();
98 if ($noteDAO->fetch()) {
99 CRM_Core_DAO
::storeValues($noteDAO, $noteValues);
103 CRM_Utils_Hook
::notePrivacy($noteValues);
105 if (!$noteValues['privacy']) {
108 elseif (isset($noteValues['notePrivacy_hidden'])) {
109 // If the hook has set visibility, use that setting.
110 return $noteValues['notePrivacy_hidden'];
113 // Default behavior (if hook has not set visibility)
114 // is to hide privacy notes unless the note creator is the current user.
116 if ($noteValues['privacy']) {
117 $session = CRM_Core_Session
::singleton();
118 $userID = $session->get('userID');
119 return ($noteValues['contact_id'] != $userID);
128 * Takes an associative array and creates a note object
130 * the function extract all the params it needs to initialize the create a
131 * note object. the params array could contain additional unused name/value
134 * @param array $params (reference) an assoc array of name/value pairs
135 * @param array $ids (deprecated) associated array with note id - preferably set $params['id']
137 * @return object $note CRM_Core_BAO_Note object
141 static function &add(&$params, $ids = array()) {
142 $dataExists = self
::dataExists($params);
144 return CRM_Core_DAO
::$_nullObject;
147 $note = new CRM_Core_BAO_Note();
149 if (!isset($params['modified_date'])) {
150 $params['modified_date'] = date("Ymd");
153 if (!isset($params['privacy'])) {
154 $params['privacy'] = 0;
157 $note->copyValues($params);
158 if (empty($params['contact_id'])) {
159 if ($params['entity_table'] == 'civicrm_contact') {
160 $note->contact_id
= $params['entity_id'];
163 $id = CRM_Utils_Array
::value('id', $params, CRM_Utils_Array
::value('id', $ids));
170 // check and attach and files as needed
171 CRM_Core_BAO_File
::processAttachment($params, 'civicrm_note', $note->id
);
173 if ($note->entity_table
== 'civicrm_contact') {
174 CRM_Core_BAO_Log
::register($note->entity_id
,
178 $displayName = CRM_Contact_BAO_Contact
::displayName($note->entity_id
);
180 $noteActions = FALSE;
181 $session = CRM_Core_Session
::singleton();
182 if ($session->get('userID')) {
183 if ($session->get('userID') == $note->entity_id
) {
186 elseif (CRM_Contact_BAO_Contact_Permission
::allow($note->entity_id
, CRM_Core_Permission
::EDIT
)) {
191 $recentOther = array();
193 $recentOther = array(
194 'editUrl' => CRM_Utils_System
::url('civicrm/contact/view/note',
195 "reset=1&action=update&cid={$note->entity_id}&id={$note->id}&context=home"
197 'deleteUrl' => CRM_Utils_System
::url('civicrm/contact/view/note',
198 "reset=1&action=delete&cid={$note->entity_id}&id={$note->id}&context=home"
203 // add the recently created Note
204 CRM_Utils_Recent
::add($displayName . ' - ' . $note->subject
,
205 CRM_Utils_System
::url('civicrm/contact/view/note',
206 "reset=1&action=view&cid={$note->entity_id}&id={$note->id}&context=home"
220 * Check if there is data to create the object
222 * @param array $params (reference ) an assoc array of name/value pairs
228 static function dataExists(&$params) {
229 // return if no data present
230 if (!strlen($params['note'])) {
237 * Given the list of params in the params array, fetch the object
238 * and store the values in the values array
240 * @param array $params input parameters to find object
241 * @param array $values output values of the object
242 * @param int $numNotes the maximum number of notes to return (0 if all)
244 * @return object $notes Object of CRM_Core_BAO_Note
248 static function &getValues(&$params, &$values, $numNotes = self
::MAX_NOTES
) {
249 if (empty($params)) {
252 $note = new CRM_Core_BAO_Note();
253 $note->entity_id
= $params['contact_id'];
254 $note->entity_table
= 'civicrm_contact';
256 // get the total count of notes
257 $values['noteTotalCount'] = $note->count();
259 // get only 3 recent notes
260 $note->orderBy('modified_date desc');
261 $note->limit($numNotes);
266 while ($note->fetch()) {
267 $values['note'][$note->id
] = array();
268 CRM_Core_DAO
::storeValues($note, $values['note'][$note->id
]);
272 // if we have collected the number of notes, exit loop
273 if ($numNotes > 0 && $count >= $numNotes) {
284 * @param int $id note id
285 * @param boolean $showStatus do we need to set status or not
287 * @return mixed|null $return no of deleted notes on success, false otherwise@access public
290 static function del($id, $showStatus = TRUE) {
292 $recent = array($id);
293 $note = new CRM_Core_DAO_Note();
297 if ($note->entity_table
== 'civicrm_note') {
298 $status = ts('Selected Comment has been deleted successfully.');
301 $status = ts('Selected Note has been deleted successfully.');
304 // Delete all descendents of this Note
305 foreach (self
::getDescendentIds($id) as $childId) {
306 $childNote = new CRM_Core_DAO_Note();
307 $childNote->id
= $childId;
308 $childNote->delete();
310 $recent[] = $childId;
313 $return = $note->delete();
316 CRM_Core_Session
::setStatus($status, ts('Deleted'), 'success');
319 // delete the recently created Note
320 foreach ($recent as $recentId) {
325 CRM_Utils_Recent
::del($noteRecent);
331 * Delete all records for this contact id
333 * @param int $id ID of the contact for which note needs to be deleted.
340 public static function deleteContact($id) {
341 // need to delete for both entity_id
342 $dao = new CRM_Core_DAO_Note();
343 $dao->entity_table
= 'civicrm_contact';
344 $dao->entity_id
= $id;
347 // and the creator contact id
348 $dao = new CRM_Core_DAO_Note();
349 $dao->contact_id
= $id;
354 * Retrieve all records for this entity-id
356 * @param int $id ID of the relationship for which records needs to be retrieved.
358 * @param string $entityTable
360 * @return array $viewNote array of note properties
365 public static function &getNote($id, $entityTable = 'civicrm_relationship') {
372 WHERE entity_table=\"{$entityTable}\"
375 ORDER BY modified_date desc";
376 $params = array(1 => array($id, 'Integer'));
378 $dao = CRM_Core_DAO
::executeQuery($query, $params);
380 while ($dao->fetch()) {
381 $viewNote[$dao->id
] = $dao->note
;
388 * Get log record count for a Contact
390 * @param int $contactID
392 * @return int $count count of log records
397 static function getContactNoteCount($contactID) {
398 $note = new CRM_Core_DAO_Note();
399 $note->entity_id
= $contactID;
400 $note->entity_table
= 'civicrm_contact';
403 while ($note->fetch()) {
404 if (!self
::getNotePrivacyHidden($note)) {
412 * Get all descendent notes of the note with given ID
414 * @param int $parentId ID of the note to start from
415 * @param int $maxDepth Maximum number of levels to descend into the tree; if not given, will include all descendents.
416 * @param bool $snippet If TRUE, returned values will be pre-formatted for display in a table of notes.
418 * @return array Nested associative array beginning with direct children of given note.
423 public static function getNoteTree($parentId, $maxDepth = 0, $snippet = FALSE) {
424 return self
::buildNoteTree($parentId, $maxDepth, $snippet);
428 * Get total count of direct children visible to the current user
430 * @param int $id Note ID
432 * @return int $count Number of notes having the give note as parent
437 public static function getChildCount($id) {
438 $note = new CRM_Core_DAO_Note();
439 $note->entity_table
= 'civicrm_note';
440 $note->entity_id
= $id;
443 while ($note->fetch()) {
444 if (!self
::getNotePrivacyHidden($note)) {
452 * Recursive function to get all descendent notes of the note with given ID
454 * @param int $parentId ID of the note to start from
455 * @param int $maxDepth Maximum number of levels to descend into the tree; if not given, will include all descendents.
456 * @param bool $snippet If TRUE, returned values will be pre-formatted for display in a table of notes.
457 * @param array $tree (Reference) Variable to store all found descendents
458 * @param int $depth Depth of current iteration within the descendent tree (used for comparison against maxDepth)
460 * @return array Nested associative array beginning with direct children of given note.
463 private static function buildNoteTree($parentId, $maxDepth = 0, $snippet = FALSE, &$tree = array(), $depth = 0) {
464 if ($maxDepth && $depth > $maxDepth) {
468 // get direct children of given parentId note
469 $note = new CRM_Core_DAO_Note();
470 $note->entity_table
= 'civicrm_note';
471 $note->entity_id
= $parentId;
472 $note->orderBy('modified_date asc');
474 while ($note->fetch()) {
475 // foreach child, call this function, unless the child is private/hidden
476 if (!self
::getNotePrivacyHidden($note)) {
477 CRM_Core_DAO
::storeValues($note, $tree[$note->id
]);
479 // get name of user that created this note
480 $contact = new CRM_Contact_DAO_Contact();
481 $createdById = $note->contact_id
;
482 $contact->id
= $createdById;
485 $tree[$note->id
]['createdBy'] = $contact->display_name
;
486 $tree[$note->id
]['createdById'] = $createdById;
487 $tree[$note->id
]['modified_date'] = CRM_Utils_Date
::customFormat($tree[$note->id
]['modified_date']);
489 // paper icon view for attachments part
490 $paperIconAttachmentInfo = CRM_Core_BAO_File
::paperIconAttachment('civicrm_note', $note->id
);
491 $tree[$note->id
]['attachment'] = $paperIconAttachmentInfo ?
implode('', $paperIconAttachmentInfo) : '';
494 $tree[$note->id
]['note'] = nl2br($tree[$note->id
]['note']);
495 $tree[$note->id
]['note'] = smarty_modifier_mb_truncate(
496 $tree[$note->id
]['note'],
501 CRM_Utils_Date
::customFormat($tree[$note->id
]['modified_date']);
507 $tree[$note->id
]['child'],
517 * Given a note id, get a list of the ids of all notes that are descendents of that note
519 * @param int $parentId Id of the given note
520 * @param array $ids (reference) one-dimensional array to store found descendent ids
522 * @return array $ids One-dimensional array containing ids of all desendent notes
524 public static function getDescendentIds($parentId, &$ids = array()) {
525 // get direct children of given parentId note
526 $note = new CRM_Core_DAO_Note();
527 $note->entity_table
= 'civicrm_note';
528 $note->entity_id
= $parentId;
530 while ($note->fetch()) {
531 // foreach child, add to ids list, and recurse
533 self
::getDescendentIds($note->id
, $ids);
539 * Delete all note related to contact when contact is deleted
541 * @param int $contactID contact id whose notes to be deleted
546 static function cleanContactNotes($contactID) {
547 $params = array(1 => array($contactID, 'Integer'));
549 // delete all notes related to contribution
550 $contributeQuery = "DELETE note.*
551 FROM civicrm_note note LEFT JOIN civicrm_contribution contribute ON note.entity_id = contribute.id
552 WHERE contribute.contact_id = %1 AND note.entity_table = 'civicrm_contribution'";
554 CRM_Core_DAO
::executeQuery($contributeQuery, $params);
556 // delete all notes related to participant
557 $participantQuery = "DELETE note.*
558 FROM civicrm_note note LEFT JOIN civicrm_participant participant ON note.entity_id = participant.id
559 WHERE participant.contact_id = %1 AND note.entity_table = 'civicrm_participant'";
561 CRM_Core_DAO
::executeQuery($participantQuery, $params);
563 // delete all contact notes
564 $contactQuery = "SELECT id FROM civicrm_note WHERE entity_id = %1 AND entity_table = 'civicrm_contact'";
566 $contactNoteId = CRM_Core_DAO
::executeQuery($contactQuery, $params);
567 while ($contactNoteId->fetch()) {
568 self
::del($contactNoteId->id
, FALSE);