add missing comments - tests directory
[civicrm-core.git] / tests / phpunit / api / v3 / ContactTypeTest.php
index f031d25dfdb509562eaa2887e7cacf75f7a4eeda..44f4357153845f0b7422a10fa62159c711dc33af 100644 (file)
@@ -1,10 +1,9 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.3                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
 
 
 require_once 'CiviTest/CiviUnitTestCase.php';
+
+/**
+ * Class api_v3_ContactTypeTest
+ */
 class api_v3_ContactTypeTest extends CiviUnitTestCase {
   protected $_apiversion;
-  public $_eNoticeCompliant = TRUE;
+
   function setUp() {
     parent::setUp();
     $this->_apiversion = 3;
@@ -99,41 +102,35 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase {
       'last_name' => 'Grant',
       'contact_type' => 'Individual',
       'contact_sub_type' => $this->subTypeIndividual,
-      'version' => $this->_apiversion,
     );
-    $contact = civicrm_api('contact', 'create', $contactParams);
-    $this->assertEquals($contact['is_error'], 0, "In line " . __LINE__);
+    $contact = $this->callAPISuccess('contact', 'create', $contactParams);
     $params = array(
       'contact_id' => $contact['id'],
-      'version' => $this->_apiversion,
     );
-    $result = civicrm_api('contact', 'get', $params);
+    $result = $this->callAPISuccess('contact', 'get', $params);
     $this->assertEquals($result['values'][$contact['id']]['first_name'], $contactParams['first_name'], "In line " . __LINE__);
     $this->assertEquals($result['values'][$contact['id']]['last_name'], $contactParams['last_name'], "In line " . __LINE__);
     $this->assertEquals($result['values'][$contact['id']]['contact_type'], $contactParams['contact_type'], "In line " . __LINE__);
     $this->assertEquals(end($result['values'][$contact['id']]['contact_sub_type']), $contactParams['contact_sub_type'], "In line " . __LINE__);
-    civicrm_api('contact', 'delete', $params);
+    $this->callAPISuccess('contact', 'delete', $params);
 
     // check for Type:Organization Subtype:sub_organization
     $contactParams = array(
       'organization_name' => 'Compumentor',
       'contact_type' => 'Organization',
       'contact_sub_type' => $this->subTypeOrganization,
-      'version' => $this->_apiversion,
     );
-    $contact = civicrm_api('contact', 'create', $contactParams);
-    $this->assertEquals($contact['is_error'], 0, "In line " . __LINE__);
+    $contact = $this->callAPISuccess('contact', 'create', $contactParams);
 
     $params = array(
       'contact_id' => $contact['id'],
-      'version' => $this->_apiversion,
     );
-    $getContacts = civicrm_api('contact', 'get', $params);
+    $getContacts = $this->callAPISuccess('contact', 'get', $params);
     $result = $getContacts['values'][$contact['id']];
     $this->assertEquals($result['organization_name'], $contactParams['organization_name'], "In line " . __LINE__);
     $this->assertEquals($result['contact_type'], $contactParams['contact_type'], "In line " . __LINE__);
     $this->assertEquals(end($result['contact_sub_type']), $contactParams['contact_sub_type'], "In line " . __LINE__);
-    civicrm_api('contact', 'delete', $params);
+    $this->callAPISuccess('contact', 'delete', $params);
   }
 
 
@@ -148,7 +145,6 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase {
       'last_name' => 'Grant',
       'contact_type' => 'Individual',
       'contact_sub_type' => $this->subTypeHousehold,
-      'version' => $this->_apiversion,
     );
     $contact = $this->callAPIFailure('contact', 'create', $contactParams);
 
@@ -157,7 +153,6 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase {
       'organization_name' => 'Compumentor',
       'contact_type' => 'Organization',
       'contact_sub_type' => $this->subTypeIndividual,
-      'version' => $this->_apiversion,
     );
     $contact = $this->callAPIFailure('contact', 'create', $contactParams);
   }
@@ -174,9 +169,8 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase {
       'first_name' => 'Anne',
       'last_name' => 'Grant',
       'contact_type' => 'Individual',
-      'version' => $this->_apiversion,
     );
-    $contact = civicrm_api('contact', 'create', $contactParams);
+    $contact = $this->callAPISuccess('contact', 'create', $contactParams);
     // subype:sub_individual
     $updateParams = array(
       'first_name' => 'John',
@@ -184,32 +178,28 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase {
       'contact_id' => $contact['id'],
       'contact_type' => 'Individual',
       'contact_sub_type' => $this->subTypeIndividual,
-      'version' => $this->_apiversion,
     );
-    $updateContact = civicrm_api('contact', 'create', $updateParams);
-    $this->assertEquals($updateContact['is_error'], 0, "In line " . __LINE__);
+    $updateContact = $this->callAPISuccess('contact', 'create', $updateParams);
     $this->assertEquals($updateContact['id'], $contact['id'], "In line " . __LINE__);
 
     $params = array(
       'contact_id' => $contact['id'],
-      'version' => $this->_apiversion,
     );
-    $getContacts = civicrm_api('contact', 'get', $params);
+    $getContacts = $this->callAPISuccess('contact', 'get', $params);
     $result = $getContacts['values'][$contact['id']];
 
     $this->assertEquals($result['first_name'], $updateParams['first_name'], "In line " . __LINE__);
     $this->assertEquals($result['last_name'], $updateParams['last_name'], "In line " . __LINE__);
     $this->assertEquals($result['contact_type'], $updateParams['contact_type'], "In line " . __LINE__);
     $this->assertEquals(end($result['contact_sub_type']), $updateParams['contact_sub_type'], "In line " . __LINE__);
-    civicrm_api('contact', 'delete', $params);
+    $this->callAPISuccess('contact', 'delete', $params);
 
     // check for Type:Organization
     $contactParams = array(
       'organization_name' => 'Compumentor',
       'contact_type' => 'Organization',
-      'version' => $this->_apiversion,
     );
-    $contact = civicrm_api('contact', 'create', $contactParams);
+    $contact = $this->callAPISuccess('contact', 'create', $contactParams);
 
     // subype:sub_organization
     $updateParams = array(
@@ -217,24 +207,20 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase {
       'contact_id' => $contact['id'],
       'contact_type' => 'Organization',
       'contact_sub_type' => $this->subTypeOrganization,
-      'version' => $this->_apiversion,
     );
-    $updateContact = civicrm_api('contact', 'create', $updateParams);
-
-    $this->assertEquals($updateContact['is_error'], 0, "In line " . __LINE__);
+    $updateContact = $this->callAPISuccess('contact', 'create', $updateParams);
     $this->assertEquals($updateContact['id'], $contact['id'], "In line " . __LINE__);
 
     $params = array(
       'contact_id' => $contact['id'],
-      'version' => $this->_apiversion,
     );
-    $getContacts = civicrm_api('contact', 'get', $params);
+    $getContacts = $this->callAPISuccess('contact', 'get', $params);
     $result = $getContacts['values'][$contact['id']];
 
     $this->assertEquals($result['organization_name'], $updateParams['organization_name'], "In line " . __LINE__);
     $this->assertEquals($result['contact_type'], $updateParams['contact_type'], "In line " . __LINE__);
     $this->assertEquals(end($result['contact_sub_type']), $updateParams['contact_sub_type'], "In line " . __LINE__);
-    civicrm_api('contact', 'delete', $params);
+    $this->callAPISuccess('contact', 'delete', $params);
   }
 
 
@@ -248,9 +234,8 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase {
       'first_name' => 'Anne',
       'last_name' => 'Grant',
       'contact_type' => 'Individual',
-      'version' => $this->_apiversion,
     );
-    $contact = civicrm_api('contact', 'create', $contactParams);
+    $contact = $this->callAPISuccess('contact', 'create', $contactParams);
 
     // subype:sub_household
     $updateParams = array(
@@ -259,36 +244,31 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase {
       'contact_id' => $contact['id'],
       'contact_type' => 'Individual',
       'contact_sub_type' => $this->subTypeHousehold,
-      'version' => $this->_apiversion,
     );
     $updateContact = $this->callAPIFailure('contact', 'create', $updateParams);
     $params = array(
       'contact_id' => $contact['id'],
-      'version' => $this->_apiversion,
-    );
-    civicrm_api('contact', 'delete', $params);
+     );
+    $this->callAPISuccess('contact', 'delete', $params);
 
     // check for Type:Organization
     $contactParams = array(
       'organization_name' => 'Compumentor',
       'contact_type' => 'Organization',
-      'version' => $this->_apiversion,
     );
-    $contact = civicrm_api('contact', 'create', $contactParams);
+    $contact = $this->callAPISuccess('contact', 'create', $contactParams);
 
     $updateParams = array(
       'organization_name' => 'Intel Arts',
       'contact_id' => $contact['id'],
       'contact_type' => 'Organization',
       'contact_sub_type' => $this->subTypeIndividual,
-      'version' => $this->_apiversion,
     );
     $updateContact = $this->callAPIFailure('contact', 'create', $updateParams);
     $params = array(
       'contact_id' => $contact['id'],
-      'version' => $this->_apiversion,
     );
-    civicrm_api('contact', 'delete', $params);
+    $this->callAPISuccess('contact', 'delete', $params);
   }
 
   /*
@@ -313,9 +293,8 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase {
       'last_name' => 'Grant',
       'contact_type' => 'Individual',
       'contact_sub_type' => $this->subTypeIndividual,
-      'version' => $this->_apiversion,
     );
-    $contact = civicrm_api('contact', 'create', $contactParams);
+    $contact = $this->callAPISuccess('contact', 'create', $contactParams);
     // subype:sub2_individual
     $updateParams = array(
       'id' => $contact['id'],
@@ -324,25 +303,22 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase {
       'contact_id' => $contact['id'],
       'contact_type' => 'Individual',
       'contact_sub_type' => $subtype,
-      'version' => $this->_apiversion,
     );
-    $updateContact = civicrm_api('contact', 'create', $updateParams);
+    $updateContact = $this->callAPISuccess('contact', 'create', $updateParams);
 
-    $this->assertEquals($updateContact['is_error'], 0, "In line " . __LINE__);
     $this->assertEquals($updateContact['id'], $contact['id'], "In line " . __LINE__);
 
     $params = array(
       'contact_id' => $contact['id'],
-      'version' => $this->_apiversion,
     );
-    $getContacts = civicrm_api('contact', 'get', $params);
+    $getContacts = $this->callAPISuccess('contact', 'get', $params);
     $result = $getContacts['values'][$contact['id']];
 
     $this->assertEquals($result['first_name'], $updateParams['first_name'], "In line " . __LINE__);
     $this->assertEquals($result['last_name'], $updateParams['last_name'], "In line " . __LINE__);
     $this->assertEquals($result['contact_type'], $updateParams['contact_type'], "In line " . __LINE__);
     $this->assertEquals(end($result['contact_sub_type']), $updateParams['contact_sub_type'], "In line " . __LINE__);
-    civicrm_api('contact', 'delete', $params);
+    $this->callAPISuccess('contact', 'delete', $params);
 
 
     $params = array(
@@ -360,9 +336,8 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase {
       'organization_name' => 'Compumentor',
       'contact_type' => 'Organization',
       'contact_sub_type' => $this->subTypeOrganization,
-      'version' => $this->_apiversion,
     );
-    $contact = civicrm_api('contact', 'create', $contactParams);
+    $contact = $this->callAPISuccess('contact', 'create', $contactParams);
 
     // subype:sub2_organization
     $updateParams = array(
@@ -370,24 +345,20 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase {
       'contact_id' => $contact['id'],
       'contact_type' => 'Organization',
       'contact_sub_type' => $subtype,
-      'version' => $this->_apiversion,
     );
-    $updateContact = civicrm_api('contact', 'create', $updateParams);
-
-    $this->assertEquals($updateContact['is_error'], 0, "In line " . __LINE__);
+    $updateContact = $this->callAPISuccess('contact', 'create', $updateParams);
     $this->assertEquals($updateContact['id'], $contact['id'], "In line " . __LINE__);
 
     $params = array(
       'contact_id' => $contact['id'],
-      'version' => $this->_apiversion,
     );
-    $getContacts = civicrm_api('contact', 'get', $params);
+    $getContacts = $this->callAPISuccess('contact', 'get', $params);
     $result = $getContacts['values'][$contact['id']];
 
     $this->assertEquals($result['organization_name'], $updateParams['organization_name'], "In line " . __LINE__);
     $this->assertEquals($result['contact_type'], $updateParams['contact_type'], "In line " . __LINE__);
     $this->assertEquals(end($result['contact_sub_type']), $updateParams['contact_sub_type'], "In line " . __LINE__);
-    civicrm_api('contact', 'delete', $params);
+    $this->callAPISuccess('contact', 'delete', $params);
   }
 
   /*
@@ -401,9 +372,8 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase {
       'last_name' => 'Grant',
       'contact_type' => 'Individual',
       'contact_sub_type' => $this->subTypeIndividual,
-      'version' => $this->_apiversion,
     );
-    $contact = civicrm_api('contact', 'create', $contactParams);
+    $contact = $this->callAPISuccess('contact', 'create', $contactParams);
 
     // subype:sub_household
     $updateParams = array(
@@ -412,36 +382,31 @@ class api_v3_ContactTypeTest extends CiviUnitTestCase {
       'contact_id' => $contact['id'],
       'contact_type' => 'Individual',
       'contact_sub_type' => $this->subTypeHousehold,
-      'version' => $this->_apiversion,
     );
     $updateContact = $this->callAPIFailure('contact', 'create', $updateParams);
     $params = array(
       'contact_id' => $contact['id'],
-      'version' => $this->_apiversion,
     );
-    civicrm_api('contact', 'delete', $params);
+    $this->callAPISuccess('contact', 'delete', $params);
 
     // check for Type:Organization subtype:
     $contactParams = array(
       'organization_name' => 'Compumentor',
       'contact_type' => 'Organization',
       'contact_sub_type' => $this->subTypeOrganization,
-      'version' => $this->_apiversion,
     );
-    $contact = civicrm_api('contact', 'create', $contactParams);
+    $contact = $this->callAPISuccess('contact', 'create', $contactParams);
 
     $updateParams = array(
       'organization_name' => 'Intel Arts',
       'contact_id' => $contact['id'],
       'contact_sub_type' => $this->subTypeIndividual,
-      'version' => $this->_apiversion,
     );
     $updateContact = $this->callAPIFailure('contact', 'create', $updateParams);
     $params = array(
       'contact_id' => $contact['id'],
-      'version' => $this->_apiversion,
     );
-    civicrm_api('contact', 'delete', $params);
+    $this->callAPISuccess('contact', 'delete', $params);
   }
 }