3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
37 * Main page for viewing Notes.
40 class CRM_Contact_Page_View_Note
extends CRM_Core_Page
{
43 * The action links for notes that we need to display for the browse screen
48 static $_links = NULL;
51 * The action links for comments that we need to display for the browse screen
56 static $_commentLinks = NULL;
59 * View details of a note
65 $note = new CRM_Core_DAO_Note();
66 $note->id
= $this->_id
;
67 if ($note->find(TRUE)) {
69 CRM_Core_DAO
::storeValues($note, $values);
70 $values['privacy'] = CRM_Core_OptionGroup
::optionLabel('note_privacy', $values['privacy']);
71 $this->assign('note', $values);
74 $comments = CRM_Core_BAO_Note
::getNoteTree($values['id'], 1);
75 if (!empty($comments)) {
76 $this->assign('comments', $comments);
79 // add attachments part
80 $currentAttachmentInfo = CRM_Core_BAO_File
::getEntityFile('civicrm_note', $this->_id
);
81 $this->assign('currentAttachmentInfo', $currentAttachmentInfo);
86 * This function is called when action is browse
92 $note = new CRM_Core_DAO_Note();
93 $note->entity_table
= 'civicrm_contact';
94 $note->entity_id
= $this->_contactId
;
96 $note->orderBy('modified_date desc');
98 //CRM-4418, handling edit and delete separately.
99 $permissions = array($this->_permission
);
100 if ($this->_permission
== CRM_Core_Permission
::EDIT
) {
101 //previously delete was subset of edit
102 //so for consistency lets grant delete also.
103 $permissions[] = CRM_Core_Permission
::DELETE
;
105 $mask = CRM_Core_Action
::mask($permissions);
108 $links = self
::links();
109 $action = array_sum(array_keys($links)) & $mask;
112 while ($note->fetch()) {
113 if (!CRM_Core_BAO_Note
::getNotePrivacyHidden($note)) {
114 CRM_Core_DAO
::storeValues($note, $values[$note->id
]);
116 $values[$note->id
]['action'] = CRM_Core_Action
::formLink($links,
120 'cid' => $this->_contactId
,
128 $contact = new CRM_Contact_DAO_Contact();
129 $contact->id
= $note->contact_id
;
132 $values[$note->id
]['createdBy'] = $contact->display_name
;
133 $values[$note->id
]['comment_count'] = CRM_Core_BAO_Note
::getChildCount($note->id
);
137 $this->assign('notes', $values);
139 $commentLinks = self
::commentLinks();
141 $action = array_sum(array_keys($commentLinks)) & $mask;
143 $commentAction = CRM_Core_Action
::formLink($commentLinks,
147 'pid' => $note->entity_id
,
148 'cid' => $note->entity_id
,
152 'note.comment.action',
156 $this->assign('commentAction', $commentAction);
160 * This function is called when action is update or new
166 $controller = new CRM_Core_Controller_Simple('CRM_Note_Form_Note', ts('Contact Notes'), $this->_action
);
167 $controller->setEmbedded(TRUE);
169 // set the userContext stack
170 $session = CRM_Core_Session
::singleton();
171 $url = CRM_Utils_System
::url('civicrm/contact/view',
172 'action=browse&selectedChild=note&cid=' . $this->_contactId
174 $session->pushUserContext($url);
176 if (CRM_Utils_Request
::retrieve('confirmed', 'Boolean',
177 CRM_Core_DAO
::$_nullObject
179 CRM_Core_BAO_Note
::del($this->_id
);
180 CRM_Utils_System
::redirect($url);
183 $controller->reset();
184 $controller->set('entityTable', 'civicrm_contact');
185 $controller->set('entityId', $this->_contactId
);
186 $controller->set('id', $this->_id
);
188 $controller->process();
192 function preProcess() {
193 $this->_id
= CRM_Utils_Request
::retrieve('id', 'Positive', $this);
195 if ($this->_id
&& CRM_Core_BAO_Note
::getNotePrivacyHidden($this->_id
)) {
196 CRM_Core_Error
::statusBounce(ts('You do not have access to this note.'));
199 $this->_contactId
= CRM_Utils_Request
::retrieve('cid', 'Positive', $this, TRUE);
200 $this->assign('contactId', $this->_contactId
);
202 // check logged in url permission
203 CRM_Contact_Page_View
::checkUserPermission($this);
206 CRM_Contact_Page_View
::setTitle($this->_contactId
);
208 $displayName = CRM_Contact_BAO_Contact
::displayName($this->_contactId
);
209 CRM_Utils_System
::setTitle(ts('Notes for') . ' ' . $displayName);
211 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this, FALSE, 'browse');
212 $this->assign('action', $this->_action
);
216 * This function is the main function that is called when the page loads,
217 * it decides the which action has to be taken for the page.
225 if ($this->_action
& CRM_Core_Action
::VIEW
) {
228 elseif ($this->_action
& (CRM_Core_Action
::UPDATE | CRM_Core_Action
::ADD
)) {
231 elseif ($this->_action
& CRM_Core_Action
::DELETE
) {
232 // we use the edit screen the confirm the delete
237 return parent
::run();
241 * delete the note object from the db
247 CRM_Core_BAO_Note
::del($this->_id
);
253 * @return array (reference) of action links
256 static function &links() {
257 if (!(self
::$_links)) {
258 $deleteExtra = ts('Are you sure you want to delete this note?');
260 self
::$_links = array(
261 CRM_Core_Action
::VIEW
=> array(
262 'name' => ts('View'),
263 'url' => 'civicrm/contact/view/note',
264 'qs' => 'action=view&reset=1&cid=%%cid%%&id=%%id%%&selectedChild=note',
265 'title' => ts('View Note'),
267 CRM_Core_Action
::UPDATE
=> array(
268 'name' => ts('Edit'),
269 'url' => 'civicrm/contact/view/note',
270 'qs' => 'action=update&reset=1&cid=%%cid%%&id=%%id%%&selectedChild=note',
271 'title' => ts('Edit Note'),
273 CRM_Core_Action
::ADD
=> array(
274 'name' => ts('Comment'),
275 'url' => 'civicrm/contact/view/note',
276 'qs' => 'action=add&reset=1&cid=%%cid%%&parentId=%%id%%&selectedChild=note',
277 'title' => ts('Add Comment'),
279 CRM_Core_Action
::DELETE
=> array(
280 'name' => ts('Delete'),
281 'url' => 'civicrm/contact/view/note',
282 'qs' => 'action=delete&reset=1&cid=%%cid%%&id=%%id%%&selectedChild=note',
283 'extra' => 'onclick = "if (confirm(\'' . $deleteExtra . '\') ) this.href+=\'&confirmed=1\'; else return false;"',
284 'title' => ts('Delete Note'),
288 return self
::$_links;
292 * Get action links for comments
294 * @return array (reference) of action links
297 static function &commentLinks() {
298 if (!(self
::$_commentLinks)) {
299 $deleteExtra = ts('Are you sure you want to delete this comment?');
300 self
::$_commentLinks = array(
301 CRM_Core_Action
::VIEW
=> array(
302 'name' => ts('View'),
303 'url' => 'civicrm/contact/view/note',
304 'qs' => 'action=view&reset=1&cid=%%cid%%&id={id}&selectedChild=note',
305 'title' => ts('View Comment'),
307 CRM_Core_Action
::UPDATE
=> array(
308 'name' => ts('Edit'),
309 'url' => 'civicrm/contact/view/note',
310 'qs' => 'action=update&reset=1&cid=%%cid%%&id={id}&parentId=%%pid%%&selectedChild=note',
311 'title' => ts('Edit Comment'),
313 CRM_Core_Action
::DELETE
=> array(
314 'name' => ts('Delete'),
315 'url' => 'civicrm/contact/view/note',
316 'qs' => 'action=delete&reset=1&cid=%%cid%%&id={id}&selectedChild=note',
317 'extra' => 'onclick = "if (confirm(\'' . $deleteExtra . '\') ) this.href+=\'&confirmed=1\'; else return false;"',
318 'title' => ts('Delete Comment'),
322 return self
::$_commentLinks;