tests/phpunit/api/v3/WebsiteTest.php

   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  *  Test APIv3 civicrm_website_* functions
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Contact
  33  * @group headless
  34  */
  35 class api_v3_WebsiteTest extends CiviUnitTestCase {
  36   protected $_apiversion = 3;
  37   protected $params;
  38   protected $id;
  39   protected $_entity;
  40
  41   public $DBResetRequired = FALSE;
  42
  43   public function setUp() {
  44     parent::setUp();
  45     $this->useTransaction();
  46
  47     $this->_entity = 'website';
  48     $this->_contactID = $this->organizationCreate();
  49     $this->params = [
  50       'contact_id' => $this->_contactID,
  51       'url' => 'website.com',
  52       'website_type_id' => 1,
  53     ];
  54   }
  55
  56   /**
  57    * @param int $version
  58    * @dataProvider versionThreeAndFour
  59    */
  60   public function testCreateWebsite($version) {
  61     $this->_apiversion = $version;
  62     $result = $this->callAPIAndDocument($this->_entity, 'create', $this->params, __FUNCTION__, __FILE__);
  63     $this->assertEquals(1, $result['count']);
  64     $this->getAndCheck($this->params, $result['id'], $this->_entity);
  65     $this->assertNotNull($result['values'][$result['id']]['id']);
  66   }
  67
  68   /**
  69    * @param int $version
  70    * @dataProvider versionThreeAndFour
  71    */
  72   public function testGetWebsite($version) {
  73     $this->_apiversion = $version;
  74     $result = $this->callAPISuccess($this->_entity, 'create', $this->params);
  75     $result = $this->callAPIAndDocument($this->_entity, 'get', $this->params, __FUNCTION__, __FILE__);
  76     $this->assertEquals(1, $result['count']);
  77     $this->assertNotNull($result['values'][$result['id']]['id']);
  78     $this->callAPISuccess('website', 'delete', ['id' => $result['id']]);
  79   }
  80
  81   /**
  82    * @param int $version
  83    * @dataProvider versionThreeAndFour
  84    */
  85   public function testDeleteWebsite($version) {
  86     $this->_apiversion = $version;
  87     $result = $this->callAPISuccess($this->_entity, 'create', $this->params);
  88     $deleteParams = ['id' => $result['id']];
  89     $result = $this->callAPIAndDocument($this->_entity, 'delete', $deleteParams, __FUNCTION__, __FILE__);
  90     $checkDeleted = $this->callAPISuccess($this->_entity, 'get', []);
  91     $this->assertEquals(0, $checkDeleted['count']);
  92   }
  93
  94   /**
  95    * @param int $version
  96    * @dataProvider versionThreeAndFour
  97    */
  98   public function testDeleteWebsiteInvalid($version) {
  99     $this->_apiversion = $version;
 100     $result = $this->callAPISuccess($this->_entity, 'create', $this->params);
 101     $deleteParams = ['id' => 600];
 102     $result = $this->callAPIFailure($this->_entity, 'delete', $deleteParams);
 103     $checkDeleted = $this->callAPISuccess($this->_entity, 'get', []);
 104     $this->assertEquals(1, $checkDeleted['count']);
 105   }
 106
 107   /**
 108    * Test retrieval of metadata.
 109    */
 110   public function testGetMetadata() {
 111     $result = $this->callAPIAndDocument($this->_entity, 'get', [
 112       'options' => [
 113         'metadata' => ['fields'],
 114       ],
 115     ], __FUNCTION__, __FILE__, 'Demonostrates returning field metadata', 'GetWithMetadata');
 116     $this->assertEquals('Website', $result['metadata']['fields']['url']['title']);
 117   }
 118
 119   /**
 120    * @param int $version
 121    * @dataProvider versionThreeAndFour
 122    */
 123   public function testGetFields($version) {
 124     $this->_apiversion = $version;
 125     $result = $this->callAPIAndDocument($this->_entity, 'getfields', ['action' => 'get'], __FUNCTION__, __FILE__);
 126     $this->assertArrayKeyExists('url', $result['values']);
 127   }
 128
 129 }