tests/phpunit/api/v3/PhoneTest.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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  *  Test APIv3 civicrm_phone* functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Contact
  33  * @group headless
  34  */
  35 class api_v3_PhoneTest extends CiviUnitTestCase {
  36   protected $_apiversion;
  37   protected $_contactID;
  38   protected $_locationType;
  39   protected $_params;
  40
  41
  42   public function setUp() {
  43     $this->_apiversion = 3;
  44     parent::setUp();
  45     $this->useTransaction();
  46
  47     $this->_contactID = $this->organizationCreate();
  48     $loc = $this->locationTypeCreate();
  49     $this->_locationType = $loc->id;
  50     CRM_Core_PseudoConstant::flush();
  51     $this->_params = array(
  52       'contact_id' => $this->_contactID,
  53       'location_type_id' => $this->_locationType,
  54       'phone' => '(123) 456-7890',
  55       'is_primary' => 1,
  56       'phone_type_id' => 1,
  57     );
  58   }
  59
  60   public function testCreatePhone() {
  61
  62     $result = $this->callAPIAndDocument('phone', 'create', $this->_params, __FUNCTION__, __FILE__);
  63     $this->assertEquals(1, $result['count']);
  64     $this->assertNotNull($result['values'][$result['id']]['id']);
  65
  66     $this->callAPISuccess('phone', 'delete', array('id' => $result['id']));
  67   }
  68
  69   public function testDeletePhone() {
  70     //create one
  71     $create = $this->callAPISuccess('phone', 'create', $this->_params);
  72
  73     $result = $this->callAPIAndDocument('phone', 'delete', array('id' => $create['id']), __FUNCTION__, __FILE__);
  74     $this->assertEquals(1, $result['count']);
  75     $get = $this->callAPISuccess('phone', 'get', array(
  76       'id' => $create['id'],
  77       'location_type_id' => $this->_locationType,
  78     ));
  79     $this->assertEquals(0, $get['count'], 'Phone not successfully deleted In line ' . __LINE__);
  80   }
  81
  82   /**
  83    * Test civicrm_phone_get with empty params.
  84    */
  85   public function testGetEmptyParams() {
  86     $result = $this->callAPISuccess('Phone', 'Get', array());
  87   }
  88
  89   /**
  90    * Test civicrm_phone_get with wrong params.
  91    */
  92   public function testGetWrongParams() {
  93     $this->callAPIFailure('Phone', 'Get', array('contact_id' => 'abc'));
  94     $this->callAPIFailure('Phone', 'Get', array('location_type_id' => 'abc'));
  95     $this->callAPIFailure('Phone', 'Get', array('phone_type_id' => 'abc'));
  96   }
  97
  98   /**
  99    * Test civicrm_phone_get - success expected.
 100    */
 101   public function testGet() {
 102     $phone = $this->callAPISuccess('phone', 'create', $this->_params);
 103     $params = array(
 104       'contact_id' => $this->_params['contact_id'],
 105       'phone' => $phone['values'][$phone['id']]['phone'],
 106     );
 107     $result = $this->callAPIAndDocument('Phone', 'Get', $params, __FUNCTION__, __FILE__);
 108     $this->assertEquals($phone['values'][$phone['id']]['location_type_id'], $result['values'][$phone['id']]['location_type_id']);
 109     $this->assertEquals($phone['values'][$phone['id']]['phone_type_id'], $result['values'][$phone['id']]['phone_type_id']);
 110     $this->assertEquals($phone['values'][$phone['id']]['is_primary'], $result['values'][$phone['id']]['is_primary']);
 111     $this->assertEquals($phone['values'][$phone['id']]['phone'], $result['values'][$phone['id']]['phone']);
 112   }
 113
 114   ///////////////// civicrm_phone_create methods
 115
 116   /**
 117    * Ensure numeric_phone field is correctly populated (this happens via sql trigger)
 118    */
 119   public function testNumericPhone() {
 120     $result = $this->callAPISuccess('phone', 'create', $this->_params);
 121     $id = $result['id'];
 122     $params = array('id' => $id, 'return.phone_numeric' => 1);
 123     $result = $this->callAPISuccess('phone', 'get', $params);
 124     $this->assertEquals('1234567890', $result['values'][$id]['phone_numeric']);
 125   }
 126
 127   /**
 128    * If a new phone is set to is_primary the prev should no longer be.
 129    *
 130    * If is_primary is not set then it should become is_primary is no others exist
 131    */
 132   public function testCreatePhonePrimaryHandlingChangeToPrimary() {
 133     $params = $this->_params;
 134     unset($params['is_primary']);
 135     $phone1 = $this->callAPISuccess('phone', 'create', $params);
 136     //now we check & make sure it has been set to primary
 137     $check = $this->callAPISuccess('phone', 'getcount', array(
 138       'is_primary' => 1,
 139       'id' => $phone1['id'],
 140     ));
 141     $this->assertEquals(1, $check);
 142   }
 143
 144   public function testCreatePhonePrimaryHandlingChangeExisting() {
 145     $phone1 = $this->callAPISuccess('phone', 'create', $this->_params);
 146     $phone2 = $this->callAPISuccess('phone', 'create', $this->_params);
 147     $check = $this->callAPISuccess('phone', 'getcount', array(
 148       'is_primary' => 1,
 149       'contact_id' => $this->_contactID,
 150     ));
 151     $this->assertEquals(1, $check);
 152   }
 153
 154 }