3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
37 * This class generates form components generic to note
39 * It delegates the work to lower level subclasses and integrates the changes
40 * back in. It also uses a lot of functionality with the CRM API's, so any change
41 * made here could potentially affect the API etc. Be careful, be aware, use unit tests.
44 class CRM_Note_Form_Note
extends CRM_Core_Form
{
47 * The table name, used when editing/creating a note
51 protected $_entityTable;
54 * The table id, used when editing/creating a note
61 * The note id, used when editing the note
68 * The parent note id, used when adding a comment to a note
74 public function preProcess() {
75 $this->_entityTable
= $this->get('entityTable');
76 $this->_entityId
= $this->get('entityId');
77 $this->_id
= $this->get('id');
78 $this->_parentId
= CRM_Utils_Array
::value('parentId', $_GET, 0);
79 if ($this->_parentId
) {
80 $this->assign('parentId', $this->_parentId
);
83 if ($this->_id
&& CRM_Core_BAO_Note
::getNotePrivacyHidden($this->_id
)) {
84 CRM_Core_Error
::statusBounce(ts('You do not have access to this note.'));
86 $this->setPageTitle($this->_parentId ?
ts('Comment') : ts('Note'));
90 * Set default values for the form. Note that in edit/view mode
91 * the default values are retrieved from the database
96 public function setDefaultValues() {
99 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
100 if (isset($this->_id
)) {
101 $params['id'] = $this->_id
;
102 CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_Note', $params, $defaults);
104 if ($defaults['entity_table'] == 'civicrm_note') {
105 $defaults['parent_id'] = $defaults['entity_id'];
108 elseif ($this->_action
& CRM_Core_Action
::ADD
&& $this->_parentId
) {
109 $defaults['parent_id'] = $this->_parentId
;
110 $defaults['subject'] = 'Re: ' . CRM_Core_BAO_Note
::getNoteSubject($this->_parentId
);
116 * Explicitly declare the entity api name.
118 public function getDefaultEntity() {
123 * Explicitly declare the form context.
125 public function getDefaultContext() {
130 * Build the form object.
134 public function buildQuickForm() {
135 if ($this->_action
& CRM_Core_Action
::DELETE
) {
139 'name' => ts('Delete'),
144 'name' => ts('Cancel'),
150 $this->addField('subject');
151 $this->addField('note', [], TRUE);
152 $this->addField('privacy');
153 $this->add('hidden', 'parent_id');
155 // add attachments part
156 CRM_Core_BAO_File
::buildAttachment($this, 'civicrm_note', $this->_id
, NULL, TRUE);
161 'name' => ts('Save'),
166 'name' => ts('Cancel'),
176 public function postProcess() {
177 // store the submitted values in an array
178 $params = $this->controller
->exportValues($this->_name
);
180 $session = CRM_Core_Session
::singleton();
181 $params['contact_id'] = $session->get('userID');
183 if ($params['parent_id']) {
184 $params['entity_table'] = 'civicrm_note';
185 $params['entity_id'] = $params['parent_id'];
188 $params['entity_table'] = $this->_entityTable
;
189 $params['entity_id'] = $this->_entityId
;
192 if ($this->_action
& CRM_Core_Action
::DELETE
) {
193 CRM_Core_BAO_Note
::del($this->_id
);
197 $params['id'] = NULL;
198 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
199 $params['id'] = $this->_id
;
202 // add attachments as needed
203 CRM_Core_BAO_File
::formatAttachment($params, $params, 'civicrm_note', $params['id']);
206 $note = CRM_Core_BAO_Note
::add($params, $ids);
208 CRM_Core_Session
::setStatus(ts('Your Note has been saved.'), ts('Saved'), 'success');