| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 5 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
| 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 | * Class contains api test cases for "civicrm_note" |
| 30 | * @group headless |
| 31 | */ |
| 32 | class api_v3_NoteTest extends CiviUnitTestCase { |
| 33 | |
| 34 | protected $_apiversion; |
| 35 | protected $_contactID; |
| 36 | protected $_params; |
| 37 | protected $_noteID; |
| 38 | protected $_note; |
| 39 | |
| 40 | public function setUp() { |
| 41 | |
| 42 | $this->_apiversion = 3; |
| 43 | // Connect to the database. |
| 44 | parent::setUp(); |
| 45 | $this->useTransaction(TRUE); |
| 46 | |
| 47 | $this->_contactID = $this->organizationCreate(NULL); |
| 48 | |
| 49 | $this->_params = array( |
| 50 | 'entity_table' => 'civicrm_contact', |
| 51 | 'entity_id' => $this->_contactID, |
| 52 | 'note' => 'Hello!!! m testing Note', |
| 53 | 'contact_id' => $this->_contactID, |
| 54 | 'modified_date' => '2011-01-31', |
| 55 | 'subject' => 'Test Note', |
| 56 | ); |
| 57 | $this->_note = $this->noteCreate($this->_contactID); |
| 58 | $this->_noteID = $this->_note['id']; |
| 59 | } |
| 60 | |
| 61 | ///////////////// civicrm_note_get methods |
| 62 | |
| 63 | /** |
| 64 | * Check retrieve note with empty parameter array. |
| 65 | * |
| 66 | * Error expected |
| 67 | */ |
| 68 | public function testGetWithEmptyParams() { |
| 69 | $this->callAPISuccess('note', 'get', array()); |
| 70 | } |
| 71 | |
| 72 | /** |
| 73 | * Check retrieve note with missing parameters. |
| 74 | * |
| 75 | * Error expected |
| 76 | */ |
| 77 | public function testGetWithoutEntityId() { |
| 78 | $params = array( |
| 79 | 'entity_table' => 'civicrm_contact', |
| 80 | ); |
| 81 | $this->callAPISuccess('note', 'get', $params); |
| 82 | } |
| 83 | |
| 84 | /** |
| 85 | * Check civicrm_note get. |
| 86 | */ |
| 87 | public function testGet() { |
| 88 | $entityId = $this->_noteID; |
| 89 | $params = array( |
| 90 | 'entity_table' => 'civicrm_contact', |
| 91 | 'entity_id' => $entityId, |
| 92 | ); |
| 93 | $this->callAPIAndDocument('note', 'get', $params, __FUNCTION__, __FILE__); |
| 94 | } |
| 95 | |
| 96 | /** |
| 97 | * Check create with empty parameter array. |
| 98 | * |
| 99 | * Error Expected |
| 100 | */ |
| 101 | public function testCreateWithEmptyNoteField() { |
| 102 | $this->_params['note'] = ""; |
| 103 | $this->callAPIFailure('note', 'create', $this->_params, |
| 104 | 'Mandatory key(s) missing from params array: note' |
| 105 | ); |
| 106 | } |
| 107 | |
| 108 | /** |
| 109 | * Check create with partial params. |
| 110 | * |
| 111 | * Error expected |
| 112 | */ |
| 113 | public function testCreateWithoutEntityId() { |
| 114 | unset($this->_params['entity_id']); |
| 115 | $this->callAPIFailure('note', 'create', $this->_params, |
| 116 | 'Mandatory key(s) missing from params array: entity_id'); |
| 117 | } |
| 118 | |
| 119 | /** |
| 120 | * Check create with partially empty params. |
| 121 | * |
| 122 | * Error expected |
| 123 | */ |
| 124 | public function testCreateWithEmptyEntityId() { |
| 125 | $this->_params['entity_id'] = ""; |
| 126 | $this->callAPIFailure('note', 'create', $this->_params, |
| 127 | 'Mandatory key(s) missing from params array: entity_id'); |
| 128 | } |
| 129 | |
| 130 | /** |
| 131 | * Check civicrm note create. |
| 132 | */ |
| 133 | public function testCreate() { |
| 134 | |
| 135 | $result = $this->callAPIAndDocument('note', 'create', $this->_params, __FUNCTION__, __FILE__); |
| 136 | $this->assertEquals($result['values'][$result['id']]['note'], 'Hello!!! m testing Note'); |
| 137 | $this->assertEquals(date('Y-m-d', strtotime($this->_params['modified_date'])), date('Y-m-d', strtotime($result['values'][$result['id']]['modified_date']))); |
| 138 | |
| 139 | $this->assertArrayHasKey('id', $result); |
| 140 | } |
| 141 | |
| 142 | public function testCreateWithApostropheInString() { |
| 143 | $params = array( |
| 144 | 'entity_table' => 'civicrm_contact', |
| 145 | 'entity_id' => $this->_contactID, |
| 146 | 'note' => "Hello!!! ' testing Note", |
| 147 | 'contact_id' => $this->_contactID, |
| 148 | 'modified_date' => '2011-01-31', |
| 149 | 'subject' => "With a '", |
| 150 | 'sequential' => 1, |
| 151 | ); |
| 152 | $result = $this->callAPISuccess('Note', 'Create', $params); |
| 153 | $this->assertAPISuccess($result); |
| 154 | $this->assertEquals($result['values'][0]['note'], "Hello!!! ' testing Note"); |
| 155 | $this->assertEquals($result['values'][0]['subject'], "With a '"); |
| 156 | $this->assertArrayHasKey('id', $result); |
| 157 | } |
| 158 | |
| 159 | /** |
| 160 | * Check civicrm_note_create - tests used of default set to . |
| 161 | */ |
| 162 | public function testCreateWithoutModifiedDate() { |
| 163 | unset($this->_params['modified_date']); |
| 164 | $apiResult = $this->callAPISuccess('note', 'create', $this->_params); |
| 165 | $this->assertAPISuccess($apiResult); |
| 166 | $this->assertEquals(date('Y-m-d'), date('Y-m-d', strtotime($apiResult['values'][$apiResult['id']]['modified_date']))); |
| 167 | } |
| 168 | |
| 169 | /** |
| 170 | * Check update with empty parameter array. |
| 171 | * |
| 172 | * Please don't copy & paste this - is of marginal value |
| 173 | * better to put time into the function on Syntax Conformance class that tests this |
| 174 | */ |
| 175 | public function testUpdateWithEmptyParams() { |
| 176 | $this->callAPIFailure('note', 'create', array()); |
| 177 | } |
| 178 | |
| 179 | /** |
| 180 | * Check update with missing parameter (contact id). |
| 181 | * |
| 182 | * Error expected |
| 183 | */ |
| 184 | public function testUpdateWithoutContactId() { |
| 185 | $params = array( |
| 186 | 'entity_id' => $this->_contactID, |
| 187 | 'entity_table' => 'civicrm_contact', |
| 188 | ); |
| 189 | $this->callAPIFailure('note', 'create', $params, |
| 190 | 'Mandatory key(s) missing from params array: note' |
| 191 | ); |
| 192 | } |
| 193 | |
| 194 | /** |
| 195 | * Check civicrm_note update. |
| 196 | */ |
| 197 | public function testUpdate() { |
| 198 | $params = array( |
| 199 | 'id' => $this->_noteID, |
| 200 | 'contact_id' => $this->_contactID, |
| 201 | 'note' => 'Note1', |
| 202 | 'subject' => 'Hello World', |
| 203 | ); |
| 204 | |
| 205 | // Update Note. |
| 206 | $this->callAPISuccess('note', 'create', $params); |
| 207 | $note = $this->callAPISuccess('Note', 'Get', array()); |
| 208 | $this->assertEquals($note['id'], $this->_noteID); |
| 209 | $this->assertEquals($note['values'][$this->_noteID]['entity_id'], $this->_contactID); |
| 210 | $this->assertEquals($note['values'][$this->_noteID]['entity_table'], 'civicrm_contact'); |
| 211 | $this->assertEquals('Hello World', $note['values'][$this->_noteID]['subject']); |
| 212 | $this->assertEquals('Note1', $note['values'][$this->_noteID]['note']); |
| 213 | } |
| 214 | |
| 215 | /** |
| 216 | * Check delete with empty parameters array. |
| 217 | * |
| 218 | * Error expected. |
| 219 | */ |
| 220 | public function testDeleteWithEmptyParams() { |
| 221 | $this->callAPIFailure('note', 'delete', array(), 'Mandatory key(s) missing from params array: id'); |
| 222 | } |
| 223 | |
| 224 | /** |
| 225 | * Check delete with wrong id. |
| 226 | * |
| 227 | * Error expected |
| 228 | */ |
| 229 | public function testDeleteWithWrongID() { |
| 230 | $params = array( |
| 231 | 'id' => 99999, |
| 232 | ); |
| 233 | $this->callAPIFailure('note', 'delete', $params, 'Error while deleting Note'); |
| 234 | } |
| 235 | |
| 236 | /** |
| 237 | * Check civicrm_note delete. |
| 238 | */ |
| 239 | public function testDelete() { |
| 240 | $additionalNote = $this->noteCreate($this->_contactID); |
| 241 | |
| 242 | $params = array( |
| 243 | 'id' => $additionalNote['id'], |
| 244 | ); |
| 245 | |
| 246 | $this->callAPIAndDocument('note', 'delete', $params, __FUNCTION__, __FILE__); |
| 247 | } |
| 248 | |
| 249 | public function testNoteJoin() { |
| 250 | $org = $this->callAPISuccess('Contact', 'create', array( |
| 251 | 'contact_type' => 'Organization', |
| 252 | 'organization_name' => 'Org123', |
| 253 | 'api.Note.create' => array( |
| 254 | 'note' => 'Hello join', |
| 255 | ), |
| 256 | )); |
| 257 | // Fetch contact info via join |
| 258 | $result = $this->callAPISuccessGetSingle('Note', array( |
| 259 | 'return' => array("entity_id.organization_name", "note"), |
| 260 | 'entity_id' => $org['id'], |
| 261 | 'entity_table' => "civicrm_contact", |
| 262 | )); |
| 263 | $this->assertEquals('Org123', $result['entity_id.organization_name']); |
| 264 | $this->assertEquals('Hello join', $result['note']); |
| 265 | // This should return no results by restricting contact_type |
| 266 | $result = $this->callAPISuccess('Note', 'get', array( |
| 267 | 'return' => array("entity_id.organization_name"), |
| 268 | 'entity_id' => $org['id'], |
| 269 | 'entity_table' => "civicrm_contact", |
| 270 | 'entity_id.contact_type' => "Individual", |
| 271 | )); |
| 272 | $this->assertEquals(0, $result['count']); |
| 273 | } |
| 274 | |
| 275 | } |
| 276 | |
| 277 | /** |
| 278 | * Test civicrm note create() using example code. |
| 279 | */ |
| 280 | function testNoteCreateExample() { |
| 281 | require_once 'api/v3/examples/Note/Create.php'; |
| 282 | $result = Note_get_example(); |
| 283 | $expectedResult = Note_get_expectedresult(); |
| 284 | $this->assertEquals($result, $expectedResult); |
| 285 | } |