add missing comments - tests directory

[civicrm-core.git] / tests / phpunit / api / v3 / PriceFieldValueTest.php

<?php

/*
 +--------------------------------------------------------------------+
| CiviCRM version 4.5                                                |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014                                |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM.                                    |
|                                                                    |
| CiviCRM is free software; you can copy, modify, and distribute it  |
| under the terms of the GNU Affero General Public License           |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
|                                                                    |
| CiviCRM is distributed in the hope that it will be useful, but     |
| WITHOUT ANY WARRANTY; without even the implied warranty of         |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
| See the GNU Affero General Public License for more details.        |
|                                                                    |
| You should have received a copy of the GNU Affero General Public   |
| License and the CiviCRM Licensing Exception along                  |
| with this program; if not, contact CiviCRM LLC                     |
| at info[AT]civicrm[DOT]org. If you have questions about the        |
| GNU Affero General Public License or the licensing of CiviCRM,     |
| see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+--------------------------------------------------------------------+
*/

require_once 'CiviTest/CiviUnitTestCase.php';
class api_v3_PriceFieldValueTest extends CiviUnitTestCase {
  protected $_apiversion = 3;
  protected $_params;
  protected $id = 0;
  protected $priceSetID = 0;
  protected $_entity = 'price_field_value';

  public $DBResetRequired = TRUE;

  public function setUp() {
    parent::setUp();
    // put stuff here that should happen before all tests in this unit
    $priceSetparams = array(
      #     [domain_id] =>
      'name' => 'default_goat_priceset',
      'title' => 'Goat accomodation',
      'is_active' => 1,
      'help_pre' => "Where does your goat sleep",
      'help_post' => "thank you for your time",
      'extends' => 2,
      'financial_type_id' => 1,
      'is_quick_config' => 1,
      'is_reserved' => 1,
    );

    $price_set = $this->callAPISuccess('price_set', 'create',$priceSetparams);
    $this->priceSetID = $price_set['id'];

    $priceFieldparams = array(
      'price_set_id' => $this->priceSetID,
      'name' => 'grassvariety',
      'label' => 'Grass Variety',
      'html_type' => 'Text',
      'is_enter_qty' => 1,
      'is_active' => 1,
    );
    $priceField = $this->callAPISuccess('price_field','create', $priceFieldparams);
    $this->priceFieldID = $priceField['id'];
    $this->_params = array(
      'price_field_id' => $this->priceFieldID,
      'name' => 'ryegrass',
      'label' => 'juicy and healthy',
      'amount' => 1
     );

    $membershipOrgId = $this->organizationCreate(NULL);
    $this->_membershipTypeID = $this->membershipTypeCreate(array('member_of_contact_id' => $membershipOrgId));
    $priceSetparams1 = array(
      'name' => 'priceset',
      'title' => 'Priceset with Multiple Terms',
      'is_active' => 1,
      'extends' => 3,
      'financial_type_id' => 2,
      'is_quick_config' => 1,
      'is_reserved' => 1,
    );
    $price_set1 = $this->callAPISuccess('price_set', 'create',$priceSetparams1);
    $this->priceSetID1 = $price_set1['id'];
    $priceFieldparams1 = array(
      'price_set_id' => $this->priceSetID1,
      'name' => 'memtype',
      'label' => 'memtype',
      'html_type' => 'Radio',
      'is_enter_qty' => 1,
      'is_active' => 1,
    );
    $priceField1 = $this->callAPISuccess('price_field','create', $priceFieldparams1);
    $this->priceFieldID1 = $priceField1['id'];
  }

  function tearDown() {
    $tablesToTruncate = array(
        'civicrm_contact',
        'civicrm_contribution',
    );
    $this->quickCleanup($tablesToTruncate);
    $this->membershipTypeDelete(array('id' => $this->_membershipTypeID));
    $this->callAPISuccess('PriceField','delete', array(
        'id' => $this->priceFieldID1,
    ));
    $this->callAPISuccess('PriceSet','delete', array(
      'id' => $this->priceSetID1,
    ));
    $this->callAPISuccess('PriceField','delete', array(
        'id' => $this->priceFieldID,
    ));
    $delete = $this->callAPISuccess('PriceSet','delete', array(
      'id' => $this->priceSetID,
    ));

    $this->assertAPISuccess($delete);
  }

  public function testCreatePriceFieldValue() {
    $result = $this->callAPIAndDocument($this->_entity, 'create', $this->_params, __FUNCTION__, __FILE__);
    $this->assertAPISuccess($result, 'In line ' . __LINE__);
    $this->assertEquals(1, $result['count'], 'In line ' . __LINE__);
    $this->assertNotNull($result['values'][$result['id']]['id'], 'In line ' . __LINE__);
    $this->getAndCheck($this->_params, $result['id'], $this->_entity);
  }

  public function testGetBasicPriceFieldValue() {
    $createResult = $this->callAPISuccess($this->_entity, 'create', $this->_params);
    $this->id = $createResult['id'];
    $this->assertAPISuccess($createResult);
    $getParams = array(
      'name' => 'contribution_amount',
    );
    $getResult = $this->callAPIAndDocument($this->_entity, 'get', $getParams, __FUNCTION__, __FILE__);
    $this->assertEquals(1, $getResult['count'], 'In line ' . __LINE__);
    $this->callAPISuccess('price_field_value','delete', array('id' => $createResult['id']));
  }

  public function testDeletePriceFieldValue() {
    $startCount = $this->callAPISuccess($this->_entity, 'getcount', array());
    $createResult = $this->callAPISuccess($this->_entity, 'create', $this->_params);
    $deleteParams = array('id' => $createResult['id']);
    $deleteResult = $this->callAPIAndDocument($this->_entity, 'delete', $deleteParams, __FUNCTION__, __FILE__);

    $endCount = $this->callAPISuccess($this->_entity, 'getcount', array());
    $this->assertEquals($startCount, $endCount, 'In line ' . __LINE__);
  }

  public function testGetFieldsPriceFieldValue() {
    $result = $this->callAPISuccess($this->_entity, 'getfields', array('action' => 'create'));
    $this->assertEquals(1, $result['values']['max_value']['type']);
  }

  public function testCreatePriceFieldValuewithMultipleTerms() {
    $params = array(
      'price_field_id' => $this->priceFieldID1,
      'membership_type_id' =>  $this->_membershipTypeID,
      'name' => 'memType1',
      'label' => 'memType1',
      'amount' => 90,
      'membership_num_terms' => 2,
      'is_active' => 1,
      'financial_type_id' => 2,
     );
    $result = $this->callAPIAndDocument($this->_entity, 'create', $params, __FUNCTION__, __FILE__);
    $this->assertEquals($result['values'][$result['id']]['membership_num_terms'], 2);
    $this->assertEquals(1, $result['count'], 'In line ' . __LINE__);
    $this->callAPISuccess($this->_entity, 'delete', array('id' => $result['id']));
  }
  public function testGetPriceFieldValuewithMultipleTerms() {
    $params1 = array(
      'price_field_id' => $this->priceFieldID1,
      'membership_type_id' =>  $this->_membershipTypeID,
      'name' => 'memType1',
      'label' => 'memType1',
      'amount' => 90,
      'membership_num_terms' => 2,
      'is_active' => 1,
      'financial_type_id' => 2,
     );
    $params2 = array(
      'price_field_id' => $this->priceFieldID1,
      'membership_type_id' =>  $this->_membershipTypeID,
      'name' => 'memType2',
      'label' => 'memType2',
      'amount' => 120,
      'membership_num_terms' => 3,
      'is_active' => 1,
      'financial_type_id' => 2,
     );
    $result1 = $this->callAPISuccess($this->_entity, 'create', $params1);
    $result2 = $this->callAPISuccess($this->_entity, 'create', $params2);
    $result = $this->callAPISuccess($this->_entity, 'get', array('price_field_id' =>$this->priceFieldID1 ));
    $this->assertEquals(2, $result['count'], 'In line ' . __LINE__);
    $this->callAPISuccess($this->_entity,'delete', array('id' => $result1['id']));
    $this->callAPISuccess($this->_entity,'delete', array('id' => $result2['id']));
  }
}